dbm数据库源代码分析(12)：gdbmreorg.c、gdbmseq.c和gdbmsetopt.c

   _gdbm_rename和gdbm_reorganize函数在gdbmreorg.c中，其中_gdbm_rename是内部函数。get_next_key、gdbm_firstkey和gdbm_nextkey函数在gdbmseq.c中。gdbm_setopt函数在gdbmsetopt.c中。
   （1）int _gdbm_rename (old_name, new_name)函数。内部函数。对文件进行重命名。如果不能重命名，则返回一个非0值，并且保证文件的old_name没有变化。

   （2）int gdbm_reorganize(dbf)函数。重组数据库文件。这需要创建一个新文件，并把旧文件dbf的所有项插入到新文件中。新文件然后重命名为旧文件dbf的名字，而dbf结构也会更新成包含新文件的所有正确信息。如果一个错误发生，则返回负值。如果操作成功，则返回0值。操作流程：
     1）为临时文件构造一个新文件名；
     2）获取旧文件的打开模式，然后打开新的数据库文件；
     3）通过gdbm_firstkey和gdbm_nextkey，获取旧数据库的每个关键字及其关联的数据，并把它存入到新数据库中；
     4）用_gdbm_end_update完成数据库的所有更新，并等待更新完成；
     5）把新文件重命名为原来的文件名，释放dbf中的原来一些域；
     6）释放所有缓存项中的桶、关键字/数据、以及整个桶缓存数组；
     7）把dbf的相关域设为新文件的正确信息；
     8）等待新文件的数据写入完成，最后设置好当前缓存项指针，以及当前桶指针。

/* gdbmreorg.c - Reorganize the database file. *//* 首先包含系统配置相关的头文件 */#include "autoconf.h"#include "gdbmdefs.h"#include "gdbmerrno.h"#include "extern.h"/* 如果系统没有rename函数，HAVE_RENAME在autoconf.h中定义 */#if !HAVE_RENAME/* 对文件进行重命名。如果不能重命名，则返回一个非0值，并且保证文件的old_name没有变化。 */static int_gdbm_rename (old_name, new_name) char* old_name; char* new_name;{ if (unlink (new_name) != 0) return -1; if (link (old_name, new_name) != 0) return -1; unlink (old_name); return 0;}#define rename _gdbm_rename#endif/* 重组数据库文件。这需要创建一个新文件，并把旧文件dbf的所有项插入到新文件中。新文件然后重命名为旧文件dbf 的名字，而dbf结构也会更新成包含新文件的所有正确信息。如果一个错误发生，则返回负值。如果操作成功，则 返回0值 */intgdbm_reorganize (dbf) gdbm_file_info *dbf;{ gdbm_file_info *new_dbf;/* 新文件The new file. */ char *new_name;/* 临时文件的文件名A temporary name. */ int len;/* 用于新文件名的构造 */ datum key, nextkey, data;/* 用于顺序扫描 */ struct stat fileinfo;/* 文件状态信息的结构 */ int index;/* 用来移动桶缓存项 */ /* 只读时禁止进行重组 */ if (dbf->read_write == GDBM_READER) { gdbm_errno = GDBM_READER_CANT_REORGANIZE; return -1; } /* 初始化gdbm_errno变量 */ gdbm_errno = GDBM_NO_ERROR; /* 为临时文件构造一个新的名字 */ len = strlen (dbf->name); new_name = (char *) malloc (len + 3); if (new_name == NULL) { gdbm_errno = GDBM_MALLOC_ERROR; return -1; } strcpy (&new_name[0], dbf->name); /* 复制文件名 */ new_name[len+2] = 0; new_name[len+1] = '#'; while ( (len > 0) && new_name[len-1] != '/') /* 文件名后移一个位置 */ { new_name[len] = new_name[len-1]; len -= 1; } new_name[len] = '#'; /* 在文件名前面插入# */ /* 获取旧文件的打开模式，然后打开新的数据库文件 */ fstat (dbf->desc, &fileinfo); new_dbf = gdbm_open (new_name, dbf->header->block_size, GDBM_WRCREAT, fileinfo.st_mode, dbf->fatal_err); /* 打开新的数据库 */ if (new_dbf == NULL) { free (new_name); gdbm_errno = GDBM_REORGANIZE_FAILED; return -1; } /* 对旧数据库的每一项，把它添加到新数据库中去 */ key = gdbm_firstkey (dbf); /* 获取首个关键字 */ while (key.dptr != NULL) { data = gdbm_fetch (dbf, key); /* 获取关键字关联的数据 */ if (data.dptr != NULL) { /* 把数据添加到新文件中去 */ if (gdbm_store (new_dbf, key, data, GDBM_INSERT) != 0) /* 如果插入失败 */ { gdbm_close (new_dbf); gdbm_errno = GDBM_REORGANIZE_FAILED; unlink (new_name); free (new_name); return -1; } } else /* 否则获取的数据有错误，不能完成重组 */ { gdbm_close (new_dbf); gdbm_errno = GDBM_REORGANIZE_FAILED; unlink (new_name); free (new_name); return -1; } nextkey = gdbm_nextkey (dbf, key); /* 获取下一个关键字 */ free (key.dptr); /* 释放原来的关键字和数据内容 */ free (data.dptr); key = nextkey; } /* 完成数据库的所有更新 */ _gdbm_end_update (new_dbf); gdbm_sync (new_dbf); /* 等待更新完成 */ /* 把新文件重命名为原来的文件名 */ if (rename (new_name, dbf->name) != 0) { gdbm_errno = GDBM_REORGANIZE_FAILED; gdbm_close (new_dbf); free (new_name); return -1; } /* 更新dbf结构，以包含新文件的正确信息 */ if (dbf->file_locking) /* 对原来的文件解锁 */ { UNLOCK_FILE(dbf); } close (dbf->desc); /* 关闭原来的文件 */ free (dbf->header); /* 释放原来的文件头和散列目录表 */ free (dbf->dir); if (dbf->bucket_cache != NULL) { /* 释放所有缓存项中的桶和关键字/数据 */ for (index = 0; index < dbf->cache_size; index++) { if (dbf->bucket_cache[index].ca_bucket != NULL)free (dbf->bucket_cache[index].ca_bucket); if (dbf->bucket_cache[index].ca_data.dptr != NULL)free (dbf->bucket_cache[index].ca_data.dptr); } free (dbf->bucket_cache); /* 释放整个桶缓存数组 */ } /* 把dbf的相关域设为新文件的正确信息 */ dbf->desc = new_dbf->desc; dbf->header = new_dbf->header; dbf->dir = new_dbf->dir; dbf->bucket = new_dbf->bucket; dbf->bucket_dir = new_dbf->bucket_dir; dbf->last_read = new_dbf->last_read; dbf->bucket_cache = new_dbf->bucket_cache; dbf->cache_size = new_dbf->cache_size; dbf->header_changed = new_dbf->header_changed; dbf->directory_changed = new_dbf->directory_changed; dbf->bucket_changed = new_dbf->bucket_changed; dbf->second_changed = new_dbf->second_changed; free (new_dbf->name); free (new_dbf); free (new_name); /* 确保新数据更新到磁盘上去 */ fsync (dbf->desc); /* 设置好当前缓存项指针，以及当前桶指针 */ dbf->cache_entry = &dbf->bucket_cache[0]; _gdbm_get_bucket (dbf, 0); return 0;}

   （3）void get_next_key (dbf, elem_loc, return_val)函数。从elem_loc位置开始搜索散列桶中的下一个关键字/数据项（在桶元素中），用return_val返回获取的值。程序从当前桶的elem_loc位置开始，根据散列目录表中的目录项查找每一个桶，扫描其每个桶元素，一旦发现其中有关键字/数据（即桶元素的哈希值不为-1）。一旦有，就调用_gdbm_read_entry把它读取到return_val中，并返回它。

   （4）datum gdbm_firstkey(dbf)函数。返回文件上的第一个散列桶中的第一个关键字。程序先获取索引0处目录项指示的桶（第一个桶），然后寻找这个桶中的第一个关键字。

   （5）datum gdbm_nextkey(dbf)函数。返回文件dbf中跟在key后面的一个关键字。程序先查找当前关键字，返回其所有桶元素的位置。然后根据这个位置调用get_next_key查找其下一个关键字。

