networking.c 45.6 KB
Newer Older
1 2 3
#include "redis.h"
#include <sys/uio.h>

4 5
static void setProtocolError(redisClient *c, int pos);

6 7 8 9 10 11 12 13
/* To evaluate the output buffer size of a client we need to get size of
 * allocated objects, however we can't used zmalloc_size() directly on sds
 * strings because of the trick they use to work (the header is before the
 * returned pointer), so we use this helper function. */
size_t zmalloc_size_sds(sds s) {
    return zmalloc_size(s-sizeof(struct sdshdr));
}

14 15 16 17 18 19 20 21 22 23
void *dupClientReplyValue(void *o) {
    incrRefCount((robj*)o);
    return o;
}

int listMatchObjects(void *a, void *b) {
    return equalStringObjects(a,b);
}

redisClient *createClient(int fd) {
24
    redisClient *c = zmalloc(sizeof(redisClient));
25

26 27 28 29 30 31 32 33 34 35 36 37 38 39
    /* passing -1 as fd it is possible to create a non connected client.
     * This is useful since all the Redis commands needs to be executed
     * in the context of a client. When commands are executed in other
     * contexts (for instance a Lua script) we need a non connected client. */
    if (fd != -1) {
        anetNonBlock(NULL,fd);
        anetTcpNoDelay(NULL,fd);
        if (aeCreateFileEvent(server.el,fd,AE_READABLE,
            readQueryFromClient, c) == AE_ERR)
        {
            close(fd);
            zfree(c);
            return NULL;
        }
40 41
    }

42 43
    selectDb(c,0);
    c->fd = fd;
44
    c->bufpos = 0;
45
    c->querybuf = sdsempty();
46
    c->querybuf_peak = 0;
47
    c->reqtype = 0;
48 49
    c->argc = 0;
    c->argv = NULL;
50
    c->cmd = c->lastcmd = NULL;
51
    c->multibulklen = 0;
52 53 54
    c->bulklen = -1;
    c->sentlen = 0;
    c->flags = 0;
55
    c->ctime = c->lastinteraction = server.unixtime;
56 57 58
    c->authenticated = 0;
    c->replstate = REDIS_REPL_NONE;
    c->reply = listCreate();
59
    c->reply_bytes = 0;
60
    c->obuf_soft_limit_reached_time = 0;
61 62
    listSetFreeMethod(c->reply,decrRefCount);
    listSetDupMethod(c->reply,dupClientReplyValue);
63 64 65 66
    c->bpop.keys = NULL;
    c->bpop.count = 0;
    c->bpop.timeout = 0;
    c->bpop.target = NULL;
67 68 69 70 71 72 73
    c->io_keys = listCreate();
    c->watched_keys = listCreate();
    listSetFreeMethod(c->io_keys,decrRefCount);
    c->pubsub_channels = dictCreate(&setDictType,NULL);
    c->pubsub_patterns = listCreate();
    listSetFreeMethod(c->pubsub_patterns,decrRefCount);
    listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
74
    if (fd != -1) listAddNodeTail(server.clients,c);
75 76 77 78
    initClientMultiState(c);
    return c;
}

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
/* This function is called every time we are going to transmit new data
 * to the client. The behavior is the following:
 *
 * If the client should receive new data (normal clients will) the function
 * returns REDIS_OK, and make sure to install the write handler in our event
 * loop so that when the socket is writable new data gets written.
 *
 * If the client should not receive new data, because it is a fake client
 * or a slave, or because the setup of the write handler failed, the function
 * returns REDIS_ERR.
 *
 * Typically gets called every time a reply is built, before adding more
 * data to the clients output buffers. If the function returns REDIS_ERR no
 * data should be appended to the output buffers. */
int prepareClientToWrite(redisClient *c) {
94
    if (c->flags & REDIS_LUA_CLIENT) return REDIS_OK;
95
    if (c->fd <= 0) return REDIS_ERR; /* Fake client */
96
    if (c->bufpos == 0 && listLength(c->reply) == 0 &&
97 98 99
        (c->replstate == REDIS_REPL_NONE ||
         c->replstate == REDIS_REPL_ONLINE) &&
        aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
100 101 102 103
        sendReplyToClient, c) == AE_ERR) return REDIS_ERR;
    return REDIS_OK;
}

104 105 106 107 108 109 110 111 112 113 114 115 116 117
/* Create a duplicate of the last object in the reply list when
 * it is not exclusively owned by the reply list. */
robj *dupLastObjectIfNeeded(list *reply) {
    robj *new, *cur;
    listNode *ln;
    redisAssert(listLength(reply) > 0);
    ln = listLast(reply);
    cur = listNodeValue(ln);
    if (cur->refcount > 1) {
        new = dupStringObject(cur);
        decrRefCount(cur);
        listNodeValue(ln) = new;
    }
    return listNodeValue(ln);
118 119
}

120 121 122 123
/* -----------------------------------------------------------------------------
 * Low level functions to add more data to output buffers.
 * -------------------------------------------------------------------------- */

124
int _addReplyToBuffer(redisClient *c, char *s, size_t len) {
125
    size_t available = sizeof(c->buf)-c->bufpos;
126

127 128
    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return REDIS_OK;

129 130 131 132 133 134
    /* If there already are entries in the reply list, we cannot
     * add anything more to the static buffer. */
    if (listLength(c->reply) > 0) return REDIS_ERR;

    /* Check that the buffer has enough space available for this string. */
    if (len > available) return REDIS_ERR;
135

136 137 138
    memcpy(c->buf+c->bufpos,s,len);
    c->bufpos+=len;
    return REDIS_OK;
139 140
}

141 142
void _addReplyObjectToList(redisClient *c, robj *o) {
    robj *tail;
143 144 145

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

146 147 148
    if (listLength(c->reply) == 0) {
        incrRefCount(o);
        listAddNodeTail(c->reply,o);
149
        c->reply_bytes += zmalloc_size_sds(o->ptr);
150 151 152 153 154 155 156
    } else {
        tail = listNodeValue(listLast(c->reply));

        /* Append to this object when possible. */
        if (tail->ptr != NULL &&
            sdslen(tail->ptr)+sdslen(o->ptr) <= REDIS_REPLY_CHUNK_BYTES)
        {
157
            c->reply_bytes -= zmalloc_size_sds(tail->ptr);
158 159
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,o->ptr,sdslen(o->ptr));
160
            c->reply_bytes += zmalloc_size_sds(tail->ptr);
161 162 163
        } else {
            incrRefCount(o);
            listAddNodeTail(c->reply,o);
164
            c->reply_bytes += zmalloc_size_sds(o->ptr);
165 166
        }
    }
167
    asyncCloseClientOnOutputBufferLimitReached(c);
168
}
169

