C语言原子接口与实现

　　原子是一个指向唯一的、不可变的0个或任意多个字节序列的指针，大多数原子都是指向以空字符结束的字符串，但是任何一个指向任意字节序列的指针都可以使原子。任何原子只能出现一次。如果两个原子指向同一个内存单元时，则两个原子是相等的。仅仅比较两个字节序列相应的指针是否相等，就可以判断这两个字节序列是否相等了，这就是使用原子的好处之一；还有一个好处就是使用原子可以节省空间，因为每个序列只会出现一次。

本文地址：http://www.cnblogs.com/archimedes/p/c-atom.html，转载请注明源地址。

接口

Atom的接口很简单：

#ifndef ATOM_INCLUDED
#define ATOM_INCLUDED
extern       int   Atom_length(const char *str);
extern const char *Atom_new   (const char *str, int len);
extern const char *Atom_string(const char *str);
extern const char *Atom_int   (long n);
#endif

Atom_new接收一个指向字节序列的指针以及该序列的字节数作为输入，它在原子表中增加一个该序列的拷贝，并且如果需要的话，返回原子表中指向该拷贝的指针（即原子）

原子总是以一个空字符结束，在必要的时候该空字符由Atom_new添加

Atom_string接收一个空字符串结束的字符串作为输入，在原子表中增加一个该串的拷贝，如果需要的话返回该原子

Atom_int返回长整数n的字符串表示的原子

Atom_length返回其原子参数的长度

实现

Atom的实现对原子表进行维护。Atom_new,Atom_string,Atom_int查找原子表，并都有可能在原子表中添加一个新的元素，而Atom_length仅仅查找原子表

#include "atom.h"

Atom_string,Atom_int可以在不知道原子表细节的情况下执行相应的操作

#include <string.h>
#include "assert.h"
const char *Atom_string(const char *str) {
    assert(str);
    return Atom_new(str, strlen(str));
}

Atom_int首先把它的参数转化为一个字符串，然后调用Atom_new:

#include <limits.h>
const char *Atom_int(long n) {  /*将参数转换成一个字符串，然后调用Atom_new*/
    char str[43];
    char *s = str + sizeof str;  /*将s指向字符数组的尾部*/
    unsigned long m;
    if (n == LONG_MIN)    /*处理最小的负长整数*/
        m = LONG_MAX + 1UL;
    else if (n < 0)
        m = -n;
    else
        m = n;
    do
        *--s = m%10 + '0';   /*对m取余获取最后一位数字倒序保存在字符数组中*/
    while ((m /= 10) > 0);
    if (n < 0)
        *--s = '-';  /*如果n是负数在结果前面加上’-‘号*/
    return Atom_new(s, (str + sizeof str) - s);
}

Atom_int必须处理二进制补码数的不对称范围以及C的除法和取余运算的不确定性，无符号的除法和取余都具有良好的定义，因此Atom_int也可以通过使用无符号算术来避免使用有符号运算引起的不确定。

引入头文件和相关宏：

#include "atom.h"
#include <string.h>
#include "assert.h"
#include <limits.h>
#include "mem.h"   /* 内存管理接口 */
#define NELEMS(x) ((sizeof (x))/(sizeof ((x)[0]))) 
 /* 求数组中元素的个数 */

散列表显然是一个针对原子表的数据结构，散列表是一个入口表的指针数组，其中每一个元素都存有一个原子：

static struct atom {
    struct atom *link;  /*指向表中的下一个入口*/
    int len;  /*len存储序列的长度*/
    char *str;   /*str指向序列本身*/
} *buckets[2048];  /*散列表的长度小于2048*/

针对“an atom”的struct atom的小尾数法布局：

Atom_new计算由str[0……len-1]给定序列的散列值，并用buckets的元素个数对其取模，搜索由buckets中该散列值元素所指向的链表。如果发现str[0……len-1]已存在于表中，它将只是简单地返回该原子：