/* gdbmseq.c - 查找关键字的例程，Routines to visit all keys. Not in sorted order. */#include "autoconf.h"#include "gdbmdefs.h"#include "gdbmerrno.h"/* 本文件中特别要用到外部函数 */extern char *_gdbm_read_entry __P((gdbm_file_info *, int));/* 从elem_loc位置开始获取散列桶中的下一个关键字/数据项（在桶元素中），用return_val返回获取的值 */static voidget_next_key (dbf, elem_loc, return_val) gdbm_file_info *dbf; int elem_loc; datum *return_val;{ int found;/* 是否发现了下一个关键字 */ char *find_data;/* find_key返回的关键字/数据起始地址 */ /* 查找下一个关键字 */ found = FALSE; while (!found) { /* 移到桶中的下一个位置 */ elem_loc++; if (elem_loc == dbf->header->bucket_elems){ /* 完成了在当前桶中的查找，到下一个桶中去找 */ elem_loc = 0; /* 查找下一个桶，有可能目录表中的几个目录项都指向同一个桶 */ while (dbf->bucket_dir < dbf->header->dir_size / sizeof (off_t) && dbf->cache_entry->ca_adr == dbf->dir[dbf->bucket_dir]) dbf->bucket_dir++; /* 检查是否还有下一个桶 */ if (dbf->bucket_dir < dbf->header->dir_size / sizeof (off_t)) _gdbm_get_bucket (dbf, dbf->bucket_dir); /* 根据给出的目录索引，获取此目录项指示的散列桶，使之成为dbf的当前桶 */ else /* 没有下一个关键字，直接返回 */ return ;} found = dbf->bucket->h_table[elem_loc].hash_value != -1; } /* 查找下一个关键字，把它读入到return_val中 */ find_data = _gdbm_read_entry (dbf, elem_loc); return_val->dsize = dbf->bucket->h_table[elem_loc].key_size; if (return_val->dsize == 0) return_val->dptr = (char *) malloc (1); else return_val->dptr = (char *) malloc (return_val->dsize); if (return_val->dptr == NULL) _gdbm_fatal (dbf, "malloc error"); bcopy (find_data, return_val->dptr, return_val->dsize); /* 把找到的关键字复制到find_data中 */}/* 返回文件上第一个散列桶中的第一个关键字 */datumgdbm_firstkey (dbf) gdbm_file_info *dbf;{ datum return_val;/* 用来返回第一个关键字 */ /* 设置默认的返回值（当没有找到第一个关键字时） */ return_val.dptr = NULL; /* 初始化gdbm_errno变量 */ gdbm_errno = GDBM_NO_ERROR; /* 获取索引0处目录项指示的桶（第一个桶） */ _gdbm_get_bucket (dbf, 0); /* 使文件上的第一个散列桶成为当前桶 */ /* 寻找这个桶中的第一个关键字 */ get_next_key (dbf, -1, &return_val); return return_val;}/* 返回文件dbf中跟在key后面的一个关键字 */datumgdbm_nextkey (dbf, key) gdbm_file_info *dbf; datum key;{ datum return_val;/* 返回值 */ int elem_loc;/* 关键字的在桶元素在桶中的位置 */ char *find_data;/* _gdbm_findkey返回的关键字/数据起始地址 */ int hash_val;/* _gdbm_findkey返回的关键字哈希值 */ /* 初始化gdbm_errno变量 */ gdbm_errno = GDBM_NO_ERROR; /* 设置默认的返回值（当没有找到下一个关键字时） */ return_val.dptr = NULL; /* 是一个有效的关键字吗？ */ if (key.dptr == NULL) return return_val; /* 查找当前关键字，返回其所有桶元素的位置 */ elem_loc = _gdbm_findkey (dbf, key, &find_data, &hash_val); if (elem_loc == -1) return return_val; /* 查找其下一个关键字 */ get_next_key (dbf, elem_loc, &return_val); return return_val;}

   （6）int gdbm_setopt(dbf,optflag,optval,optlen)函数。设置一个gdbm数据库的一些选项，这些选项标志参看gdbmconst.h。操作在这个打开的数据库文件描述符上进行。主要的选项有GDBM_CACHESIZE、GDBM_FASTMODE、GDBM_SYNCMODE、GDBM_CENTFREE、GDBM_COALESCEBLKS。除GDBM_CACHESIZE选项关联的值为一个正整数值外，其余选项关联的值均为布尔值。