170 171 172 173
/* This method takes responsibility over the sds. When it is no longer
 * needed it will be free'd, otherwise it ends up in a robj. */
void _addReplySdsToList(redisClient *c, sds s) {
    robj *tail;
174

175 176 177 178
    if (c->flags & REDIS_CLOSE_AFTER_REPLY) {
        sdsfree(s);
        return;
    }
179

180 181
    if (listLength(c->reply) == 0) {
        listAddNodeTail(c->reply,createObject(REDIS_STRING,s));
182
        c->reply_bytes += zmalloc_size_sds(s);
183 184 185 186 187 188 189
    } else {
        tail = listNodeValue(listLast(c->reply));

        /* Append to this object when possible. */
        if (tail->ptr != NULL &&
            sdslen(tail->ptr)+sdslen(s) <= REDIS_REPLY_CHUNK_BYTES)
        {
190
            c->reply_bytes -= zmalloc_size_sds(tail->ptr);
191 192
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,s,sdslen(s));
193
            c->reply_bytes += zmalloc_size_sds(tail->ptr);
194
            sdsfree(s);
195
        } else {
196
            listAddNodeTail(c->reply,createObject(REDIS_STRING,s));
197
            c->reply_bytes += zmalloc_size_sds(s);
198
        }
199
    }
200
    asyncCloseClientOnOutputBufferLimitReached(c);
201 202 203 204
}

void _addReplyStringToList(redisClient *c, char *s, size_t len) {
    robj *tail;
205 206 207

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

208
    if (listLength(c->reply) == 0) {
209 210 211
        robj *o = createStringObject(s,len);

        listAddNodeTail(c->reply,o);
212
        c->reply_bytes += zmalloc_size_sds(o->ptr);
213
    } else {
214 215 216 217 218 219
        tail = listNodeValue(listLast(c->reply));

        /* Append to this object when possible. */
        if (tail->ptr != NULL &&
            sdslen(tail->ptr)+len <= REDIS_REPLY_CHUNK_BYTES)
        {
220
            c->reply_bytes -= zmalloc_size_sds(tail->ptr);
221 222
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,s,len);
223
            c->reply_bytes += zmalloc_size_sds(tail->ptr);
224
        } else {
225 226 227
            robj *o = createStringObject(s,len);

            listAddNodeTail(c->reply,o);
228
            c->reply_bytes += zmalloc_size_sds(o->ptr);
229 230
        }
    }
231
    asyncCloseClientOnOutputBufferLimitReached(c);
232
}
233

234 235 236 237 238
/* -----------------------------------------------------------------------------
 * Higher level functions to queue data on the client output buffer.
 * The following functions are the ones that commands implementations will call.
 * -------------------------------------------------------------------------- */

239
void addReply(redisClient *c, robj *obj) {
240
    if (prepareClientToWrite(c) != REDIS_OK) return;
241 242 243 244 245 246 247 248 249 250 251

    /* This is an important place where we can avoid copy-on-write
     * when there is a saving child running, avoiding touching the
     * refcount field of the object if it's not needed.
     *
     * If the encoding is RAW and there is room in the static buffer
     * we'll be able to send the object to the client without
     * messing with its page. */
    if (obj->encoding == REDIS_ENCODING_RAW) {
        if (_addReplyToBuffer(c,obj->ptr,sdslen(obj->ptr)) != REDIS_OK)
            _addReplyObjectToList(c,obj);
252 253 254 255 256 257 258 259 260 261 262 263 264 265
    } else if (obj->encoding == REDIS_ENCODING_INT) {
        /* Optimization: if there is room in the static buffer for 32 bytes
         * (more than the max chars a 64 bit integer can take as string) we
         * avoid decoding the object and go for the lower level approach. */
        if (listLength(c->reply) == 0 && (sizeof(c->buf) - c->bufpos) >= 32) {
            char buf[32];
            int len;

            len = ll2string(buf,sizeof(buf),(long)obj->ptr);
            if (_addReplyToBuffer(c,buf,len) == REDIS_OK)
                return;
            /* else... continue with the normal code path, but should never
             * happen actually since we verified there is room. */
        }
266
        obj = getDecodedObject(obj);
267 268 269
        if (_addReplyToBuffer(c,obj->ptr,sdslen(obj->ptr)) != REDIS_OK)
            _addReplyObjectToList(c,obj);
        decrRefCount(obj);
270 271
    } else {
        redisPanic("Wrong obj->encoding in addReply()");
272 273 274 275
    }
}

void addReplySds(redisClient *c, sds s) {
276
    if (prepareClientToWrite(c) != REDIS_OK) {
277 278 279 280
        /* The caller expects the sds to be free'd. */
        sdsfree(s);
        return;
    }
281
    if (_addReplyToBuffer(c,s,sdslen(s)) == REDIS_OK) {
282 283
        sdsfree(s);
    } else {
284 285
        /* This method free's the sds when it is no longer needed. */
        _addReplySdsToList(c,s);
286
    }
287 288
}

289
void addReplyString(redisClient *c, char *s, size_t len) {
290
    if (prepareClientToWrite(c) != REDIS_OK) return;
291 292
    if (_addReplyToBuffer(c,s,len) != REDIS_OK)
        _addReplyStringToList(c,s,len);
293
}
294

295
void addReplyErrorLength(redisClient *c, char *s, size_t len) {
296 297 298
    addReplyString(c,"-ERR ",5);
    addReplyString(c,s,len);
    addReplyString(c,"\r\n",2);
299 300
}

301
void addReplyError(redisClient *c, char *err) {
302
    addReplyErrorLength(c,err,strlen(err));
303
}
304

305
void addReplyErrorFormat(redisClient *c, const char *fmt, ...) {
306
    size_t l, j;
307 308 309 310
    va_list ap;
    va_start(ap,fmt);
    sds s = sdscatvprintf(sdsempty(),fmt,ap);
    va_end(ap);
311 312 313 314 315 316
    /* Make sure there are no newlines in the string, otherwise invalid protocol
     * is emitted. */
    l = sdslen(s);
    for (j = 0; j < l; j++) {
        if (s[j] == '\r' || s[j] == '\n') s[j] = ' ';
    }
317
    addReplyErrorLength(c,s,sdslen(s));
318 319 320
    sdsfree(s);
}

321
void addReplyStatusLength(redisClient *c, char *s, size_t len) {
322 323 324 325 326 327
    addReplyString(c,"+",1);
    addReplyString(c,s,len);
    addReplyString(c,"\r\n",2);
}

void addReplyStatus(redisClient *c, char *status) {
328
    addReplyStatusLength(c,status,strlen(status));
329 330 331 332 333 334 335
}

