Xen project Mailing List

Re: [Xen-devel] [PATCH 09 of 30] tools: blktap2: copy xenstore/hashtable.h into blktap2

To: Ian Jackson <Ian.Jackson@xxxxxxxxxxxxx>

From: Ian Campbell <Ian.Campbell@xxxxxxxxxx>

Date: Thu, 24 Mar 2011 10:29:26 +0000

Cc: "xen-devel@xxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxx>

Delivery-date: Thu, 24 Mar 2011 03:31:03 -0700

List-id: Xen developer discussion <xen-devel.lists.xensource.com>

On Mon, 2011-03-21 at 18:03 +0000, Ian Jackson wrote: > Ian Campbell writes ("[Xen-devel] [PATCH 09 of 30] tools: blktap2: copy > xenstore/hashtable.h into blktap2"): > > tools: blktap2: copy xenstore/hashtable.h into blktap2 > > > > hashtable.c has already been copied, forked and modified, there > > doesn't seem much point in avoiding the same for the header until > > someone feels motivated to properly refactor. > > Before we make this any worse, perhaps we should at least leave a > comment in every copy of hashtable.c referring to every other clone ? Sure. I found another one in vtpm_manager while doing so as well :-( 8<----------------------- # HG changeset patch # User Ian Campbell <ian.campbell@xxxxxxxxxx> # Date 1300962476 0 # Node ID 708fdb28b0530e331a6df59cd42b1c3acfc85f8b # Parent 63f4adae7d7b70d323181ff31fc19f5432d283ff tools: blktap2: copy xenstore/hashtable.h into blktap2 hashtable.c has already been copied, forked and modified, there doesn't seem much point in avoiding the same for the header until someone feels motivated to properly refactor. Add comments to the various duplicated files cross-referencing each other for future reference and as a barrier to forking again... Signed-off-by: Ian Campbell <ian.campbell@xxxxxxxxxx> diff -r 63f4adae7d7b -r 708fdb28b053 tools/blktap2/drivers/Makefile --- a/tools/blktap2/drivers/Makefile Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/blktap2/drivers/Makefile Thu Mar 24 10:27:56 2011 +0000 @@ -29,8 +29,6 @@ REMUS-OBJS += hashtable.o REMUS-OBJS += hashtable.o REMUS-OBJS += hashtable_itr.o REMUS-OBJS += hashtable_utility.o - -$(REMUS-OBJS): CFLAGS += -I$(XEN_XENSTORE) LIBAIO_DIR = $(XEN_ROOT)/tools/libaio/src MEMSHR_DIR = $(XEN_ROOT)/tools/memshr diff -r 63f4adae7d7b -r 708fdb28b053 tools/blktap2/drivers/hashtable.c --- a/tools/blktap2/drivers/hashtable.c Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/blktap2/drivers/hashtable.c Thu Mar 24 10:27:56 2011 +0000 @@ -1,4 +1,10 @@ /* Copyright (C) 2004 Christopher Clark <firstname.lastname@xxxxxxxxxxxx> */ + +/* + * There are duplicates of this code in: + * - tools/xenstore/hashtable.c + * - tools/vtpm_manager/util/hashtable.c + */ #include "hashtable.h" #include "hashtable_private.h" diff -r 63f4adae7d7b -r 708fdb28b053 tools/blktap2/drivers/hashtable.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/tools/blktap2/drivers/hashtable.h Thu Mar 24 10:27:56 2011 +0000 @@ -0,0 +1,205 @@ +/* Copyright (C) 2002 Christopher Clark <firstname.lastname@xxxxxxxxxxxx> */ + +/* + * There are duplicates of this code in: + * - tools/xenstore/hashtable.h + * - tools/vtpm_manager/util/hashtable.h + */ + +#ifndef __HASHTABLE_CWC22_H__ +#define __HASHTABLE_CWC22_H__ + +struct hashtable; + +/* Example of use: + * + * struct hashtable *h; + * struct some_key *k; + * struct some_value *v; + * + * static unsigned int hash_from_key_fn( void *k ); + * static int keys_equal_fn ( void *key1, void *key2 ); + * + * h = create_hashtable(16, hash_from_key_fn, keys_equal_fn); + * k = (struct some_key *) malloc(sizeof(struct some_key)); + * v = (struct some_value *) malloc(sizeof(struct some_value)); + * + * (initialise k and v to suitable values) + * + * if (! hashtable_insert(h,k,v) ) + * { exit(-1); } + * + * if (NULL == (found = hashtable_search(h,k) )) + * { printf("not found!"); } + * + * if (NULL == (found = hashtable_remove(h,k) )) + * { printf("Not found\n"); } + * + */ + +/* Macros may be used to define type-safe(r) hashtable access functions, with + * methods specialized to take known key and value types as parameters. + * + * Example: + * + * Insert this at the start of your file: + * + * DEFINE_HASHTABLE_INSERT(insert_some, struct some_key, struct some_value); + * DEFINE_HASHTABLE_SEARCH(search_some, struct some_key, struct some_value); + * DEFINE_HASHTABLE_REMOVE(remove_some, struct some_key, struct some_value); + * + * This defines the functions 'insert_some', 'search_some' and 'remove_some'. + * These operate just like hashtable_insert etc., with the same parameters, + * but their function signatures have 'struct some_key *' rather than + * 'void *', and hence can generate compile time errors if your program is + * supplying incorrect data as a key (and similarly for value). + * + * Note that the hash and key equality functions passed to create_hashtable + * still take 'void *' parameters instead of 'some key *'. This shouldn't be + * a difficult issue as they're only defined and passed once, and the other + * functions will ensure that only valid keys are supplied to them. + * + * The cost for this checking is increased code size and runtime overhead + * - if performance is important, it may be worth switching back to the + * unsafe methods once your program has been debugged with the safe methods. + * This just requires switching to some simple alternative defines - eg: + * #define insert_some hashtable_insert + * + */ + +/***************************************************************************** + * create_hashtable + + * @name create_hashtable + * @param minsize minimum initial size of hashtable + * @param hashfunction function for hashing keys + * @param key_eq_fn function for determining key equality + * @return newly created hashtable or NULL on failure + */ + +struct hashtable * +create_hashtable(unsigned int minsize, + unsigned int (*hashfunction) (void*), + int (*key_eq_fn) (void*,void*)); + +/***************************************************************************** + * hashtable_insert + + * @name hashtable_insert + * @param h the hashtable to insert into + * @param k the key - hashtable claims ownership and will free on removal + * @param v the value - does not claim ownership + * @return non-zero for successful insertion + * + * This function will cause the table to expand if the insertion would take + * the ratio of entries to table size over the maximum load factor. + * + * This function does not check for repeated insertions with a duplicate key. + * The value returned when using a duplicate key is undefined -- when + * the hashtable changes size, the order of retrieval of duplicate key + * entries is reversed. + * If in doubt, remove before insert. + */ + +int +hashtable_insert(struct hashtable *h, void *k, void *v); + +#define DEFINE_HASHTABLE_INSERT(fnname, keytype, valuetype) \ +int fnname (struct hashtable *h, keytype *k, valuetype *v) \ +{ \ + return hashtable_insert(h,k,v); \ +} + +/***************************************************************************** + * hashtable_search + + * @name hashtable_search + * @param h the hashtable to search + * @param k the key to search for - does not claim ownership + * @return the value associated with the key, or NULL if none found + */ + +void * +hashtable_search(struct hashtable *h, void *k); + +#define DEFINE_HASHTABLE_SEARCH(fnname, keytype, valuetype) \ +valuetype * fnname (struct hashtable *h, keytype *k) \ +{ \ + return (valuetype *) (hashtable_search(h,k)); \ +} + +/***************************************************************************** + * hashtable_remove + + * @name hashtable_remove + * @param h the hashtable to remove the item from + * @param k the key to search for - does not claim ownership + * @return the value associated with the key, or NULL if none found + */ + +void * /* returns value */ +hashtable_remove(struct hashtable *h, void *k); + +#define DEFINE_HASHTABLE_REMOVE(fnname, keytype, valuetype) \ +valuetype * fnname (struct hashtable *h, keytype *k) \ +{ \ + return (valuetype *) (hashtable_remove(h,k)); \ +} + + +/***************************************************************************** + * hashtable_count + + * @name hashtable_count + * @param h the hashtable + * @return the number of items stored in the hashtable + */ +unsigned int +hashtable_count(struct hashtable *h); + + +/***************************************************************************** + * hashtable_destroy + + * @name hashtable_destroy + * @param h the hashtable + * @param free_values whether to call 'free' on the remaining values + */ + +void +hashtable_destroy(struct hashtable *h, int free_values); + +#endif /* __HASHTABLE_CWC22_H__ */ + +/* + * Copyright (c) 2002, Christopher Clark + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * * Neither the name of the original author; nor the names of any contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER + * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ diff -r 63f4adae7d7b -r 708fdb28b053 tools/blktap2/drivers/hashtable_itr.c --- a/tools/blktap2/drivers/hashtable_itr.c Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/blktap2/drivers/hashtable_itr.c Thu Mar 24 10:27:56 2011 +0000 @@ -1,4 +1,9 @@ /* Copyright (C) 2002, 2004 Christopher Clark <firstname.lastname@xxxxxxxxxxxx> */ + +/* + * There are duplicates of this code in: + * - tools/vtpm_manager/util/hashtable_itr.c + */ #include "hashtable.h" #include "hashtable_private.h" diff -r 63f4adae7d7b -r 708fdb28b053 tools/blktap2/drivers/hashtable_itr.h --- a/tools/blktap2/drivers/hashtable_itr.h Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/blktap2/drivers/hashtable_itr.h Thu Mar 24 10:27:56 2011 +0000 @@ -1,4 +1,9 @@ /* Copyright (C) 2002, 2004 Christopher Clark <firstname.lastname@xxxxxxxxxxxx> */ + +/* + * There are duplicates of this code in: + * - tools/vtpm_manager/util/hashtable_itr.h + */ #ifndef __HASHTABLE_ITR_CWC22__ #define __HASHTABLE_ITR_CWC22__ diff -r 63f4adae7d7b -r 708fdb28b053 tools/blktap2/drivers/hashtable_private.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/tools/blktap2/drivers/hashtable_private.h Thu Mar 24 10:27:56 2011 +0000 @@ -0,0 +1,91 @@ +/* Copyright (C) 2002, 2004 Christopher Clark <firstname.lastname@xxxxxxxxxxxx> */ + +/* + * There are duplicates of this code in: + * - tools/xenstore/hashtable_private.h + * - tools/vtpm_manager/util/hashtable_private.h + */ + +#ifndef __HASHTABLE_PRIVATE_CWC22_H__ +#define __HASHTABLE_PRIVATE_CWC22_H__ + +#include "hashtable.h" + +/*****************************************************************************/ +struct entry +{ + void *k, *v; + unsigned int h; + struct entry *next; +}; + +struct hashtable { + unsigned int tablelength; + struct entry **table; + unsigned int entrycount; + unsigned int loadlimit; + unsigned int primeindex; + unsigned int (*hashfn) (void *k); + int (*eqfn) (void *k1, void *k2); +}; + +/*****************************************************************************/ +unsigned int +hash(struct hashtable *h, void *k); + +/*****************************************************************************/ +/* indexFor */ +static inline unsigned int +indexFor(unsigned int tablelength, unsigned int hashvalue) { + return (hashvalue % tablelength); +}; + +/* Only works if tablelength == 2^N */ +/*static inline unsigned int +indexFor(unsigned int tablelength, unsigned int hashvalue) +{ + return (hashvalue & (tablelength - 1u)); +} +*/ + +/*****************************************************************************/ +#define freekey(X) free(X) +/*define freekey(X) ; */ + + +/*****************************************************************************/ + +#endif /* __HASHTABLE_PRIVATE_CWC22_H__*/ + +/* + * Copyright (c) 2002, Christopher Clark + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * * Neither the name of the original author; nor the names of any contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER + * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ diff -r 63f4adae7d7b -r 708fdb28b053 tools/vtpm_manager/util/hashtable.c --- a/tools/vtpm_manager/util/hashtable.c Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/vtpm_manager/util/hashtable.c Thu Mar 24 10:27:56 2011 +0000 @@ -31,6 +31,12 @@ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ + +/* + * There are duplicates of this code in: + * - tools/xenstore/hashtable.c + * - tools/blktap2/drivers/hashtable.c + */ #include "hashtable.h" #include "hashtable_private.h" diff -r 63f4adae7d7b -r 708fdb28b053 tools/vtpm_manager/util/hashtable.h --- a/tools/vtpm_manager/util/hashtable.h Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/vtpm_manager/util/hashtable.h Thu Mar 24 10:27:56 2011 +0000 @@ -32,6 +32,11 @@ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/* + * There are duplicates of this code in: + * - tools/xenstore/hashtable.h + * - tools/blktap2/drivers/hashtable.h + */ #ifndef __HASHTABLE_CWC22_H__ #define __HASHTABLE_CWC22_H__ diff -r 63f4adae7d7b -r 708fdb28b053 tools/vtpm_manager/util/hashtable_itr.c --- a/tools/vtpm_manager/util/hashtable_itr.c Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/vtpm_manager/util/hashtable_itr.c Thu Mar 24 10:27:56 2011 +0000 @@ -31,6 +31,11 @@ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ + +/* + * There are duplicates of this code in: + * - tools/blktap2/drivers/hashtable_itr.c + */ #include "hashtable.h" #include "hashtable_private.h" diff -r 63f4adae7d7b -r 708fdb28b053 tools/vtpm_manager/util/hashtable_itr.h --- a/tools/vtpm_manager/util/hashtable_itr.h Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/vtpm_manager/util/hashtable_itr.h Thu Mar 24 10:27:56 2011 +0000 @@ -31,6 +31,11 @@ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ + +/* + * There are duplicates of this code in: + * - tools/blktap2/drivers/hashtable_itr.h + */ #ifndef __HASHTABLE_ITR_CWC22__ diff -r 63f4adae7d7b -r 708fdb28b053 tools/vtpm_manager/util/hashtable_private.h --- a/tools/vtpm_manager/util/hashtable_private.h Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/vtpm_manager/util/hashtable_private.h Thu Mar 24 10:27:56 2011 +0000 @@ -31,6 +31,12 @@ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ + +/* + * There are duplicates of this code in: + * - tools/xenstore/hashtable_private.h + * - tools/blktap2/drivers/hashtable_private.h + */ #ifndef __HASHTABLE_PRIVATE_CWC22_H__ #define __HASHTABLE_PRIVATE_CWC22_H__ diff -r 63f4adae7d7b -r 708fdb28b053 tools/xenstore/hashtable.c --- a/tools/xenstore/hashtable.c Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/xenstore/hashtable.c Thu Mar 24 10:27:56 2011 +0000 @@ -1,4 +1,10 @@ /* Copyright (C) 2004 Christopher Clark <firstname.lastname@xxxxxxxxxxxx> */ + +/* + * There are duplicates of this code in: + * - tools/blktap2/drivers/hashtable.c + * - tools/vtpm_manager/util/hashtable.c + */ #include "hashtable.h" #include "hashtable_private.h" diff -r 63f4adae7d7b -r 708fdb28b053 tools/xenstore/hashtable.h --- a/tools/xenstore/hashtable.h Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/xenstore/hashtable.h Thu Mar 24 10:27:56 2011 +0000 @@ -1,4 +1,10 @@ /* Copyright (C) 2002 Christopher Clark <firstname.lastname@xxxxxxxxxxxx> */ + +/* + * There are duplicates of this code in: + * - tools/blktap2/drivers/hashtable.h + * - tools/vtpm_manager/util/hashtable.h + */ #ifndef __HASHTABLE_CWC22_H__ #define __HASHTABLE_CWC22_H__ diff -r 63f4adae7d7b -r 708fdb28b053 tools/xenstore/hashtable_private.h --- a/tools/xenstore/hashtable_private.h Wed Mar 23 17:04:20 2011 +0000 +++ b/tools/xenstore/hashtable_private.h Thu Mar 24 10:27:56 2011 +0000 @@ -1,4 +1,10 @@ /* Copyright (C) 2002, 2004 Christopher Clark <firstname.lastname@xxxxxxxxxxxx> */ + +/* + * There are duplicates of this code in: + * - tools/blktap2/drivers/hashtable_private.h + * - tools/vtpm_manager/util/hashtable_private.h + */ #ifndef __HASHTABLE_PRIVATE_CWC22_H__ #define __HASHTABLE_PRIVATE_CWC22_H__ _______________________________________________ Xen-devel mailing list Xen-devel@xxxxxxxxxxxxxxxxxxx http://lists.xensource.com/xen-devel

©2013 Xen Project, A Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation.
Xen Project is a trademark of The Linux Foundation.