networking.c 44.3 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 14 15
void *dupClientReplyValue(void *o) {
    incrRefCount((robj*)o);
    return o;
}

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

redisClient *createClient(int fd) {
16
    redisClient *c = zmalloc(sizeof(redisClient));
17
    c->bufpos = 0;
18

19 20 21 22 23 24 25 26 27 28 29 30 31 32
    /* 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;
        }
33 34
    }

35 36 37
    selectDb(c,0);
    c->fd = fd;
    c->querybuf = sdsempty();
38
    c->reqtype = 0;
39 40
    c->argc = 0;
    c->argv = NULL;
41
    c->cmd = c->lastcmd = NULL;
42
    c->multibulklen = 0;
43 44 45 46 47 48 49
    c->bulklen = -1;
    c->sentlen = 0;
    c->flags = 0;
    c->lastinteraction = time(NULL);
    c->authenticated = 0;
    c->replstate = REDIS_REPL_NONE;
    c->reply = listCreate();
50
    c->reply_bytes = 0;
51
    c->obuf_soft_limit_reached_time = 0;
52 53
    listSetFreeMethod(c->reply,decrRefCount);
    listSetDupMethod(c->reply,dupClientReplyValue);
54 55 56 57
    c->bpop.keys = NULL;
    c->bpop.count = 0;
    c->bpop.timeout = 0;
    c->bpop.target = NULL;
58 59 60 61 62 63 64
    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);
65
    if (fd != -1) listAddNodeTail(server.clients,c);
66 67 68 69
    initClientMultiState(c);
    return c;
}

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
/* 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) {
85
    if (c->flags & REDIS_LUA_CLIENT) return REDIS_OK;
86
    if (c->fd <= 0) return REDIS_ERR; /* Fake client */
87
    if (c->bufpos == 0 && listLength(c->reply) == 0 &&
88 89 90
        (c->replstate == REDIS_REPL_NONE ||
         c->replstate == REDIS_REPL_ONLINE) &&
        aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
91 92 93 94
        sendReplyToClient, c) == AE_ERR) return REDIS_ERR;
    return REDIS_OK;
}

95 96 97 98 99 100 101 102 103 104 105 106 107 108
/* 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);
109 110
}

111 112 113 114
/* -----------------------------------------------------------------------------
 * Low level functions to add more data to output buffers.
 * -------------------------------------------------------------------------- */

115
int _addReplyToBuffer(redisClient *c, char *s, size_t len) {
116
    size_t available = sizeof(c->buf)-c->bufpos;
117

118 119
    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return REDIS_OK;

120 121 122 123 124 125
    /* 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;
126

127 128 129
    memcpy(c->buf+c->bufpos,s,len);
    c->bufpos+=len;
    return REDIS_OK;
130 131
}

132 133
void _addReplyObjectToList(redisClient *c, robj *o) {
    robj *tail;
134 135 136

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
    if (listLength(c->reply) == 0) {
        incrRefCount(o);
        listAddNodeTail(c->reply,o);
    } 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)
        {
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,o->ptr,sdslen(o->ptr));
        } else {
            incrRefCount(o);
            listAddNodeTail(c->reply,o);
        }
    }
154
    c->reply_bytes += sdslen(o->ptr);
155
    asyncCloseClientOnOutputBufferLimitReached(c);
156
}
157

158 159 160 161
/* 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;
162

163 164 165 166
    if (c->flags & REDIS_CLOSE_AFTER_REPLY) {
        sdsfree(s);
        return;
    }
167

168
    c->reply_bytes += sdslen(s);
169 170 171 172 173 174 175 176 177 178 179 180
    if (listLength(c->reply) == 0) {
        listAddNodeTail(c->reply,createObject(REDIS_STRING,s));
    } 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)
        {
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,s,sdslen(s));
            sdsfree(s);
181
        } else {
182
            listAddNodeTail(c->reply,createObject(REDIS_STRING,s));
183
        }
184
    }
185
    asyncCloseClientOnOutputBufferLimitReached(c);
186 187 188 189
}

void _addReplyStringToList(redisClient *c, char *s, size_t len) {
    robj *tail;
190 191 192

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

193 194
    if (listLength(c->reply) == 0) {
        listAddNodeTail(c->reply,createStringObject(s,len));
195
    } else {
196 197 198 199 200 201 202 203
        tail = listNodeValue(listLast(c->reply));

        /* Append to this object when possible. */
        if (tail->ptr != NULL &&
            sdslen(tail->ptr)+len <= REDIS_REPLY_CHUNK_BYTES)
        {
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,s,len);
204
        } else {
205
            listAddNodeTail(c->reply,createStringObject(s,len));
206 207
        }
    }