void addReplyStatusFormat(redisClient *c, const char *fmt, ...) {
    va_list ap;
    va_start(ap,fmt);
    sds s = sdscatvprintf(sdsempty(),fmt,ap);
    va_end(ap);
336
    addReplyStatusLength(c,s,sdslen(s));
337 338 339
    sdsfree(s);
}

340 341 342
/* Adds an empty object to the reply list that will contain the multi bulk
 * length, which is not known when this function is called. */
void *addDeferredMultiBulkLength(redisClient *c) {
343 344 345
    /* Note that we install the write event here even if the object is not
     * ready to be sent, since we are sure that before returning to the
     * event loop setDeferredMultiBulkLength() will be called. */
346
    if (prepareClientToWrite(c) != REDIS_OK) return NULL;
347
    listAddNodeTail(c->reply,createObject(REDIS_STRING,NULL));
348 349 350 351 352 353 354 355 356 357 358 359 360
    return listLast(c->reply);
}

/* Populate the length object and try glueing it to the next chunk. */
void setDeferredMultiBulkLength(redisClient *c, void *node, long length) {
    listNode *ln = (listNode*)node;
    robj *len, *next;

    /* Abort when *node is NULL (see addDeferredMultiBulkLength). */
    if (node == NULL) return;

    len = listNodeValue(ln);
    len->ptr = sdscatprintf(sdsempty(),"*%ld\r\n",length);
361
    c->reply_bytes += zmalloc_size_sds(len->ptr);
362 363
    if (ln->next != NULL) {
        next = listNodeValue(ln->next);
364

365
        /* Only glue when the next node is non-NULL (an sds in this case) */
366
        if (next->ptr != NULL) {
367 368
            c->reply_bytes -= zmalloc_size_sds(len->ptr);
            c->reply_bytes -= zmalloc_size_sds(next->ptr);
369
            len->ptr = sdscatlen(len->ptr,next->ptr,sdslen(next->ptr));
370
            c->reply_bytes += zmalloc_size_sds(len->ptr);
371 372
            listDelNode(c->reply,ln->next);
        }
373
    }
374
    asyncCloseClientOnOutputBufferLimitReached(c);
375 376
}

377
/* Add a duble as a bulk reply */
378 379 380 381 382 383
void addReplyDouble(redisClient *c, double d) {
    char dbuf[128], sbuf[128];
    int dlen, slen;
    dlen = snprintf(dbuf,sizeof(dbuf),"%.17g",d);
    slen = snprintf(sbuf,sizeof(sbuf),"$%d\r\n%s\r\n",dlen,dbuf);
    addReplyString(c,sbuf,slen);
384 385
}

386 387
/* Add a long long as integer reply or bulk len / multi bulk count.
 * Basically this is used to output <prefix><long long><crlf>. */
388
void addReplyLongLongWithPrefix(redisClient *c, long long ll, char prefix) {
389
    char buf[128];
390
    int len;
391 392 393 394 395 396 397 398 399 400 401 402

    /* Things like $3\r\n or *2\r\n are emitted very often by the protocol
     * so we have a few shared objects to use if the integer is small
     * like it is most of the times. */
    if (prefix == '*' && ll < REDIS_SHARED_BULKHDR_LEN) {
        addReply(c,shared.mbulkhdr[ll]);
        return;
    } else if (prefix == '$' && ll < REDIS_SHARED_BULKHDR_LEN) {
        addReply(c,shared.bulkhdr[ll]);
        return;
    }

403
    buf[0] = prefix;
404 405 406
    len = ll2string(buf+1,sizeof(buf)-1,ll);
    buf[len+1] = '\r';
    buf[len+2] = '\n';
407
    addReplyString(c,buf,len+3);
408 409
}

410
void addReplyLongLong(redisClient *c, long long ll) {
411 412 413 414 415
    if (ll == 0)
        addReply(c,shared.czero);
    else if (ll == 1)
        addReply(c,shared.cone);
    else
416
        addReplyLongLongWithPrefix(c,ll,':');
417
}
418

419
void addReplyMultiBulkLen(redisClient *c, long length) {
420
    addReplyLongLongWithPrefix(c,length,'*');
421 422
}

423
/* Create the length prefix of a bulk reply, example: $2234 */
424
void addReplyBulkLen(redisClient *c, robj *obj) {
425
    size_t len;
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441

    if (obj->encoding == REDIS_ENCODING_RAW) {
        len = sdslen(obj->ptr);
    } else {
        long n = (long)obj->ptr;

        /* Compute how many bytes will take this integer as a radix 10 string */
        len = 1;
        if (n < 0) {
            len++;
            n = -n;
        }
        while((n = n/10) != 0) {
            len++;
        }
    }
442
    addReplyLongLongWithPrefix(c,len,'$');
443 444
}

445
/* Add a Redis Object as a bulk reply */
446 447 448 449 450 451
void addReplyBulk(redisClient *c, robj *obj) {
    addReplyBulkLen(c,obj);
    addReply(c,obj);
    addReply(c,shared.crlf);
}

452 453
/* Add a C buffer as bulk reply */
void addReplyBulkCBuffer(redisClient *c, void *p, size_t len) {
454
    addReplyLongLongWithPrefix(c,len,'$');
455 456 457 458 459
    addReplyString(c,p,len);
    addReply(c,shared.crlf);
}

/* Add a C nul term string as bulk reply */
460 461 462 463
void addReplyBulkCString(redisClient *c, char *s) {
    if (s == NULL) {
        addReply(c,shared.nullbulk);
    } else {
464
        addReplyBulkCBuffer(c,s,strlen(s));
465 466 467
    }
}

468 469 470 471 472 473 474 475 476
/* Add a long long as a bulk reply */
void addReplyBulkLongLong(redisClient *c, long long ll) {
    char buf[64];
    int len;

    len = ll2string(buf,64,ll);
    addReplyBulkCBuffer(c,buf,len);
}

477 478 479 480 481 482 483 484
/* Copy 'src' client output buffers into 'dst' client output buffers.
 * The function takes care of freeing the old output buffers of the
 * destination client. */
void copyClientOutputBuffer(redisClient *dst, redisClient *src) {
    listRelease(dst->reply);
    dst->reply = listDup(src->reply);
    memcpy(dst->buf,src->buf,src->bufpos);
    dst->bufpos = src->bufpos;
485
    dst->reply_bytes = src->reply_bytes;
486 487
}

