]>
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.
32 * - 22 March 2011: History section created on top of sds.c
33 * - 22 March 2011: Fixed a problem with "\xab" escapes convertion in
34 * function sdssplitargs().
37 #define SDS_ABORT_ON_OOM
47 static void sdsOomAbort(void) {
48 fprintf(stderr
,"SDS: Out Of Memory (SDS_ABORT_ON_OOM defined)\n");
52 sds
sdsnewlen(const void *init
, size_t initlen
) {
56 sh
= zmalloc(sizeof(struct sdshdr
)+initlen
+1);
58 sh
= zcalloc(sizeof(struct sdshdr
)+initlen
+1);
60 #ifdef SDS_ABORT_ON_OOM
61 if (sh
== NULL
) sdsOomAbort();
63 if (sh
== NULL
) return NULL
;
68 memcpy(sh
->buf
, init
, initlen
);
69 sh
->buf
[initlen
] = '\0';
70 return (char*)sh
->buf
;
74 return sdsnewlen("",0);
77 sds
sdsnew(const char *init
) {
78 size_t initlen
= (init
== NULL
) ? 0 : strlen(init
);
79 return sdsnewlen(init
, initlen
);
82 sds
sdsdup(const sds s
) {
83 return sdsnewlen(s
, sdslen(s
));
87 if (s
== NULL
) return;
88 zfree(s
-sizeof(struct sdshdr
));
91 void sdsupdatelen(sds s
) {
92 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
93 int reallen
= strlen(s
);
94 sh
->free
+= (sh
->len
-reallen
);
98 void sdsclear(sds s
) {
99 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
105 /* Enlarge the free space at the end of the sds string so that the caller
106 * is sure that after calling this function can overwrite up to addlen
107 * bytes after the end of the string, plus one more byte for nul term.
109 * Note: this does not change the *size* of the sds string as returned
110 * by sdslen(), but only the free buffer space we have. */
111 sds
sdsMakeRoomFor(sds s
, size_t addlen
) {
112 struct sdshdr
*sh
, *newsh
;
113 size_t free
= sdsavail(s
);
116 if (free
>= addlen
) return s
;
118 sh
= (void*) (s
-(sizeof(struct sdshdr
)));
119 newlen
= (len
+addlen
)*2;
120 newsh
= zrealloc(sh
, sizeof(struct sdshdr
)+newlen
+1);
121 #ifdef SDS_ABORT_ON_OOM
122 if (newsh
== NULL
) sdsOomAbort();
124 if (newsh
== NULL
) return NULL
;
127 newsh
->free
= newlen
- len
;
131 /* Increment the sds length and decrements the left free space at the
132 * end of the string accordingly to 'incr'. Also set the null term
133 * in the new end of the string.
135 * This function is used in order to fix the string length after the
136 * user calls sdsMakeRoomFor(), writes something after the end of
137 * the current string, and finally needs to set the new length.
139 * Note: it is possible to use a negative increment in order to
140 * right-trim the string.
142 * Using sdsIncrLen() and sdsMakeRoomFor() it is possible to mount the
143 * following schema to cat bytes coming from the kerenl to the end of an
144 * sds string new things without copying into an intermediate buffer:
146 * oldlen = sdslen(s);
147 * s = sdsMakeRoomFor(s, BUFFER_SIZE);
148 * nread = read(fd, s+oldlen, BUFFER_SIZE);
149 * ... check for nread <= 0 and handle it ...
150 * sdsIncrLen(s, nhread);
152 void sdsIncrLen(sds s
, int incr
) {
153 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
155 assert(sh
->free
>= incr
);
158 assert(sh
->free
>= 0);
162 /* Grow the sds to have the specified length. Bytes that were not part of
163 * the original length of the sds will be set to zero. */
164 sds
sdsgrowzero(sds s
, size_t len
) {
165 struct sdshdr
*sh
= (void*)(s
-(sizeof(struct sdshdr
)));
166 size_t totlen
, curlen
= sh
->len
;
168 if (len
<= curlen
) return s
;
169 s
= sdsMakeRoomFor(s
,len
-curlen
);
170 if (s
== NULL
) return NULL
;
172 /* Make sure added region doesn't contain garbage */
173 sh
= (void*)(s
-(sizeof(struct sdshdr
)));
174 memset(s
+curlen
,0,(len
-curlen
+1)); /* also set trailing \0 byte */
175 totlen
= sh
->len
+sh
->free
;
177 sh
->free
= totlen
-sh
->len
;
181 sds
sdscatlen(sds s
, void *t
, size_t len
) {
183 size_t curlen
= sdslen(s
);
185 s
= sdsMakeRoomFor(s
,len
);
186 if (s
== NULL
) return NULL
;
187 sh
= (void*) (s
-(sizeof(struct sdshdr
)));
188 memcpy(s
+curlen
, t
, len
);
189 sh
->len
= curlen
+len
;
190 sh
->free
= sh
->free
-len
;
191 s
[curlen
+len
] = '\0';
195 sds
sdscat(sds s
, char *t
) {
196 return sdscatlen(s
, t
, strlen(t
));
199 sds
sdscatsds(sds s
, sds t
) {
200 return sdscatlen(s
, t
, sdslen(t
));
203 sds
sdscpylen(sds s
, char *t
, size_t len
) {
204 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
205 size_t totlen
= sh
->free
+sh
->len
;
208 s
= sdsMakeRoomFor(s
,len
-sh
->len
);
209 if (s
== NULL
) return NULL
;
210 sh
= (void*) (s
-(sizeof(struct sdshdr
)));
211 totlen
= sh
->free
+sh
->len
;
216 sh
->free
= totlen
-len
;
220 sds
sdscpy(sds s
, char *t
) {
221 return sdscpylen(s
, t
, strlen(t
));
224 sds
sdscatvprintf(sds s
, const char *fmt
, va_list ap
) {
230 buf
= zmalloc(buflen
);
231 #ifdef SDS_ABORT_ON_OOM
232 if (buf
== NULL
) sdsOomAbort();
234 if (buf
== NULL
) return NULL
;
236 buf
[buflen
-2] = '\0';
238 vsnprintf(buf
, buflen
, fmt
, cpy
);
239 if (buf
[buflen
-2] != '\0') {
251 sds
sdscatprintf(sds s
, const char *fmt
, ...) {
255 t
= sdscatvprintf(s
,fmt
,ap
);
260 sds
sdstrim(sds s
, const char *cset
) {
261 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
262 char *start
, *end
, *sp
, *ep
;
266 ep
= end
= s
+sdslen(s
)-1;
267 while(sp
<= end
&& strchr(cset
, *sp
)) sp
++;
268 while(ep
> start
&& strchr(cset
, *ep
)) ep
--;
269 len
= (sp
> ep
) ? 0 : ((ep
-sp
)+1);
270 if (sh
->buf
!= sp
) memmove(sh
->buf
, sp
, len
);
272 sh
->free
= sh
->free
+(sh
->len
-len
);
277 sds
sdsrange(sds s
, int start
, int end
) {
278 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
279 size_t newlen
, len
= sdslen(s
);
281 if (len
== 0) return s
;
284 if (start
< 0) start
= 0;
288 if (end
< 0) end
= 0;
290 newlen
= (start
> end
) ? 0 : (end
-start
)+1;
292 if (start
>= (signed)len
) {
294 } else if (end
>= (signed)len
) {
296 newlen
= (start
> end
) ? 0 : (end
-start
)+1;
301 if (start
&& newlen
) memmove(sh
->buf
, sh
->buf
+start
, newlen
);
303 sh
->free
= sh
->free
+(sh
->len
-newlen
);
308 void sdstolower(sds s
) {
309 int len
= sdslen(s
), j
;
311 for (j
= 0; j
< len
; j
++) s
[j
] = tolower(s
[j
]);
314 void sdstoupper(sds s
) {
315 int len
= sdslen(s
), j
;
317 for (j
= 0; j
< len
; j
++) s
[j
] = toupper(s
[j
]);
320 int sdscmp(sds s1
, sds s2
) {
321 size_t l1
, l2
, minlen
;
326 minlen
= (l1
< l2
) ? l1
: l2
;
327 cmp
= memcmp(s1
,s2
,minlen
);
328 if (cmp
== 0) return l1
-l2
;
332 /* Split 's' with separator in 'sep'. An array
333 * of sds strings is returned. *count will be set
334 * by reference to the number of tokens returned.
336 * On out of memory, zero length string, zero length
337 * separator, NULL is returned.
339 * Note that 'sep' is able to split a string using
340 * a multi-character separator. For example
341 * sdssplit("foo_-_bar","_-_"); will return two
342 * elements "foo" and "bar".
344 * This version of the function is binary-safe but
345 * requires length arguments. sdssplit() is just the
346 * same function but for zero-terminated strings.
348 sds
*sdssplitlen(char *s
, int len
, char *sep
, int seplen
, int *count
) {
349 int elements
= 0, slots
= 5, start
= 0, j
;
352 if (seplen
< 1 || len
< 0) return NULL
;
354 tokens
= zmalloc(sizeof(sds
)*slots
);
355 #ifdef SDS_ABORT_ON_OOM
356 if (tokens
== NULL
) sdsOomAbort();
358 if (tokens
== NULL
) return NULL
;
365 for (j
= 0; j
< (len
-(seplen
-1)); j
++) {
366 /* make sure there is room for the next element and the final one */
367 if (slots
< elements
+2) {
371 newtokens
= zrealloc(tokens
,sizeof(sds
)*slots
);
372 if (newtokens
== NULL
) {
373 #ifdef SDS_ABORT_ON_OOM
381 /* search the separator */
382 if ((seplen
== 1 && *(s
+j
) == sep
[0]) || (memcmp(s
+j
,sep
,seplen
) == 0)) {
383 tokens
[elements
] = sdsnewlen(s
+start
,j
-start
);
384 if (tokens
[elements
] == NULL
) {
385 #ifdef SDS_ABORT_ON_OOM
393 j
= j
+seplen
-1; /* skip the separator */
396 /* Add the final element. We are sure there is room in the tokens array. */
397 tokens
[elements
] = sdsnewlen(s
+start
,len
-start
);
398 if (tokens
[elements
] == NULL
) {
399 #ifdef SDS_ABORT_ON_OOM
409 #ifndef SDS_ABORT_ON_OOM
413 for (i
= 0; i
< elements
; i
++) sdsfree(tokens
[i
]);
421 void sdsfreesplitres(sds
*tokens
, int count
) {
424 sdsfree(tokens
[count
]);
428 sds
sdsfromlonglong(long long value
) {
430 unsigned long long v
;
432 v
= (value
< 0) ? -value
: value
;
433 p
= buf
+31; /* point to the last character */
438 if (value
< 0) *p
-- = '-';
440 return sdsnewlen(p
,32-(p
-buf
));
443 sds
sdscatrepr(sds s
, char *p
, size_t len
) {
444 s
= sdscatlen(s
,"\"",1);
449 s
= sdscatprintf(s
,"\\%c",*p
);
451 case '\n': s
= sdscatlen(s
,"\\n",2); break;
452 case '\r': s
= sdscatlen(s
,"\\r",2); break;
453 case '\t': s
= sdscatlen(s
,"\\t",2); break;
454 case '\a': s
= sdscatlen(s
,"\\a",2); break;
455 case '\b': s
= sdscatlen(s
,"\\b",2); break;
458 s
= sdscatprintf(s
,"%c",*p
);
460 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
465 return sdscatlen(s
,"\"",1);
468 /* Helper function for sdssplitargs() that returns non zero if 'c'
469 * is a valid hex digit. */
470 int is_hex_digit(char c
) {
471 return (c
>= '0' && c
<= '9') || (c
>= 'a' && c
<= 'f') ||
472 (c
>= 'A' && c
<= 'F');
475 /* Helper function for sdssplitargs() that converts an hex digit into an
476 * integer from 0 to 15 */
477 int hex_digit_to_int(char c
) {
489 case 'a': case 'A': return 10;
490 case 'b': case 'B': return 11;
491 case 'c': case 'C': return 12;
492 case 'd': case 'D': return 13;
493 case 'e': case 'E': return 14;
494 case 'f': case 'F': return 15;
499 /* Split a line into arguments, where every argument can be in the
500 * following programming-language REPL-alike form:
502 * foo bar "newline are supported\n" and "\xff\x00otherstuff"
504 * The number of arguments is stored into *argc, and an array
505 * of sds is returned. The caller should sdsfree() all the returned
506 * strings and finally zfree() the array itself.
508 * Note that sdscatrepr() is able to convert back a string into
509 * a quoted string in the same format sdssplitargs() is able to parse.
511 sds
*sdssplitargs(char *line
, int *argc
) {
513 char *current
= NULL
;
514 char **vector
= NULL
;
519 while(*p
&& isspace(*p
)) p
++;
522 int inq
=0; /* set to 1 if we are in "quotes" */
523 int insq
=0; /* set to 1 if we are in 'single quotes' */
526 if (current
== NULL
) current
= sdsempty();
529 if (*p
== '\\' && *(p
+1) == 'x' &&
530 is_hex_digit(*(p
+2)) &&
531 is_hex_digit(*(p
+3)))
535 byte
= (hex_digit_to_int(*(p
+2))*16)+
536 hex_digit_to_int(*(p
+3));
537 current
= sdscatlen(current
,(char*)&byte
,1);
539 } else if (*p
== '\\' && *(p
+1)) {
544 case 'n': c
= '\n'; break;
545 case 'r': c
= '\r'; break;
546 case 't': c
= '\t'; break;
547 case 'b': c
= '\b'; break;
548 case 'a': c
= '\a'; break;
549 default: c
= *p
; break;
551 current
= sdscatlen(current
,&c
,1);
552 } else if (*p
== '"') {
553 /* closing quote must be followed by a space or
555 if (*(p
+1) && !isspace(*(p
+1))) goto err
;
558 /* unterminated quotes */
561 current
= sdscatlen(current
,p
,1);
564 if (*p
== '\\' && *(p
+1) == '\'') {
566 current
= sdscatlen(current
,"'",1);
567 } else if (*p
== '\'') {
568 /* closing quote must be followed by a space or
570 if (*(p
+1) && !isspace(*(p
+1))) goto err
;
573 /* unterminated quotes */
576 current
= sdscatlen(current
,p
,1);
594 current
= sdscatlen(current
,p
,1);
600 /* add the token to the vector */
601 vector
= zrealloc(vector
,((*argc
)+1)*sizeof(char*));
602 vector
[*argc
] = current
;
612 sdsfree(vector
[*argc
]);
614 if (current
) sdsfree(current
);
618 void sdssplitargs_free(sds
*argv
, int argc
) {
621 for (j
= 0 ;j
< argc
; j
++) sdsfree(argv
[j
]);
625 /* Modify the string substituting all the occurrences of the set of
626 * characters specifed in the 'from' string to the corresponding character
629 * For instance: sdsmapchars(mystring, "ho", "01", 2)
630 * will have the effect of turning the string "hello" into "0ell1".
632 * The function returns the sds string pointer, that is always the same
633 * as the input pointer since no resize is needed. */
634 sds
sdsmapchars(sds s
, char *from
, char *to
, size_t setlen
) {
635 size_t j
, i
, l
= sdslen(s
);
637 for (j
= 0; j
< l
; j
++) {
638 for (i
= 0; i
< setlen
; i
++) {
639 if (s
[j
] == from
[i
]) {
650 #include "testhelp.h"
655 sds x
= sdsnew("foo"), y
;
657 test_cond("Create a string and obtain the length",
658 sdslen(x
) == 3 && memcmp(x
,"foo\0",4) == 0)
661 x
= sdsnewlen("foo",2);
662 test_cond("Create a string with specified length",
663 sdslen(x
) == 2 && memcmp(x
,"fo\0",3) == 0)
666 test_cond("Strings concatenation",
667 sdslen(x
) == 5 && memcmp(x
,"fobar\0",6) == 0);
670 test_cond("sdscpy() against an originally longer string",
671 sdslen(x
) == 1 && memcmp(x
,"a\0",2) == 0)
673 x
= sdscpy(x
,"xyzxxxxxxxxxxyyyyyyyyyykkkkkkkkkk");
674 test_cond("sdscpy() against an originally shorter string",
676 memcmp(x
,"xyzxxxxxxxxxxyyyyyyyyyykkkkkkkkkk\0",33) == 0)
679 x
= sdscatprintf(sdsempty(),"%d",123);
680 test_cond("sdscatprintf() seems working in the base case",
681 sdslen(x
) == 3 && memcmp(x
,"123\0",4) ==0)
684 x
= sdstrim(sdsnew("xxciaoyyy"),"xy");
685 test_cond("sdstrim() correctly trims characters",
686 sdslen(x
) == 4 && memcmp(x
,"ciao\0",5) == 0)
688 y
= sdsrange(sdsdup(x
),1,1);
689 test_cond("sdsrange(...,1,1)",
690 sdslen(y
) == 1 && memcmp(y
,"i\0",2) == 0)
693 y
= sdsrange(sdsdup(x
),1,-1);
694 test_cond("sdsrange(...,1,-1)",
695 sdslen(y
) == 3 && memcmp(y
,"iao\0",4) == 0)
698 y
= sdsrange(sdsdup(x
),-2,-1);
699 test_cond("sdsrange(...,-2,-1)",
700 sdslen(y
) == 2 && memcmp(y
,"ao\0",3) == 0)
703 y
= sdsrange(sdsdup(x
),2,1);
704 test_cond("sdsrange(...,2,1)",
705 sdslen(y
) == 0 && memcmp(y
,"\0",1) == 0)
708 y
= sdsrange(sdsdup(x
),1,100);
709 test_cond("sdsrange(...,1,100)",
710 sdslen(y
) == 3 && memcmp(y
,"iao\0",4) == 0)
713 y
= sdsrange(sdsdup(x
),100,100);
714 test_cond("sdsrange(...,100,100)",
715 sdslen(y
) == 0 && memcmp(y
,"\0",1) == 0)
721 test_cond("sdscmp(foo,foa)", sdscmp(x
,y
) > 0)
727 test_cond("sdscmp(bar,bar)", sdscmp(x
,y
) == 0)
733 test_cond("sdscmp(bar,bar)", sdscmp(x
,y
) < 0)
740 sh
= (void*) (x
-(sizeof(struct sdshdr
)));
741 test_cond("sdsnew() free/len buffers", sh
->len
== 1 && sh
->free
== 0);
742 x
= sdsMakeRoomFor(x
,1);
743 sh
= (void*) (x
-(sizeof(struct sdshdr
)));
744 test_cond("sdsMakeRoomFor()", sh
->len
== 1 && sh
->free
> 0);
748 test_cond("sdsIncrLen() -- content", x
[0] == '0' && x
[1] == '1');
749 test_cond("sdsIncrLen() -- len", sh
->len
== 2);
750 test_cond("sdsIncrLen() -- free", sh
->free
== oldfree
-1);