Redis源码分析——链表

Redis自己实现了一个双向链表，作为对象的底层实现之一。它有头结点和尾节点和长度，方便操作。而且支持多态，链表中复制函数、释放函数、匹配函数都是函数指针的方式，允许用户赋值。

/* adlist.h - A generic doubly linked list implementation
 *
 * Copyright (c) 2006-2012, Salvatore Sanfilippo <antirez at gmail dot com>
 * 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 Redis nor the names of its 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.
 */

#ifndef __ADLIST_H__
#define __ADLIST_H__

/* Node, List, and Iterator are the only data structures used currently. */

// 节点
typedef struct listNode {
    struct listNode *prev; // 前驱
    struct listNode *next; // 后继
    void *value; // 值
} listNode;

// 迭代器
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;

/* Functions implemented as macros */
// 获取链表长度
#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)

/* Prototypes */
// 创建空链表
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);
// 根据索引查找节点
listNode *listIndex(list *list, long index);
// 重置迭代器到链表头
void listRewind(list *list, listIter *li);
// 重置迭代器到链表尾
void listRewindTail(list *list, listIter *li);
// 旋转链表，即将尾节点挪到头节点前面
void listRotate(list *list);

/* Directions for iterators */
#define AL_START_HEAD 0
#define AL_START_TAIL 1

#endif /* __ADLIST_H__ */</span><span style="font-size:18px;">
</span>