488
static void acceptCommonHandler(int fd) {
489
    redisClient *c;
490
    if ((c = createClient(fd)) == NULL) {
491
        redisLog(REDIS_WARNING,"Error allocating resoures for the client");
492
        close(fd); /* May be already closed, just ingore errors */
493 494 495 496 497 498
        return;
    }
    /* If maxclient directive is set and this is one client more... close the
     * connection. Note that we create the client instead to check before
     * for this condition, since now the socket is already set in nonblocking
     * mode and we can send an error for free using the Kernel I/O */
499
    if (listLength(server.clients) > server.maxclients) {
500 501 502 503 504 505
        char *err = "-ERR max number of clients reached\r\n";

        /* That's a best effort error message, don't check write errors */
        if (write(c->fd,err,strlen(err)) == -1) {
            /* Nothing to do, Just to avoid the warning... */
        }
506
        server.stat_rejected_conn++;
507 508 509 510 511 512
        freeClient(c);
        return;
    }
    server.stat_numconnections++;
}

513 514 515 516 517 518 519 520 521
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    int cport, cfd;
    char cip[128];
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

    cfd = anetTcpAccept(server.neterr, fd, cip, &cport);
    if (cfd == AE_ERR) {
522
        redisLog(REDIS_WARNING,"Accepting client connection: %s", server.neterr);
523 524 525 526 527 528 529 530 531 532 533 534
        return;
    }
    redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
    acceptCommonHandler(cfd);
}

void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    int cfd;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

535
    cfd = anetUnixAccept(server.neterr, fd);
536
    if (cfd == AE_ERR) {
537
        redisLog(REDIS_WARNING,"Accepting client connection: %s", server.neterr);
538 539 540 541 542 543 544
        return;
    }
    redisLog(REDIS_VERBOSE,"Accepted connection to %s", server.unixsocket);
    acceptCommonHandler(cfd);
}


545 546 547 548 549
static void freeClientArgv(redisClient *c) {
    int j;
    for (j = 0; j < c->argc; j++)
        decrRefCount(c->argv[j]);
    c->argc = 0;
550
    c->cmd = NULL;
551 552
}

553 554 555 556 557 558 559 560 561 562
/* Close all the slaves connections. This is useful in chained replication
 * when we resync with our own master and want to force all our slaves to
 * resync with us as well. */
void disconnectSlaves(void) {
    while (listLength(server.slaves)) {
        listNode *ln = listFirst(server.slaves);
        freeClient((redisClient*)ln->value);
    }
}

563 564 565
void freeClient(redisClient *c) {
    listNode *ln;

566 567 568
    /* If this is marked as current client unset it */
    if (server.current_client == c) server.current_client = NULL;

569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
    /* Note that if the client we are freeing is blocked into a blocking
     * call, we have to set querybuf to NULL *before* to call
     * unblockClientWaitingData() to avoid processInputBuffer() will get
     * called. Also it is important to remove the file events after
     * this, because this call adds the READABLE event. */
    sdsfree(c->querybuf);
    c->querybuf = NULL;
    if (c->flags & REDIS_BLOCKED)
        unblockClientWaitingData(c);

    /* UNWATCH all the keys */
    unwatchAllKeys(c);
    listRelease(c->watched_keys);
    /* Unsubscribe from all the pubsub channels */
    pubsubUnsubscribeAllChannels(c,0);
    pubsubUnsubscribeAllPatterns(c,0);
    dictRelease(c->pubsub_channels);
    listRelease(c->pubsub_patterns);
    /* Obvious cleanup */
    aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
    aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
    listRelease(c->reply);
    freeClientArgv(c);
    close(c->fd);
    /* Remove from the list of clients */
    ln = listSearchKey(server.clients,c);
    redisAssert(ln != NULL);
    listDelNode(server.clients,ln);
597 598 599 600 601 602 603
    /* When client was just unblocked because of a blocking operation,
     * remove it from the list with unblocked clients. */
    if (c->flags & REDIS_UNBLOCKED) {
        ln = listSearchKey(server.unblocked_clients,c);
        redisAssert(ln != NULL);
        listDelNode(server.unblocked_clients,ln);
    }
604
    listRelease(c->io_keys);
605 606
    /* Master/slave cleanup.
     * Case 1: we lost the connection with a slave. */
607 608 609 610 611 612 613 614
    if (c->flags & REDIS_SLAVE) {
        if (c->replstate == REDIS_REPL_SEND_BULK && c->repldbfd != -1)
            close(c->repldbfd);
        list *l = (c->flags & REDIS_MONITOR) ? server.monitors : server.slaves;
        ln = listSearchKey(l,c);
        redisAssert(ln != NULL);
        listDelNode(l,ln);
    }
615 616

    /* Case 2: we lost the connection with the master. */
617 618
    if (c->flags & REDIS_MASTER) {
        server.master = NULL;
A
antirez 已提交
619
        server.repl_state = REDIS_REPL_CONNECT;
620
        server.repl_down_since = server.unixtime;
621 622
        /* We lost connection with our master, force our slaves to resync
         * with us as well to load the new data set.
623
         *
A
antirez 已提交
624
         * If server.masterhost is NULL the user called SLAVEOF NO ONE so
625 626
         * slave resync is not needed. */
        if (server.masterhost != NULL) disconnectSlaves();
627
    }
628 629 630 631 632 633 634 635 636

    /* If this client was scheduled for async freeing we need to remove it
     * from the queue. */
    if (c->flags & REDIS_CLOSE_ASAP) {
        ln = listSearchKey(server.clients_to_close,c);
        redisAssert(ln != NULL);
        listDelNode(server.clients_to_close,ln);
    }

637 638 639 640 641 642
    /* Release memory */
    zfree(c->argv);
    freeClientMultiState(c);
    zfree(c);
}

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
/* Schedule a client to free it at a safe time in the serverCron() function.
 * This function is useful when we need to terminate a client but we are in
 * a context where calling freeClient() is not possible, because the client
 * should be valid for the continuation of the flow of the program. */
void freeClientAsync(redisClient *c) {
    if (c->flags & REDIS_CLOSE_ASAP) return;
    c->flags |= REDIS_CLOSE_ASAP;
    listAddNodeTail(server.clients_to_close,c);
}

void freeClientsInAsyncFreeQueue(void) {
    while (listLength(server.clients_to_close)) {
        listNode *ln = listFirst(server.clients_to_close);
        redisClient *c = listNodeValue(ln);

        c->flags &= ~REDIS_CLOSE_ASAP;
        freeClient(c);
        listDelNode(server.clients_to_close,ln);
    }
}

664 665 666
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = privdata;
    int nwritten = 0, totwritten = 0, objlen;
667
    size_t objmem;
