hiredis.c 35.9 KB
Newer Older
1
/*
2 3
 * Copyright (c) 2009-2011, Salvatore Sanfilippo <antirez at gmail dot com>
 * Copyright (c) 2010-2011, Pieter Noordhuis <pcnoordhuis at gmail dot com>
P
Pieter Noordhuis 已提交
4
 *
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 * 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.
 */

32
#include "fmacros.h"
33 34 35 36 37
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <assert.h>
#include <errno.h>
P
Pieter Noordhuis 已提交
38
#include <ctype.h>
39 40 41 42 43 44 45 46 47 48 49

#include "hiredis.h"
#include "net.h"
#include "sds.h"

static redisReply *createReplyObject(int type);
static void *createStringObject(const redisReadTask *task, char *str, size_t len);
static void *createArrayObject(const redisReadTask *task, int elements);
static void *createIntegerObject(const redisReadTask *task, long long value);
static void *createNilObject(const redisReadTask *task);

50 51
/* Default set of functions to build the reply. Keep in mind that such a
 * function returning NULL is interpreted as OOM. */
52 53 54 55 56 57 58 59 60 61
static redisReplyObjectFunctions defaultFunctions = {
    createStringObject,
    createArrayObject,
    createIntegerObject,
    createNilObject,
    freeReplyObject
};

/* Create a reply object */
static redisReply *createReplyObject(int type) {
62 63 64 65
    redisReply *r = calloc(1,sizeof(*r));

    if (r == NULL)
        return NULL;
66 67 68 69 70 71 72 73 74 75 76 77 78 79

    r->type = type;
    return r;
}

/* Free a reply object */
void freeReplyObject(void *reply) {
    redisReply *r = reply;
    size_t j;

    switch(r->type) {
    case REDIS_REPLY_INTEGER:
        break; /* Nothing to free */
    case REDIS_REPLY_ARRAY:
80 81 82 83 84 85
        if (r->element != NULL) {
            for (j = 0; j < r->elements; j++)
                if (r->element[j] != NULL)
                    freeReplyObject(r->element[j]);
            free(r->element);
        }
86
        break;
P
Pieter Noordhuis 已提交
87 88 89
    case REDIS_REPLY_ERROR:
    case REDIS_REPLY_STATUS:
    case REDIS_REPLY_STRING:
90 91
        if (r->str != NULL)
            free(r->str);
92 93 94 95 96 97
        break;
    }
    free(r);
}

static void *createStringObject(const redisReadTask *task, char *str, size_t len) {
98 99 100 101 102 103 104 105 106 107 108 109 110 111
    redisReply *r, *parent;
    char *buf;

    r = createReplyObject(task->type);
    if (r == NULL)
        return NULL;

    buf = malloc(len+1);
    if (buf == NULL) {
        freeReplyObject(r);
        return NULL;
    }

    assert(task->type == REDIS_REPLY_ERROR  ||
112 113 114 115
           task->type == REDIS_REPLY_STATUS ||
           task->type == REDIS_REPLY_STRING);

    /* Copy string value */
116 117 118
    memcpy(buf,str,len);
    buf[len] = '\0';
    r->str = buf;
119 120 121
    r->len = len;

    if (task->parent) {
122
        parent = task->parent->obj;
123 124 125 126 127 128 129
        assert(parent->type == REDIS_REPLY_ARRAY);
        parent->element[task->idx] = r;
    }
    return r;
}

static void *createArrayObject(const redisReadTask *task, int elements) {
130 131 132 133 134 135 136 137 138 139 140 141 142 143
    redisReply *r, *parent;

    r = createReplyObject(REDIS_REPLY_ARRAY);
    if (r == NULL)
        return NULL;

    if (elements > 0) {
        r->element = calloc(elements,sizeof(redisReply*));
        if (r->element == NULL) {
            freeReplyObject(r);
            return NULL;
        }
    }

144
    r->elements = elements;
145

146
    if (task->parent) {
147
        parent = task->parent->obj;
148 149 150 151 152 153 154
        assert(parent->type == REDIS_REPLY_ARRAY);
        parent->element[task->idx] = r;
    }
    return r;
}

static void *createIntegerObject(const redisReadTask *task, long long value) {
155 156 157 158 159 160
    redisReply *r, *parent;

    r = createReplyObject(REDIS_REPLY_INTEGER);
    if (r == NULL)
        return NULL;

161
    r->integer = value;
162

163
    if (task->parent) {
164
        parent = task->parent->obj;
165 166 167 168 169 170 171
        assert(parent->type == REDIS_REPLY_ARRAY);
        parent->element[task->idx] = r;
    }
    return r;
}

static void *createNilObject(const redisReadTask *task) {
172 173 174 175 176 177
    redisReply *r, *parent;

    r = createReplyObject(REDIS_REPLY_NIL);
    if (r == NULL)
        return NULL;

178
    if (task->parent) {
179
        parent = task->parent->obj;
180 181 182 183 184 185
        assert(parent->type == REDIS_REPLY_ARRAY);
        parent->element[task->idx] = r;
    }
    return r;
}

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
static void __redisReaderSetError(redisReader *r, int type, const char *str) {
    size_t len;

    if (r->reply != NULL && r->fn && r->fn->freeObject) {
        r->fn->freeObject(r->reply);
        r->reply = NULL;
    }

    /* Clear input buffer on errors. */
    if (r->buf != NULL) {
        sdsfree(r->buf);
        r->buf = NULL;
        r->pos = r->len = 0;
    }

    /* Reset task stack. */
    r->ridx = -1;

    /* Set error. */
    r->err = type;
    len = strlen(str);
    len = len < (sizeof(r->errstr)-1) ? len : (sizeof(r->errstr)-1);
    memcpy(r->errstr,str,len);
    r->errstr[len] = '\0';
}

