redis1.2.6 sds.c

sds定义

typedef char *sds;

struct sdshdr {
    long len;
    long free;
    char buf[];
};

代码及注释

#define SDS_ABORT_ON_OOM

#include "sds.h"
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <ctype.h>
#include "zmalloc.h"

static void sdsOomAbort(void) {
    fprintf(stderr,"SDS: Out Of Memory (SDS_ABORT_ON_OOM defined)\n");
    abort();
}
/* sdsnewlen 主要是创建sdshdr，将其buf属性地址返回
 * @param const void *     字符串
 * @param siez_t           字符串长度
 * @return sds              创建sdshdr，将其buf属性地址返回
*/
sds sdsnewlen(const void *init, size_t initlen) {
    struct sdshdr *sh;

    sh = zmalloc(sizeof(struct sdshdr)+initlen+1);//+1的意思是主要用来放'\0'
#ifdef SDS_ABORT_ON_OOM     //错误处理
    if (sh == NULL) sdsOomAbort();
#else
    if (sh == NULL) return NULL;
#endif
    //初始化值
    sh->len = initlen;
    sh->free = 0;
    if (initlen) {//有长度
        if (init) memcpy(sh->buf, init, initlen);//存在字符串就将字符串复制到buf中
        else memset(sh->buf,0,initlen);//不存在字符串就用'\0' 填充buf的长度
    }
    sh->buf[initlen] = '\0';//最后一位设置结束符
    return (char*)sh->buf;
}
//设置个空的sds和sdshdr
sds sdsempty(void) {
    return sdsnewlen("",0);
}
/*sdsnew 主要是创建sdshdr结构与赋值
* @param const char *init   字符串
* @return sds               返回sdshdr的buf地址
*/
sds sdsnew(const char *init) {
    size_t initlen = (init == NULL) ? 0 : strlen(init);
    return sdsnewlen(init, initlen);
}
/*sdslen 获取sds的长度
* @param const sds s        字符串
* @return size_t            长度
*/
size_t sdslen(const sds s) {
    //因为sds是sdshdr属性buf的地址，所以当现在的地址减去sdshdr的大小就是sdshdr的位置地址
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    return sh->len;
}
/*sdsdup 传入一个sds获取一个和旧sds值一样的新sds
* @param const sds s    sds字符串
* @return sds           新的sds
*/
sds sdsdup(const sds s) {
    return sdsnewlen(s, sdslen(s));
}
//释放空间
void sdsfree(sds s) {
    if (s == NULL) return;
    zfree(s-sizeof(struct sdshdr));
}
/*sdsavail 获取sds的空闲大小
* @param sds s          字符串
* @return size_t        长度
*/
size_t sdsavail(sds s) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    return sh->free;
}
/*sdsupdatelen  更新sds对应sdshdr的len与free属性
* @param sds s  需要更新的sds字符串
*/
void sdsupdatelen(sds s) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    int reallen = strlen(s);
    sh->free += (sh->len-reallen);
    //free写的很简洁，如果s的真正长度大于原来的长度，那么会变成+一个负数 挺nice的
    sh->len = reallen;
}
/*sdsMakeRoomFor 分配长度 free不够的话 重新分配(len+addlen)*2的长度
* @param sds s          需要再分配的字符串
* @param size_t addlen  还需要的长度
* @return sds           分配完成的字符串
*/
static sds sdsMakeRoomFor(sds s, size_t addlen) {
    struct sdshdr *sh, *newsh;
    size_t free = sdsavail(s);
    size_t len, newlen;

    if (free >= addlen) return s;//空闲空间还够大，不需要再扩容
    len = sdslen(s);//获取s的长度
    sh = (void*) (s-(sizeof(struct sdshdr)));//到sds对应的sdshdr的地址
    newlen = (len+addlen)*2;//重新分配的长度
    newsh = zrealloc(sh, sizeof(struct sdshdr)+newlen+1);//重新分配 (long len)+(long free)+newlen+1
#ifdef SDS_ABORT_ON_OOM //错误处理
    if (newsh == NULL) sdsOomAbort();
#else
    if (newsh == NULL) return NULL;
#endif
    //设置空闲空间
    newsh->free = newlen - len;
    return newsh->buf;
}
/*sdscatlen 追加字符串
* @param sds s          源字符串
* @param void *t        需要追加的字符串
* @param size_t len     需要追加字符串的长度
* @return sds           新的字符串
*/
sds sdscatlen(sds s, void *t, size_t len) {
    struct sdshdr *sh;
    size_t curlen = sdslen(s);//获取s现有长度

    s = sdsMakeRoomFor(s,len);//增加len空间，如果free有足够的空间就不需要增加了
    if (s == NULL) return NULL;
    sh = (void*) (s-(sizeof(struct sdshdr)));//找到sdshdr地址
    memcpy(s+curlen, t, len);//为s字符串追加一个t字符串
    sh->len = curlen+len;//设置长度
    sh->free = sh->free-len;//设置剩余空间
    s[curlen+len] = '\0';
    return s;
}
/*sdscat 追加字符串
* @param sds s          源字符串
* @param char *t        需要追加的字符串
* @return sds           新的字符串
*/
sds sdscat(sds s, char *t) {
    return sdscatlen(s, t, strlen(t));
}
/*sdscpylen 将指定长度的字符串覆盖到源字符串中
* @param sds s          源字符串
* @param char *t        新字符串
* @param size_t len     覆盖的大小
* @retrun sds           新字符串
*/
sds sdscpylen(sds s, char *t, size_t len) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    size_t totlen = sh->free+sh->len;//总空间

    if (totlen < len) {//空间不足
        s = sdsMakeRoomFor(s,len-sh->len);//分点空间
        if (s == NULL) return NULL;
        sh = (void*) (s-(sizeof(struct sdshdr)));
        totlen = sh->free+sh->len;//分配成功后的空间
    }
    memcpy(s, t, len);//t直接覆盖到s上
    s[len] = '\0';
    sh->len = len;
    sh->free = totlen-len;
    return s;
}
/*sdscpy 将字符串覆盖写入到源字符串中
* @param sds s          源字符串
* @param char *t        新字符串
* @retrun sds           新字符串
*/
sds sdscpy(sds s, char *t) {
    return sdscpylen(s, t, strlen(t));
}
//将参数以fmt的格式打印到s中
sds sdscatprintf(sds s, const char *fmt, ...) {
    va_list ap;
    char *buf, *t;
    size_t buflen = 32;

    while(1) {
        buf = zmalloc(buflen);
#ifdef SDS_ABORT_ON_OOM
        if (buf == NULL) sdsOomAbort();
#else
        if (buf == NULL) return NULL;
#endif
        buf[buflen-2] = '\0';
        va_start(ap, fmt);//va,vs C的库函数 主要用于函数的可变参数
        vsnprintf(buf, buflen, fmt, ap);//以fmt个数将ap参数，打印buflen个到buf中
        va_end(ap);
        if (buf[buflen-2] != '\0') {//空间不够，再申请
            zfree(buf);
            buflen *= 2;
            continue;
        }
        break;
    }
    t = sdscat(s, buf);
    zfree(buf);
    return t;
}
/*sdstrim 去除cset字符串出现的字符【头和尾】
* @param sds s          源字符串
* @param char *cset     需要去除的字符串
* @return sds           新的字符串
*/
sds sdstrim(sds s, const char *cset) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));//sdshdr地址
    char *start, *end, *sp, *ep;
    size_t len;

    sp = start = s;//sdshdr->buf首地址
    ep = end = s+sdslen(s)-1;//sdshdr->buf结束地址
    while(sp <= end && strchr(cset, *sp)) sp++;
    while(ep > start && strchr(cset, *ep)) ep--;
    len = (sp > ep) ? 0 : ((ep-sp)+1);//去掉的长度
    if (sh->buf != sp) memmove(sh->buf, sp, len);
    sh->buf[len] = '\0';
    sh->free = sh->free+(sh->len-len);
    sh->len = len;
    return s;
}
//获取下标为start~end-1之间的字符串  下标从0开始
sds sdsrange(sds s, long start, long end) {
    struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
    size_t newlen, len = sdslen(s);

    if (len == 0) return s;
    if (start < 0) {//负数的话是从后面来
        start = len+start;
        if (start < 0) start = 0;
    }
    if (end < 0) {
        end = len+end;
        if (end < 0) end = 0;
    }
    newlen = (start > end) ? 0 : (end-start)+1;
    if (newlen != 0) {
        if (start >= (signed)len) start = len-1;//边界控制
        if (end >= (signed)len) end = len-1;
        newlen = (start > end) ? 0 : (end-start)+1;
    } else {
        start = 0;
    }
    if (start != 0) memmove(sh->buf, sh->buf+start, newlen);
    sh->buf[newlen] = 0;
    sh->free = sh->free+(sh->len-newlen);
    sh->len = newlen;
    return s;
}
//变为小写 遍历每一个字节 将其小写
void sdstolower(sds s) {
    int len = sdslen(s), j;

    for (j = 0; j < len; j++) s[j] = tolower(s[j]);
}
//变为大写
void sdstoupper(sds s) {
    int len = sdslen(s), j;

    for (j = 0; j < len; j++) s[j] = toupper(s[j]);
}
//比较两个字符串
int sdscmp(sds s1, sds s2) {
    size_t l1, l2, minlen;
    int cmp;

    l1 = sdslen(s1);
    l2 = sdslen(s2);
    minlen = (l1 < l2) ? l1 : l2;
    cmp = memcmp(s1,s2,minlen);
    if (cmp == 0) return l1-l2;
    return cmp;
}

