【Redis】汎用双方向チェーンテーブルの実現に対する理解

10965 ワード

Redisが実現した双方向チェーンテーブルは比較的分かりやすく、その実現原理は古典的で、コードがきれいではっきりしている.
以下はそのソースコードの注釈の翻訳と本人の見解の部分の説明で、偏りがあれば指摘を歓迎します.
/* adlist.h -          */

#ifndef __ADLIST_H__
#define __ADLIST_H__

/*            Node, List, and Iterator. */

/* list  */
typedef struct listNode {
    struct listNode *prev;        //     
    struct listNode *next;        //     
    void *value;                  //      
} listNode;

/* list   */
typedef struct listIter {
    listNode *next;               //     
    int direction;                //      
} listIter;

/*    */
typedef struct list {
    listNode *head;                           //    
    listNode *tail;                           //    
    void *(*dup)(void *ptr);                  //     
    void (*free)(void *ptr);                  //     
    int (*match)(void *ptr, void *key);       //     
    unsigned long len;                        //     
} list;

/*       */
#define listLength(l) ((l)->len)                       //     
#define listFirst(l) ((l)->head)                       //      
#define listLast(l) ((l)->tail)                        //      
#define listPrevNode(n) ((n)->prev)                    //          
#define listNextNode(n) ((n)->next)                    //          
#define listNodeValue(n) ((n)->value)                  //       

/*     ,                 */
#define listSetDupMethod(l,m) ((l)->dup = (m))         //     
#define listSetFreeMethod(l,m) ((l)->free = (m))       //     
#define listSetMatchMethod(l,m) ((l)->match = (m))     //   

/*     ,                 */
#define listGetDupMethod(l) ((l)->dup)                      //           
#define listGetFree(l) ((l)->free)                          //           
#define listGetMatchMethod(l) ((l)->match)                  //           

/*      */
list *listCreate(void);                                                               //     
void listRelease(list *list);                                                         //     
list *listAddNodeHead(list *list, void *value);                                       //        
list *listAddNodeTail(list *list, void *value);                                       //        
list *listInsertNode(list *list, listNode *old_node, void *value, int after);         //            
void listDelNode(list *list, listNode *node);                                         //     
listIter *listGetIterator(list *list, int direction);                                 //        
listNode *listNext(listIter *iter);                                                   //        
void listReleaseIterator(listIter *iter);                                             //        
list *listDup(list *orig);                                                            //     
listNode *listSearchKey(list *list, void *key);                                       //   key    
listNode *listIndex(list *list, long index);                                          //   index    
void listRewind(list *list, listIter *li);                                            //             
void listRewindTail(list *list, listIter *li);                                        //             
void listRotate(list *list);                                                          //     ,           

/*          */
#define AL_START_HEAD 0
#define AL_START_TAIL 1

#endif /* __ADLIST_H__ */
/* adlist.c -           */


#include 
#include "adlist.h"
#include "zmalloc.h"

/*      .           
* AlFreeList()   ,                             
*
*        NULL,       list   */
list *listCreate(void)
{
    struct list *list;

    if ((list = zmalloc(sizeof(*list))) == NULL)       //    malloc     zmalloc     
        return NULL;
    list->head = list->tail = NULL;
    list->len = 0;
    list->dup = NULL;
    list->free = NULL;
    list->match = NULL;
    return list;
}

/*     ,       .
*
 */
void listRelease(list *list)
{
    unsigned long len;
    listNode *current, *next;

    current = list->head;
    len = list->len;
    while(len--) {
        next = current->next;
        if (list->free) list->free(current->value);   //               
        zfree(current);       // zfree      free                                    
        current = next;
    }
    zfree(list);
}

/*                   
*
*      ,   NULL            ,
*
*            .*/
list *listAddNodeHead(list *list, void *value)
{
    listNode *node;
    if ((node = zmalloc(sizeof(*node))) == NULL)
        return NULL;
    node->value = value;
    if (list->len == 0) {
        list->head = list->tail = node;
        node->prev = node->next = NULL;
    } else {
        node->prev = NULL;
        node->next = list->head;
        list->head->prev = node;
        list->head = node;
    }
    list->len++;
    return list;
}

/*                   ,

*      ,   NULL            ,
*
*            .*/
list *listAddNodeTail(list *list, void *value)
{
    listNode *node;
    if ((node = zmalloc(sizeof(*node))) == NULL)
        return NULL;
    node->value = value;
    if (list->len == 0) {
        list->head = list->tail = node;
        node->prev = node->next = NULL;
    } else {
        node->prev = list->tail;
        node->next = NULL;
        list->tail->next = node;
        list->tail = node;
    }
    list->len++;
    return list;
}

