redis源碼2--字符串SDS

Redis是用C語(yǔ)言實(shí)現(xiàn)的,但是并沒(méi)有使用 C 語(yǔ)言傳統(tǒng)的字符串表示(以空字符結(jié)尾的字符數(shù)組,以下簡(jiǎn)稱 C 字符串), 而是自己構(gòu)建了一種名為簡(jiǎn)單動(dòng)態(tài)字符串(simple dynamic string,SDS)的抽象類型, 并將 SDS 用作 Redis 的默認(rèn)字符串表示

比如客戶端執(zhí)行命令

redis> SET hello "world"
OK

那么鍵 hello 和 值 wrold 內(nèi)部都是保存了 "hello" 和 "wrold" 的SDS對(duì)象

SDS與C字符串的區(qū)別

1.常數(shù)復(fù)雜度獲取字符串長(zhǎng)度。
2.杜絕緩沖區(qū)溢出。
3.減少修改字符串長(zhǎng)度時(shí)所需的內(nèi)存重分配次數(shù)。
4.二進(jìn)制安全。
5.兼容部分 C 字符串函數(shù)。

關(guān)于SDS的更多基礎(chǔ)知識(shí),可以詳見(jiàn) http://redisbook.com/ ,本文主要介紹sds源碼部分。源碼文件在sds.h和sds.c中。關(guān)于zmalloc和zfree的部分,請(qǐng)看上一個(gè)博客 http://www.itdecent.cn/p/da5dae89c979

SDS定義

在 sds.h中定義

struct sdshdr {

    // buf 中已使用空間的長(zhǎng)度
    //等于SDS中所保存字符串的長(zhǎng)度
    int len;

    // buf 中剩余可用空間的長(zhǎng)度
    int free;

    // 數(shù)據(jù)空間
    char buf[];
};

結(jié)構(gòu)定義非常簡(jiǎn)單,在內(nèi)存中簡(jiǎn)單表示為


SDS示例

全局變量及其他定義

//最大預(yù)分配長(zhǎng)度(1MB)
#define SDS_MAX_PREALLOC (1024*1024)
//類型別名,用于指向 sdshdr 的 buf 屬性,所以下文的sds,指向的是sdshdr 的buf字段
typedef char *sds;

靜態(tài)函數(shù)

//O(1)時(shí)間復(fù)雜度返回 sds 實(shí)際保存的字符串的長(zhǎng)度
static inline size_t sdslen(const sds s) {
  struct sdshdr *sh = (void*)(s-(sizeof(struct sdshdr)));
  return sh->len;
}

//O(1)時(shí)間復(fù)雜度返回 sds 可用空間的長(zhǎng)度
static inline size_t sdsavail(const sds s) {
  struct sdshdr *sh = (void*)(s-(sizeof(struct sdshdr)));
  return sh->free;
}

主要函數(shù)