208
    c->reply_bytes += len;
209
    asyncCloseClientOnOutputBufferLimitReached(c);
210
}
211

212 213 214 215 216
/* -----------------------------------------------------------------------------
 * Higher level functions to queue data on the client output buffer.
 * The following functions are the ones that commands implementations will call.
 * -------------------------------------------------------------------------- */

217
void addReply(redisClient *c, robj *obj) {
218
    if (prepareClientToWrite(c) != REDIS_OK) return;
219 220 221 222 223 224 225 226 227 228 229

    /* 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);
230 231 232 233 234 235 236 237 238 239 240 241 242 243
    } 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. */
        }
244
        obj = getDecodedObject(obj);
245 246 247
        if (_addReplyToBuffer(c,obj->ptr,sdslen(obj->ptr)) != REDIS_OK)
            _addReplyObjectToList(c,obj);
        decrRefCount(obj);
248 249
    } else {
        redisPanic("Wrong obj->encoding in addReply()");
250 251 252 253
    }
}

void addReplySds(redisClient *c, sds s) {
254
    if (prepareClientToWrite(c) != REDIS_OK) {
255 256 257 258
        /* The caller expects the sds to be free'd. */
        sdsfree(s);
        return;
    }
259
    if (_addReplyToBuffer(c,s,sdslen(s)) == REDIS_OK) {
260 261
        sdsfree(s);
    } else {
262 263
        /* This method free's the sds when it is no longer needed. */
        _addReplySdsToList(c,s);
264
    }
265 266
}

267
void addReplyString(redisClient *c, char *s, size_t len) {
268
    if (prepareClientToWrite(c) != REDIS_OK) return;
269 270
    if (_addReplyToBuffer(c,s,len) != REDIS_OK)
        _addReplyStringToList(c,s,len);
271
}
272

273
void addReplyErrorLength(redisClient *c, char *s, size_t len) {
274 275 276
    addReplyString(c,"-ERR ",5);
    addReplyString(c,s,len);
    addReplyString(c,"\r\n",2);
277 278
}

279
void addReplyError(redisClient *c, char *err) {
280
    addReplyErrorLength(c,err,strlen(err));
281
}
282

283
void addReplyErrorFormat(redisClient *c, const char *fmt, ...) {
284
    size_t l, j;
285 286 287 288
    va_list ap;
    va_start(ap,fmt);
    sds s = sdscatvprintf(sdsempty(),fmt,ap);
    va_end(ap);
289 290 291 292 293 294
    /* 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] = ' ';
    }
295
    addReplyErrorLength(c,s,sdslen(s));
296 297 298
    sdsfree(s);
}

299
void addReplyStatusLength(redisClient *c, char *s, size_t len) {
300 301 302 303 304 305
    addReplyString(c,"+",1);
    addReplyString(c,s,len);
    addReplyString(c,"\r\n",2);
}

void addReplyStatus(redisClient *c, char *status) {
306
    addReplyStatusLength(c,status,strlen(status));
307 308 309 310 311 312 313
}

void addReplyStatusFormat(redisClient *c, const char *fmt, ...) {
    va_list ap;
    va_start(ap,fmt);
    sds s = sdscatvprintf(sdsempty(),fmt,ap);
    va_end(ap);
314
    addReplyStatusLength(c,s,sdslen(s));
315 316 317
    sdsfree(s);
}

318 319 320
/* 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) {
321 322 323
    /* 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. */
324
    if (prepareClientToWrite(c) != REDIS_OK) return NULL;
325
    listAddNodeTail(c->reply,createObject(REDIS_STRING,NULL));
326 327 328 329 330 331 332 333 334 335 336 337 338
    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);
339
    c->reply_bytes += sdslen(len->ptr);
340 341
    if (ln->next != NULL) {
        next = listNodeValue(ln->next);
342

343
        /* Only glue when the next node is non-NULL (an sds in this case) */
344
        if (next->ptr != NULL) {
345
            len->ptr = sdscatlen(len->ptr,next->ptr,sdslen(next->ptr));
346 347
            listDelNode(c->reply,ln->next);
        }
348
    }
349
    asyncCloseClientOnOutputBufferLimitReached(c);
350 351
}

352
/* Add a duble as a bulk reply */
353 354 355 356 357 358
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);
359 360
}

