]>
git.saurik.com Git - redis.git/blob - src/sds.c
1 /* SDSLib, A C dynamic strings library
3 * Copyright (c) 2006-2010, Salvatore Sanfilippo <antirez at gmail dot com>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * * Neither the name of Redis nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without
16 * specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
39 sds
sdsnewlen(const void *init
, size_t initlen
) {
43 sh
= zmalloc(sizeof(struct sdshdr
)+initlen
+1);
45 sh
= zcalloc(sizeof(struct sdshdr
)+initlen
+1);
47 if (sh
== NULL
) return NULL
;
51 memcpy(sh
->buf
, init
, initlen
);
52 sh
->buf
[initlen
] = '\0';
53 return (char*)sh
->buf
;
57 return sdsnewlen("",0);
60 sds
sdsnew(const char *init
) {
61 size_t initlen
= (init
== NULL
) ? 0 : strlen(init
);
62 return sdsnewlen(init
, initlen
);
65 sds
sdsdup(const sds s
) {
66 return sdsnewlen(s
, sdslen(s
));
70 if (s
== NULL
) return;
71 zfree(s
-sizeof(struct sdshdr
));
74 void sdsupdatelen(sds s
) {
75 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
76 int reallen
= strlen(s
);
77 sh
->free
+= (sh
->len
-reallen
);
81 void sdsclear(sds s
) {
82 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
88 /* Enlarge the free space at the end of the sds string so that the caller
89 * is sure that after calling this function can overwrite up to addlen
90 * bytes after the end of the string, plus one more byte for nul term.
92 * Note: this does not change the *size* of the sds string as returned
93 * by sdslen(), but only the free buffer space we have. */
94 sds
sdsMakeRoomFor(sds s
, size_t addlen
) {
95 struct sdshdr
*sh
, *newsh
;
96 size_t free
= sdsavail(s
);
99 if (free
>= addlen
) return s
;
101 sh
= (void*) (s
-(sizeof(struct sdshdr
)));
102 newlen
= (len
+addlen
);
103 if (newlen
< SDS_MAX_PREALLOC
)
106 newlen
+= SDS_MAX_PREALLOC
;
107 newsh
= zrealloc(sh
, sizeof(struct sdshdr
)+newlen
+1);
108 if (newsh
== NULL
) return NULL
;
110 newsh
->free
= newlen
- len
;
114 /* Reallocate the sds string so that it has no free space at the end. The
115 * contained string remains not altered, but next concatenation operations
116 * will require a reallocation. */
117 sds
sdsRemoveFreeSpace(sds s
) {
120 sh
= (void*) (s
-(sizeof(struct sdshdr
)));
121 sh
= zrealloc(sh
, sizeof(struct sdshdr
)+sh
->len
+1);
126 /* Increment the sds length and decrements the left free space at the
127 * end of the string accordingly to 'incr'. Also set the null term
128 * in the new end of the string.
130 * This function is used in order to fix the string length after the
131 * user calls sdsMakeRoomFor(), writes something after the end of
132 * the current string, and finally needs to set the new length.
134 * Note: it is possible to use a negative increment in order to
135 * right-trim the string.
137 * Using sdsIncrLen() and sdsMakeRoomFor() it is possible to mount the
138 * following schema to cat bytes coming from the kerenl to the end of an
139 * sds string new things without copying into an intermediate buffer:
141 * oldlen = sdslen(s);
142 * s = sdsMakeRoomFor(s, BUFFER_SIZE);
143 * nread = read(fd, s+oldlen, BUFFER_SIZE);
144 * ... check for nread <= 0 and handle it ...
145 * sdsIncrLen(s, nhread);
147 void sdsIncrLen(sds s
, int incr
) {
148 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
150 assert(sh
->free
>= incr
);
153 assert(sh
->free
>= 0);
157 /* Grow the sds to have the specified length. Bytes that were not part of
158 * the original length of the sds will be set to zero. */
159 sds
sdsgrowzero(sds s
, size_t len
) {
160 struct sdshdr
*sh
= (void*)(s
-(sizeof(struct sdshdr
)));
161 size_t totlen
, curlen
= sh
->len
;
163 if (len
<= curlen
) return s
;
164 s
= sdsMakeRoomFor(s
,len
-curlen
);
165 if (s
== NULL
) return NULL
;
167 /* Make sure added region doesn't contain garbage */
168 sh
= (void*)(s
-(sizeof(struct sdshdr
)));
169 memset(s
+curlen
,0,(len
-curlen
+1)); /* also set trailing \0 byte */
170 totlen
= sh
->len
+sh
->free
;
172 sh
->free
= totlen
-sh
->len
;
176 sds
sdscatlen(sds s
, void *t
, size_t len
) {
178 size_t curlen
= sdslen(s
);
180 s
= sdsMakeRoomFor(s
,len
);
181 if (s
== NULL
) return NULL
;
182 sh
= (void*) (s
-(sizeof(struct sdshdr
)));
183 memcpy(s
+curlen
, t
, len
);
184 sh
->len
= curlen
+len
;
185 sh
->free
= sh
->free
-len
;
186 s
[curlen
+len
] = '\0';
190 sds
sdscat(sds s
, char *t
) {
191 return sdscatlen(s
, t
, strlen(t
));
194 sds
sdscatsds(sds s
, sds t
) {
195 return sdscatlen(s
, t
, sdslen(t
));
198 sds
sdscpylen(sds s
, char *t
, size_t len
) {
199 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
200 size_t totlen
= sh
->free
+sh
->len
;
203 s
= sdsMakeRoomFor(s
,len
-sh
->len
);
204 if (s
== NULL
) return NULL
;
205 sh
= (void*) (s
-(sizeof(struct sdshdr
)));
206 totlen
= sh
->free
+sh
->len
;
211 sh
->free
= totlen
-len
;
215 sds
sdscpy(sds s
, char *t
) {
216 return sdscpylen(s
, t
, strlen(t
));
219 sds
sdscatvprintf(sds s
, const char *fmt
, va_list ap
) {
225 buf
= zmalloc(buflen
);
226 if (buf
== NULL
) return NULL
;
227 buf
[buflen
-2] = '\0';
229 vsnprintf(buf
, buflen
, fmt
, cpy
);
230 if (buf
[buflen
-2] != '\0') {
242 sds
sdscatprintf(sds s
, const char *fmt
, ...) {
246 t
= sdscatvprintf(s
,fmt
,ap
);
251 sds
sdstrim(sds s
, const char *cset
) {
252 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
253 char *start
, *end
, *sp
, *ep
;
257 ep
= end
= s
+sdslen(s
)-1;
258 while(sp
<= end
&& strchr(cset
, *sp
)) sp
++;
259 while(ep
> start
&& strchr(cset
, *ep
)) ep
--;
260 len
= (sp
> ep
) ? 0 : ((ep
-sp
)+1);
261 if (sh
->buf
!= sp
) memmove(sh
->buf
, sp
, len
);
263 sh
->free
= sh
->free
+(sh
->len
-len
);
268 sds
sdsrange(sds s
, int start
, int end
) {
269 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
270 size_t newlen
, len
= sdslen(s
);
272 if (len
== 0) return s
;
275 if (start
< 0) start
= 0;
279 if (end
< 0) end
= 0;
281 newlen
= (start
> end
) ? 0 : (end
-start
)+1;
283 if (start
>= (signed)len
) {
285 } else if (end
>= (signed)len
) {
287 newlen
= (start
> end
) ? 0 : (end
-start
)+1;
292 if (start
&& newlen
) memmove(sh
->buf
, sh
->buf
+start
, newlen
);
294 sh
->free
= sh
->free
+(sh
->len
-newlen
);
299 void sdstolower(sds s
) {
300 int len
= sdslen(s
), j
;
302 for (j
= 0; j
< len
; j
++) s
[j
] = tolower(s
[j
]);
305 void sdstoupper(sds s
) {
306 int len
= sdslen(s
), j
;
308 for (j
= 0; j
< len
; j
++) s
[j
] = toupper(s
[j
]);
311 int sdscmp(sds s1
, sds s2
) {
312 size_t l1
, l2
, minlen
;
317 minlen
= (l1
< l2
) ? l1
: l2
;
318 cmp
= memcmp(s1
,s2
,minlen
);
319 if (cmp
== 0) return l1
-l2
;
323 /* Split 's' with separator in 'sep'. An array
324 * of sds strings is returned. *count will be set
325 * by reference to the number of tokens returned.
327 * On out of memory, zero length string, zero length
328 * separator, NULL is returned.
330 * Note that 'sep' is able to split a string using
331 * a multi-character separator. For example
332 * sdssplit("foo_-_bar","_-_"); will return two
333 * elements "foo" and "bar".
335 * This version of the function is binary-safe but
336 * requires length arguments. sdssplit() is just the
337 * same function but for zero-terminated strings.
339 sds
*sdssplitlen(char *s
, int len
, char *sep
, int seplen
, int *count
) {
340 int elements
= 0, slots
= 5, start
= 0, j
;
343 if (seplen
< 1 || len
< 0) return NULL
;
345 tokens
= zmalloc(sizeof(sds
)*slots
);
346 if (tokens
== NULL
) return NULL
;
352 for (j
= 0; j
< (len
-(seplen
-1)); j
++) {
353 /* make sure there is room for the next element and the final one */
354 if (slots
< elements
+2) {
358 newtokens
= zrealloc(tokens
,sizeof(sds
)*slots
);
359 if (newtokens
== NULL
) goto cleanup
;
362 /* search the separator */
363 if ((seplen
== 1 && *(s
+j
) == sep
[0]) || (memcmp(s
+j
,sep
,seplen
) == 0)) {
364 tokens
[elements
] = sdsnewlen(s
+start
,j
-start
);
365 if (tokens
[elements
] == NULL
) goto cleanup
;
368 j
= j
+seplen
-1; /* skip the separator */
371 /* Add the final element. We are sure there is room in the tokens array. */
372 tokens
[elements
] = sdsnewlen(s
+start
,len
-start
);
373 if (tokens
[elements
] == NULL
) goto cleanup
;
381 for (i
= 0; i
< elements
; i
++) sdsfree(tokens
[i
]);
388 void sdsfreesplitres(sds
*tokens
, int count
) {
391 sdsfree(tokens
[count
]);
395 sds
sdsfromlonglong(long long value
) {
397 unsigned long long v
;
399 v
= (value
< 0) ? -value
: value
;
400 p
= buf
+31; /* point to the last character */
405 if (value
< 0) *p
-- = '-';
407 return sdsnewlen(p
,32-(p
-buf
));
410 sds
sdscatrepr(sds s
, char *p
, size_t len
) {
411 s
= sdscatlen(s
,"\"",1);
416 s
= sdscatprintf(s
,"\\%c",*p
);
418 case '\n': s
= sdscatlen(s
,"\\n",2); break;
419 case '\r': s
= sdscatlen(s
,"\\r",2); break;
420 case '\t': s
= sdscatlen(s
,"\\t",2); break;
421 case '\a': s
= sdscatlen(s
,"\\a",2); break;
422 case '\b': s
= sdscatlen(s
,"\\b",2); break;
425 s
= sdscatprintf(s
,"%c",*p
);
427 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
432 return sdscatlen(s
,"\"",1);
435 /* Helper function for sdssplitargs() that returns non zero if 'c'
436 * is a valid hex digit. */
437 int is_hex_digit(char c
) {
438 return (c
>= '0' && c
<= '9') || (c
>= 'a' && c
<= 'f') ||
439 (c
>= 'A' && c
<= 'F');
442 /* Helper function for sdssplitargs() that converts an hex digit into an
443 * integer from 0 to 15 */
444 int hex_digit_to_int(char c
) {
456 case 'a': case 'A': return 10;
457 case 'b': case 'B': return 11;
458 case 'c': case 'C': return 12;
459 case 'd': case 'D': return 13;
460 case 'e': case 'E': return 14;
461 case 'f': case 'F': return 15;
466 /* Split a line into arguments, where every argument can be in the
467 * following programming-language REPL-alike form:
469 * foo bar "newline are supported\n" and "\xff\x00otherstuff"
471 * The number of arguments is stored into *argc, and an array
472 * of sds is returned. The caller should sdsfree() all the returned
473 * strings and finally zfree() the array itself.
475 * Note that sdscatrepr() is able to convert back a string into
476 * a quoted string in the same format sdssplitargs() is able to parse.
478 sds
*sdssplitargs(char *line
, int *argc
) {
480 char *current
= NULL
;
481 char **vector
= NULL
;
486 while(*p
&& isspace(*p
)) p
++;
489 int inq
=0; /* set to 1 if we are in "quotes" */
490 int insq
=0; /* set to 1 if we are in 'single quotes' */
493 if (current
== NULL
) current
= sdsempty();
496 if (*p
== '\\' && *(p
+1) == 'x' &&
497 is_hex_digit(*(p
+2)) &&
498 is_hex_digit(*(p
+3)))
502 byte
= (hex_digit_to_int(*(p
+2))*16)+
503 hex_digit_to_int(*(p
+3));
504 current
= sdscatlen(current
,(char*)&byte
,1);
506 } else if (*p
== '\\' && *(p
+1)) {
511 case 'n': c
= '\n'; break;
512 case 'r': c
= '\r'; break;
513 case 't': c
= '\t'; break;
514 case 'b': c
= '\b'; break;
515 case 'a': c
= '\a'; break;
516 default: c
= *p
; break;
518 current
= sdscatlen(current
,&c
,1);
519 } else if (*p
== '"') {
520 /* closing quote must be followed by a space or
522 if (*(p
+1) && !isspace(*(p
+1))) goto err
;
525 /* unterminated quotes */
528 current
= sdscatlen(current
,p
,1);
531 if (*p
== '\\' && *(p
+1) == '\'') {
533 current
= sdscatlen(current
,"'",1);
534 } else if (*p
== '\'') {
535 /* closing quote must be followed by a space or
537 if (*(p
+1) && !isspace(*(p
+1))) goto err
;
540 /* unterminated quotes */
543 current
= sdscatlen(current
,p
,1);
561 current
= sdscatlen(current
,p
,1);
567 /* add the token to the vector */
568 vector
= zrealloc(vector
,((*argc
)+1)*sizeof(char*));
569 vector
[*argc
] = current
;
579 sdsfree(vector
[*argc
]);
581 if (current
) sdsfree(current
);
585 void sdssplitargs_free(sds
*argv
, int argc
) {
588 for (j
= 0 ;j
< argc
; j
++) sdsfree(argv
[j
]);
592 /* Modify the string substituting all the occurrences of the set of
593 * characters specifed in the 'from' string to the corresponding character
596 * For instance: sdsmapchars(mystring, "ho", "01", 2)
597 * will have the effect of turning the string "hello" into "0ell1".
599 * The function returns the sds string pointer, that is always the same
600 * as the input pointer since no resize is needed. */
601 sds
sdsmapchars(sds s
, char *from
, char *to
, size_t setlen
) {
602 size_t j
, i
, l
= sdslen(s
);
604 for (j
= 0; j
< l
; j
++) {
605 for (i
= 0; i
< setlen
; i
++) {
606 if (s
[j
] == from
[i
]) {
617 #include "testhelp.h"
622 sds x
= sdsnew("foo"), y
;
624 test_cond("Create a string and obtain the length",
625 sdslen(x
) == 3 && memcmp(x
,"foo\0",4) == 0)
628 x
= sdsnewlen("foo",2);
629 test_cond("Create a string with specified length",
630 sdslen(x
) == 2 && memcmp(x
,"fo\0",3) == 0)
633 test_cond("Strings concatenation",
634 sdslen(x
) == 5 && memcmp(x
,"fobar\0",6) == 0);
637 test_cond("sdscpy() against an originally longer string",
638 sdslen(x
) == 1 && memcmp(x
,"a\0",2) == 0)
640 x
= sdscpy(x
,"xyzxxxxxxxxxxyyyyyyyyyykkkkkkkkkk");
641 test_cond("sdscpy() against an originally shorter string",
643 memcmp(x
,"xyzxxxxxxxxxxyyyyyyyyyykkkkkkkkkk\0",33) == 0)
646 x
= sdscatprintf(sdsempty(),"%d",123);
647 test_cond("sdscatprintf() seems working in the base case",
648 sdslen(x
) == 3 && memcmp(x
,"123\0",4) ==0)
651 x
= sdstrim(sdsnew("xxciaoyyy"),"xy");
652 test_cond("sdstrim() correctly trims characters",
653 sdslen(x
) == 4 && memcmp(x
,"ciao\0",5) == 0)
655 y
= sdsrange(sdsdup(x
),1,1);
656 test_cond("sdsrange(...,1,1)",
657 sdslen(y
) == 1 && memcmp(y
,"i\0",2) == 0)
660 y
= sdsrange(sdsdup(x
),1,-1);
661 test_cond("sdsrange(...,1,-1)",
662 sdslen(y
) == 3 && memcmp(y
,"iao\0",4) == 0)
665 y
= sdsrange(sdsdup(x
),-2,-1);
666 test_cond("sdsrange(...,-2,-1)",
667 sdslen(y
) == 2 && memcmp(y
,"ao\0",3) == 0)
670 y
= sdsrange(sdsdup(x
),2,1);
671 test_cond("sdsrange(...,2,1)",
672 sdslen(y
) == 0 && memcmp(y
,"\0",1) == 0)
675 y
= sdsrange(sdsdup(x
),1,100);
676 test_cond("sdsrange(...,1,100)",
677 sdslen(y
) == 3 && memcmp(y
,"iao\0",4) == 0)
680 y
= sdsrange(sdsdup(x
),100,100);
681 test_cond("sdsrange(...,100,100)",
682 sdslen(y
) == 0 && memcmp(y
,"\0",1) == 0)
688 test_cond("sdscmp(foo,foa)", sdscmp(x
,y
) > 0)
694 test_cond("sdscmp(bar,bar)", sdscmp(x
,y
) == 0)
700 test_cond("sdscmp(bar,bar)", sdscmp(x
,y
) < 0)
707 sh
= (void*) (x
-(sizeof(struct sdshdr
)));
708 test_cond("sdsnew() free/len buffers", sh
->len
== 1 && sh
->free
== 0);
709 x
= sdsMakeRoomFor(x
,1);
710 sh
= (void*) (x
-(sizeof(struct sdshdr
)));
711 test_cond("sdsMakeRoomFor()", sh
->len
== 1 && sh
->free
> 0);
715 test_cond("sdsIncrLen() -- content", x
[0] == '0' && x
[1] == '1');
716 test_cond("sdsIncrLen() -- len", sh
->len
== 2);
717 test_cond("sdsIncrLen() -- free", sh
->free
== oldfree
-1);