//根據(jù)給定的初始化字符串 init 和字符串長(zhǎng)度 initlen 創(chuàng)建一個(gè)新的 sds
//并且該sds buf屬性多申請(qǐng)了一個(gè)字節(jié),結(jié)尾的最后一個(gè)字節(jié)被置為'\0'
sds sdsnewlen(const void *init, size_t initlen)
//創(chuàng)建并返回一個(gè)只保存了空字符串 "" 的 sds
//實(shí)際上是調(diào)用 sdsnewlen
sds sdsempty(void)
//給定字符串 init ,創(chuàng)建一個(gè)包含同樣字符串的 sds,輸入為 NULL ,創(chuàng)建一個(gè)空白 sds
//實(shí)際上是調(diào)用 sdsnewlen
sds sdsnew(const char *init)
//復(fù)制給定 sds 的副本,創(chuàng)建成功返回輸入 sds 的副本,失敗返回 NULL
//實(shí)際上是調(diào)用 sdsnewlen
sds sdsdup(const sds s)
//釋放給定的 SDS
void sdsfree(sds s)
//重置sds所保存的字段串為空字符串,但不回收內(nèi)存,第一個(gè)字節(jié)為'\0'
void sdsclear(sds s)
//對(duì) sds 中 buf 的長(zhǎng)度進(jìn)行擴(kuò)展,會(huì)進(jìn)行空間預(yù)分配
//底層是調(diào)用了realloc,所以數(shù)據(jù)不會(huì)丟失,最后一個(gè)字節(jié)也置為'\0'
sds sdsMakeRoomFor(sds s, size_t addlen)
//回收 sds 中的空閑空間,也就是將free屬性置0
//底層調(diào)用了realloc
sds sdsRemoveFreeSpace(sds s)
//返回給定 sds 分配的內(nèi)存字節(jié)數(shù),包括struct sdshdr所占的字節(jié)數(shù)和最后一個(gè)'\0'
size_t sdsAllocSize(sds s) 
//將 sds 擴(kuò)充至指定長(zhǎng)度,未使用的空間以 0 字節(jié)填充。
sds sdsgrowzero(sds s, size_t len)
//將長(zhǎng)度為 len 的字符串 t 追加到 sds 的字符串末尾
//不去判斷free夠不夠用,直接將sds的buf擴(kuò)展len長(zhǎng)度存放傳入的數(shù)據(jù),最后會(huì)將最后一個(gè)字節(jié)置為'\0'
sds sdscatlen(sds s, const void *t, size_t len)
//將給定字符串 t 追加到 sds 的末尾
//實(shí)際是調(diào)用 sdscatlen
sds sdscat(sds s, const char *t)
//將另一個(gè) sds 追加到一個(gè) sds 的末尾
//實(shí)際是調(diào)用 sdscatlen
sds sdscatsds(sds s, const sds t) 
//將字符串 t 的前 len 個(gè)字符復(fù)制到 sds s 當(dāng)中,并在字符串的最后添加終結(jié)符。
//會(huì)覆蓋sds原來(lái)的字符串內(nèi)容
sds sdscpylen(sds s, const char *t, size_t len)
//將字符串復(fù)制到 sds 當(dāng)中,覆蓋原有的字符。
//實(shí)際是調(diào)用 sdscpylen
sds sdscpy(sds s, const char *t)
//對(duì) sds 左右兩端進(jìn)行修剪,清除其中 cset 指定的所有字符
sds sdstrim(sds s, const char *cset)
//按索引對(duì)截取 sds 字符串的其中一段,start 和 end 都是閉區(qū)間(包含在內(nèi))
void sdsrange(sds s, int start, int end)
//將 sds 字符串中的所有字符轉(zhuǎn)換為小寫
void sdstolower(sds s)
//將 sds 字符串中的所有字符轉(zhuǎn)換為大寫
void sdstoupper(sds s)
//對(duì)比兩個(gè) sds , strcmp 的 sds 版本,相等返回 0 ,s1 較大返回正數(shù), s2 較大返回負(fù)數(shù)
int sdscmp(const sds s1, const sds s2)

其他函數(shù)

//用戶主動(dòng)調(diào)用,增加len屬性,減少free屬性
void sdsIncrLen(sds s, int incr)
//傳入一個(gè)char * 和long long 的數(shù)值,將數(shù)值轉(zhuǎn)為字符串放入傳入的char *中,char* 指向的地址要事先分配好內(nèi)存
int sdsll2str(char *s, long long value) 
//跟sdsll2str原理一樣,只不過(guò)傳入的是unsigned long long
int sdsull2str(char *s, unsigned long long v)
// 根據(jù)輸入的 long long 值 value ,轉(zhuǎn)為字符串創(chuàng)建一個(gè) SDS
////實(shí)際是調(diào)用 sdsll2str 和 sdsnewlen
sds sdsfromlonglong(long long value)
//輸出函數(shù),懶得看了
sds sdscatvprintf(sds s, const char *fmt, va_list ap)
//打印任意數(shù)量個(gè)字符串,并將這些字符串追加到給定 sds 的末尾,調(diào)用了 sdscatvprintf
sds sdscatprintf(sds s, const char *fmt, ...)
//對(duì) sds 左右兩端進(jìn)行修剪,清除其中 cset 指定的所有字符
sds sdstrim(sds s, const char *cset)