static size_t chrtos(char *buf, size_t size, char byte) {
    size_t len = 0;

    switch(byte) {
    case '\\':
    case '"':
        len = snprintf(buf,size,"\"\\%c\"",byte);
        break;
    case '\n': len = snprintf(buf,size,"\"\\n\""); break;
    case '\r': len = snprintf(buf,size,"\"\\r\""); break;
    case '\t': len = snprintf(buf,size,"\"\\t\""); break;
    case '\a': len = snprintf(buf,size,"\"\\a\""); break;
    case '\b': len = snprintf(buf,size,"\"\\b\""); break;
    default:
        if (isprint(byte))
            len = snprintf(buf,size,"\"%c\"",byte);
        else
            len = snprintf(buf,size,"\"\\x%02x\"",(unsigned char)byte);
        break;
    }

    return len;
}

static void __redisReaderSetErrorProtocolByte(redisReader *r, char byte) {
    char cbuf[8], sbuf[128];

    chrtos(cbuf,sizeof(cbuf),byte);
    snprintf(sbuf,sizeof(sbuf),
        "Protocol error, got %s as reply type byte", cbuf);
    __redisReaderSetError(r,REDIS_ERR_PROTOCOL,sbuf);
}

static void __redisReaderSetErrorOOM(redisReader *r) {
    __redisReaderSetError(r,REDIS_ERR_OOM,"Out of memory");
}

249 250
static char *readBytes(redisReader *r, unsigned int bytes) {
    char *p;
P
Pieter Noordhuis 已提交
251
    if (r->len-r->pos >= bytes) {
252 253 254 255 256 257 258
        p = r->buf+r->pos;
        r->pos += bytes;
        return p;
    }
    return NULL;
}

P
Pieter Noordhuis 已提交
259 260 261 262 263 264 265 266 267 268 269 270 271 272
/* Find pointer to \r\n. */
static char *seekNewline(char *s, size_t len) {
    int pos = 0;
    int _len = len-1;

    /* Position should be < len-1 because the character at "pos" should be
     * followed by a \n. Note that strchr cannot be used because it doesn't
     * allow to search a limited length and the buffer that is being searched
     * might not have a trailing NULL character. */
    while (pos < _len) {
        while(pos < _len && s[pos] != '\r') pos++;
        if (s[pos] != '\r') {
            /* Not found. */
            return NULL;
P
Pieter Noordhuis 已提交
273
        } else {
P
Pieter Noordhuis 已提交
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
            if (s[pos+1] == '\n') {
                /* Found. */
                return s+pos;
            } else {
                /* Continue searching. */
                pos++;
            }
        }
    }
    return NULL;
}

/* Read a long long value starting at *s, under the assumption that it will be
 * terminated by \r\n. Ambiguously returns -1 for unexpected input. */
static long long readLongLong(char *s) {
    long long v = 0;
    int dec, mult = 1;
    char c;

    if (*s == '-') {
        mult = -1;
        s++;
    } else if (*s == '+') {
        mult = 1;
        s++;
    }

    while ((c = *(s++)) != '\r') {
        dec = c - '0';
        if (dec >= 0 && dec < 10) {
            v *= 10;
            v += dec;
        } else {
            /* Should not happen... */
            return -1;
P
Pieter Noordhuis 已提交
309 310
        }
    }
P
Pieter Noordhuis 已提交
311 312

    return mult*v;
P
Pieter Noordhuis 已提交
313 314
}

315
static char *readLine(redisReader *r, int *_len) {
P
Pieter Noordhuis 已提交
316
    char *p, *s;
317
    int len;
P
Pieter Noordhuis 已提交
318 319

    p = r->buf+r->pos;
P
Pieter Noordhuis 已提交
320
    s = seekNewline(p,(r->len-r->pos));
321 322 323 324 325 326 327 328 329 330 331
    if (s != NULL) {
        len = s-(r->buf+r->pos);
        r->pos += len+2; /* skip \r\n */
        if (_len) *_len = len;
        return p;
    }
    return NULL;
}

static void moveToNextTask(redisReader *r) {
    redisReadTask *cur, *prv;
P
Pieter Noordhuis 已提交
332 333 334 335 336 337
    while (r->ridx >= 0) {
        /* Return a.s.a.p. when the stack is now empty. */
        if (r->ridx == 0) {
            r->ridx--;
            return;
        }
338

P
Pieter Noordhuis 已提交
339 340 341 342 343 344 345 346 347 348 349 350 351
        cur = &(r->rstack[r->ridx]);
        prv = &(r->rstack[r->ridx-1]);
        assert(prv->type == REDIS_REPLY_ARRAY);
        if (cur->idx == prv->elements-1) {
            r->ridx--;
        } else {
            /* Reset the type because the next item can be anything */
            assert(cur->idx < prv->elements);
            cur->type = -1;
            cur->elements = -1;
            cur->idx++;
            return;
        }
352 353 354 355 356 357 358 359 360 361
    }
}