#define NELEMS(x) ((sizeof (x))/(sizeof ((x)[0])))  /* 求数组中元素的个数 */
const char *Atom_new(const char *str, int len) {  /*接收一个指向字节序列的指针以及该序列的字节数，在原子表中增加一个该序列的拷贝*/
    unsigned long h;
    int i;
    struct atom *p;
    assert(str);
    assert(len >= 0);
    for (h = 0, i = 0; i < len; i++)  /*查找表算法*/
        h = (h<<1) + scatter[(unsigned char)str[i]];
    h &= NELEMS(buckets)-1;
    for (p = buckets[h]; p; p = p->link)  /*在buckets[h]中查找是否存在str*/
        if (len == p->len) {
            for (i = 0; i < len && p->str[i] == str[i]; )
                i++;
            if (i == len)
                return p->str;  /*找到即返回*/
        }
    p = ALLOC(sizeof (*p) + len + 1);  /*没找到则新建原子*/
    p->len = len;
    p->str = (char *)(p + 1);
    if (len > 0)
        memcpy(p->str, str, len);
    p->str[len] = '\0';
    p->link = buckets[h];
    buckets[h] = p;
    return p->str;
}

Hash表结构：

Atom的实现对原子表进行维护，Atom_new、Atom_string以及Atom_int查找原子表，并且都有可能在原子表中添加一个新的元素，而Atom_length仅仅查找原子表。

完整实现代码如下：