sdsnewlen

根據(jù)給定的初始化字符串 init 和字符串長(zhǎng)度 initlen 創(chuàng)建一個(gè)新的 sds

//申請(qǐng)后,bug數(shù)組默認(rèn)含有一個(gè) '\0',但是不計(jì)入len屬性中
sds sdsnewlen(const void *init, size_t initlen) {

  struct sdshdr *sh;

  // 根據(jù)是否有初始化內(nèi)容,選擇適當(dāng)?shù)膬?nèi)存分配方式
  //多申請(qǐng)一個(gè)字節(jié),用于存放 '\0'
  // T = O(N)
  if (init) {
      // zmalloc 不初始化所分配的內(nèi)存    
      sh = zmalloc(sizeof(struct sdshdr)+initlen+1);
  } else {
      // zcalloc 將分配的內(nèi)存全部初始化為 0
      sh = zcalloc(sizeof(struct sdshdr)+initlen+1);
  }

  // 內(nèi)存分配失敗,返回
  if (sh == NULL) return NULL;

  // 設(shè)置初始化長(zhǎng)度
  sh->len = initlen;
  // 新 sds 不預(yù)留任何空間
  sh->free = 0;
  // 如果有指定初始化內(nèi)容,將它們復(fù)制到 sdshdr 的 buf 中
  // T = O(N)
  if (initlen && init)
      memcpy(sh->buf, init, initlen);
  // 以 \0 結(jié)尾
  sh->buf[initlen] = '\0';

  // 返回 buf 部分,而不是整個(gè) sdshdr
  return (char*)sh->buf;
}

sdsempty

//創(chuàng)建并返回一個(gè)只保存了空字符串 "" 的 sds
sds sdsempty(void) {
  return sdsnewlen("",0);
}

sdsnew

根據(jù)給定字符串 init ,創(chuàng)建一個(gè)包含同樣字符串的 sds,如果輸入為 NULL ,那么創(chuàng)建一個(gè)空白 sds

sds sdsnew(const char *init) {
  size_t initlen = (init == NULL) ? 0 : strlen(init);
  return sdsnewlen(init, initlen);
}

sdsdup

復(fù)制給定 sds 的副本,創(chuàng)建成功返回輸入 sds 的副本,失敗返回 NULL

sds sdsdup(const sds s) {
  //傳入的s,就是sdshdr 的 buf 屬性,所以和傳入一個(gè)char* 一樣
  return sdsnewlen(s, sdslen(s));
}

sdsfree

void sdsfree(sds s) {
  if (s == NULL) return;
  zfree(s-sizeof(struct sdshdr));
}

sdsclear

重置 SDS 所保存的字符串為空字符串,但不釋放SDS 的字符串空間。相當(dāng)于惰性空間釋放(縮短 SDS 保存的字符串,但并不立即使用內(nèi)存重分配來(lái)回收縮短后多出來(lái)的字節(jié))

void sdsclear(sds s) {

  // 取出 sdshdr
  struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));

  // 重新計(jì)算屬性
  sh->free += sh->len;
  sh->len = 0;

  // 將結(jié)束符放到最前面(相當(dāng)于惰性地刪除 buf 中的內(nèi)容)
  sh->buf[0] = '\0';
}  

sdsMakeRoomFor

對(duì) sds 中 buf 的長(zhǎng)度進(jìn)行擴(kuò)展,SDS對(duì)buf進(jìn)行擴(kuò)展時(shí),會(huì)進(jìn)行空間預(yù)分配,不僅會(huì)為 SDS 分配修改所必須要的空間, 還會(huì)為 SDS 分配額外的未使用空間,以減少后續(xù)可能會(huì)出現(xiàn)的空間擴(kuò)展操作
其中, 額外分配的未使用空間數(shù)量由以下公式?jīng)Q定:

  • 如果對(duì) SDS 進(jìn)行修改之后, SDS 的長(zhǎng)度(也即是 len 屬性的值)將小于 1 MB , 那么程序分配和 len 屬性同樣大小的未使用空間, 這時(shí) SDS len 屬性的值將和 free 屬性的值相同。 舉個(gè)例子, 如果進(jìn)行修改之后, SDS 的 len 將變成 13 字節(jié), 那么程序也會(huì)分配 13 字節(jié)的未使用空間, SDS 的 buf 數(shù)組的實(shí)際長(zhǎng)度將變成 13 + 13 + 1 = 27 字節(jié)(額外的一字節(jié)用于保存空字符)。
  • 如果對(duì) SDS 進(jìn)行修改之后, SDS 的長(zhǎng)度將大于等于 1 MB , 那么程序會(huì)分配 1 MB 的未使用空間。 舉個(gè)例子, 如果進(jìn)行修改之后, SDS 的 len 將變成 30 MB , 那么程序會(huì)分配 1 MB 的未使用空間, SDS 的 buf 數(shù)組的實(shí)際長(zhǎng)度將為 30 MB + 1 MB + 1 byte 。
sds sdsMakeRoomFor(sds s, size_t addlen) {

  struct sdshdr *sh, *newsh;

  // 獲取 s 目前的空余空間長(zhǎng)度
  size_t free = sdsavail(s);

  size_t len, newlen;

  // s 目前的空余空間已經(jīng)足夠,無(wú)須再進(jìn)行擴(kuò)展,直接返回
  if (free >= addlen) return s;

  // 獲取 s 目前已占用空間的長(zhǎng)度
  len = sdslen(s);
  sh = (void*) (s-(sizeof(struct sdshdr)));

  // s 最少需要的長(zhǎng)度
  newlen = (len+addlen);

  // 根據(jù)新長(zhǎng)度,為 s 分配新空間所需的大小
  if (newlen < SDS_MAX_PREALLOC) {
      // 如果新長(zhǎng)度小于 SDS_MAX_PREALLOC 
      // 那么為它分配兩倍于所需長(zhǎng)度的空間
      newlen *= 2;
  } else {
       // 否則,分配長(zhǎng)度為目前長(zhǎng)度加上 SDS_MAX_PREALLOC
      newlen += SDS_MAX_PREALLOC;
  }
   // T = O(N)
   //zrealloc,指向新的內(nèi)存,釋放原來(lái)的內(nèi)存
   newsh = zrealloc(sh, sizeof(struct sdshdr)+newlen+1);

   // 內(nèi)存不足,分配失敗,返回
   if (newsh == NULL) return NULL;
   //已用長(zhǎng)度不變,還是原來(lái)的len 屬性
   //更新 sds 的空余長(zhǎng)度
   newsh->free = newlen - len;

    // 返回 sds
   return newsh->buf;
}

從代碼可以看出,擴(kuò)展以后,free屬性,并不是嚴(yán)格的 2 * len,比如,zrealloc的時(shí)候,長(zhǎng)度為 newlen = 2,那么最終free的長(zhǎng)度為,len + 2addlen,并且zrealloc內(nèi)部是調(diào)用了realloc,不僅重新分配新的內(nèi)存,還會(huì)把原來(lái)內(nèi)存中的數(shù)據(jù)拷貝到新內(nèi)存中,所以數(shù)據(jù)不會(huì)被影響,len屬性還是原來(lái)的長(zhǎng)度,并且最后一個(gè)字節(jié)存儲(chǔ)的'\0' 也被拷貝過(guò)去

sdsRemoveFreeSpace

回收 sds 中的空閑空間,不會(huì)對(duì) sds 中保存的字符串內(nèi)容做任何修改,返回內(nèi)存調(diào)整后的 sds

sds sdsRemoveFreeSpace(sds s) {
  struct sdshdr *sh;

  sh = (void*) (s-(sizeof(struct sdshdr)));

  // 進(jìn)行內(nèi)存重分配,讓 buf 的長(zhǎng)度僅僅足夠保存字符串內(nèi)容
  // T = O(N)
  sh = zrealloc(sh, sizeof(struct sdshdr)+sh->len+1);

  // 空余空間為 0
  sh->free = 0;

  return sh->buf;
}

sdsAllocSize

返回給定 sds 分配的內(nèi)存字節(jié)數(shù)

size_t sdsAllocSize(sds s) {
  struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
  //buf的字節(jié)數(shù),為已使用的加上未使用的,再加上一個(gè)'\0'
  return sizeof(*sh)+sh->len+sh->free+1;
}

sdsIncrLen

傳入 incr 參數(shù),增加sds已使用長(zhǎng)度,減少可用空余長(zhǎng)度,用戶主動(dòng)調(diào)用,調(diào)用前要保證空余長(zhǎng)度夠用,這個(gè)函數(shù)是在調(diào)用 sdsMakeRoomFor() 對(duì)字符串進(jìn)行擴(kuò)展,然后用戶在字符串尾部寫入了某些內(nèi)容之后,用來(lái)正確更新 free 和 len 屬性的。
以下是 sdsIncrLen 的用例:

oldlen = sdslen(s);
s = sdsMakeRoomFor(s, BUFFER_SIZE);
nread = read(fd, s+oldlen, BUFFER_SIZE);
... check for nread <= 0 and handle it ...
sdsIncrLen(s, nread);

如果 incr 參數(shù)為負(fù)數(shù),那么對(duì)字符串進(jìn)行右截?cái)嗖僮?/p>

void sdsIncrLen(sds s, int incr) {
  struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));

  // 確保 sds 空間足夠
  assert(sh->free >= incr);

  // 更新屬性
  sh->len += incr;
  sh->free -= incr;

  // 這個(gè) assert 其實(shí)可以忽略
  // 因?yàn)榍耙粋€(gè) assert 已經(jīng)確保 sh->free - incr >= 0 了
  assert(sh->free >= 0);

  // 放置新的結(jié)尾符號(hào)
  s[sh->len] = '\0';
}

sdsgrowzero

將 sds 擴(kuò)充至指定長(zhǎng)度,未使用的空間以 0 字節(jié)填充。

sds sdsgrowzero(sds s, size_t len) {
  struct sdshdr *sh = (void*)(s-(sizeof(struct sdshdr)));
  size_t totlen, curlen = sh->len;

  // 如果 len 比字符串的現(xiàn)有長(zhǎng)度小,
  // 那么直接返回,不做動(dòng)作
  if (len <= curlen) return s;

  // 擴(kuò)展 sds
  // 改變的是free的長(zhǎng)度,沒(méi)有改變len的長(zhǎng)度
  s = sdsMakeRoomFor(s,len-curlen);
  // 如果內(nèi)存不足,直接返回
  if (s == NULL) return NULL;

  // 將新分配的空間用 0 填充,防止出現(xiàn)垃圾內(nèi)容
  // 包括最后一個(gè)字節(jié)
  sh = (void*)(s-(sizeof(struct sdshdr)));
  memset(s+curlen,0,(len-curlen+1)); /* also set trailing \0 byte */

  // 更新屬性
  totlen = sh->len+sh->free;
  //將len字段,擴(kuò)展到所傳入的len參數(shù)的長(zhǎng)度,并減少可用空余長(zhǎng)度
  sh->len = len;
  sh->free = totlen-sh->len;

  // 返回新的 sds
  return s;
}

sdscatlen

將長(zhǎng)度為 len 的字符串 t 追加到 sds 的字符串末尾

sds sdscatlen(sds s, const void *t, size_t len) {

  struct sdshdr *sh;

  // 原有字符串長(zhǎng)度
  size_t curlen = sdslen(s);

  // 擴(kuò)展 sds 空間
  // T = O(N)
  s = sdsMakeRoomFor(s,len);

  // 內(nèi)存不足?直接返回
  if (s == NULL) return NULL;

  // 復(fù)制 t 中的內(nèi)容到字符串后部
  // T = O(N)
  sh = (void*) (s-(sizeof(struct sdshdr)));
  memcpy(s+curlen, t, len);

  // 更新屬性
  sh->len = curlen+len;
  sh->free = sh->free-len;

  // 添加新結(jié)尾符號(hào)
  s[curlen+len] = '\0';

  // 返回新 sds
  return s;
}

sdscat

將給定字符串 t 追加到 sds 的末尾

sds sdscat(sds s, const char *t) {
  return sdscatlen(s, t, strlen(t));
}

sdscatsds

將另一個(gè) sds 追加到一個(gè) sds 的末尾

sds sdscatsds(sds s, const sds t) {
  return sdscatlen(s, t, sdslen(t));
}

sdscpylen

將字符串 t 的前 len 個(gè)字符復(fù)制到 sds s 當(dāng)中,并在字符串的最后添加終結(jié)符。會(huì)覆蓋原來(lái)sds字符串的數(shù)據(jù)

sds sdscpylen(sds s, const char *t, size_t len) {

  struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));

  // sds 現(xiàn)有 buf 的長(zhǎng)度
  size_t totlen = sh->free+sh->len;

  // 如果 s 的 buf 長(zhǎng)度不滿足 len ,那么擴(kuò)展它
  if (totlen < len) {
      //這里擴(kuò)展的長(zhǎng)度之所以不用 len - sh->len - sh->free
      //是因?yàn)?sdsMakeRoomFor 內(nèi)部會(huì)對(duì) free 進(jìn)行判斷和處理
      s = sdsMakeRoomFor(s,len-sh->len);
      if (s == NULL) return NULL;
      sh = (void*) (s-(sizeof(struct sdshdr)));
      //用于更新最后的 free屬性
      totlen = sh->free+sh->len;
  }

  // 復(fù)制內(nèi)容
  // T = O(N)
  memcpy(s, t, len);

  // 添加終結(jié)符號(hào)
  s[len] = '\0';

  // 更新屬性
  sh->len = len;
  sh->free = totlen-len;

  // 返回新的 sds
  return s;
}

sdscpy

將字符串復(fù)制到 sds 當(dāng)中,覆蓋原有的字符。如果 sds 的長(zhǎng)度少于字符串的長(zhǎng)度,那么擴(kuò)展 sds 。

sds sdscpy(sds s, const char *t) {
  return sdscpylen(s, t, strlen(t));
}

sdsll2str

傳入一個(gè)char * 和long long 的數(shù)值,將數(shù)值轉(zhuǎn)為字符串放入傳入的char 中,char 指向的地址要事先分配好內(nèi)存

#define SDS_LLSTR_SIZE 21
int sdsll2str(char *s, long long value) {
  char *p, aux;
  unsigned long long v;
  size_t l;
  //轉(zhuǎn)為無(wú)符號(hào)數(shù)
  v = (value < 0) ? -value : value;
  //指向字符串開頭
  p = s;
  //不占用額外的空間,直接在原來(lái)的字符串內(nèi)存上改
  do {
      //按照個(gè)十百千萬(wàn)的順序
      *p++ = '0'+(v%10);
      v /= 10;
  } while(v);
  //這樣運(yùn)行完,是倒序的,比如 -123456,運(yùn)行完是 654321-
  if (value < 0) *p++ = '-';

  l = p-s;
  *p = '\0';
   //p指向的是 '\0',所以要 -- 以后重新指向有效的數(shù)據(jù)位
   //如果value是 123456,運(yùn)行完是654321,p指向 1,如果value是 -123456,p指向 -(負(fù)號(hào))
  p--;
  //前后交換,s還是指向開頭
  while(s < p) {
      aux = *s;
      *s = *p;
      *p = aux;
      s++;
      p--;
   }
  return l;
}

sdsfromlonglong

輸入一個(gè) long long 值 value ,轉(zhuǎn)為字符串,創(chuàng)建一個(gè) SDS

sds sdsfromlonglong(long long value) {
  char buf[SDS_LLSTR_SIZE];
  int len = sdsll2str(buf,value);

  return sdsnewlen(buf,len);
}