static int processLineItem(redisReader *r) {
    redisReadTask *cur = &(r->rstack[r->ridx]);
    void *obj;
    char *p;
    int len;

    if ((p = readLine(r,&len)) != NULL) {
P
Pieter Noordhuis 已提交
362 363
        if (cur->type == REDIS_REPLY_INTEGER) {
            if (r->fn && r->fn->createInteger)
P
Pieter Noordhuis 已提交
364
                obj = r->fn->createInteger(cur,readLongLong(p));
P
Pieter Noordhuis 已提交
365 366
            else
                obj = (void*)REDIS_REPLY_INTEGER;
367
        } else {
P
Pieter Noordhuis 已提交
368 369 370 371 372
            /* Type will be error or status. */
            if (r->fn && r->fn->createString)
                obj = r->fn->createString(cur,p,len);
            else
                obj = (void*)(size_t)(cur->type);
373 374
        }

375 376 377 378 379
        if (obj == NULL) {
            __redisReaderSetErrorOOM(r);
            return REDIS_ERR;
        }

P
Pieter Noordhuis 已提交
380 381
        /* Set reply if this is the root object. */
        if (r->ridx == 0) r->reply = obj;
382
        moveToNextTask(r);
383
        return REDIS_OK;
384
    }
385 386

    return REDIS_ERR;
387 388 389 390 391 392 393 394
}

static int processBulkItem(redisReader *r) {
    redisReadTask *cur = &(r->rstack[r->ridx]);
    void *obj = NULL;
    char *p, *s;
    long len;
    unsigned long bytelen;
P
Pieter Noordhuis 已提交
395
    int success = 0;
396 397

    p = r->buf+r->pos;
P
Pieter Noordhuis 已提交
398
    s = seekNewline(p,r->len-r->pos);
399 400 401
    if (s != NULL) {
        p = r->buf+r->pos;
        bytelen = s-(r->buf+r->pos)+2; /* include \r\n */
P
Pieter Noordhuis 已提交
402
        len = readLongLong(p);
403 404 405

        if (len < 0) {
            /* The nil object can always be created. */
P
Pieter Noordhuis 已提交
406 407 408 409
            if (r->fn && r->fn->createNil)
                obj = r->fn->createNil(cur);
            else
                obj = (void*)REDIS_REPLY_NIL;
P
Pieter Noordhuis 已提交
410
            success = 1;
411 412 413
        } else {
            /* Only continue when the buffer contains the entire bulk item. */
            bytelen += len+2; /* include \r\n */
P
Pieter Noordhuis 已提交
414
            if (r->pos+bytelen <= r->len) {
P
Pieter Noordhuis 已提交
415 416 417 418
                if (r->fn && r->fn->createString)
                    obj = r->fn->createString(cur,s+2,len);
                else
                    obj = (void*)REDIS_REPLY_STRING;
P
Pieter Noordhuis 已提交
419
                success = 1;
420 421 422 423
            }
        }

        /* Proceed when obj was created. */
P
Pieter Noordhuis 已提交
424
        if (success) {
425 426 427 428 429
            if (obj == NULL) {
                __redisReaderSetErrorOOM(r);
                return REDIS_ERR;
            }

430
            r->pos += bytelen;
P
Pieter Noordhuis 已提交
431 432 433

            /* Set reply if this is the root object. */
            if (r->ridx == 0) r->reply = obj;
434
            moveToNextTask(r);
435
            return REDIS_OK;
436 437
        }
    }
438 439

    return REDIS_ERR;
440 441 442 443 444 445 446
}

static int processMultiBulkItem(redisReader *r) {
    redisReadTask *cur = &(r->rstack[r->ridx]);
    void *obj;
    char *p;
    long elements;
P
Pieter Noordhuis 已提交
447 448
    int root = 0;

A
antirez 已提交
449
    /* Set error for nested multi bulks with depth > 7 */
450
    if (r->ridx == 8) {
451
        __redisReaderSetError(r,REDIS_ERR_PROTOCOL,
452
            "No support for nested multi bulk replies with depth > 7");
453
        return REDIS_ERR;
P
Pieter Noordhuis 已提交
454
    }
455 456

    if ((p = readLine(r,NULL)) != NULL) {
P
Pieter Noordhuis 已提交
457 458 459
        elements = readLongLong(p);
        root = (r->ridx == 0);

460
        if (elements == -1) {
P
Pieter Noordhuis 已提交
461 462 463 464
            if (r->fn && r->fn->createNil)
                obj = r->fn->createNil(cur);
            else
                obj = (void*)REDIS_REPLY_NIL;
465 466 467 468 469 470

            if (obj == NULL) {
                __redisReaderSetErrorOOM(r);
                return REDIS_ERR;
            }

471 472
            moveToNextTask(r);
        } else {
P
Pieter Noordhuis 已提交
473 474 475 476
            if (r->fn && r->fn->createArray)
                obj = r->fn->createArray(cur,elements);
            else
                obj = (void*)REDIS_REPLY_ARRAY;
477

478 479 480 481 482
            if (obj == NULL) {
                __redisReaderSetErrorOOM(r);
                return REDIS_ERR;
            }

483 484 485
            /* Modify task stack when there are more than 0 elements. */
            if (elements > 0) {
                cur->elements = elements;
P
Pieter Noordhuis 已提交
486
                cur->obj = obj;
487 488 489 490
                r->ridx++;
                r->rstack[r->ridx].type = -1;
                r->rstack[r->ridx].elements = -1;
                r->rstack[r->ridx].idx = 0;
P
Pieter Noordhuis 已提交
491 492 493
                r->rstack[r->ridx].obj = NULL;
                r->rstack[r->ridx].parent = cur;
                r->rstack[r->ridx].privdata = r->privdata;
494 495 496 497 498
            } else {
                moveToNextTask(r);
            }
        }

P
Pieter Noordhuis 已提交
499 500
        /* Set reply if this is the root object. */
        if (root) r->reply = obj;
501
        return REDIS_OK;
502
    }
503 504

    return REDIS_ERR;
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
}