/*                 ,
*      ,   NULL            ,
*
*            .*/
list *listInsertNode(list *list, listNode *old_node, void *value, int after) {
    listNode *node;

    if ((node = zmalloc(sizeof(*node))) == NULL)
        return NULL;
    node->value = value;
    if (after) {                          // after!=0                ,      
        node->prev = old_node;
        node->next = old_node->next;
        if (list->tail == old_node) {
            list->tail = node;
        }
    } else {
        node->next = old_node;
        node->prev = old_node->prev;
        if (list->head == old_node) {
            list->head = node;
        }
    }
    if (node->prev != NULL) {
        node->prev->next = node;
    }
    if (node->next != NULL) {
        node->next->prev = node;
    }
    list->len++;
    return list;
}

/*           .
*                .
*
*        . */
void listDelNode(list *list, listNode *node)
{
    if (node->prev)
        node->prev->next = node->next;
    else
        list->head = node->next;
    if (node->next)
        node->next->prev = node->prev;
    else
        list->tail = node->prev;
    if (list->free) list->free(node->value);
    zfree(node);
    list->len--;
}

/*        'iter'.       
*    listNext()            .
*
*        . */
listIter *listGetIterator(list *list, int direction)
{
    listIter *iter;

    if ((iter = zmalloc(sizeof(*iter))) == NULL) return NULL;
    if (direction == AL_START_HEAD)
        iter->next = list->head;
    else
        iter->next = list->tail;
        iter->direction = direction;
    return iter;
}

/*            */
void listReleaseIterator(listIter *iter) {
    zfree(iter);
}

/*              */
void listRewind(list *list, listIter *li) {
    li->next = list->head;
    li->direction = AL_START_HEAD;
}

/*              */

void listRewindTail(list *list, listIter *li){
    li->next = list->tail;
    li->direction = AL_START_TAIL;
}

/*            .
*     listDelNode()            ,          。
*
*                 ,    NULL;
*           :
*
* iter = listGetIterator(list,);
* while ((node = listNext(iter)) != NULL) {
* doSomethingWith(listNodeValue(node));
* }
*
* */
listNode *listNext(listIter *iter)
{
    listNode *current = iter->next;

    if (current != NULL) {
        if (iter->direction == AL_START_HEAD)
        iter->next = current->next;
    else
        iter->next = current->prev;
    }
    return current;
}

/*       . 
*             ,    NULL.
*
*        listSetDupMethod()   ,
*       dup              .
*
*          . */
list *listDup(list *orig)       //     :                ,     const  ?
{
    list *copy;
    listIter *iter;
    listNode *node;

    if ((copy = listCreate()) == NULL)
        return NULL;
    copy->dup = orig->dup;
    copy->free = orig->free;
    copy->match = orig->match;
    iter = listGetIterator(orig, AL_START_HEAD);
    while((node = listNext(iter)) != NULL) {
        void *value;

        if (copy->dup) {
            value = copy->dup(node->value);
            if (value == NULL) {
                listRelease(copy);
                listReleaseIterator(iter);
                return NULL;
            }
        } else
            value = node->value;
        if (listAddNodeTail(copy, value) == NULL) {
            listRelease(copy);
            listReleaseIterator(iter);
            return NULL;
        }
    }

    listReleaseIterator(iter);

    return copy;
}

/*     key     .
*              listSetMatchMethod()   . 
*                 ,      key             .
*
*                  ,            NULL. */
listNode *listSearchKey(list *list, void *key)
{
    listIter *iter;
    listNode *node;

    iter = listGetIterator(list, AL_START_HEAD);
    while((node = listNext(iter)) != NULL) {
        if (list->match) {                                       //       match  
            if (list->match(node->value, key)) {
                listReleaseIterator(iter);
                return node;
            }
        } else {                                                     //      
            if (key == node->value) {
                listReleaseIterator(iter);
                return node;
            }
        }
    }
    listReleaseIterator(iter);   //   iter  
    return NULL;
}

/*   index     。
*     index    ,       : 0    ,1      ,    .
*      ,        : -1    , -2        ,     
*   index     NULL. */
listNode *listIndex(list *list, long index) {
    listNode *n;

    if (index < 0) {
        index = (-index)-1;
        n = list->tail;
        while(index-- && n) n = n->prev;
    } else {
        n = list->head;
        while(index-- && n) n = n->next;
    }
    return n;
}

/*     ,           . */
void listRotate(list *list) {
    listNode *tail = list->tail;

    if (listLength(list) <= 1) return;

    /*              */
    list->tail = tail->prev;
    list->tail->next = NULL;
    /*           */
    list->head->prev = tail;
    tail->prev = NULL;
    tail->next = list->head;
    list->head = tail;
}

次の2つの点を理解する必要があります.
1)ソースコードにおけるlist空間の作成と破棄がzmallocモジュールのzmallocとzfreeによって行われる以上,zmallocはどのように実現されるのだろうか.
2)こんなに多くのオブジェクトポインタがconstとして制限されていないのは、なぜ省略できるのでしょうか.