sdstrim

對(duì) sds 左右兩端進(jìn)行修剪,清除其中 cset 指定的所有字符
比如 sdstrim(AA...AA.a.aa.aHello World:::Aa,"A.:"),返回 Hello World,不區(qū)分大小寫。但是,只會(huì)清除兩端的,比如sdstrim(xyyxHelloxxxyxWorldxyxxy","xy"),返回HelloxxxyxWorld

sds sdstrim(sds s, const char *cset) {
  struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
  char *start, *end, *sp, *ep;
  size_t len;

  // sp 和 start 指向字符串開頭
  sp = start = s;
  // ep 和 end 指向字符串的結(jié)尾
  ep = end = s+sdslen(s)-1;

  //從頭開始遍歷,只要當(dāng)前sp指向的字符,在cset中,指針就繼續(xù)后移
  while(sp <= end && strchr(cset, *sp)) sp++;
  //從尾部朝前遍歷,只要當(dāng)前ep指向的字符,在cset中,指針就繼續(xù)前移
  while(ep > start && strchr(cset, *ep)) ep--;

  //到這的時(shí)候,sp和ep所指向的字符,在cset中不存在,但是sp和ep之間的不管

  // 計(jì)算 trim 完畢之后剩余的字符串長(zhǎng)度
  len = (sp > ep) ? 0 : ((ep-sp)+1);

  // 如果有需要,前移字符串內(nèi)容
  if (sh->buf != sp) memmove(sh->buf, sp, len);

  // 添加終結(jié)符
  sh->buf[len] = '\0';

  // 更新屬性
  sh->free = sh->free+(sh->len-len);
  sh->len = len;

  // 返回修剪后的 sds
  return s;
}

sdsrange

按索引截取 sds 字符串的其中一段,start 和 end 都是閉區(qū)間(包含在內(nèi)),索引從 0 開始,最大為 sdslen(s) - 1,索引可以是負(fù)數(shù), sdslen(s) - 1 == -1,例如:sdsrange("Hello World",1,-1); => "ello World"

void sdsrange(sds s, int start, int end) {
  struct sdshdr *sh = (void*) (s-(sizeof(struct sdshdr)));
  size_t newlen, len = sdslen(s);

  if (len == 0) return;
  //先對(duì)輸入為負(fù)數(shù)的情況做處理
  if (start < 0) {
      start = len+start;
      //處理完還是負(fù)數(shù),指向開頭
      if (start < 0) start = 0;
  }
  if (end < 0) {
      end = len+end;
      if (end < 0) end = 0;
  }
  //進(jìn)行邊界處理
  newlen = (start > end) ? 0 : (end-start)+1;
  //newlen大于0,截取才有意義
  if (newlen != 0) {
     if (start >= (signed)len) {
        newlen = 0;
        //當(dāng)結(jié)束的下標(biāo)大于字符串長(zhǎng)度時(shí),做一個(gè)處理,截取到尾部,但是start沒(méi)有這種處理
     } else if (end >= (signed)len) {
        end = len-1;
        newlen = (start > end) ? 0 : (end-start)+1;
     }
  } else {
      start = 0;
  }

  if (start && newlen) memmove(sh->buf, sh->buf+start, newlen);

  // 添加終結(jié)符
  sh->buf[newlen] = 0;

  // 更新屬性
  sh->free = sh->free+(sh->len-newlen);
  sh->len = newlen;
}

sdstolower

將 sds 字符串中的所有字符轉(zhuǎn)換為小寫

void sdstolower(sds s) {
  int len = sdslen(s), j;

  for (j = 0; j < len; j++) s[j] = tolower(s[j]);
}

sdstoupper

將 sds 字符串中的所有字符轉(zhuǎn)換為大寫

void sdstoupper(sds s) {
  int len = sdslen(s), j;

  for (j = 0; j < len; j++) s[j] = toupper(s[j]);
}

sdscmp

對(duì)比兩個(gè) sds , strcmp 的 sds 版本,相等返回 0 ,s1 較大返回正數(shù), s2 較大返回負(fù)數(shù)

int sdscmp(const sds s1, const sds s2) {
  size_t l1, l2, minlen;
  int cmp;

  l1 = sdslen(s1);
  l2 = sdslen(s2);
  minlen = (l1 < l2) ? l1 : l2;
  //memcmp按字節(jié)比較,返回值的意義和sdscmp一樣
  cmp = memcmp(s1,s2,minlen);

  if (cmp == 0) return l1-l2;

  return cmp;
}

sdssplitlen

使用分隔符 sep 對(duì) s 進(jìn)行分割,返回一個(gè) sds 字符串的數(shù)組。*count 會(huì)被設(shè)置為返回?cái)?shù)組元素的數(shù)量。
如果出現(xiàn)內(nèi)存不足、字符串長(zhǎng)度為 0 或分隔符長(zhǎng)度為 0的情況,返回 NULL
分隔符可以的是包含多個(gè)字符的字符串
這個(gè)函數(shù)接受 len 參數(shù),因此它是二進(jìn)制安全的

