fts3_hash.c.svn-base
上传用户:sunhongbo
上传日期:2022-01-25
资源大小:3010k
文件大小:11k
源码类别:

数据库系统

开发平台:

C/C++

  1. /*
  2. ** 2001 September 22
  3. **
  4. ** The author disclaims copyright to this source code.  In place of
  5. ** a legal notice, here is a blessing:
  6. **
  7. **    May you do good and not evil.
  8. **    May you find forgiveness for yourself and forgive others.
  9. **    May you share freely, never taking more than you give.
  10. **
  11. *************************************************************************
  12. ** This is the implementation of generic hash-tables used in SQLite.
  13. ** We've modified it slightly to serve as a standalone hash table
  14. ** implementation for the full-text indexing module.
  15. */
  16. /*
  17. ** The code in this file is only compiled if:
  18. **
  19. **     * The FTS3 module is being built as an extension
  20. **       (in which case SQLITE_CORE is not defined), or
  21. **
  22. **     * The FTS3 module is being built into the core of
  23. **       SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  24. */
  25. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  26. #include <assert.h>
  27. #include <stdlib.h>
  28. #include <string.h>
  29. #include "sqlite3.h"
  30. #include "fts3_hash.h"
  31. /*
  32. ** Malloc and Free functions
  33. */
  34. static void *fts3HashMalloc(int n){
  35.   void *p = sqlite3_malloc(n);
  36.   if( p ){
  37.     memset(p, 0, n);
  38.   }
  39.   return p;
  40. }
  41. static void fts3HashFree(void *p){
  42.   sqlite3_free(p);
  43. }
  44. /* Turn bulk memory into a hash table object by initializing the
  45. ** fields of the Hash structure.
  46. **
  47. ** "pNew" is a pointer to the hash table that is to be initialized.
  48. ** keyClass is one of the constants 
  49. ** FTS3_HASH_BINARY or FTS3_HASH_STRING.  The value of keyClass 
  50. ** determines what kind of key the hash table will use.  "copyKey" is
  51. ** true if the hash table should make its own private copy of keys and
  52. ** false if it should just use the supplied pointer.
  53. */
  54. void sqlite3Fts3HashInit(fts3Hash *pNew, int keyClass, int copyKey){
  55.   assert( pNew!=0 );
  56.   assert( keyClass>=FTS3_HASH_STRING && keyClass<=FTS3_HASH_BINARY );
  57.   pNew->keyClass = keyClass;
  58.   pNew->copyKey = copyKey;
  59.   pNew->first = 0;
  60.   pNew->count = 0;
  61.   pNew->htsize = 0;
  62.   pNew->ht = 0;
  63. }
  64. /* Remove all entries from a hash table.  Reclaim all memory.
  65. ** Call this routine to delete a hash table or to reset a hash table
  66. ** to the empty state.
  67. */
  68. void sqlite3Fts3HashClear(fts3Hash *pH){
  69.   fts3HashElem *elem;         /* For looping over all elements of the table */
  70.   assert( pH!=0 );
  71.   elem = pH->first;
  72.   pH->first = 0;
  73.   fts3HashFree(pH->ht);
  74.   pH->ht = 0;
  75.   pH->htsize = 0;
  76.   while( elem ){
  77.     fts3HashElem *next_elem = elem->next;
  78.     if( pH->copyKey && elem->pKey ){
  79.       fts3HashFree(elem->pKey);
  80.     }
  81.     fts3HashFree(elem);
  82.     elem = next_elem;
  83.   }
  84.   pH->count = 0;
  85. }
  86. /*
  87. ** Hash and comparison functions when the mode is FTS3_HASH_STRING
  88. */
  89. static int fts3StrHash(const void *pKey, int nKey){
  90.   const char *z = (const char *)pKey;
  91.   int h = 0;
  92.   if( nKey<=0 ) nKey = (int) strlen(z);
  93.   while( nKey > 0  ){
  94.     h = (h<<3) ^ h ^ *z++;
  95.     nKey--;
  96.   }
  97.   return h & 0x7fffffff;
  98. }
  99. static int fts3StrCompare(const void *pKey1, int n1, const void *pKey2, int n2){
  100.   if( n1!=n2 ) return 1;
  101.   return strncmp((const char*)pKey1,(const char*)pKey2,n1);
  102. }
  103. /*
  104. ** Hash and comparison functions when the mode is FTS3_HASH_BINARY
  105. */
  106. static int fts3BinHash(const void *pKey, int nKey){
  107.   int h = 0;
  108.   const char *z = (const char *)pKey;
  109.   while( nKey-- > 0 ){
  110.     h = (h<<3) ^ h ^ *(z++);
  111.   }
  112.   return h & 0x7fffffff;
  113. }
  114. static int fts3BinCompare(const void *pKey1, int n1, const void *pKey2, int n2){
  115.   if( n1!=n2 ) return 1;
  116.   return memcmp(pKey1,pKey2,n1);
  117. }
  118. /*
  119. ** Return a pointer to the appropriate hash function given the key class.
  120. **
  121. ** The C syntax in this function definition may be unfamilar to some 
  122. ** programmers, so we provide the following additional explanation:
  123. **
  124. ** The name of the function is "ftsHashFunction".  The function takes a
  125. ** single parameter "keyClass".  The return value of ftsHashFunction()
  126. ** is a pointer to another function.  Specifically, the return value
  127. ** of ftsHashFunction() is a pointer to a function that takes two parameters
  128. ** with types "const void*" and "int" and returns an "int".
  129. */
  130. static int (*ftsHashFunction(int keyClass))(const void*,int){
  131.   if( keyClass==FTS3_HASH_STRING ){
  132.     return &fts3StrHash;
  133.   }else{
  134.     assert( keyClass==FTS3_HASH_BINARY );
  135.     return &fts3BinHash;
  136.   }
  137. }
  138. /*
  139. ** Return a pointer to the appropriate hash function given the key class.
  140. **
  141. ** For help in interpreted the obscure C code in the function definition,
  142. ** see the header comment on the previous function.
  143. */
  144. static int (*ftsCompareFunction(int keyClass))(const void*,int,const void*,int){
  145.   if( keyClass==FTS3_HASH_STRING ){
  146.     return &fts3StrCompare;
  147.   }else{
  148.     assert( keyClass==FTS3_HASH_BINARY );
  149.     return &fts3BinCompare;
  150.   }
  151. }
  152. /* Link an element into the hash table
  153. */
  154. static void fts3HashInsertElement(
  155.   fts3Hash *pH,            /* The complete hash table */
  156.   struct _fts3ht *pEntry,  /* The entry into which pNew is inserted */
  157.   fts3HashElem *pNew       /* The element to be inserted */
  158. ){
  159.   fts3HashElem *pHead;     /* First element already in pEntry */
  160.   pHead = pEntry->chain;
  161.   if( pHead ){
  162.     pNew->next = pHead;
  163.     pNew->prev = pHead->prev;
  164.     if( pHead->prev ){ pHead->prev->next = pNew; }
  165.     else             { pH->first = pNew; }
  166.     pHead->prev = pNew;
  167.   }else{
  168.     pNew->next = pH->first;
  169.     if( pH->first ){ pH->first->prev = pNew; }
  170.     pNew->prev = 0;
  171.     pH->first = pNew;
  172.   }
  173.   pEntry->count++;
  174.   pEntry->chain = pNew;
  175. }
  176. /* Resize the hash table so that it cantains "new_size" buckets.
  177. ** "new_size" must be a power of 2.  The hash table might fail 
  178. ** to resize if sqliteMalloc() fails.
  179. */
  180. static void fts3Rehash(fts3Hash *pH, int new_size){
  181.   struct _fts3ht *new_ht;          /* The new hash table */
  182.   fts3HashElem *elem, *next_elem;  /* For looping over existing elements */
  183.   int (*xHash)(const void*,int);   /* The hash function */
  184.   assert( (new_size & (new_size-1))==0 );
  185.   new_ht = (struct _fts3ht *)fts3HashMalloc( new_size*sizeof(struct _fts3ht) );
  186.   if( new_ht==0 ) return;
  187.   fts3HashFree(pH->ht);
  188.   pH->ht = new_ht;
  189.   pH->htsize = new_size;
  190.   xHash = ftsHashFunction(pH->keyClass);
  191.   for(elem=pH->first, pH->first=0; elem; elem = next_elem){
  192.     int h = (*xHash)(elem->pKey, elem->nKey) & (new_size-1);
  193.     next_elem = elem->next;
  194.     fts3HashInsertElement(pH, &new_ht[h], elem);
  195.   }
  196. }
  197. /* This function (for internal use only) locates an element in an
  198. ** hash table that matches the given key.  The hash for this key has
  199. ** already been computed and is passed as the 4th parameter.
  200. */
  201. static fts3HashElem *fts3FindElementByHash(
  202.   const fts3Hash *pH, /* The pH to be searched */
  203.   const void *pKey,   /* The key we are searching for */
  204.   int nKey,
  205.   int h               /* The hash for this key. */
  206. ){
  207.   fts3HashElem *elem;            /* Used to loop thru the element list */
  208.   int count;                     /* Number of elements left to test */
  209.   int (*xCompare)(const void*,int,const void*,int);  /* comparison function */
  210.   if( pH->ht ){
  211.     struct _fts3ht *pEntry = &pH->ht[h];
  212.     elem = pEntry->chain;
  213.     count = pEntry->count;
  214.     xCompare = ftsCompareFunction(pH->keyClass);
  215.     while( count-- && elem ){
  216.       if( (*xCompare)(elem->pKey,elem->nKey,pKey,nKey)==0 ){ 
  217.         return elem;
  218.       }
  219.       elem = elem->next;
  220.     }
  221.   }
  222.   return 0;
  223. }
  224. /* Remove a single entry from the hash table given a pointer to that
  225. ** element and a hash on the element's key.
  226. */
  227. static void fts3RemoveElementByHash(
  228.   fts3Hash *pH,         /* The pH containing "elem" */
  229.   fts3HashElem* elem,   /* The element to be removed from the pH */
  230.   int h                 /* Hash value for the element */
  231. ){
  232.   struct _fts3ht *pEntry;
  233.   if( elem->prev ){
  234.     elem->prev->next = elem->next; 
  235.   }else{
  236.     pH->first = elem->next;
  237.   }
  238.   if( elem->next ){
  239.     elem->next->prev = elem->prev;
  240.   }
  241.   pEntry = &pH->ht[h];
  242.   if( pEntry->chain==elem ){
  243.     pEntry->chain = elem->next;
  244.   }
  245.   pEntry->count--;
  246.   if( pEntry->count<=0 ){
  247.     pEntry->chain = 0;
  248.   }
  249.   if( pH->copyKey && elem->pKey ){
  250.     fts3HashFree(elem->pKey);
  251.   }
  252.   fts3HashFree( elem );
  253.   pH->count--;
  254.   if( pH->count<=0 ){
  255.     assert( pH->first==0 );
  256.     assert( pH->count==0 );
  257.     fts3HashClear(pH);
  258.   }
  259. }
  260. /* Attempt to locate an element of the hash table pH with a key
  261. ** that matches pKey,nKey.  Return the data for this element if it is
  262. ** found, or NULL if there is no match.
  263. */
  264. void *sqlite3Fts3HashFind(const fts3Hash *pH, const void *pKey, int nKey){
  265.   int h;                 /* A hash on key */
  266.   fts3HashElem *elem;    /* The element that matches key */
  267.   int (*xHash)(const void*,int);  /* The hash function */
  268.   if( pH==0 || pH->ht==0 ) return 0;
  269.   xHash = ftsHashFunction(pH->keyClass);
  270.   assert( xHash!=0 );
  271.   h = (*xHash)(pKey,nKey);
  272.   assert( (pH->htsize & (pH->htsize-1))==0 );
  273.   elem = fts3FindElementByHash(pH,pKey,nKey, h & (pH->htsize-1));
  274.   return elem ? elem->data : 0;
  275. }
  276. /* Insert an element into the hash table pH.  The key is pKey,nKey
  277. ** and the data is "data".
  278. **
  279. ** If no element exists with a matching key, then a new
  280. ** element is created.  A copy of the key is made if the copyKey
  281. ** flag is set.  NULL is returned.
  282. **
  283. ** If another element already exists with the same key, then the
  284. ** new data replaces the old data and the old data is returned.
  285. ** The key is not copied in this instance.  If a malloc fails, then
  286. ** the new data is returned and the hash table is unchanged.
  287. **
  288. ** If the "data" parameter to this function is NULL, then the
  289. ** element corresponding to "key" is removed from the hash table.
  290. */
  291. void *sqlite3Fts3HashInsert(
  292.   fts3Hash *pH,        /* The hash table to insert into */
  293.   const void *pKey,    /* The key */
  294.   int nKey,            /* Number of bytes in the key */
  295.   void *data           /* The data */
  296. ){
  297.   int hraw;                 /* Raw hash value of the key */
  298.   int h;                    /* the hash of the key modulo hash table size */
  299.   fts3HashElem *elem;       /* Used to loop thru the element list */
  300.   fts3HashElem *new_elem;   /* New element added to the pH */
  301.   int (*xHash)(const void*,int);  /* The hash function */
  302.   assert( pH!=0 );
  303.   xHash = ftsHashFunction(pH->keyClass);
  304.   assert( xHash!=0 );
  305.   hraw = (*xHash)(pKey, nKey);
  306.   assert( (pH->htsize & (pH->htsize-1))==0 );
  307.   h = hraw & (pH->htsize-1);
  308.   elem = fts3FindElementByHash(pH,pKey,nKey,h);
  309.   if( elem ){
  310.     void *old_data = elem->data;
  311.     if( data==0 ){
  312.       fts3RemoveElementByHash(pH,elem,h);
  313.     }else{
  314.       elem->data = data;
  315.     }
  316.     return old_data;
  317.   }
  318.   if( data==0 ) return 0;
  319.   new_elem = (fts3HashElem*)fts3HashMalloc( sizeof(fts3HashElem) );
  320.   if( new_elem==0 ) return data;
  321.   if( pH->copyKey && pKey!=0 ){
  322.     new_elem->pKey = fts3HashMalloc( nKey );
  323.     if( new_elem->pKey==0 ){
  324.       fts3HashFree(new_elem);
  325.       return data;
  326.     }
  327.     memcpy((void*)new_elem->pKey, pKey, nKey);
  328.   }else{
  329.     new_elem->pKey = (void*)pKey;
  330.   }
  331.   new_elem->nKey = nKey;
  332.   pH->count++;
  333.   if( pH->htsize==0 ){
  334.     fts3Rehash(pH,8);
  335.     if( pH->htsize==0 ){
  336.       pH->count = 0;
  337.       fts3HashFree(new_elem);
  338.       return data;
  339.     }
  340.   }
  341.   if( pH->count > pH->htsize ){
  342.     fts3Rehash(pH,pH->htsize*2);
  343.   }
  344.   assert( pH->htsize>0 );
  345.   assert( (pH->htsize & (pH->htsize-1))==0 );
  346.   h = hraw & (pH->htsize-1);
  347.   fts3HashInsertElement(pH, &pH->ht[h], new_elem);
  348.   new_elem->data = data;
  349.   return 0;
  350. }
  351. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */