Palacios Public Git Repository

To checkout Palacios execute

  git clone http://v3vee.org/palacios/palacios.web/palacios.git
This will give you the master branch. You probably want the devel branch or one of the release branches. To switch to the devel branch, simply execute
  cd palacios
  git checkout --track -b devel origin/devel
The other branches are similar.


Merge branch 'Release-1.2' of ssh://palacios@newskysaw.cs.northwestern.edu//home...
[palacios.git] / palacios / include / palacios / vmm_hashtable.h
index 380af91..79f5f05 100644 (file)
@@ -1,7 +1,37 @@
-/* Copyright (C) 2002 Christopher Clark <firstname.lastname@cl.cam.ac.uk> */
+/*
+  Copyright (c) 2002, 2004, 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.
+*/
 /* Modifications made by Jack Lange <jarusl@cs.northwestern.edu> */
-/* (c) 2008, Jack Lange <jarusl@cs.northwestern.edu> */
-/* (c) 2008, The V3VEE Project <http://www.v3vee.org> */
+
 
 
 #ifndef __VMM_HASHTABLE_H__
@@ -67,37 +97,36 @@ struct hashtable;
  *
  */
 
-ulong_t hash_long(ulong_t val, uint_t bits);
-ulong_t hash_buffer(uchar_t * msg, uint_t length);
-
-
-
-
 #define DEFINE_HASHTABLE_INSERT(fnname, keytype, valuetype)            \
-  int fnname (struct hashtable * htable, keytype key, valuetype value) { \
-    return hashtable_insert(htable, (addr_t)key, (addr_t)value);               \
-  }
+    static int fnname (struct hashtable * htable, keytype key, valuetype value) { \
+       return v3_htable_insert(htable, (addr_t)key, (addr_t)value);    \
+    }
 
 #define DEFINE_HASHTABLE_SEARCH(fnname, keytype, valuetype)            \
-  valuetype * fnname (struct hashtable * htable, keytype  key) {       \
-    return (valuetype *) (hashtable_search(htable, (addr_t)key));              \
-  }
+    static valuetype * fnname (struct hashtable * htable, keytype  key) { \
+       return (valuetype *) (v3_htable_search(htable, (addr_t)key));   \
+    }
 
 #define DEFINE_HASHTABLE_REMOVE(fnname, keytype, valuetype, free_key)  \
-  valuetype * fnname (struct hashtable * htable, keytype key) {        \
-    return (valuetype *) (hashtable_remove(htable, (addr_t)key, free_key));    \
-  }
+    static valuetype * fnname (struct hashtable * htable, keytype key) { \
+       return (valuetype *) (v3_htable_remove(htable, (addr_t)key, free_key)); \
+    }
 
 
 
 
 
+/* These cannot be inlined because they are referenced as fn ptrs */
+ulong_t v3_hash_long(ulong_t val, uint_t bits);
+ulong_t v3_hash_buffer(uchar_t * msg, uint_t length);
 