static int processItem(redisReader *r) {
    redisReadTask *cur = &(r->rstack[r->ridx]);
    char *p;

    /* check if we need to read type */
    if (cur->type < 0) {
        if ((p = readBytes(r,1)) != NULL) {
            switch (p[0]) {
            case '-':
                cur->type = REDIS_REPLY_ERROR;
                break;
            case '+':
                cur->type = REDIS_REPLY_STATUS;
                break;
            case ':':
                cur->type = REDIS_REPLY_INTEGER;
                break;
            case '$':
                cur->type = REDIS_REPLY_STRING;
                break;
            case '*':
                cur->type = REDIS_REPLY_ARRAY;
                break;
            default:
531 532
                __redisReaderSetErrorProtocolByte(r,*p);
                return REDIS_ERR;
533 534 535
            }
        } else {
            /* could not consume 1 byte */
536
            return REDIS_ERR;
537 538 539 540 541 542 543 544 545 546 547 548 549 550
        }
    }

    /* process typed item */
    switch(cur->type) {
    case REDIS_REPLY_ERROR:
    case REDIS_REPLY_STATUS:
    case REDIS_REPLY_INTEGER:
        return processLineItem(r);
    case REDIS_REPLY_STRING:
        return processBulkItem(r);
    case REDIS_REPLY_ARRAY:
        return processMultiBulkItem(r);
    default:
P
Pieter Noordhuis 已提交
551
        assert(NULL);
552
        return REDIS_ERR; /* Avoid warning. */
553 554 555
    }
}

556 557
redisReader *redisReaderCreate(void) {
    redisReader *r;
558

559 560 561
    r = calloc(sizeof(redisReader),1);
    if (r == NULL)
        return NULL;
P
Pieter Noordhuis 已提交
562

563 564 565 566
    r->err = 0;
    r->errstr[0] = '\0';
    r->fn = &defaultFunctions;
    r->buf = sdsempty();
A
antirez 已提交
567
    r->maxbuf = REDIS_READER_MAX_BUF;
568 569 570
    if (r->buf == NULL) {
        free(r);
        return NULL;
P
Pieter Noordhuis 已提交
571 572
    }

573 574
    r->ridx = -1;
    return r;
575 576
}

577 578
void redisReaderFree(redisReader *r) {
    if (r->reply != NULL && r->fn && r->fn->freeObject)
579 580 581 582 583 584
        r->fn->freeObject(r->reply);
    if (r->buf != NULL)
        sdsfree(r->buf);
    free(r);
}

585 586
int redisReaderFeed(redisReader *r, const char *buf, size_t len) {
    sds newbuf;
587

588 589 590
    /* Return early when this reader is in an erroneous state. */
    if (r->err)
        return REDIS_ERR;
591 592

    /* Copy the provided buffer. */
P
Pieter Noordhuis 已提交
593
    if (buf != NULL && len >= 1) {
P
Pieter Noordhuis 已提交
594
        /* Destroy internal buffer when it is empty and is quite large. */
A
antirez 已提交
595
        if (r->len == 0 && r->maxbuf != 0 && sdsavail(r->buf) > r->maxbuf) {
P
Pieter Noordhuis 已提交
596 597 598
            sdsfree(r->buf);
            r->buf = sdsempty();
            r->pos = 0;
599 600 601 602 603 604 605 606 607

            /* r->buf should not be NULL since we just free'd a larger one. */
            assert(r->buf != NULL);
        }

        newbuf = sdscatlen(r->buf,buf,len);
        if (newbuf == NULL) {
            __redisReaderSetErrorOOM(r);
            return REDIS_ERR;
P
Pieter Noordhuis 已提交
608
        }
609 610

        r->buf = newbuf;
P
Pieter Noordhuis 已提交
611 612
        r->len = sdslen(r->buf);
    }
613 614

    return REDIS_OK;
615 616
}

617 618 619 620 621 622 623 624
int redisReaderGetReply(redisReader *r, void **reply) {
    /* Default target pointer to NULL. */
    if (reply != NULL)
        *reply = NULL;

    /* Return early when this reader is in an erroneous state. */
    if (r->err)
        return REDIS_ERR;
625 626

    /* When the buffer is empty, there will never be a reply. */
P
Pieter Noordhuis 已提交
627
    if (r->len == 0)
628 629 630 631 632 633 634
        return REDIS_OK;

    /* Set first item to process when the stack is empty. */
    if (r->ridx == -1) {
        r->rstack[0].type = -1;
        r->rstack[0].elements = -1;
        r->rstack[0].idx = -1;
P
Pieter Noordhuis 已提交
635 636 637
        r->rstack[0].obj = NULL;
        r->rstack[0].parent = NULL;
        r->rstack[0].privdata = r->privdata;
638 639 640 641 642
        r->ridx = 0;
    }

    /* Process items in reply. */
    while (r->ridx >= 0)
643
        if (processItem(r) != REDIS_OK)
644 645
            break;

646 647 648 649
    /* Return ASAP when an error occurred. */
    if (r->err)
        return REDIS_ERR;

P
Pieter Noordhuis 已提交
650 651 652 653
    /* Discard part of the buffer when we've consumed at least 1k, to avoid
     * doing unnecessary calls to memmove() in sds.c. */
    if (r->pos >= 1024) {
        r->buf = sdsrange(r->buf,r->pos,-1);
654
        r->pos = 0;
P
Pieter Noordhuis 已提交
655
        r->len = sdslen(r->buf);
656 657 658 659
    }

    /* Emit a reply when there is one. */
    if (r->ridx == -1) {
660 661
        if (reply != NULL)
            *reply = r->reply;
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
        r->reply = NULL;
    }
    return REDIS_OK;
}