668 669 670 671
    robj *o;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
    while(c->bufpos > 0 || listLength(c->reply)) {
        if (c->bufpos > 0) {
            if (c->flags & REDIS_MASTER) {
                /* Don't reply to a master */
                nwritten = c->bufpos - c->sentlen;
            } else {
                nwritten = write(fd,c->buf+c->sentlen,c->bufpos-c->sentlen);
                if (nwritten <= 0) break;
            }
            c->sentlen += nwritten;
            totwritten += nwritten;

            /* If the buffer was sent, set bufpos to zero to continue with
             * the remainder of the reply. */
            if (c->sentlen == c->bufpos) {
                c->bufpos = 0;
                c->sentlen = 0;
            }
        } else {
            o = listNodeValue(listFirst(c->reply));
            objlen = sdslen(o->ptr);
693
            objmem = zmalloc_size_sds(o->ptr);
694

695 696 697 698
            if (objlen == 0) {
                listDelNode(c->reply,listFirst(c->reply));
                continue;
            }
699

700 701 702 703 704 705 706 707 708
            if (c->flags & REDIS_MASTER) {
                /* Don't reply to a master */
                nwritten = objlen - c->sentlen;
            } else {
                nwritten = write(fd, ((char*)o->ptr)+c->sentlen,objlen-c->sentlen);
                if (nwritten <= 0) break;
            }
            c->sentlen += nwritten;
            totwritten += nwritten;
709

710 711 712 713
            /* If we fully sent the object on head go to the next one */
            if (c->sentlen == objlen) {
                listDelNode(c->reply,listFirst(c->reply));
                c->sentlen = 0;
714
                c->reply_bytes -= objmem;
715
            }
716
        }
717
        /* Note that we avoid to send more than REDIS_MAX_WRITE_PER_EVENT
718 719 720
         * bytes, in a single threaded server it's a good idea to serve
         * other clients as well, even if a very large request comes from
         * super fast link that is always able to accept data (in real world
721 722 723 724 725 726 727
         * scenario think about 'KEYS *' against the loopback interface).
         *
         * However if we are over the maxmemory limit we ignore that and
         * just deliver as much data as it is possible to deliver. */
        if (totwritten > REDIS_MAX_WRITE_PER_EVENT &&
            (server.maxmemory == 0 ||
             zmalloc_used_memory() < server.maxmemory)) break;
728 729 730 731 732 733 734 735 736 737 738
    }
    if (nwritten == -1) {
        if (errno == EAGAIN) {
            nwritten = 0;
        } else {
            redisLog(REDIS_VERBOSE,
                "Error writing to client: %s", strerror(errno));
            freeClient(c);
            return;
        }
    }
739
    if (totwritten > 0) c->lastinteraction = server.unixtime;
740
    if (c->bufpos == 0 && listLength(c->reply) == 0) {
741 742
        c->sentlen = 0;
        aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
P
Pieter Noordhuis 已提交
743 744

        /* Close connection after entire reply has been sent. */
745
        if (c->flags & REDIS_CLOSE_AFTER_REPLY) freeClient(c);
746 747 748 749 750 751
    }
}

/* resetClient prepare the client to process the next command */
void resetClient(redisClient *c) {
    freeClientArgv(c);
752 753
    c->reqtype = 0;
    c->multibulklen = 0;
754
    c->bulklen = -1;
755 756
    /* We clear the ASKING flag as well if we are not inside a MULTI. */
    if (!(c->flags & REDIS_MULTI)) c->flags &= (~REDIS_ASKING);
757 758
}

759 760 761 762 763 764 765
int processInlineBuffer(redisClient *c) {
    char *newline = strstr(c->querybuf,"\r\n");
    int argc, j;
    sds *argv;
    size_t querylen;

    /* Nothing to do without a \r\n */
766 767 768 769 770
    if (newline == NULL) {
        if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
            addReplyError(c,"Protocol error: too big inline request");
            setProtocolError(c,0);
        }
771
        return REDIS_ERR;
772
    }
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800

    /* Split the input buffer up to the \r\n */
    querylen = newline-(c->querybuf);
    argv = sdssplitlen(c->querybuf,querylen," ",1,&argc);

    /* Leave data after the first line of the query in the buffer */
    c->querybuf = sdsrange(c->querybuf,querylen+2,-1);

    /* Setup argv array on client structure */
    if (c->argv) zfree(c->argv);
    c->argv = zmalloc(sizeof(robj*)*argc);

    /* Create redis objects for all arguments. */
    for (c->argc = 0, j = 0; j < argc; j++) {
        if (sdslen(argv[j])) {
            c->argv[c->argc] = createObject(REDIS_STRING,argv[j]);
            c->argc++;
        } else {
            sdsfree(argv[j]);
        }
    }
    zfree(argv);
    return REDIS_OK;
}

/* Helper function. Trims query buffer to make the function that processes
 * multi bulk requests idempotent. */
static void setProtocolError(redisClient *c, int pos) {
801 802 803 804 805 806
    if (server.verbosity >= REDIS_VERBOSE) {
        sds client = getClientInfoString(c);
        redisLog(REDIS_VERBOSE,
            "Protocol error from client: %s", client);
        sdsfree(client);
    }
807 808 809 810 811 812
    c->flags |= REDIS_CLOSE_AFTER_REPLY;
    c->querybuf = sdsrange(c->querybuf,pos,-1);
}

int processMultibulkBuffer(redisClient *c) {
    char *newline = NULL;
813 814
    int pos = 0, ok;
    long long ll;
815 816 817

    if (c->multibulklen == 0) {
        /* The client should have been reset */
818
        redisAssertWithInfo(c,NULL,c->argc == 0);
819 820

        /* Multi bulk length cannot be read without a \r\n */
821
        newline = strchr(c->querybuf,'\r');
822 823 824 825 826
        if (newline == NULL) {
            if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
                addReplyError(c,"Protocol error: too big mbulk count string");
                setProtocolError(c,0);
            }
827
            return REDIS_ERR;
828
        }
829

P
Pieter Noordhuis 已提交
830 831 832 833
        /* Buffer should also contain \n */
        if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
            return REDIS_ERR;

834 835
        /* We know for sure there is a whole line since newline != NULL,
         * so go ahead and find out the multi bulk length. */
836
        redisAssertWithInfo(c,NULL,c->querybuf[0] == '*');
837 838
        ok = string2ll(c->querybuf+1,newline-(c->querybuf+1),&ll);
        if (!ok || ll > 1024*1024) {
839 840 841
            addReplyError(c,"Protocol error: invalid multibulk length");
            setProtocolError(c,pos);
            return REDIS_ERR;
842
        }
P
Pieter Noordhuis 已提交
843 844 845 846 847 848 849

        pos = (newline-c->querybuf)+2;
        if (ll <= 0) {
            c->querybuf = sdsrange(c->querybuf,pos,-1);
            return REDIS_OK;
        }

850
        c->multibulklen = ll;
851 852 853 854 855 856

        /* Setup argv array on client structure */
        if (c->argv) zfree(c->argv);
        c->argv = zmalloc(sizeof(robj*)*c->multibulklen);
    }

857
    redisAssertWithInfo(c,NULL,c->multibulklen > 0);