-struct hashtable * create_hashtable(uint_t min_size,
+
+
+struct hashtable * v3_create_htable(uint_t min_size,
                                    uint_t (*hashfunction) (addr_t key),
                                    int (*key_eq_fn) (addr_t key1, addr_t key2));
 
-void hashtable_destroy(struct hashtable * htable, int free_values, int free_keys);
+void v3_free_htable(struct hashtable * htable, int free_values, int free_keys);
 
 /*
  * returns non-zero for successful insertion
@@ -111,27 +140,32 @@ void hashtable_destroy(struct hashtable * htable, int free_values, int free_keys
  * entries is reversed.
  * If in doubt, remove before insert.
  */
-int hashtable_insert(struct hashtable * htable, addr_t key, addr_t value);
+int v3_htable_insert(struct hashtable * htable, addr_t key, addr_t value);
 
-int hashtable_change(struct hashtable * htable, addr_t key, addr_t value, int free_value);
+int v3_htable_change(struct hashtable * htable, addr_t key, addr_t value, int free_value);
 
 
 // returns the value associated with the key, or NULL if none found
-addr_t hashtable_search(struct hashtable * htable, addr_t key);
+addr_t v3_htable_search(struct hashtable * htable, addr_t key);
 
 // returns the value associated with the key, or NULL if none found
-addr_t hashtable_remove(struct hashtable * htable, addr_t key, int free_key);
+addr_t v3_htable_remove(struct hashtable * htable, addr_t key, int free_key);
+
+uint_t v3_htable_count(struct hashtable * htable);
+
+// Specialty functions for a counting hashtable 
+int v3_htable_inc(struct hashtable * htable, addr_t key, addr_t value);
+int v3_htable_dec(struct hashtable * htable, addr_t key, addr_t value);
 
-uint_t hashtable_count(struct hashtable * htable);
 
-  /* ************ */
- /* ITERATOR API */
+/* ************ */
+/* ITERATOR API */
 /* ************ */
 
 #define DEFINE_HASHTABLE_ITERATOR_SEARCH(fnname, keytype)              \
-  int fnname (struct hashtable_itr * iter, struct hashtable * htable, keytype * key) { \
-    return (hashtable_iterator_search(iter, htable, key));             \
-  }
+   static int fnname (struct hashtable_itr * iter, struct hashtable * htable, keytype * key) { \
+       return (v3_htable_iter_search(iter, htable, key));              \
+    }
 
 
 
@@ -139,18 +173,18 @@ uint_t hashtable_count(struct hashtable * htable);
 /* This struct is only concrete here to allow the inlining of two of the
  * accessor functions. */
 struct hashtable_iter {
-  struct hashtable * htable;
-  struct hash_entry * entry;
-  struct hash_entry * parent;
-  uint_t index;
+    struct hashtable * htable;
+    struct hash_entry * entry;
+    struct hash_entry * parent;
+    uint_t index;
 };
 
 
-struct hashtable_iter * create_hashtable_iterator(struct hashtable * htable);
+struct hashtable_iter * v3_create_htable_iter(struct hashtable * htable);
 
 /* - return the value of the (key,value) pair at the current position */
 //extern inline 
-addr_t  hashtable_get_iter_key(struct hashtable_iter * iter);
+addr_t v3_htable_get_iter_key(struct hashtable_iter * iter);
 /* {
    return iter->entry->key;
    }
@@ -159,7 +193,7 @@ addr_t  hashtable_get_iter_key(struct hashtable_iter * iter);
 
 /* value - return the value of the (key,value) pair at the current position */
 //extern inline 
-addr_t hashtable_get_iter_value(struct hashtable_iter * iter);
+addr_t v3_htable_get_iter_value(struct hashtable_iter * iter);
 /* {
    return iter->entry->value;
    }
@@ -168,20 +202,20 @@ addr_t hashtable_get_iter_value(struct hashtable_iter * iter);
 
 
 /* returns zero if advanced to end of table */
-int hashtable_iterator_advance(struct hashtable_iter * iter);
+int v3_htable_iter_advance(struct hashtable_iter * iter);
 
 /* remove current element and advance the iterator to the next element
  *          NB: if you need the value to free it, read it before
  *          removing. ie: beware memory leaks!
  *          returns zero if advanced to end of table 
  */
-int hashtable_iterator_remove(struct hashtable_iter * iter, int free_key);
+int v3_htable_iter_remove(struct hashtable_iter * iter, int free_key);
 
 
 /* search - overwrite the supplied iterator, to point to the entry
  *          matching the supplied key.
  *          returns zero if not found. */
-int hashtable_iterator_search(struct hashtable_iter * iter, struct hashtable * htable, addr_t key);
+int v3_htable_iter_search(struct hashtable_iter * iter, struct hashtable * htable, addr_t key);
 
 
 
@@ -259,4 +293,4 @@ int hashtable_iterator_search(struct hashtable_iter * iter, struct hashtable * h
  * 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.
-*/
+ */