/* Calculate the number of bytes needed to represent an integer as string. */
static int intlen(int i) {
    int len = 0;
    if (i < 0) {
        len++;
        i = -i;
    }
    do {
        len++;
        i /= 10;
    } while(i);
    return len;
}

681 682 683
/* Helper that calculates the bulk length given a certain string length. */
static size_t bulklen(size_t len) {
    return 1+intlen(len)+2+len+2;
684 685 686
}

int redisvFormatCommand(char **target, const char *format, va_list ap) {
687
    const char *c = format;
688 689
    char *cmd = NULL; /* final command */
    int pos; /* position in final command */
690
    sds curarg, newarg; /* current argument */
P
Pieter Noordhuis 已提交
691
    int touched = 0; /* was the current argument touched? */
692 693
    char **curargv = NULL, **newargv = NULL;
    int argc = 0;
694
    int totlen = 0;
695
    int j;
696 697 698 699 700 701

    /* Abort if there is not target to set */
    if (target == NULL)
        return -1;

    /* Build the command string accordingly to protocol */
702 703 704 705
    curarg = sdsempty();
    if (curarg == NULL)
        return -1;

706 707 708
    while(*c != '\0') {
        if (*c != '%' || c[1] == '\0') {
            if (*c == ' ') {
P
Pieter Noordhuis 已提交
709
                if (touched) {
710 711 712 713 714 715 716 717 718
                    newargv = realloc(curargv,sizeof(char*)*(argc+1));
                    if (newargv == NULL) goto err;
                    curargv = newargv;
                    curargv[argc++] = curarg;
                    totlen += bulklen(sdslen(curarg));

                    /* curarg is put in argv so it can be overwritten. */
                    curarg = sdsempty();
                    if (curarg == NULL) goto err;
P
Pieter Noordhuis 已提交
719
                    touched = 0;
720 721
                }
            } else {
722 723 724
                newarg = sdscatlen(curarg,c,1);
                if (newarg == NULL) goto err;
                curarg = newarg;
P
Pieter Noordhuis 已提交
725
                touched = 1;
726 727
            }
        } else {
728 729 730 731 732 733
            char *arg;
            size_t size;

            /* Set newarg so it can be checked even if it is not touched. */
            newarg = curarg;

734 735 736
            switch(c[1]) {
            case 's':
                arg = va_arg(ap,char*);
P
Pieter Noordhuis 已提交
737 738
                size = strlen(arg);
                if (size > 0)
739
                    newarg = sdscatlen(curarg,arg,size);
740 741 742 743
                break;
            case 'b':
                arg = va_arg(ap,char*);
                size = va_arg(ap,size_t);
P
Pieter Noordhuis 已提交
744
                if (size > 0)
745
                    newarg = sdscatlen(curarg,arg,size);
746 747
                break;
            case '%':
748
                newarg = sdscat(curarg,"%");
749
                break;
P
Pieter Noordhuis 已提交
750 751 752
            default:
                /* Try to detect printf format */
                {
753
                    static const char intfmts[] = "diouxX";
P
Pieter Noordhuis 已提交
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
                    char _format[16];
                    const char *_p = c+1;
                    size_t _l = 0;
                    va_list _cpy;

                    /* Flags */
                    if (*_p != '\0' && *_p == '#') _p++;
                    if (*_p != '\0' && *_p == '0') _p++;
                    if (*_p != '\0' && *_p == '-') _p++;
                    if (*_p != '\0' && *_p == ' ') _p++;
                    if (*_p != '\0' && *_p == '+') _p++;

                    /* Field width */
                    while (*_p != '\0' && isdigit(*_p)) _p++;

                    /* Precision */
                    if (*_p == '.') {
                        _p++;
                        while (*_p != '\0' && isdigit(*_p)) _p++;
                    }

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
                    /* Copy va_list before consuming with va_arg */
                    va_copy(_cpy,ap);

                    /* Integer conversion (without modifiers) */
                    if (strchr(intfmts,*_p) != NULL) {
                        va_arg(ap,int);
                        goto fmt_valid;
                    }

                    /* Double conversion (without modifiers) */
                    if (strchr("eEfFgGaA",*_p) != NULL) {
                        va_arg(ap,double);
                        goto fmt_valid;
                    }

                    /* Size: char */
                    if (_p[0] == 'h' && _p[1] == 'h') {
                        _p += 2;
                        if (*_p != '\0' && strchr(intfmts,*_p) != NULL) {
                            va_arg(ap,int); /* char gets promoted to int */
                            goto fmt_valid;
P
Pieter Noordhuis 已提交
796
                        }
797
                        goto fmt_invalid;
P
Pieter Noordhuis 已提交
798 799
                    }

800 801 802 803 804 805
                    /* Size: short */
                    if (_p[0] == 'h') {
                        _p += 1;
                        if (*_p != '\0' && strchr(intfmts,*_p) != NULL) {
                            va_arg(ap,int); /* short gets promoted to int */
                            goto fmt_valid;
P
Pieter Noordhuis 已提交
806
                        }
807
                        goto fmt_invalid;
P
Pieter Noordhuis 已提交
808 809
                    }

810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
                    /* Size: long long */
                    if (_p[0] == 'l' && _p[1] == 'l') {
                        _p += 2;
                        if (*_p != '\0' && strchr(intfmts,*_p) != NULL) {
                            va_arg(ap,long long);
                            goto fmt_valid;
                        }
                        goto fmt_invalid;
                    }

                    /* Size: long */
                    if (_p[0] == 'l') {
                        _p += 1;
                        if (*_p != '\0' && strchr(intfmts,*_p) != NULL) {
                            va_arg(ap,long);
                            goto fmt_valid;
                        }
                        goto fmt_invalid;
                    }

                fmt_invalid:
                    va_end(_cpy);
                    goto err;

                fmt_valid:
                    _l = (_p+1)-c;
                    if (_l < sizeof(_format)-2) {
                        memcpy(_format,c,_l);
                        _format[_l] = '\0';
                        newarg = sdscatvprintf(curarg,_format,_cpy);

                        /* Update current position (note: outer blocks
                         * increment c twice so compensate here) */
                        c = _p-1;
                    }

                    va_end(_cpy);
                    break;
P
Pieter Noordhuis 已提交
848
                }
849
            }
850 851 852 853

            if (newarg == NULL) goto err;
            curarg = newarg;

P
Pieter Noordhuis 已提交
854
            touched = 1;
855 856 857 858 859 860
            c++;
        }
        c++;
    }

    /* Add the last argument if needed */
P
Pieter Noordhuis 已提交
861
    if (touched) {
862 863 864 865 866
        newargv = realloc(curargv,sizeof(char*)*(argc+1));
        if (newargv == NULL) goto err;
        curargv = newargv;
        curargv[argc++] = curarg;
        totlen += bulklen(sdslen(curarg));
867
    } else {
868
        sdsfree(curarg);
869 870
    }

871 872 873
    /* Clear curarg because it was put in curargv or was free'd. */
    curarg = NULL;

874 875 876 877 878
    /* Add bytes needed to hold multi bulk count */
    totlen += 1+intlen(argc)+2;

    /* Build the command at protocol level */
    cmd = malloc(totlen+1);
879 880
    if (cmd == NULL) goto err;

881 882
    pos = sprintf(cmd,"*%d\r\n",argc);
    for (j = 0; j < argc; j++) {
883 884 885 886
        pos += sprintf(cmd+pos,"$%zu\r\n",sdslen(curargv[j]));
        memcpy(cmd+pos,curargv[j],sdslen(curargv[j]));
        pos += sdslen(curargv[j]);
        sdsfree(curargv[j]);
887 888 889 890
        cmd[pos++] = '\r';
        cmd[pos++] = '\n';
    }
    assert(pos == totlen);
891 892 893
    cmd[pos] = '\0';

    free(curargv);
894 895
    *target = cmd;
    return totlen;
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910

err:
    while(argc--)
        sdsfree(curargv[argc]);
    free(curargv);

    if (curarg != NULL)
        sdsfree(curarg);

    /* No need to check cmd since it is the last statement that can fail,
     * but do it anyway to be as defensive as possible. */
    if (cmd != NULL)
        free(cmd);

    return -1;
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
}