858 859 860
    while(c->multibulklen) {
        /* Read bulk length if unknown */
        if (c->bulklen == -1) {
861
            newline = strchr(c->querybuf+pos,'\r');
862 863 864 865 866
            if (newline == NULL) {
                if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
                    addReplyError(c,"Protocol error: too big bulk count string");
                    setProtocolError(c,0);
                }
P
Pieter Noordhuis 已提交
867
                break;
868
            }
P
Pieter Noordhuis 已提交
869 870 871

            /* Buffer should also contain \n */
            if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
872
                break;
P
Pieter Noordhuis 已提交
873 874 875 876 877 878 879

            if (c->querybuf[pos] != '$') {
                addReplyErrorFormat(c,
                    "Protocol error: expected '$', got '%c'",
                    c->querybuf[pos]);
                setProtocolError(c,pos);
                return REDIS_ERR;
880
            }
P
Pieter Noordhuis 已提交
881 882 883 884 885 886 887 888 889

            ok = string2ll(c->querybuf+pos+1,newline-(c->querybuf+pos+1),&ll);
            if (!ok || ll < 0 || ll > 512*1024*1024) {
                addReplyError(c,"Protocol error: invalid bulk length");
                setProtocolError(c,pos);
                return REDIS_ERR;
            }

            pos += newline-(c->querybuf+pos)+2;
890
            if (ll >= REDIS_MBULK_BIG_ARG) {
891 892 893 894 895 896
                /* If we are going to read a large object from network
                 * try to make it likely that it will start at c->querybuf
                 * boundary so that we can optimized object creation
                 * avoiding a large copy of data. */
                c->querybuf = sdsrange(c->querybuf,pos,-1);
                pos = 0;
A
antirez 已提交
897 898
                /* Hint the sds library about the amount of bytes this string is
                 * going to contain. */
899
                c->querybuf = sdsMakeRoomFor(c->querybuf,ll+2);
A
antirez 已提交
900
            }
P
Pieter Noordhuis 已提交
901
            c->bulklen = ll;
902 903 904 905 906 907 908
        }

        /* Read bulk argument */
        if (sdslen(c->querybuf)-pos < (unsigned)(c->bulklen+2)) {
            /* Not enough data (+2 == trailing \r\n) */
            break;
        } else {
909 910 911 912
            /* Optimization: if the buffer contanins JUST our bulk element
             * instead of creating a new object by *copying* the sds we
             * just use the current sds string. */
            if (pos == 0 &&
913
                c->bulklen >= REDIS_MBULK_BIG_ARG &&
914 915 916 917 918 919 920 921 922 923 924 925 926 927
                (signed) sdslen(c->querybuf) == c->bulklen+2)
            {
                c->argv[c->argc++] = createObject(REDIS_STRING,c->querybuf);
                sdsIncrLen(c->querybuf,-2); /* remove CRLF */
                c->querybuf = sdsempty();
                /* Assume that if we saw a fat argument we'll see another one
                 * likely... */
                c->querybuf = sdsMakeRoomFor(c->querybuf,c->bulklen+2);
                pos = 0;
            } else {
                c->argv[c->argc++] =
                    createStringObject(c->querybuf+pos,c->bulklen);
                pos += c->bulklen+2;
            }
928 929 930 931 932 933
            c->bulklen = -1;
            c->multibulklen--;
        }
    }

    /* Trim to pos */
934
    if (pos) c->querybuf = sdsrange(c->querybuf,pos,-1);
935 936

    /* We're done when c->multibulk == 0 */
937 938 939
    if (c->multibulklen == 0) return REDIS_OK;

    /* Still not read to process the command */
940 941 942 943 944 945
    return REDIS_ERR;
}

void processInputBuffer(redisClient *c) {
    /* Keep processing while there is something in the input buffer */
    while(sdslen(c->querybuf)) {
946 947 948
        /* Immediately abort if the client is in the middle of something. */
        if (c->flags & REDIS_BLOCKED) return;

949 950 951 952
        /* REDIS_CLOSE_AFTER_REPLY closes the connection once the reply is
         * written to the client. Make sure to not let the reply grow after
         * this flag has been set (i.e. don't process more commands). */
        if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;
953 954 955 956 957

        /* Determine request type when unknown. */
        if (!c->reqtype) {
            if (c->querybuf[0] == '*') {
                c->reqtype = REDIS_REQ_MULTIBULK;
958
            } else {
959
                c->reqtype = REDIS_REQ_INLINE;
960 961
            }
        }
962 963 964 965 966 967 968

        if (c->reqtype == REDIS_REQ_INLINE) {
            if (processInlineBuffer(c) != REDIS_OK) break;
        } else if (c->reqtype == REDIS_REQ_MULTIBULK) {
            if (processMultibulkBuffer(c) != REDIS_OK) break;
        } else {
            redisPanic("Unknown request type");
969
        }
970 971

        /* Multibulk processing could see a <= 0 length. */
972 973 974 975 976 977 978
        if (c->argc == 0) {
            resetClient(c);
        } else {
            /* Only reset the client when the command was executed. */
            if (processCommand(c) == REDIS_OK)
                resetClient(c);
        }
979 980 981 982 983
    }
}

void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = (redisClient*) privdata;
984
    int nread, readlen;
985
    size_t qblen;
986 987 988
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

989
    server.current_client = c;
990 991 992 993 994 995 996 997
    readlen = REDIS_IOBUF_LEN;
    /* If this is a multi bulk request, and we are processing a bulk reply
     * that is large enough, try to maximize the probabilty that the query
     * buffer contains excatly the SDS string representing the object, even
     * at the risk of requring more read(2) calls. This way the function
     * processMultiBulkBuffer() can avoid copying buffers to create the
     * Redis Object representing the argument. */
    if (c->reqtype == REDIS_REQ_MULTIBULK && c->multibulklen && c->bulklen != -1
998
        && c->bulklen >= REDIS_MBULK_BIG_ARG)
999 1000 1001 1002 1003 1004
    {
        int remaining = (unsigned)(c->bulklen+2)-sdslen(c->querybuf);

        if (remaining < readlen) readlen = remaining;
    }

1005
    qblen = sdslen(c->querybuf);
1006
    if (c->querybuf_peak < qblen) c->querybuf_peak = qblen;
1007 1008
    c->querybuf = sdsMakeRoomFor(c->querybuf, readlen);
    nread = read(fd, c->querybuf+qblen, readlen);
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
    if (nread == -1) {
        if (errno == EAGAIN) {
            nread = 0;
        } else {
            redisLog(REDIS_VERBOSE, "Reading from client: %s",strerror(errno));
            freeClient(c);
            return;
        }
    } else if (nread == 0) {
        redisLog(REDIS_VERBOSE, "Client closed connection");
        freeClient(c);
        return;
    }
    if (nread) {
1023
        sdsIncrLen(c->querybuf,nread);
1024
        c->lastinteraction = server.unixtime;
1025
    } else {
1026
        server.current_client = NULL;
1027 1028
        return;
    }