SDS的二進(jìn)制安全

C 字符串中的字符必須符合某種編碼(比如 ASCII), 并且除了字符串的末尾之外, 字符串里面不能包含空字符, 否則最先被程序讀入的空字符將被誤認(rèn)為是字符串結(jié)尾 —— 這些限制使得 C 字符串只能保存文本數(shù)據(jù), 而不能保存像圖片、音頻、視頻、壓縮文件這樣的二進(jìn)制數(shù)據(jù)。所有 SDS API 都會(huì)以處理二進(jìn)制的方式來(lái)處理 SDS 存放在 buf 數(shù)組里的數(shù)據(jù), 程序不會(huì)對(duì)其中的數(shù)據(jù)做任何限制、過(guò)濾、或者假設(shè) —— 數(shù)據(jù)在寫入時(shí)是什么樣的, 它被讀取時(shí)就是什么樣。這也是我們將 SDS 的 buf 屬性稱為字節(jié)數(shù)組的原因 —— Redis 不是用這個(gè)數(shù)組來(lái)保存字符, 而是用它來(lái)保存一系列二進(jìn)制數(shù)據(jù)

sds *sdssplitlen(const char *s, int len, const char *sep, int seplen, int *count) {
  //返回的字符串?dāng)?shù)組的元素個(gè)數(shù)
  int elements = 0;
  //用于申請(qǐng)返回字符串?dāng)?shù)組的容量
  int slots = 5;
  //用于標(biāo)記從哪開始分割
  int start = 0, j;
  sds *tokens;

  if (seplen < 1 || len < 0) return NULL;
  //先申請(qǐng)slots 個(gè) sds內(nèi)存
  tokens = zmalloc(sizeof(sds)*slots);
  if (tokens == NULL) return NULL;

  if (len == 0) {
    *count = 0;
    return tokens;
  }

  // T = O(N^2)
  for (j = 0; j < (len-(seplen-1)); j++) {
    /* make sure there is room for the next element and the final one */
    //當(dāng)數(shù)組內(nèi)存不太夠用的時(shí)候,直接重新分配2倍
    if (slots < elements+2) {
        sds *newtokens;

        slots *= 2;
        newtokens = zrealloc(tokens,sizeof(sds)*slots);
        if (newtokens == NULL) goto cleanup;
        tokens = newtokens;
    }
    /* search the separator */
    // T = O(N)
    //判斷一下是否相等,如果相等,增加到返回?cái)?shù)組里
    if ((seplen == 1 && *(s+j) == sep[0]) || (memcmp(s+j,sep,seplen) == 0)) {
        tokens[elements] = sdsnewlen(s+start,j-start);
        if (tokens[elements] == NULL) goto cleanup;
        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) goto cleanup;
  elements++;
  *count = elements;
  return tokens;

cleanup:
 {
    int i;
    for (i = 0; i < elements; i++) sdsfree(tokens[i]);
    zfree(tokens);
    *count = 0;
    return NULL;
  }
 }
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容