/* Format a command according to the Redis protocol. This function
 * takes a format similar to printf:
 *
 * %s represents a C null terminated string you want to interpolate
 * %b represents a binary safe string
 *
 * When using %b you need to provide both the pointer to the string
 * and the length in bytes. Examples:
 *
 * len = redisFormatCommand(target, "GET %s", mykey);
 * len = redisFormatCommand(target, "SET %s %b", mykey, myval, myvallen);
 */
int redisFormatCommand(char **target, const char *format, ...) {
    va_list ap;
    int len;
    va_start(ap,format);
    len = redisvFormatCommand(target,format,ap);
    va_end(ap);
    return len;
}

/* Format a command according to the Redis protocol. This function takes the
 * number of arguments, an array with arguments and an array with their
 * lengths. If the latter is set to NULL, strlen will be used to compute the
 * argument lengths.
 */
int redisFormatCommandArgv(char **target, int argc, const char **argv, const size_t *argvlen) {
    char *cmd = NULL; /* final command */
    int pos; /* position in final command */
    size_t len;
    int totlen, j;

    /* Calculate number of bytes needed for the command */
    totlen = 1+intlen(argc)+2;
    for (j = 0; j < argc; j++) {
        len = argvlen ? argvlen[j] : strlen(argv[j]);
949
        totlen += bulklen(len);
950 951 952 953
    }

    /* Build the command at protocol level */
    cmd = malloc(totlen+1);
954 955 956
    if (cmd == NULL)
        return -1;

957 958 959 960 961 962 963 964 965 966
    pos = sprintf(cmd,"*%d\r\n",argc);
    for (j = 0; j < argc; j++) {
        len = argvlen ? argvlen[j] : strlen(argv[j]);
        pos += sprintf(cmd+pos,"$%zu\r\n",len);
        memcpy(cmd+pos,argv[j],len);
        pos += len;
        cmd[pos++] = '\r';
        cmd[pos++] = '\n';
    }
    assert(pos == totlen);
967 968
    cmd[pos] = '\0';

969 970 971 972
    *target = cmd;
    return totlen;
}

973 974 975
void __redisSetError(redisContext *c, int type, const char *str) {
    size_t len;

976
    c->err = type;
977 978 979 980 981
    if (str != NULL) {
        len = strlen(str);
        len = len < (sizeof(c->errstr)-1) ? len : (sizeof(c->errstr)-1);
        memcpy(c->errstr,str,len);
        c->errstr[len] = '\0';
982 983 984
    } else {
        /* Only REDIS_ERR_IO may lack a description! */
        assert(type == REDIS_ERR_IO);
985
        strerror_r(errno,c->errstr,sizeof(c->errstr));
986 987 988
    }
}