1029
    if (sdslen(c->querybuf) > server.client_max_querybuf_len) {
1030 1031 1032 1033
        sds ci = getClientInfoString(c), bytes = sdsempty();

        bytes = sdscatrepr(bytes,c->querybuf,64);
        redisLog(REDIS_WARNING,"Closing client that reached max query buffer length: %s (qbuf initial bytes: %s)", ci, bytes);
1034
        sdsfree(ci);
1035
        sdsfree(bytes);
1036 1037 1038
        freeClient(c);
        return;
    }
1039
    processInputBuffer(c);
1040
    server.current_client = NULL;
1041
}
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060

void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer) {
    redisClient *c;
    listNode *ln;
    listIter li;
    unsigned long lol = 0, bib = 0;

    listRewind(server.clients,&li);
    while ((ln = listNext(&li)) != NULL) {
        c = listNodeValue(ln);

        if (listLength(c->reply) > lol) lol = listLength(c->reply);
        if (sdslen(c->querybuf) > bib) bib = sdslen(c->querybuf);
    }
    *longest_output_list = lol;
    *biggest_input_buffer = bib;
}

1061 1062
/* Turn a Redis client into an sds string representing its state. */
sds getClientInfoString(redisClient *client) {
1063
    char ip[32], flags[16], events[3], *p;
1064
    int port;
1065
    int emask;
1066

1067
    anetPeerToString(client->fd,ip,&port);
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
    p = flags;
    if (client->flags & REDIS_SLAVE) {
        if (client->flags & REDIS_MONITOR)
            *p++ = 'O';
        else
            *p++ = 'S';
    }
    if (client->flags & REDIS_MASTER) *p++ = 'M';
    if (client->flags & REDIS_MULTI) *p++ = 'x';
    if (client->flags & REDIS_BLOCKED) *p++ = 'b';
    if (client->flags & REDIS_DIRTY_CAS) *p++ = 'd';
    if (client->flags & REDIS_CLOSE_AFTER_REPLY) *p++ = 'c';
    if (client->flags & REDIS_UNBLOCKED) *p++ = 'u';
1081
    if (client->flags & REDIS_CLOSE_ASAP) *p++ = 'A';
1082
    if (p == flags) *p++ = 'N';
1083
    *p++ = '\0';
1084 1085 1086 1087 1088 1089

    emask = client->fd == -1 ? 0 : aeGetFileEvents(server.el,client->fd);
    p = events;
    if (emask & AE_READABLE) *p++ = 'r';
    if (emask & AE_WRITABLE) *p++ = 'w';
    *p = '\0';
1090
    return sdscatprintf(sdsempty(),
1091
        "addr=%s:%d fd=%d age=%ld idle=%ld flags=%s db=%d sub=%d psub=%d multi=%d qbuf=%lu qbuf-free=%lu obl=%lu oll=%lu omem=%lu events=%s cmd=%s",
1092
        ip,port,client->fd,
1093 1094
        (long)(server.unixtime - client->ctime),
        (long)(server.unixtime - client->lastinteraction),
1095 1096 1097
        flags,
        client->db->id,
        (int) dictSize(client->pubsub_channels),
1098
        (int) listLength(client->pubsub_patterns),
1099
        (client->flags & REDIS_MULTI) ? client->mstate.count : -1,
1100
        (unsigned long) sdslen(client->querybuf),
1101
        (unsigned long) sdsavail(client->querybuf),
1102
        (unsigned long) client->bufpos,
1103
        (unsigned long) listLength(client->reply),
1104
        getClientOutputBufferMemoryUsage(client),
1105 1106
        events,
        client->lastcmd ? client->lastcmd->name : "NULL");
1107 1108
}

1109 1110 1111 1112 1113 1114 1115 1116
sds getAllClientsInfoString(void) {
    listNode *ln;
    listIter li;
    redisClient *client;
    sds o = sdsempty();

    listRewind(server.clients,&li);
    while ((ln = listNext(&li)) != NULL) {
1117 1118
        sds cs;

1119
        client = listNodeValue(ln);
1120 1121 1122
        cs = getClientInfoString(client);
        o = sdscatsds(o,cs);
        sdsfree(cs);
1123 1124 1125 1126 1127
        o = sdscatlen(o,"\n",1);
    }
    return o;
}

A
antirez 已提交
1128
void clientCommand(redisClient *c) {
A
antirez 已提交
1129 1130 1131 1132
    listNode *ln;
    listIter li;
    redisClient *client;

A
antirez 已提交
1133
    if (!strcasecmp(c->argv[1]->ptr,"list") && c->argc == 2) {
1134
        sds o = getAllClientsInfoString();
A
antirez 已提交
1135 1136
        addReplyBulkCBuffer(c,o,sdslen(o));
        sdsfree(o);
A
antirez 已提交
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
    } else if (!strcasecmp(c->argv[1]->ptr,"kill") && c->argc == 3) {
        listRewind(server.clients,&li);
        while ((ln = listNext(&li)) != NULL) {
            char ip[32], addr[64];
            int port;

            client = listNodeValue(ln);
            if (anetPeerToString(client->fd,ip,&port) == -1) continue;
            snprintf(addr,sizeof(addr),"%s:%d",ip,port);
            if (strcmp(addr,c->argv[2]->ptr) == 0) {
                addReply(c,shared.ok);
                if (c == client) {
                    client->flags |= REDIS_CLOSE_AFTER_REPLY;
                } else {
                    freeClient(client);
                }
                return;
            }
        }
        addReplyError(c,"No such client");
A
antirez 已提交
1157 1158 1159 1160
    } else {
        addReplyError(c, "Syntax error, try CLIENT (LIST | KILL ip:port)");
    }
}
1161

1162 1163 1164
/* Rewrite the command vector of the client. All the new objects ref count
 * is incremented. The old command vector is freed, and the old objects
 * ref count is decremented. */
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
void rewriteClientCommandVector(redisClient *c, int argc, ...) {
    va_list ap;
    int j;
    robj **argv; /* The new argument vector */

    argv = zmalloc(sizeof(robj*)*argc);
    va_start(ap,argc);
    for (j = 0; j < argc; j++) {
        robj *a;
        
        a = va_arg(ap, robj*);
        argv[j] = a;
        incrRefCount(a);
    }
    /* We free the objects in the original vector at the end, so we are
     * sure that if the same objects are reused in the new vector the
     * refcount gets incremented before it gets decremented. */
    for (j = 0; j < c->argc; j++) decrRefCount(c->argv[j]);
    zfree(c->argv);
    /* Replace argv and argc with our new versions. */
    c->argv = argv;
    c->argc = argc;
1187
    c->cmd = lookupCommand(c->argv[0]->ptr);
1188
    redisAssertWithInfo(c,NULL,c->cmd != NULL);
1189 1190
    va_end(ap);
}
1191 1192 1193 1194 1195 1196