361 362
/* Add a long long as integer reply or bulk len / multi bulk count.
 * Basically this is used to output <prefix><long long><crlf>. */
363
void addReplyLongLongWithPrefix(redisClient *c, long long ll, char prefix) {
364
    char buf[128];
365
    int len;
366 367 368 369 370 371 372 373 374 375 376 377

    /* 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;
    }

378
    buf[0] = prefix;
379 380 381
    len = ll2string(buf+1,sizeof(buf)-1,ll);
    buf[len+1] = '\r';
    buf[len+2] = '\n';
382
    addReplyString(c,buf,len+3);
383 384
}

385
void addReplyLongLong(redisClient *c, long long ll) {
386 387 388 389 390
    if (ll == 0)
        addReply(c,shared.czero);
    else if (ll == 1)
        addReply(c,shared.cone);
    else
391
        addReplyLongLongWithPrefix(c,ll,':');
392
}
393

394
void addReplyMultiBulkLen(redisClient *c, long length) {
395
    addReplyLongLongWithPrefix(c,length,'*');
396 397
}

398
/* Create the length prefix of a bulk reply, example: $2234 */
399
void addReplyBulkLen(redisClient *c, robj *obj) {
400
    size_t len;
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416

    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++;
        }
    }
417
    addReplyLongLongWithPrefix(c,len,'$');
418 419
}

420
/* Add a Redis Object as a bulk reply */
421 422 423 424 425 426
void addReplyBulk(redisClient *c, robj *obj) {
    addReplyBulkLen(c,obj);
    addReply(c,obj);
    addReply(c,shared.crlf);
}

427 428
/* Add a C buffer as bulk reply */
void addReplyBulkCBuffer(redisClient *c, void *p, size_t len) {
429
    addReplyLongLongWithPrefix(c,len,'$');
430 431 432 433 434
    addReplyString(c,p,len);
    addReply(c,shared.crlf);
}

/* Add a C nul term string as bulk reply */
435 436 437 438
void addReplyBulkCString(redisClient *c, char *s) {
    if (s == NULL) {
        addReply(c,shared.nullbulk);
    } else {
439
        addReplyBulkCBuffer(c,s,strlen(s));
440 441 442
    }
}

443 444 445 446 447 448 449 450 451
/* 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);
}

452 453 454 455 456 457 458 459
/* 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;
460
    dst->reply_bytes = src->reply_bytes;
461 462
}

463
static void acceptCommonHandler(int fd) {
464
    redisClient *c;
465
    if ((c = createClient(fd)) == NULL) {
466
        redisLog(REDIS_WARNING,"Error allocating resoures for the client");
467
        close(fd); /* May be already closed, just ingore errors */
468 469 470 471 472 473
        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 */
474
    if (listLength(server.clients) > server.maxclients) {
475 476 477 478 479 480
        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... */
        }
481
        server.stat_rejected_conn++;
482 483 484 485 486 487
        freeClient(c);
        return;
    }
    server.stat_numconnections++;
}

488 489 490 491 492 493 494 495 496
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) {
497
        redisLog(REDIS_WARNING,"Accepting client connection: %s", server.neterr);
498 499 500 501 502 503 504 505 506 507 508 509
        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);

510
    cfd = anetUnixAccept(server.neterr, fd);
511
    if (cfd == AE_ERR) {
512
        redisLog(REDIS_WARNING,"Accepting client connection: %s", server.neterr);
513 514 515 516 517 518 519
        return;
    }
    redisLog(REDIS_VERBOSE,"Accepted connection to %s", server.unixsocket);
    acceptCommonHandler(cfd);
}


520 521 522 523 524
static void freeClientArgv(redisClient *c) {
    int j;
    for (j = 0; j < c->argc; j++)
        decrRefCount(c->argv[j]);
    c->argc = 0;
525
    c->cmd = NULL;
526 527 528 529 530
}

void freeClient(redisClient *c) {
    listNode *ln;

531 532 533
    /* If this is marked as current client unset it */
    if (server.current_client == c) server.current_client = NULL;

534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
    /* 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);
562 563 564 565 566 567 568
    /* 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);
    }
569
    listRelease(c->io_keys);
570 571
    /* Master/slave cleanup.
     * Case 1: we lost the connection with a slave. */
572 573 574 575 576 577 578 579
    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);
    }
580 581

    /* Case 2: we lost the connection with the master. */