P
Pieter Noordhuis 已提交
989
static redisContext *redisContextInit(void) {
990 991 992 993 994 995
    redisContext *c;

    c = calloc(1,sizeof(redisContext));
    if (c == NULL)
        return NULL;

996
    c->err = 0;
997
    c->errstr[0] = '\0';
998
    c->obuf = sdsempty();
999
    c->reader = redisReaderCreate();
1000 1001 1002 1003
    return c;
}

void redisFree(redisContext *c) {
P
Pieter Noordhuis 已提交
1004
    if (c->fd > 0)
1005 1006 1007 1008
        close(c->fd);
    if (c->obuf != NULL)
        sdsfree(c->obuf);
    if (c->reader != NULL)
1009
        redisReaderFree(c->reader);
1010 1011 1012 1013 1014 1015 1016 1017 1018
    free(c);
}

/* Connect to a Redis instance. On error the field error in the returned
 * context will be set to the return value of the error function.
 * When no set of reply functions is given, the default set will be used. */
redisContext *redisConnect(const char *ip, int port) {
    redisContext *c = redisContextInit();
    c->flags |= REDIS_BLOCK;
P
Pieter Noordhuis 已提交
1019 1020 1021 1022 1023 1024 1025 1026
    redisContextConnectTcp(c,ip,port,NULL);
    return c;
}

redisContext *redisConnectWithTimeout(const char *ip, int port, struct timeval tv) {
    redisContext *c = redisContextInit();
    c->flags |= REDIS_BLOCK;
    redisContextConnectTcp(c,ip,port,&tv);
1027 1028 1029 1030 1031 1032
    return c;
}

redisContext *redisConnectNonBlock(const char *ip, int port) {
    redisContext *c = redisContextInit();
    c->flags &= ~REDIS_BLOCK;
P
Pieter Noordhuis 已提交
1033
    redisContextConnectTcp(c,ip,port,NULL);
1034 1035 1036 1037 1038 1039
    return c;
}

redisContext *redisConnectUnix(const char *path) {
    redisContext *c = redisContextInit();
    c->flags |= REDIS_BLOCK;
P
Pieter Noordhuis 已提交
1040 1041 1042 1043 1044 1045 1046 1047
    redisContextConnectUnix(c,path,NULL);
    return c;
}

redisContext *redisConnectUnixWithTimeout(const char *path, struct timeval tv) {
    redisContext *c = redisContextInit();
    c->flags |= REDIS_BLOCK;
    redisContextConnectUnix(c,path,&tv);
1048 1049 1050 1051 1052 1053
    return c;
}

redisContext *redisConnectUnixNonBlock(const char *path) {
    redisContext *c = redisContextInit();
    c->flags &= ~REDIS_BLOCK;
P
Pieter Noordhuis 已提交
1054
    redisContextConnectUnix(c,path,NULL);
1055 1056 1057
    return c;
}

P
Pieter Noordhuis 已提交
1058 1059 1060 1061 1062 1063 1064
/* Set read/write timeout on a blocking socket. */
int redisSetTimeout(redisContext *c, struct timeval tv) {
    if (c->flags & REDIS_BLOCK)
        return redisContextSetTimeout(c,tv);
    return REDIS_ERR;
}

1065 1066 1067 1068 1069 1070
/* Use this function to handle a read event on the descriptor. It will try
 * and read some bytes from the socket and feed them to the reply parser.
 *
 * After this function is called, you may use redisContextReadReply to
 * see if there is a reply available. */
int redisBufferRead(redisContext *c) {
1071
    char buf[1024*16];
1072 1073 1074 1075 1076 1077 1078
    int nread;

    /* Return early when the context has seen an error. */
    if (c->err)
        return REDIS_ERR;

    nread = read(c->fd,buf,sizeof(buf));
1079
    if (nread == -1) {
P
Pieter Noordhuis 已提交
1080
        if (errno == EAGAIN && !(c->flags & REDIS_BLOCK)) {
1081 1082 1083 1084 1085 1086
            /* Try again later */
        } else {
            __redisSetError(c,REDIS_ERR_IO,NULL);
            return REDIS_ERR;
        }
    } else if (nread == 0) {
1087
        __redisSetError(c,REDIS_ERR_EOF,"Server closed the connection");
1088 1089
        return REDIS_ERR;
    } else {
1090 1091 1092 1093
        if (redisReaderFeed(c->reader,buf,nread) != REDIS_OK) {
            __redisSetError(c,c->reader->err,c->reader->errstr);
            return REDIS_ERR;
        }
1094 1095 1096 1097 1098 1099 1100 1101
    }
    return REDIS_OK;
}

/* Write the output buffer to the socket.
 *
 * Returns REDIS_OK when the buffer is empty, or (a part of) the buffer was
 * succesfully written to the socket. When the buffer is empty after the
1102
 * write operation, "done" is set to 1 (if given).
1103 1104
 *
 * Returns REDIS_ERR if an error occured trying to write and sets
1105
 * c->errstr to hold the appropriate error string.
1106 1107 1108
 */