/* Split 's' with separator in 'sep'. An array
 * of sds strings is returned. *count will be set
 * by reference to the number of tokens returned.
 *
 * On out of memory, zero length string, zero length
 * separator, NULL is returned.
 *
 * Note that 'sep' is able to split a string using
 * a multi-character separator. For example
 * sdssplit("foo_-_bar","_-_"); will return two
 * elements "foo" and "bar".
 *
 * This version of the function is binary-safe but
 * requires length arguments. sdssplit() is just the
 * same function but for zero-terminated strings.
 * 将s用sep分割符 分成sds数组
 * 如果len为0 直接返回zmalloc(sizeof(sds)*5)
 */
sds *sdssplitlen(char *s, int len, char *sep, int seplen, int *count) {
    int elements = 0, slots = 5, start = 0, j;

    sds *tokens = zmalloc(sizeof(sds)*slots);
#ifdef SDS_ABORT_ON_OOM
    if (tokens == NULL) sdsOomAbort();
#endif
    if (seplen < 1 || len < 0 || tokens == NULL) return NULL;//错误处理
    if (len == 0) {
        *count = 0;
        return tokens;
    }
    for (j = 0; j < (len-(seplen-1)); j++) {
        /* make sure there is room for the next element and the final one */
        if (slots < elements+2) {//空间不够分配点
            sds *newtokens;

            slots *= 2;//2倍
            newtokens = zrealloc(tokens,sizeof(sds)*slots);
            if (newtokens == NULL) {
#ifdef SDS_ABORT_ON_OOM
                sdsOomAbort();
#else
                goto cleanup;
#endif
            }
            tokens = newtokens;
        }
        /* search the separator */
        if ((seplen == 1 && *(s+j) == sep[0]) || (memcmp(s+j,sep,seplen) == 0)) {//找到了 相同分裂
            tokens[elements] = sdsnewlen(s+start,j-start);//j相等的分解线
            if (tokens[elements] == NULL) {
#ifdef SDS_ABORT_ON_OOM
                sdsOomAbort();
#else
                goto cleanup;
#endif
            }
            elements++;
            start = j+seplen;//挪到分割之后的位置
            j = j+seplen-1; /* skip the separator */
        }
    }
    /* Add the final element. We are sure there is room in the tokens array. */
    tokens[elements] = sdsnewlen(s+start,len-start);
    if (tokens[elements] == NULL) {
#ifdef SDS_ABORT_ON_OOM
                sdsOomAbort();
#else
                goto cleanup;
#endif
    }
    elements++;
    *count = elements;
    return tokens;

#ifndef SDS_ABORT_ON_OOM
cleanup:
    {
        int i;
        for (i = 0; i < elements; i++) sdsfree(tokens[i]);
        zfree(tokens);
        return NULL;
    }
#endif
}