582 583
    if (c->flags & REDIS_MASTER) {
        server.master = NULL;
A
antirez 已提交
584
        server.repl_state = REDIS_REPL_CONNECT;
585
        server.repl_down_since = time(NULL);
586 587 588 589
        /* Since we lost the connection with the master, we should also
         * close the connection with all our slaves if we have any, so
         * when we'll resync with the master the other slaves will sync again
         * with us as well. Note that also when the slave is not connected
590 591 592 593 594 595 596 597 598 599
         * to the master it will keep refusing connections by other slaves.
         *
         * We do this only if server.masterhost != NULL. If it is NULL this
         * means the user called SLAVEOF NO ONE and we are freeing our
         * link with the master, so no need to close link with slaves. */
        if (server.masterhost != NULL) {
            while (listLength(server.slaves)) {
                ln = listFirst(server.slaves);
                freeClient((redisClient*)ln->value);
            }
600
        }
601
    }
602 603 604 605 606 607 608 609 610

    /* 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);
    }

611 612 613 614 615 616
    /* Release memory */
    zfree(c->argv);
    freeClientMultiState(c);
    zfree(c);
}

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
/* 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);
    }
}

638 639 640 641 642 643 644
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = privdata;
    int nwritten = 0, totwritten = 0, objlen;
    robj *o;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
    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);
666

667 668 669 670
            if (objlen == 0) {
                listDelNode(c->reply,listFirst(c->reply));
                continue;
            }
671

672 673 674 675 676 677 678 679 680
            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;
681

682 683 684 685
            /* 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;
686
                c->reply_bytes -= objlen;
687
            }
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
        }
        /* Note that we avoid to send more thank REDIS_MAX_WRITE_PER_EVENT
         * 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
         * scenario think about 'KEYS *' against the loopback interfae) */
        if (totwritten > REDIS_MAX_WRITE_PER_EVENT) break;
    }
    if (nwritten == -1) {
        if (errno == EAGAIN) {
            nwritten = 0;
        } else {
            redisLog(REDIS_VERBOSE,
                "Error writing to client: %s", strerror(errno));
            freeClient(c);
            return;
        }
    }
    if (totwritten > 0) c->lastinteraction = time(NULL);
707
    if (c->bufpos == 0 && listLength(c->reply) == 0) {
708 709
        c->sentlen = 0;
        aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
P
Pieter Noordhuis 已提交
710 711

        /* Close connection after entire reply has been sent. */
712
        if (c->flags & REDIS_CLOSE_AFTER_REPLY) freeClient(c);
713 714 715 716 717 718
    }
}

/* resetClient prepare the client to process the next command */
void resetClient(redisClient *c) {
    freeClientArgv(c);
719 720
    c->reqtype = 0;
    c->multibulklen = 0;
721
    c->bulklen = -1;
722 723
    /* We clear the ASKING flag as well if we are not inside a MULTI. */
    if (!(c->flags & REDIS_MULTI)) c->flags &= (~REDIS_ASKING);
724 725 726 727 728 729 730 731 732 733 734 735 736 737
}

void closeTimedoutClients(void) {
    redisClient *c;
    listNode *ln;
    time_t now = time(NULL);
    listIter li;

    listRewind(server.clients,&li);
    while ((ln = listNext(&li)) != NULL) {
        c = listNodeValue(ln);
        if (server.maxidletime &&
            !(c->flags & REDIS_SLAVE) &&    /* no timeout for slaves */
            !(c->flags & REDIS_MASTER) &&   /* no timeout for masters */
738
            !(c->flags & REDIS_BLOCKED) &&  /* no timeout for BLPOP */
739 740 741 742 743 744 745
            dictSize(c->pubsub_channels) == 0 && /* no timeout for pubsub */
            listLength(c->pubsub_patterns) == 0 &&
            (now - c->lastinteraction > server.maxidletime))
        {
            redisLog(REDIS_VERBOSE,"Closing idle client");
            freeClient(c);
        } else if (c->flags & REDIS_BLOCKED) {
746
            if (c->bpop.timeout != 0 && c->bpop.timeout < now) {
747 748 749 750 751 752 753
                addReply(c,shared.nullmultibulk);
                unblockClientWaitingData(c);
            }
        }
    }
}

754 755 756 757 758 759 760
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 */
761 762 763 764 765
    if (newline == NULL) {
        if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
            addReplyError(c,"Protocol error: too big inline request");
            setProtocolError(c,0);
        }
766
        return REDIS_ERR;