int redisBufferWrite(redisContext *c, int *done) {
    int nwritten;
1109 1110 1111 1112 1113

    /* Return early when the context has seen an error. */
    if (c->err)
        return REDIS_ERR;

1114 1115 1116
    if (sdslen(c->obuf) > 0) {
        nwritten = write(c->fd,c->obuf,sdslen(c->obuf));
        if (nwritten == -1) {
P
Pieter Noordhuis 已提交
1117
            if (errno == EAGAIN && !(c->flags & REDIS_BLOCK)) {
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
                /* Try again later */
            } else {
                __redisSetError(c,REDIS_ERR_IO,NULL);
                return REDIS_ERR;
            }
        } else if (nwritten > 0) {
            if (nwritten == (signed)sdslen(c->obuf)) {
                sdsfree(c->obuf);
                c->obuf = sdsempty();
            } else {
                c->obuf = sdsrange(c->obuf,nwritten,-1);
            }
        }
    }
    if (done != NULL) *done = (sdslen(c->obuf) == 0);
    return REDIS_OK;
}

/* Internal helper function to try and get a reply from the reader,
 * or set an error in the context otherwise. */
int redisGetReplyFromReader(redisContext *c, void **reply) {
1139 1140
    if (redisReaderGetReply(c->reader,reply) == REDIS_ERR) {
        __redisSetError(c,c->reader->err,c->reader->errstr);
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
        return REDIS_ERR;
    }
    return REDIS_OK;
}

int redisGetReply(redisContext *c, void **reply) {
    int wdone = 0;
    void *aux = NULL;

    /* Try to read pending replies */
    if (redisGetReplyFromReader(c,&aux) == REDIS_ERR)
        return REDIS_ERR;

    /* For the blocking context, flush output buffer and read reply */
    if (aux == NULL && c->flags & REDIS_BLOCK) {
        /* Write until done */
        do {
            if (redisBufferWrite(c,&wdone) == REDIS_ERR)
                return REDIS_ERR;
        } while (!wdone);

        /* Read until there is a reply */
        do {
            if (redisBufferRead(c) == REDIS_ERR)
                return REDIS_ERR;
            if (redisGetReplyFromReader(c,&aux) == REDIS_ERR)
                return REDIS_ERR;
        } while (aux == NULL);
    }

    /* Set reply object */
    if (reply != NULL) *reply = aux;
    return REDIS_OK;
}


/* Helper function for the redisAppendCommand* family of functions.
 *
 * Write a formatted command to the output buffer. When this family
 * is used, you need to call redisGetReply yourself to retrieve
 * the reply (or replies in pub/sub).
 */
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
int __redisAppendCommand(redisContext *c, char *cmd, size_t len) {
    sds newbuf;

    newbuf = sdscatlen(c->obuf,cmd,len);
    if (newbuf == NULL) {
        __redisSetError(c,REDIS_ERR_OOM,"Out of memory");
        return REDIS_ERR;
    }

    c->obuf = newbuf;
    return REDIS_OK;
1194 1195
}

1196
int redisvAppendCommand(redisContext *c, const char *format, va_list ap) {
1197 1198
    char *cmd;
    int len;
1199

1200
    len = redisvFormatCommand(&cmd,format,ap);
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
    if (len == -1) {
        __redisSetError(c,REDIS_ERR_OOM,"Out of memory");
        return REDIS_ERR;
    }

    if (__redisAppendCommand(c,cmd,len) != REDIS_OK) {
        free(cmd);
        return REDIS_ERR;
    }

1211
    free(cmd);
1212
    return REDIS_OK;
1213 1214
}

1215
int redisAppendCommand(redisContext *c, const char *format, ...) {
1216
    va_list ap;
1217 1218
    int ret;

1219
    va_start(ap,format);
1220
    ret = redisvAppendCommand(c,format,ap);
1221
    va_end(ap);
1222
    return ret;
1223 1224
}

1225
int redisAppendCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen) {
1226 1227
    char *cmd;
    int len;
1228

1229
    len = redisFormatCommandArgv(&cmd,argc,argv,argvlen);
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
    if (len == -1) {
        __redisSetError(c,REDIS_ERR_OOM,"Out of memory");
        return REDIS_ERR;
    }

    if (__redisAppendCommand(c,cmd,len) != REDIS_OK) {
        free(cmd);
        return REDIS_ERR;
    }

1240
    free(cmd);
1241
    return REDIS_OK;
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
}

/* Helper function for the redisCommand* family of functions.
 *
 * Write a formatted command to the output buffer. If the given context is
 * blocking, immediately read the reply into the "reply" pointer. When the
 * context is non-blocking, the "reply" pointer will not be used and the
 * command is simply appended to the write buffer.
 *
 * Returns the reply when a reply was succesfully retrieved. Returns NULL
 * otherwise. When NULL is returned in a blocking context, the error field
 * in the context will be set.
 */
1255 1256
static void *__redisBlockForReply(redisContext *c) {
    void *reply;
1257 1258

    if (c->flags & REDIS_BLOCK) {
1259 1260 1261
        if (redisGetReply(c,&reply) != REDIS_OK)
            return NULL;
        return reply;
1262 1263 1264 1265 1266
    }
    return NULL;
}

void *redisvCommand(redisContext *c, const char *format, va_list ap) {
1267 1268 1269
    if (redisvAppendCommand(c,format,ap) != REDIS_OK)
        return NULL;
    return __redisBlockForReply(c);
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
}

void *redisCommand(redisContext *c, const char *format, ...) {
    va_list ap;
    void *reply = NULL;
    va_start(ap,format);
    reply = redisvCommand(c,format,ap);
    va_end(ap);
    return reply;
}

void *redisCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen) {
1282 1283 1284
    if (redisAppendCommandArgv(c,argc,argv,argvlen) != REDIS_OK)
        return NULL;
    return __redisBlockForReply(c);
1285
}