/* gdbmsetopt.c - 设置一个gdbm数据库的选项 */#include "autoconf.h"#include "gdbmdefs.h"#include "gdbmerrno.h"/* 设置一个gdbm数据库的一些选项，这些选项标志参看gdbmconst.h。操作在这个打开的数据库文件描述符上进行 */intgdbm_setopt(dbf, optflag, optval, optlen) gdbm_file_info *dbf;/* 打开的文件描述符 */ int optflag;/* 要设置的选项 */ int *optval;/* 指向选项关联的值 */ int optlen;/* optval的长度 */{ switch(optflag) { case GDBM_CACHESIZE: /* 设置缓存的大小 */ /* Optval将会指向新的缓存大小值 */ if (dbf->bucket_cache != NULL) { gdbm_errno = GDBM_OPT_ALREADY_SET; return(-1); } return(_gdbm_init_cache(dbf, ((*optval) > 9) ? (*optval) : 10)); /* 用新的大小值重新初始化桶缓存数组 */ case GDBM_FASTMODE: /* 设置打开或关闭快速写模式 */ /* SYNCMODE的过时形式 */if ((*optval != TRUE) && (*optval != FALSE)) { gdbm_errno = GDBM_OPT_ILLEGAL; return(-1); }dbf->fast_write = *optval;break; case GDBM_SYNCMODE: /* 设置打开或关闭同步操作（sync） */ /* Optval将指向true或false */if ((*optval != TRUE) && (*optval != FALSE)) { gdbm_errno = GDBM_OPT_ILLEGAL; return(-1); }dbf->fast_write = !(*optval);break; case GDBM_CENTFREE: /* 设置是否保持文件头中的所有空闲数据块 */ /* Optval将指向true或false */if ((*optval != TRUE) && (*optval != FALSE)) { gdbm_errno = GDBM_OPT_ILLEGAL; return(-1); }dbf->fast_write = *optval;break; case GDBM_COALESCEBLKS: /* 设置是否合并空闲数据块*/ /* Optval将指向true或false */if ((*optval != TRUE) && (*optval != FALSE)) { gdbm_errno = GDBM_OPT_ILLEGAL; return(-1); }dbf->fast_write = *optval;break; default: gdbm_errno = GDBM_OPT_ILLEGAL; return(-1); } return(0);}