767
    }
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795

    /* 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) {
796 797 798 799 800 801
    if (server.verbosity >= REDIS_VERBOSE) {
        sds client = getClientInfoString(c);
        redisLog(REDIS_VERBOSE,
            "Protocol error from client: %s", client);
        sdsfree(client);
    }
802 803 804 805 806 807
    c->flags |= REDIS_CLOSE_AFTER_REPLY;
    c->querybuf = sdsrange(c->querybuf,pos,-1);
}

int processMultibulkBuffer(redisClient *c) {
    char *newline = NULL;
808 809
    int pos = 0, ok;
    long long ll;
810 811 812

    if (c->multibulklen == 0) {
        /* The client should have been reset */
813
        redisAssertWithInfo(c,NULL,c->argc == 0);
814 815

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

P
Pieter Noordhuis 已提交
825 826 827 828
        /* Buffer should also contain \n */
        if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
            return REDIS_ERR;

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

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

845
        c->multibulklen = ll;
846 847 848 849 850 851

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

852
    redisAssertWithInfo(c,NULL,c->multibulklen > 0);
853 854 855
    while(c->multibulklen) {
        /* Read bulk length if unknown */
        if (c->bulklen == -1) {
856
            newline = strchr(c->querybuf+pos,'\r');
857 858 859 860 861
            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 已提交
862
                break;
863
            }
P
Pieter Noordhuis 已提交
864 865 866

            /* Buffer should also contain \n */
            if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
867
                break;
P
Pieter Noordhuis 已提交
868 869 870 871 872 873 874

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

            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;
885
            if (ll >= REDIS_MBULK_BIG_ARG) {
886 887 888 889 890 891
                /* 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 已提交
892 893
                /* Hint the sds library about the amount of bytes this string is
                 * going to contain. */
894
                c->querybuf = sdsMakeRoomFor(c->querybuf,ll+2);
A
antirez 已提交
895
            }
P
Pieter Noordhuis 已提交
896
            c->bulklen = ll;
897 898 899 900 901 902 903
        }

        /* Read bulk argument */
        if (sdslen(c->querybuf)-pos < (unsigned)(c->bulklen+2)) {
            /* Not enough data (+2 == trailing \r\n) */
            break;
        } else {
904 905 906 907
            /* 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 &&
908
                c->bulklen >= REDIS_MBULK_BIG_ARG &&
909 910 911 912 913 914 915 916 917 918 919 920 921 922
                (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;
            }
923 924 925 926 927 928
            c->bulklen = -1;
            c->multibulklen--;
        }
    }

    /* Trim to pos */
929
    if (pos) c->querybuf = sdsrange(c->querybuf,pos,-1);
930 931

    /* We're done when c->multibulk == 0 */
932 933 934
    if (c->multibulklen == 0) return REDIS_OK;

    /* Still not read to process the command */
935 936 937 938 939 940
    return REDIS_ERR;
}

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

944 945 946 947
        /* 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;
948 949 950 951 952

        /* Determine request type when unknown. */
        if (!c->reqtype) {
            if (c->querybuf[0] == '*') {
                c->reqtype = REDIS_REQ_MULTIBULK;
953
            } else {
954
                c->reqtype = REDIS_REQ_INLINE;
955 956
            }
        }
957 958 959 960 961 962 963

        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");
964
        }
965 966

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

void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = (redisClient*) privdata;
979
    int nread, readlen;
980
    size_t qblen;
981 982 983
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

984
    server.current_client = c;
985 986 987 988 989 990 991 992
    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
993
        && c->bulklen >= REDIS_MBULK_BIG_ARG)
994 995 996 997 998 999
    {
        int remaining = (unsigned)(c->bulklen+2)-sdslen(c->querybuf);

        if (remaining < readlen) readlen = remaining;
    }

1000
    qblen = sdslen(c->querybuf);
1001 1002
    c->querybuf = sdsMakeRoomFor(c->querybuf, readlen);
    nread = read(fd, c->querybuf+qblen, readlen);
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
    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) {
1017
        sdsIncrLen(c->querybuf,nread);
1018 1019
        c->lastinteraction = time(NULL);
    } else {
1020
        server.current_client = NULL;
1021 1022
        return;
    }
1023
    if (sdslen(c->querybuf) > server.client_max_querybuf_len) {
1024 1025 1026 1027
        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);
1028
        sdsfree(ci);
1029
        sdsfree(bytes);
1030 1031 1032
        freeClient(c);
        return;
    }
1033
    processInputBuffer(c);
1034
    server.current_client = NULL;
1035
}
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054

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;
}