#include "atom.h"
#include <string.h>
#include "assert.h"
#include <limits.h>
#include "mem.h"   /* 内存管理接口 */
#define NELEMS(x) ((sizeof (x))/(sizeof ((x)[0])))  /* 求数组中元素的个数 */
static struct atom {
    struct atom *link;  /*指向表中的下一个入口*/
    int len;  /*len存储序列的长度*/
    char *str;   /*str指向序列本身*/
} *buckets[2048];  /*散列表的长度小于2048*/
static unsigned long scatter[] = {  /*256入口数组，它将字节映射为随机数，这些随机数通过标准库的rand函数生成*/
2078917053, 143302914, 1027100827, 1953210302, 755253631, 2002600785,
1405390230, 45248011, 1099951567, 433832350, 2018585307, 438263339,
813528929, 1703199216, 618906479, 573714703, 766270699, 275680090,
1510320440, 1583583926, 1723401032, 1965443329, 1098183682, 1636505764,
980071615, 1011597961, 643279273, 1315461275, 157584038, 1069844923,
471560540, 89017443, 1213147837, 1498661368, 2042227746, 1968401469,
1353778505, 1300134328, 2013649480, 306246424, 1733966678, 1884751139,
744509763, 400011959, 1440466707, 1363416242, 973726663, 59253759,
1639096332, 336563455, 1642837685, 1215013716, 154523136, 593537720,
704035832, 1134594751, 1605135681, 1347315106, 302572379, 1762719719,
269676381, 774132919, 1851737163, 1482824219, 125310639, 1746481261,
1303742040, 1479089144, 899131941, 1169907872, 1785335569, 485614972,
907175364, 382361684, 885626931, 200158423, 1745777927, 1859353594,
259412182, 1237390611, 48433401, 1902249868, 304920680, 202956538,
348303940, 1008956512, 1337551289, 1953439621, 208787970, 1640123668,
1568675693, 478464352, 266772940, 1272929208, 1961288571, 392083579,
871926821, 1117546963, 1871172724, 1771058762, 139971187, 1509024645,
109190086, 1047146551, 1891386329, 994817018, 1247304975, 1489680608,
706686964, 1506717157, 579587572, 755120366, 1261483377, 884508252,
958076904, 1609787317, 1893464764, 148144545, 1415743291, 2102252735,
1788268214, 836935336, 433233439, 2055041154, 2109864544, 247038362,
299641085, 834307717, 1364585325, 23330161, 457882831, 1504556512,
1532354806, 567072918, 404219416, 1276257488, 1561889936, 1651524391,
618454448, 121093252, 1010757900, 1198042020, 876213618, 124757630,
2082550272, 1834290522, 1734544947, 1828531389, 1982435068, 1002804590,
1783300476, 1623219634, 1839739926, 69050267, 1530777140, 1802120822,
316088629, 1830418225, 488944891, 1680673954, 1853748387, 946827723,
1037746818, 1238619545, 1513900641, 1441966234, 367393385, 928306929,
946006977, 985847834, 1049400181, 1956764878, 36406206, 1925613800,
2081522508, 2118956479, 1612420674, 1668583807, 1800004220, 1447372094,
523904750, 1435821048, 923108080, 216161028, 1504871315, 306401572,
2018281851, 1820959944, 2136819798, 359743094, 1354150250, 1843084537,
1306570817, 244413420, 934220434, 672987810, 1686379655, 1301613820,
1601294739, 484902984, 139978006, 503211273, 294184214, 176384212,
281341425, 228223074, 147857043, 1893762099, 1896806882, 1947861263,
1193650546, 273227984, 1236198663, 2116758626, 489389012, 593586330,
275676551, 360187215, 267062626, 265012701, 719930310, 1621212876,
2108097238, 2026501127, 1865626297, 894834024, 552005290, 1404522304,
48964196, 5816381, 1889425288, 188942202, 509027654, 36125855,
365326415, 790369079, 264348929, 513183458, 536647531, 13672163,
313561074, 1730298077, 286900147, 1549759737, 1699573055, 776289160,
2143346068, 1975249606, 1136476375, 262925046, 92778659, 1856406685,
1884137923, 53392249, 1735424165, 1602280572
};
const char *Atom_string(const char *str) {
    assert(str);
    return Atom_new(str, strlen(str));
}
const char *Atom_int(long n) {  /*将参数转换成一个字符串，然后调用Atom_new*/
    char str[43];
    char *s = str + sizeof str;  /*将s指向字符数组的尾部*/
    unsigned long m;
    if (n == LONG_MIN)    /*处理最小的负长整数*/
        m = LONG_MAX + 1UL;
    else if (n < 0)
        m = -n;
    else
        m = n;
    do
        *--s = m%10 + '0';   /*对m取余获取最后一位数字倒序保存在字符数组中*/
    while ((m /= 10) > 0);
    if (n < 0)
        *--s = '-';  /*如果n是负数在结果前面加上’-‘号*/
    return Atom_new(s, (str + sizeof str) - s);
}
const char *Atom_new(const char *str, int len) {  /*接收一个指向字节序列的指针以及该序列的字节数，在原子表中增加一个该序列的拷贝*/
    unsigned long h;
    int i;
    struct atom *p;
    assert(str);
    assert(len >= 0);
    for (h = 0, i = 0; i < len; i++)  /*查找表算法*/
        h = (h<<1) + scatter[(unsigned char)str[i]];
    h &= NELEMS(buckets)-1;
    for (p = buckets[h]; p; p = p->link)  /*在buckets[h]中查找是否存在str*/
        if (len == p->len) {
            for (i = 0; i < len && p->str[i] == str[i]; )
                i++;
            if (i == len)
                return p->str;  /*找到即返回*/
        }
    p = ALLOC(sizeof (*p) + len + 1);  /*没找到则新建原子*/
    p->len = len;
    p->str = (char *)(p + 1);
    if (len > 0)
        memcpy(p->str, str, len);
    p->str[len] = '\0';
    p->link = buckets[h];
    buckets[h] = p;
    return p->str;
}
int Atom_length(const char *str) {
    struct atom *p;
    int i;
    assert(str);
    for (i = 0; i < NELEMS(buckets); i++)
        for (p = buckets[i]; p; p = p->link)  /*在buckets表中查找str*/
            if (p->str == str)
                return p->len;  /*成功找到后返回len*/
    assert(0);
    return 0;
}

 

参考资料

《C语言接口与实现--创建可重用软件的技术》