/* Rewrite a single item in the command vector.
 * The new val ref count is incremented, and the old decremented. */
void rewriteClientCommandArgument(redisClient *c, int i, robj *newval) {
    robj *oldval;
   
1197
    redisAssertWithInfo(c,NULL,i < c->argc);
1198 1199 1200 1201 1202 1203 1204 1205
    oldval = c->argv[i];
    c->argv[i] = newval;
    incrRefCount(newval);
    decrRefCount(oldval);

    /* If this is the command name make sure to fix c->cmd. */
    if (i == 0) {
        c->cmd = lookupCommand(c->argv[0]->ptr);
1206
        redisAssertWithInfo(c,NULL,c->cmd != NULL);
1207 1208
    }
}
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221

/* This function returns the number of bytes that Redis is virtually
 * using to store the reply still not read by the client.
 * It is "virtual" since the reply output list may contain objects that
 * are shared and are not really using additional memory.
 *
 * The function returns the total sum of the length of all the objects
 * stored in the output list, plus the memory used to allocate every
 * list node. The static reply buffer is not taken into account since it
 * is allocated anyway.
 *
 * Note: this function is very fast so can be called as many time as
 * the caller wishes. The main usage of this function currently is
A
antirez 已提交
1222
 * enforcing the client output length limits. */
1223
unsigned long getClientOutputBufferMemoryUsage(redisClient *c) {
1224
    unsigned long list_item_size = sizeof(listNode)+sizeof(robj);
1225 1226 1227

    return c->reply_bytes + (list_item_size*listLength(c->reply));
}
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242

/* Get the class of a client, used in order to envorce limits to different
 * classes of clients.
 *
 * The function will return one of the following:
 * REDIS_CLIENT_LIMIT_CLASS_NORMAL -> Normal client
 * REDIS_CLIENT_LIMIT_CLASS_SLAVE  -> Slave or client executing MONITOR command
 * REDIS_CLIENT_LIMIT_CLASS_PUBSUB -> Client subscribed to Pub/Sub channels
 */
int getClientLimitClass(redisClient *c) {
    if (c->flags & REDIS_SLAVE) return REDIS_CLIENT_LIMIT_CLASS_SLAVE;
    if (dictSize(c->pubsub_channels) || listLength(c->pubsub_patterns))
        return REDIS_CLIENT_LIMIT_CLASS_PUBSUB;
    return REDIS_CLIENT_LIMIT_CLASS_NORMAL;
}
1243

1244 1245 1246
int getClientLimitClassByName(char *name) {
    if (!strcasecmp(name,"normal")) return REDIS_CLIENT_LIMIT_CLASS_NORMAL;
    else if (!strcasecmp(name,"slave")) return REDIS_CLIENT_LIMIT_CLASS_SLAVE;
1247
    else if (!strcasecmp(name,"pubsub")) return REDIS_CLIENT_LIMIT_CLASS_PUBSUB;
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
    else return -1;
}

char *getClientLimitClassName(int class) {
    switch(class) {
    case REDIS_CLIENT_LIMIT_CLASS_NORMAL:   return "normal";
    case REDIS_CLIENT_LIMIT_CLASS_SLAVE:    return "slave";
    case REDIS_CLIENT_LIMIT_CLASS_PUBSUB:   return "pubsub";
    default:                                return NULL;
    }
}

1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
/* The function checks if the client reached output buffer soft or hard
 * limit, and also update the state needed to check the soft limit as
 * a side effect.
 *
 * Return value: non-zero if the client reached the soft or the hard limit.
 *               Otherwise zero is returned. */
int checkClientOutputBufferLimits(redisClient *c) {
    int soft = 0, hard = 0, class;
    unsigned long used_mem = getClientOutputBufferMemoryUsage(c);

    class = getClientLimitClass(c);
    if (server.client_obuf_limits[class].hard_limit_bytes &&
        used_mem >= server.client_obuf_limits[class].hard_limit_bytes)
        hard = 1;
    if (server.client_obuf_limits[class].soft_limit_bytes &&
        used_mem >= server.client_obuf_limits[class].soft_limit_bytes)
        soft = 1;

    /* We need to check if the soft limit is reached continuously for the
     * specified amount of seconds. */
    if (soft) {
        if (c->obuf_soft_limit_reached_time == 0) {
            c->obuf_soft_limit_reached_time = server.unixtime;
            soft = 0; /* First time we see the soft limit reached */
        } else {
            time_t elapsed = server.unixtime - c->obuf_soft_limit_reached_time;

            if (elapsed <=
                server.client_obuf_limits[class].soft_limit_seconds) {
                soft = 0; /* The client still did not reached the max number of
                             seconds for the soft limit to be considered
                             reached. */
            }
        }
    } else {
        c->obuf_soft_limit_reached_time = 0;
    }
    return soft || hard;
}

/* Asynchronously close a client if soft or hard limit is reached on the
1301 1302
 * output buffer size. The caller can check if the client will be closed
 * checking if the client REDIS_CLOSE_ASAP flag is set.
1303 1304 1305 1306
 *
 * Note: we need to close the client asynchronously because this function is
 * called from contexts where the client can't be freed safely, i.e. from the
 * lower level functions pushing data inside the client output buffers. */
1307
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c) {
1308
    redisAssert(c->reply_bytes < ULONG_MAX-(1024*64));
1309
    if (c->reply_bytes == 0 || c->flags & REDIS_CLOSE_ASAP) return;
1310 1311 1312 1313
    if (checkClientOutputBufferLimits(c)) {
        sds client = getClientInfoString(c);

        freeClientAsync(c);
1314
        redisLog(REDIS_WARNING,"Client %s scheduled to be closed ASAP for overcoming of output buffer limits.", client);
1315 1316 1317
        sdsfree(client);
    }
}
A
antirez 已提交
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338

/* Helper function used by freeMemoryIfNeeded() in order to flush slaves
 * output buffers without returning control to the event loop. */
void flushSlavesOutputBuffers(void) {
    listIter li;
    listNode *ln;

    listRewind(server.slaves,&li);
    while((ln = listNext(&li))) {
        redisClient *slave = listNodeValue(ln);
        int events;

        events = aeGetFileEvents(server.el,slave->fd);
        if (events & AE_WRITABLE &&
            slave->replstate == REDIS_REPL_ONLINE &&
            listLength(slave->reply))
        {
            sendReplyToClient(server.el,slave->fd,slave,0);
        }
    }
}