1055 1056
/* Turn a Redis client into an sds string representing its state. */
sds getClientInfoString(redisClient *client) {
1057
    char ip[32], flags[16], events[3], *p;
1058 1059
    int port;
    time_t now = time(NULL);
1060
    int emask;
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079

    if (anetPeerToString(client->fd,ip,&port) == -1) {
        ip[0] = '?';
        ip[1] = '\0';
        port = 0;
    }
    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';
1080
    if (client->flags & REDIS_CLOSE_ASAP) *p++ = 'A';
1081
    if (p == flags) *p++ = 'N';
1082
    *p++ = '\0';
1083 1084 1085 1086 1087 1088

    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';
1089
    return sdscatprintf(sdsempty(),
1090
        "addr=%s:%d fd=%d idle=%ld flags=%s db=%d sub=%d psub=%d qbuf=%lu obl=%lu oll=%lu omem=%lu events=%s cmd=%s",
1091 1092 1093 1094 1095
        ip,port,client->fd,
        (long)(now - client->lastinteraction),
        flags,
        client->db->id,
        (int) dictSize(client->pubsub_channels),
1096 1097 1098
        (int) listLength(client->pubsub_patterns),
        (unsigned long) sdslen(client->querybuf),
        (unsigned long) client->bufpos,
1099
        (unsigned long) listLength(client->reply),
1100
        getClientOutputBufferMemoryUsage(client),
1101 1102
        events,
        client->lastcmd ? client->lastcmd->name : "NULL");
1103 1104
}

1105 1106 1107 1108 1109 1110 1111 1112
sds getAllClientsInfoString(void) {
    listNode *ln;
    listIter li;
    redisClient *client;
    sds o = sdsempty();

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

1115
        client = listNodeValue(ln);
1116 1117 1118
        cs = getClientInfoString(client);
        o = sdscatsds(o,cs);
        sdsfree(cs);
1119 1120 1121 1122 1123
        o = sdscatlen(o,"\n",1);
    }
    return o;
}

A
antirez 已提交
1124
void clientCommand(redisClient *c) {
A
antirez 已提交
1125 1126 1127 1128
    listNode *ln;
    listIter li;
    redisClient *client;

A
antirez 已提交
1129
    if (!strcasecmp(c->argv[1]->ptr,"list") && c->argc == 2) {
1130
        sds o = getAllClientsInfoString();
A
antirez 已提交
1131 1132
        addReplyBulkCBuffer(c,o,sdslen(o));
        sdsfree(o);
A
antirez 已提交
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
    } 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 已提交
1153 1154 1155 1156
    } else {
        addReplyError(c, "Syntax error, try CLIENT (LIST | KILL ip:port)");
    }
}
1157

1158 1159 1160
/* 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. */
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
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;
1183
    c->cmd = lookupCommand(c->argv[0]->ptr);
1184
    redisAssertWithInfo(c,NULL,c->cmd != NULL);
1185 1186
    va_end(ap);
}
1187 1188 1189 1190 1191 1192

/* 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;
   
1193
    redisAssertWithInfo(c,NULL,i < c->argc);
1194 1195 1196 1197 1198 1199 1200 1201
    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);
1202
        redisAssertWithInfo(c,NULL,c->cmd != NULL);
1203 1204
    }
}
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217

/* 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 已提交
1218
 * enforcing the client output length limits. */
1219 1220 1221 1222 1223
unsigned long getClientOutputBufferMemoryUsage(redisClient *c) {
    unsigned long list_item_size = sizeof(listNode);

    return c->reply_bytes + (list_item_size*listLength(c->reply));
}
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238

/* 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;
}
1239

1240 1241 1242
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;
1243
    else if (!strcasecmp(name,"pubsub")) return REDIS_CLIENT_LIMIT_CLASS_PUBSUB;
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
    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;
    }
}

1256 1257 1258 1259 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
/* 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
1297 1298
 * output buffer size. The caller can check if the client will be closed
 * checking if the client REDIS_CLOSE_ASAP flag is set.
1299 1300 1301 1302
 *
 * 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. */
1303 1304
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c) {
    if (c->flags & REDIS_CLOSE_ASAP) return;
1305 1306 1307 1308
    if (checkClientOutputBufferLimits(c)) {
        sds client = getClientInfoString(c);

        freeClientAsync(c);
1309
        redisLog(REDIS_WARNING,"Client %s scheduled to be closed ASAP for overcoming of output buffer limits.", client);
1310 1311 1312
        sdsfree(client);
    }
}