networking.c 52.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*
 * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Redis nor the names of its contributors may be used
 *     to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

30 31
#include "redis.h"
#include <sys/uio.h>
32
#include <math.h>
33

34 35
static void setProtocolError(redisClient *c, int pos);

36 37 38 39 40 41 42 43
/* 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));
}

44 45 46 47 48 49 50 51 52 53 54
/* Return the amount of memory used by the sds string at object->ptr
 * for a string object. */
size_t getStringObjectSdsUsedMemory(robj *o) {
    redisAssertWithInfo(NULL,o,o->type == REDIS_STRING);
    switch(o->encoding) {
    case REDIS_ENCODING_RAW: return zmalloc_size_sds(o->ptr);
    case REDIS_ENCODING_EMBSTR: return sdslen(o->ptr);
    default: return 0; /* Just integer encoding for now. */
    }
}

55 56 57 58 59 60 61 62 63 64
void *dupClientReplyValue(void *o) {
    incrRefCount((robj*)o);
    return o;
}

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

redisClient *createClient(int fd) {
65
    redisClient *c = zmalloc(sizeof(redisClient));
66

67 68 69 70 71 72
    /* 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);
73
        anetEnableTcpNoDelay(NULL,fd);
74 75
        if (server.tcpkeepalive)
            anetKeepAlive(NULL,fd,server.tcpkeepalive);
76 77 78 79 80 81 82
        if (aeCreateFileEvent(server.el,fd,AE_READABLE,
            readQueryFromClient, c) == AE_ERR)
        {
            close(fd);
            zfree(c);
            return NULL;
        }
83 84
    }

85 86
    selectDb(c,0);
    c->fd = fd;
87
    c->name = NULL;
88
    c->bufpos = 0;
89
    c->querybuf = sdsempty();
90
    c->querybuf_peak = 0;
91
    c->reqtype = 0;
92 93
    c->argc = 0;
    c->argv = NULL;
94
    c->cmd = c->lastcmd = NULL;
95
    c->multibulklen = 0;
96 97 98
    c->bulklen = -1;
    c->sentlen = 0;
    c->flags = 0;
99
    c->ctime = c->lastinteraction = server.unixtime;
100 101
    c->authenticated = 0;
    c->replstate = REDIS_REPL_NONE;
102
    c->reploff = 0;
A
antirez 已提交
103 104
    c->repl_ack_off = 0;
    c->repl_ack_time = 0;
A
antirez 已提交
105
    c->slave_listening_port = 0;
106
    c->reply = listCreate();
107
    c->reply_bytes = 0;
108
    c->obuf_soft_limit_reached_time = 0;
109
    listSetFreeMethod(c->reply,decrRefCountVoid);
110
    listSetDupMethod(c->reply,dupClientReplyValue);
111
    c->bpop.keys = dictCreate(&setDictType,NULL);
112 113
    c->bpop.timeout = 0;
    c->bpop.target = NULL;
114 115
    c->io_keys = listCreate();
    c->watched_keys = listCreate();
116
    listSetFreeMethod(c->io_keys,decrRefCountVoid);
117 118
    c->pubsub_channels = dictCreate(&setDictType,NULL);
    c->pubsub_patterns = listCreate();
119
    listSetFreeMethod(c->pubsub_patterns,decrRefCountVoid);
120
    listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
121
    if (fd != -1) listAddNodeTail(server.clients,c);
122 123 124 125
    initClientMultiState(c);
    return c;
}

126 127 128 129 130 131 132
/* 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.
 *
133 134
 * If the client should not receive new data, because it is a fake client,
 * a master, a slave not yet online, or because the setup of the write handler
135
 * failed, the function returns REDIS_ERR.
136 137 138 139 140
 *
 * 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) {
141
    if (c->flags & REDIS_LUA_CLIENT) return REDIS_OK;
142 143
    if ((c->flags & REDIS_MASTER) &&
        !(c->flags & REDIS_MASTER_FORCE_REPLY)) return REDIS_ERR;
144
    if (c->fd <= 0) return REDIS_ERR; /* Fake client */
145
    if (c->bufpos == 0 && listLength(c->reply) == 0 &&
146 147 148
        (c->replstate == REDIS_REPL_NONE ||
         c->replstate == REDIS_REPL_ONLINE) &&
        aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
149 150 151 152
        sendReplyToClient, c) == AE_ERR) return REDIS_ERR;
    return REDIS_OK;
}

153 154 155 156 157 158 159 160 161 162 163 164 165 166
/* 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);
167 168
}

169 170 171 172
/* -----------------------------------------------------------------------------
 * Low level functions to add more data to output buffers.
 * -------------------------------------------------------------------------- */

173
int _addReplyToBuffer(redisClient *c, char *s, size_t len) {
174
    size_t available = sizeof(c->buf)-c->bufpos;
175

176 177
    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return REDIS_OK;

178 179 180 181 182 183
    /* 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;
184

185 186 187
    memcpy(c->buf+c->bufpos,s,len);
    c->bufpos+=len;
    return REDIS_OK;
188 189
}

190 191
void _addReplyObjectToList(redisClient *c, robj *o) {
    robj *tail;
192 193 194

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

195 196 197
    if (listLength(c->reply) == 0) {
        incrRefCount(o);
        listAddNodeTail(c->reply,o);
198
        c->reply_bytes += getStringObjectSdsUsedMemory(o);
199 200 201 202 203
    } else {
        tail = listNodeValue(listLast(c->reply));

        /* Append to this object when possible. */
        if (tail->ptr != NULL &&
204
            tail->encoding == REDIS_ENCODING_RAW &&
205 206
            sdslen(tail->ptr)+sdslen(o->ptr) <= REDIS_REPLY_CHUNK_BYTES)
        {
207
            c->reply_bytes -= zmalloc_size_sds(tail->ptr);
208 209
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,o->ptr,sdslen(o->ptr));
210
            c->reply_bytes += zmalloc_size_sds(tail->ptr);
211 212 213
        } else {
            incrRefCount(o);
            listAddNodeTail(c->reply,o);
214
            c->reply_bytes += getStringObjectSdsUsedMemory(o);
215 216
        }
    }
217
    asyncCloseClientOnOutputBufferLimitReached(c);
218
}
219

220 221 222 223
/* 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;
224

225 226 227 228
    if (c->flags & REDIS_CLOSE_AFTER_REPLY) {
        sdsfree(s);
        return;
    }
229

230 231
    if (listLength(c->reply) == 0) {
        listAddNodeTail(c->reply,createObject(REDIS_STRING,s));
232
        c->reply_bytes += zmalloc_size_sds(s);
233 234 235 236
    } else {
        tail = listNodeValue(listLast(c->reply));

        /* Append to this object when possible. */
237
        if (tail->ptr != NULL && tail->encoding == REDIS_ENCODING_RAW &&
238 239
            sdslen(tail->ptr)+sdslen(s) <= REDIS_REPLY_CHUNK_BYTES)
        {
240
            c->reply_bytes -= zmalloc_size_sds(tail->ptr);
241 242
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,s,sdslen(s));
243
            c->reply_bytes += zmalloc_size_sds(tail->ptr);
244
            sdsfree(s);
245
        } else {
246
            listAddNodeTail(c->reply,createObject(REDIS_STRING,s));
247
            c->reply_bytes += zmalloc_size_sds(s);
248
        }
249
    }
250
    asyncCloseClientOnOutputBufferLimitReached(c);
251 252 253 254
}

void _addReplyStringToList(redisClient *c, char *s, size_t len) {
    robj *tail;
255 256 257

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

258
    if (listLength(c->reply) == 0) {
259 260 261
        robj *o = createStringObject(s,len);

        listAddNodeTail(c->reply,o);
262
        c->reply_bytes += getStringObjectSdsUsedMemory(o);
263
    } else {
264 265 266
        tail = listNodeValue(listLast(c->reply));

        /* Append to this object when possible. */
267
        if (tail->ptr != NULL && tail->encoding == REDIS_ENCODING_RAW &&
268 269
            sdslen(tail->ptr)+len <= REDIS_REPLY_CHUNK_BYTES)
        {
270
            c->reply_bytes -= zmalloc_size_sds(tail->ptr);
271 272
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,s,len);
273
            c->reply_bytes += zmalloc_size_sds(tail->ptr);
274
        } else {
275 276 277
            robj *o = createStringObject(s,len);

            listAddNodeTail(c->reply,o);
278
            c->reply_bytes += getStringObjectSdsUsedMemory(o);
279 280
        }
    }
281
    asyncCloseClientOnOutputBufferLimitReached(c);
282
}
283

284 285 286 287 288
/* -----------------------------------------------------------------------------
 * Higher level functions to queue data on the client output buffer.
 * The following functions are the ones that commands implementations will call.
 * -------------------------------------------------------------------------- */

289
void addReply(redisClient *c, robj *obj) {
290
    if (prepareClientToWrite(c) != REDIS_OK) return;
291 292 293 294 295 296 297 298

    /* 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. */
299
    if (sdsEncodedObject(obj)) {
300 301
        if (_addReplyToBuffer(c,obj->ptr,sdslen(obj->ptr)) != REDIS_OK)
            _addReplyObjectToList(c,obj);
302 303 304 305 306 307 308 309 310 311 312 313 314 315
    } 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. */
        }
316
        obj = getDecodedObject(obj);
317 318 319
        if (_addReplyToBuffer(c,obj->ptr,sdslen(obj->ptr)) != REDIS_OK)
            _addReplyObjectToList(c,obj);
        decrRefCount(obj);
320 321
    } else {
        redisPanic("Wrong obj->encoding in addReply()");
322 323 324 325
    }
}

void addReplySds(redisClient *c, sds s) {
326
    if (prepareClientToWrite(c) != REDIS_OK) {
327 328 329 330
        /* The caller expects the sds to be free'd. */
        sdsfree(s);
        return;
    }
331
    if (_addReplyToBuffer(c,s,sdslen(s)) == REDIS_OK) {
332 333
        sdsfree(s);
    } else {
334 335
        /* This method free's the sds when it is no longer needed. */
        _addReplySdsToList(c,s);
336
    }
337 338
}

339
void addReplyString(redisClient *c, char *s, size_t len) {
340
    if (prepareClientToWrite(c) != REDIS_OK) return;
341 342
    if (_addReplyToBuffer(c,s,len) != REDIS_OK)
        _addReplyStringToList(c,s,len);
343
}
344

345
void addReplyErrorLength(redisClient *c, char *s, size_t len) {
346 347 348
    addReplyString(c,"-ERR ",5);
    addReplyString(c,s,len);
    addReplyString(c,"\r\n",2);
349 350
}

351
void addReplyError(redisClient *c, char *err) {
352
    addReplyErrorLength(c,err,strlen(err));
353
}
354

355
void addReplyErrorFormat(redisClient *c, const char *fmt, ...) {
356
    size_t l, j;
357 358 359 360
    va_list ap;
    va_start(ap,fmt);
    sds s = sdscatvprintf(sdsempty(),fmt,ap);
    va_end(ap);
361 362 363 364 365 366
    /* 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] = ' ';
    }
367
    addReplyErrorLength(c,s,sdslen(s));
368 369 370
    sdsfree(s);
}

371
void addReplyStatusLength(redisClient *c, char *s, size_t len) {
372 373 374 375 376 377
    addReplyString(c,"+",1);
    addReplyString(c,s,len);
    addReplyString(c,"\r\n",2);
}

void addReplyStatus(redisClient *c, char *status) {
378
    addReplyStatusLength(c,status,strlen(status));
379 380 381 382 383 384 385
}

void addReplyStatusFormat(redisClient *c, const char *fmt, ...) {
    va_list ap;
    va_start(ap,fmt);
    sds s = sdscatvprintf(sdsempty(),fmt,ap);
    va_end(ap);
386
    addReplyStatusLength(c,s,sdslen(s));
387 388 389
    sdsfree(s);
}

390 391 392
/* 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) {
393 394 395
    /* 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. */
396
    if (prepareClientToWrite(c) != REDIS_OK) return NULL;
397
    listAddNodeTail(c->reply,createObject(REDIS_STRING,NULL));
398 399 400
    return listLast(c->reply);
}

G
guiquanz 已提交
401
/* Populate the length object and try gluing it to the next chunk. */
402 403 404 405 406 407 408 409 410
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);
411
    len->encoding = REDIS_ENCODING_RAW; /* in case it was an EMBSTR. */
412
    c->reply_bytes += zmalloc_size_sds(len->ptr);
413 414
    if (ln->next != NULL) {
        next = listNodeValue(ln->next);
415

416
        /* Only glue when the next node is non-NULL (an sds in this case) */
417
        if (next->ptr != NULL) {
418
            c->reply_bytes -= zmalloc_size_sds(len->ptr);
419
            c->reply_bytes -= getStringObjectSdsUsedMemory(next);
420
            len->ptr = sdscatlen(len->ptr,next->ptr,sdslen(next->ptr));
421
            c->reply_bytes += zmalloc_size_sds(len->ptr);
422 423
            listDelNode(c->reply,ln->next);
        }
424
    }
425
    asyncCloseClientOnOutputBufferLimitReached(c);
426 427
}

G
guiquanz 已提交
428
/* Add a double as a bulk reply */
429 430 431
void addReplyDouble(redisClient *c, double d) {
    char dbuf[128], sbuf[128];
    int dlen, slen;
432 433 434 435 436 437 438 439 440
    if (isinf(d)) {
        /* Libc in odd systems (Hi Solaris!) will format infinite in a
         * different way, so better to handle it in an explicit way. */
        addReplyBulkCString(c, d > 0 ? "inf" : "-inf");
    } else {
        dlen = snprintf(dbuf,sizeof(dbuf),"%.17g",d);
        slen = snprintf(sbuf,sizeof(sbuf),"$%d\r\n%s\r\n",dlen,dbuf);
        addReplyString(c,sbuf,slen);
    }
441 442
}

443 444
/* Add a long long as integer reply or bulk len / multi bulk count.
 * Basically this is used to output <prefix><long long><crlf>. */
445
void addReplyLongLongWithPrefix(redisClient *c, long long ll, char prefix) {
446
    char buf[128];
447
    int len;
448 449 450 451 452 453 454 455 456 457 458 459

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

460
    buf[0] = prefix;
461 462 463
    len = ll2string(buf+1,sizeof(buf)-1,ll);
    buf[len+1] = '\r';
    buf[len+2] = '\n';
464
    addReplyString(c,buf,len+3);
465 466
}

467
void addReplyLongLong(redisClient *c, long long ll) {
468 469 470 471 472
    if (ll == 0)
        addReply(c,shared.czero);
    else if (ll == 1)
        addReply(c,shared.cone);
    else
473
        addReplyLongLongWithPrefix(c,ll,':');
474
}
475

476
void addReplyMultiBulkLen(redisClient *c, long length) {
477 478 479 480
    if (length < REDIS_SHARED_BULKHDR_LEN)
        addReply(c,shared.mbulkhdr[length]);
    else
        addReplyLongLongWithPrefix(c,length,'*');
481 482
}

483
/* Create the length prefix of a bulk reply, example: $2234 */
484
void addReplyBulkLen(redisClient *c, robj *obj) {
485
    size_t len;
486

487
    if (sdsEncodedObject(obj)) {
488 489 490 491 492 493 494 495 496 497 498 499 500 501
        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++;
        }
    }
502 503 504 505 506

    if (len < REDIS_SHARED_BULKHDR_LEN)
        addReply(c,shared.bulkhdr[len]);
    else
        addReplyLongLongWithPrefix(c,len,'$');
507 508
}

509
/* Add a Redis Object as a bulk reply */
510 511 512 513 514 515
void addReplyBulk(redisClient *c, robj *obj) {
    addReplyBulkLen(c,obj);
    addReply(c,obj);
    addReply(c,shared.crlf);
}

516 517
/* Add a C buffer as bulk reply */
void addReplyBulkCBuffer(redisClient *c, void *p, size_t len) {
518
    addReplyLongLongWithPrefix(c,len,'$');
519 520 521 522 523
    addReplyString(c,p,len);
    addReply(c,shared.crlf);
}

/* Add a C nul term string as bulk reply */
524 525 526 527
void addReplyBulkCString(redisClient *c, char *s) {
    if (s == NULL) {
        addReply(c,shared.nullbulk);
    } else {
528
        addReplyBulkCBuffer(c,s,strlen(s));
529 530 531
    }
}

532 533 534 535 536 537 538 539 540
/* 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);
}

541 542 543 544 545 546 547 548
/* 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;
549
    dst->reply_bytes = src->reply_bytes;
550 551
}

552
static void acceptCommonHandler(int fd, int flags) {
553
    redisClient *c;
554
    if ((c = createClient(fd)) == NULL) {
555 556 557
        redisLog(REDIS_WARNING,
            "Error registering fd event for the new client: %s (fd=%d)",
            strerror(errno),fd);
558
        close(fd); /* May be already closed, just ignore errors */
559 560 561 562
        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
G
guiquanz 已提交
563
     * for this condition, since now the socket is already set in non-blocking
564
     * mode and we can send an error for free using the Kernel I/O */
565
    if (listLength(server.clients) > server.maxclients) {
566 567 568 569 570 571
        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... */
        }
572
        server.stat_rejected_conn++;
573 574 575 576
        freeClient(c);
        return;
    }
    server.stat_numconnections++;
577
    c->flags |= flags;
578 579
}

580 581
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    int cport, cfd;
582
    char cip[REDIS_IP_STR_LEN];
583 584 585 586
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

587
    cfd = anetTcpAccept(server.neterr, fd, cip, sizeof(cip), &cport);
588
    if (cfd == AE_ERR) {
589
        redisLog(REDIS_WARNING,"Accepting client connection: %s", server.neterr);
590 591 592
        return;
    }
    redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
593
    acceptCommonHandler(cfd,0);
594 595 596 597 598 599 600 601
}

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

602
    cfd = anetUnixAccept(server.neterr, fd);
603
    if (cfd == AE_ERR) {
604
        redisLog(REDIS_WARNING,"Accepting client connection: %s", server.neterr);
605 606 607
        return;
    }
    redisLog(REDIS_VERBOSE,"Accepted connection to %s", server.unixsocket);
608
    acceptCommonHandler(cfd,REDIS_UNIX_SOCKET);
609 610 611
}


612 613 614 615 616
static void freeClientArgv(redisClient *c) {
    int j;
    for (j = 0; j < c->argc; j++)
        decrRefCount(c->argv[j]);
    c->argc = 0;
617
    c->cmd = NULL;
618 619
}

620 621 622 623 624 625 626 627 628 629
/* 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);
    }
}

630 631 632 633 634 635 636 637 638 639 640 641 642 643
/* This function is called when the slave lose the connection with the
 * master into an unexpected way. */
void replicationHandleMasterDisconnection(void) {
    server.master = NULL;
    server.repl_state = REDIS_REPL_CONNECT;
    server.repl_down_since = server.unixtime;
    /* We lost connection with our master, force our slaves to resync
     * with us as well to load the new data set.
     *
     * If server.masterhost is NULL the user called SLAVEOF NO ONE so
     * slave resync is not needed. */
    if (server.masterhost != NULL) disconnectSlaves();
}

644 645 646
void freeClient(redisClient *c) {
    listNode *ln;

647 648 649
    /* If this is marked as current client unset it */
    if (server.current_client == c) server.current_client = NULL;

650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
    /* If it is our master that's beging disconnected we should make sure
     * to cache the state to try a partial resynchronization later.
     *
     * Note that before doing this we make sure that the client is not in
     * some unexpected state, by checking its flags. */
    if (server.master &&
         (c->flags & REDIS_MASTER) &&
        !(c->flags & (REDIS_CLOSE_AFTER_REPLY|
                     REDIS_CLOSE_ASAP|
                     REDIS_BLOCKED|
                     REDIS_UNBLOCKED)))
    {
        replicationCacheMaster(c);
        return;
    }

666 667 668 669 670 671 672 673 674
    /* 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);
675
    dictRelease(c->bpop.keys);
676 677 678 679 680 681 682 683 684

    /* 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);
685 686 687 688 689 690 691
    /* Close socket, unregister events, and remove list of replies and
     * accumulated arguments. */
    if (c->fd != -1) {
        aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
        aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
        close(c->fd);
    }
692 693 694
    listRelease(c->reply);
    freeClientArgv(c);
    /* Remove from the list of clients */
695 696 697 698 699
    if (c->fd != -1) {
        ln = listSearchKey(server.clients,c);
        redisAssert(ln != NULL);
        listDelNode(server.clients,ln);
    }
700 701 702 703 704 705 706
    /* 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);
    }
707
    listRelease(c->io_keys);
708 709
    /* Master/slave cleanup.
     * Case 1: we lost the connection with a slave. */
710
    if (c->flags & REDIS_SLAVE) {
711 712 713 714
        if (c->replstate == REDIS_REPL_SEND_BULK) {
            if (c->repldbfd != -1) close(c->repldbfd);
            if (c->replpreamble) sdsfree(c->replpreamble);
        }
715 716 717 718
        list *l = (c->flags & REDIS_MONITOR) ? server.monitors : server.slaves;
        ln = listSearchKey(l,c);
        redisAssert(ln != NULL);
        listDelNode(l,ln);
719 720 721 722 723
        /* We need to remember the time when we started to have zero
         * attached slaves, as after some time we'll free the replication
         * backlog. */
        if (c->flags & REDIS_SLAVE && listLength(server.slaves) == 0)
            server.repl_no_slaves_since = server.unixtime;
724
        refreshGoodSlavesCount();
725
    }
726 727

    /* Case 2: we lost the connection with the master. */
728
    if (c->flags & REDIS_MASTER) replicationHandleMasterDisconnection();
729 730 731 732 733 734 735 736 737

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

738
    /* Release memory */
739
    if (c->name) decrRefCount(c->name);
740 741 742 743 744
    zfree(c->argv);
    freeClientMultiState(c);
    zfree(c);
}

745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
/* 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);
    }
}

766 767 768
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = privdata;
    int nwritten = 0, totwritten = 0, objlen;
769
    size_t objmem;
770 771 772 773
    robj *o;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

774 775
    while(c->bufpos > 0 || listLength(c->reply)) {
        if (c->bufpos > 0) {
776 777
            nwritten = write(fd,c->buf+c->sentlen,c->bufpos-c->sentlen);
            if (nwritten <= 0) break;
778 779 780 781 782 783 784 785 786 787 788 789
            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);
790
            objmem = getStringObjectSdsUsedMemory(o);
791

792 793
            if (objlen == 0) {
                listDelNode(c->reply,listFirst(c->reply));
794
                c->reply_bytes -= objmem;
795 796
                continue;
            }
797

798 799
            nwritten = write(fd, ((char*)o->ptr)+c->sentlen,objlen-c->sentlen);
            if (nwritten <= 0) break;
800 801
            c->sentlen += nwritten;
            totwritten += nwritten;
802

803 804 805 806
            /* 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;
807
                c->reply_bytes -= objmem;
808
            }
809
        }
810
        /* Note that we avoid to send more than REDIS_MAX_WRITE_PER_EVENT
811 812 813
         * 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
814 815 816 817 818 819 820
         * 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;
821 822 823 824 825 826 827 828 829 830 831
    }
    if (nwritten == -1) {
        if (errno == EAGAIN) {
            nwritten = 0;
        } else {
            redisLog(REDIS_VERBOSE,
                "Error writing to client: %s", strerror(errno));
            freeClient(c);
            return;
        }
    }
832
    if (totwritten > 0) c->lastinteraction = server.unixtime;
833
    if (c->bufpos == 0 && listLength(c->reply) == 0) {
834 835
        c->sentlen = 0;
        aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
P
Pieter Noordhuis 已提交
836 837

        /* Close connection after entire reply has been sent. */
838
        if (c->flags & REDIS_CLOSE_AFTER_REPLY) freeClient(c);
839 840 841 842 843
    }
}

/* resetClient prepare the client to process the next command */
void resetClient(redisClient *c) {
844 845
    redisCommandProc *prevcmd = c->cmd ? c->cmd->proc : NULL;

846
    freeClientArgv(c);
847 848
    c->reqtype = 0;
    c->multibulklen = 0;
849
    c->bulklen = -1;
850 851 852 853
    /* We clear the ASKING flag as well if we are not inside a MULTI, and
     * if what we just executed is not the ASKING command itself. */
    if (!(c->flags & REDIS_MULTI) && prevcmd != askingCommand)
        c->flags &= (~REDIS_ASKING);
854 855
}

856 857 858
int processInlineBuffer(redisClient *c) {
    char *newline = strstr(c->querybuf,"\r\n");
    int argc, j;
859
    sds *argv, aux;
860 861 862
    size_t querylen;

    /* Nothing to do without a \r\n */
863 864 865 866 867
    if (newline == NULL) {
        if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
            addReplyError(c,"Protocol error: too big inline request");
            setProtocolError(c,0);
        }
868
        return REDIS_ERR;
869
    }
870 871 872

    /* Split the input buffer up to the \r\n */
    querylen = newline-(c->querybuf);
873 874 875
    aux = sdsnewlen(c->querybuf,querylen);
    argv = sdssplitargs(aux,&argc);
    sdsfree(aux);
876 877

    /* Leave data after the first line of the query in the buffer */
878
    sdsrange(c->querybuf,querylen+2,-1);
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899

    /* 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) {
900 901 902 903 904 905
    if (server.verbosity >= REDIS_VERBOSE) {
        sds client = getClientInfoString(c);
        redisLog(REDIS_VERBOSE,
            "Protocol error from client: %s", client);
        sdsfree(client);
    }
906
    c->flags |= REDIS_CLOSE_AFTER_REPLY;
907
    sdsrange(c->querybuf,pos,-1);
908 909 910 911
}

int processMultibulkBuffer(redisClient *c) {
    char *newline = NULL;
912 913
    int pos = 0, ok;
    long long ll;
914 915 916

    if (c->multibulklen == 0) {
        /* The client should have been reset */
917
        redisAssertWithInfo(c,NULL,c->argc == 0);
918 919

        /* Multi bulk length cannot be read without a \r\n */
920
        newline = strchr(c->querybuf,'\r');
921 922 923 924 925
        if (newline == NULL) {
            if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
                addReplyError(c,"Protocol error: too big mbulk count string");
                setProtocolError(c,0);
            }
926
            return REDIS_ERR;
927
        }
928

P
Pieter Noordhuis 已提交
929 930 931 932
        /* Buffer should also contain \n */
        if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
            return REDIS_ERR;

933 934
        /* We know for sure there is a whole line since newline != NULL,
         * so go ahead and find out the multi bulk length. */
935
        redisAssertWithInfo(c,NULL,c->querybuf[0] == '*');
936 937
        ok = string2ll(c->querybuf+1,newline-(c->querybuf+1),&ll);
        if (!ok || ll > 1024*1024) {
938 939 940
            addReplyError(c,"Protocol error: invalid multibulk length");
            setProtocolError(c,pos);
            return REDIS_ERR;
941
        }
P
Pieter Noordhuis 已提交
942 943 944

        pos = (newline-c->querybuf)+2;
        if (ll <= 0) {
945
            sdsrange(c->querybuf,pos,-1);
P
Pieter Noordhuis 已提交
946 947 948
            return REDIS_OK;
        }

949
        c->multibulklen = ll;
950 951 952 953 954 955

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

956
    redisAssertWithInfo(c,NULL,c->multibulklen > 0);
957 958 959
    while(c->multibulklen) {
        /* Read bulk length if unknown */
        if (c->bulklen == -1) {
960
            newline = strchr(c->querybuf+pos,'\r');
961 962 963 964 965
            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 已提交
966
                break;
967
            }
P
Pieter Noordhuis 已提交
968 969 970

            /* Buffer should also contain \n */
            if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
971
                break;
P
Pieter Noordhuis 已提交
972 973 974 975 976 977 978

            if (c->querybuf[pos] != '$') {
                addReplyErrorFormat(c,
                    "Protocol error: expected '$', got '%c'",
                    c->querybuf[pos]);
                setProtocolError(c,pos);
                return REDIS_ERR;
979
            }
P
Pieter Noordhuis 已提交
980 981 982 983 984 985 986 987 988

            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;
989
            if (ll >= REDIS_MBULK_BIG_ARG) {
990 991 992 993
                /* 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. */
994
                sdsrange(c->querybuf,pos,-1);
995
                pos = 0;
A
antirez 已提交
996 997
                /* Hint the sds library about the amount of bytes this string is
                 * going to contain. */
998
                c->querybuf = sdsMakeRoomFor(c->querybuf,ll+2);
A
antirez 已提交
999
            }
P
Pieter Noordhuis 已提交
1000
            c->bulklen = ll;
1001 1002 1003 1004 1005 1006 1007
        }

        /* Read bulk argument */
        if (sdslen(c->querybuf)-pos < (unsigned)(c->bulklen+2)) {
            /* Not enough data (+2 == trailing \r\n) */
            break;
        } else {
1008
            /* Optimization: if the buffer contains JUST our bulk element
1009 1010 1011
             * instead of creating a new object by *copying* the sds we
             * just use the current sds string. */
            if (pos == 0 &&
1012
                c->bulklen >= REDIS_MBULK_BIG_ARG &&
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
                (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;
            }
1027 1028 1029 1030 1031 1032
            c->bulklen = -1;
            c->multibulklen--;
        }
    }

    /* Trim to pos */
1033
    if (pos) sdsrange(c->querybuf,pos,-1);
1034 1035

    /* We're done when c->multibulk == 0 */
1036 1037 1038
    if (c->multibulklen == 0) return REDIS_OK;

    /* Still not read to process the command */
1039 1040 1041 1042 1043 1044
    return REDIS_ERR;
}

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

1048 1049 1050 1051
        /* 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;
1052 1053 1054 1055 1056

        /* Determine request type when unknown. */
        if (!c->reqtype) {
            if (c->querybuf[0] == '*') {
                c->reqtype = REDIS_REQ_MULTIBULK;
1057
            } else {
1058
                c->reqtype = REDIS_REQ_INLINE;
1059 1060
            }
        }
1061 1062 1063 1064 1065 1066 1067

        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");
1068
        }
1069 1070

        /* Multibulk processing could see a <= 0 length. */
1071 1072 1073 1074 1075 1076 1077
        if (c->argc == 0) {
            resetClient(c);
        } else {
            /* Only reset the client when the command was executed. */
            if (processCommand(c) == REDIS_OK)
                resetClient(c);
        }
1078 1079 1080 1081 1082
    }
}

void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = (redisClient*) privdata;
1083
    int nread, readlen;
1084
    size_t qblen;
1085 1086 1087
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1088
    server.current_client = c;
1089 1090
    readlen = REDIS_IOBUF_LEN;
    /* If this is a multi bulk request, and we are processing a bulk reply
1091 1092 1093
     * that is large enough, try to maximize the probability that the query
     * buffer contains exactly the SDS string representing the object, even
     * at the risk of requiring more read(2) calls. This way the function
1094 1095 1096
     * processMultiBulkBuffer() can avoid copying buffers to create the
     * Redis Object representing the argument. */
    if (c->reqtype == REDIS_REQ_MULTIBULK && c->multibulklen && c->bulklen != -1
1097
        && c->bulklen >= REDIS_MBULK_BIG_ARG)
1098 1099 1100 1101 1102 1103
    {
        int remaining = (unsigned)(c->bulklen+2)-sdslen(c->querybuf);

        if (remaining < readlen) readlen = remaining;
    }

1104
    qblen = sdslen(c->querybuf);
1105
    if (c->querybuf_peak < qblen) c->querybuf_peak = qblen;
1106 1107
    c->querybuf = sdsMakeRoomFor(c->querybuf, readlen);
    nread = read(fd, c->querybuf+qblen, readlen);
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
    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) {
1122
        sdsIncrLen(c->querybuf,nread);
1123
        c->lastinteraction = server.unixtime;
1124
        if (c->flags & REDIS_MASTER) c->reploff += nread;
1125
    } else {
1126
        server.current_client = NULL;
1127 1128
        return;
    }
1129
    if (sdslen(c->querybuf) > server.client_max_querybuf_len) {
1130 1131 1132 1133
        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);
1134
        sdsfree(ci);
1135
        sdsfree(bytes);
1136 1137 1138
        freeClient(c);
        return;
    }
1139
    processInputBuffer(c);
1140
    server.current_client = NULL;
1141
}
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160

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

1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
/* This is an helper function for getClientPeerId().
 * It writes the specified ip/port to "peerid" as a null termiated string
 * in the form ip:port if ip does not contain ":" itself, otherwise
 * [ip]:port format is used (for IPv6 addresses basically). */
void formatPeerId(char *peerid, size_t peerid_len, char *ip, int port) {
    if (strchr(ip,':'))
        snprintf(peerid,peerid_len,"[%s]:%d",ip,port);
    else
        snprintf(peerid,peerid_len,"%s:%d",ip,port);
}

A
antirez 已提交
1172 1173 1174 1175 1176 1177 1178 1179
/* A Redis "Peer ID" is a colon separated ip:port pair.
 * For IPv4 it's in the form x.y.z.k:pork, example: "127.0.0.1:1234".
 * For IPv6 addresses we use [] around the IP part, like in "[::1]:1234".
 * For Unix socekts we use path:0, like in "/tmp/redis:0".
 *
 * A Peer ID always fits inside a buffer of REDIS_PEER_ID_LEN bytes, including
 * the null term.
 *
A
antirez 已提交
1180 1181 1182 1183 1184 1185
 * The function returns REDIS_OK on succcess, and REDIS_ERR on failure.
 *
 * On failure the function still populates 'peerid' with the "?:0" string
 * in case you want to relax error checking or need to display something
 * anyway (see anetPeerToString implementation for more info). */
int getClientPeerId(redisClient *client, char *peerid, size_t peerid_len) {
A
antirez 已提交
1186 1187 1188 1189 1190 1191
    char ip[REDIS_IP_STR_LEN];
    int port;

    if (client->flags & REDIS_UNIX_SOCKET) {
        /* Unix socket client. */
        snprintf(peerid,peerid_len,"%s:0",server.unixsocket);
A
antirez 已提交
1192
        return REDIS_OK;
A
antirez 已提交
1193 1194
    } else {
        /* TCP client. */
A
antirez 已提交
1195
        int retval = anetPeerToString(client->fd,ip,sizeof(ip),&port);
1196
        formatPeerId(peerid,peerid_len,ip,port);
A
antirez 已提交
1197
        return (retval == -1) ? REDIS_ERR : REDIS_OK;
A
antirez 已提交
1198 1199 1200
    }
}

1201 1202
/* Turn a Redis client into an sds string representing its state. */
sds getClientInfoString(redisClient *client) {
A
antirez 已提交
1203
    char peerid[REDIS_PEER_ID_LEN], flags[16], events[3], *p;
1204
    int emask;
1205

A
antirez 已提交
1206
    getClientPeerId(client,peerid,sizeof(peerid));
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
    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';
1220
    if (client->flags & REDIS_CLOSE_ASAP) *p++ = 'A';
1221
    if (client->flags & REDIS_UNIX_SOCKET) *p++ = 'U';
1222
    if (p == flags) *p++ = 'N';
1223
    *p++ = '\0';
1224 1225 1226 1227 1228 1229

    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';
1230
    return sdscatprintf(sdsempty(),
A
antirez 已提交
1231 1232
        "addr=%s fd=%d name=%s 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",
        peerid,
1233 1234
        client->fd,
        client->name ? (char*)client->name->ptr : "",
1235 1236
        (long)(server.unixtime - client->ctime),
        (long)(server.unixtime - client->lastinteraction),
1237 1238 1239
        flags,
        client->db->id,
        (int) dictSize(client->pubsub_channels),
1240
        (int) listLength(client->pubsub_patterns),
1241
        (client->flags & REDIS_MULTI) ? client->mstate.count : -1,
1242
        (unsigned long) sdslen(client->querybuf),
1243
        (unsigned long) sdsavail(client->querybuf),
1244
        (unsigned long) client->bufpos,
1245
        (unsigned long) listLength(client->reply),
1246
        getClientOutputBufferMemoryUsage(client),
1247 1248
        events,
        client->lastcmd ? client->lastcmd->name : "NULL");
1249 1250
}

1251 1252 1253 1254 1255 1256 1257 1258
sds getAllClientsInfoString(void) {
    listNode *ln;
    listIter li;
    redisClient *client;
    sds o = sdsempty();

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

1261
        client = listNodeValue(ln);
1262 1263 1264
        cs = getClientInfoString(client);
        o = sdscatsds(o,cs);
        sdsfree(cs);
1265 1266 1267 1268 1269
        o = sdscatlen(o,"\n",1);
    }
    return o;
}

A
antirez 已提交
1270
void clientCommand(redisClient *c) {
A
antirez 已提交
1271 1272 1273 1274
    listNode *ln;
    listIter li;
    redisClient *client;

A
antirez 已提交
1275
    if (!strcasecmp(c->argv[1]->ptr,"list") && c->argc == 2) {
1276
        sds o = getAllClientsInfoString();
A
antirez 已提交
1277 1278
        addReplyBulkCBuffer(c,o,sdslen(o));
        sdsfree(o);
A
antirez 已提交
1279 1280 1281
    } else if (!strcasecmp(c->argv[1]->ptr,"kill") && c->argc == 3) {
        listRewind(server.clients,&li);
        while ((ln = listNext(&li)) != NULL) {
A
antirez 已提交
1282
            char peerid[REDIS_PEER_ID_LEN];
A
antirez 已提交
1283 1284

            client = listNodeValue(ln);
A
antirez 已提交
1285 1286 1287
            if (getClientPeerId(client,peerid,sizeof(peerid)) == REDIS_ERR)
                continue;
            if (strcmp(peerid,c->argv[2]->ptr) == 0) {
A
antirez 已提交
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
                addReply(c,shared.ok);
                if (c == client) {
                    client->flags |= REDIS_CLOSE_AFTER_REPLY;
                } else {
                    freeClient(client);
                }
                return;
            }
        }
        addReplyError(c,"No such client");
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
    } else if (!strcasecmp(c->argv[1]->ptr,"setname") && c->argc == 3) {
        int j, len = sdslen(c->argv[2]->ptr);
        char *p = c->argv[2]->ptr;

        /* Setting the client name to an empty string actually removes
         * the current name. */
        if (len == 0) {
            if (c->name) decrRefCount(c->name);
            c->name = NULL;
            addReply(c,shared.ok);
            return;
        }

        /* Otherwise check if the charset is ok. We need to do this otherwise
         * CLIENT LIST format will break. You should always be able to
         * split by space to get the different fields. */
        for (j = 0; j < len; j++) {
A
antirez 已提交
1315
            if (p[j] < '!' || p[j] > '~') { /* ASCII is assumed. */
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330
                addReplyError(c,
                    "Client names cannot contain spaces, "
                    "newlines or special characters.");
                return;
            }
        }
        if (c->name) decrRefCount(c->name);
        c->name = c->argv[2];
        incrRefCount(c->name);
        addReply(c,shared.ok);
    } else if (!strcasecmp(c->argv[1]->ptr,"getname") && c->argc == 2) {
        if (c->name)
            addReplyBulk(c,c->name);
        else
            addReply(c,shared.nullbulk);
A
antirez 已提交
1331
    } else {
B
bitterb 已提交
1332
        addReplyError(c, "Syntax error, try CLIENT (LIST | KILL ip:port | GETNAME | SETNAME connection-name)");
A
antirez 已提交
1333 1334
    }
}
1335

1336 1337 1338
/* 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. */
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
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;
1361
    c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
1362
    redisAssertWithInfo(c,NULL,c->cmd != NULL);
1363 1364
    va_end(ap);
}
1365 1366 1367 1368 1369 1370

/* 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;
   
1371
    redisAssertWithInfo(c,NULL,i < c->argc);
1372 1373 1374 1375 1376 1377 1378
    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) {
1379
        c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
1380
        redisAssertWithInfo(c,NULL,c->cmd != NULL);
1381 1382
    }
}
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395

/* 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 已提交
1396
 * enforcing the client output length limits. */
1397
unsigned long getClientOutputBufferMemoryUsage(redisClient *c) {
1398
    unsigned long list_item_size = sizeof(listNode)+sizeof(robj);
1399 1400 1401

    return c->reply_bytes + (list_item_size*listLength(c->reply));
}
1402

1403
/* Get the class of a client, used in order to enforce limits to different
1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
 * 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;
}
1417

1418 1419 1420
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;
1421
    else if (!strcasecmp(name,"pubsub")) return REDIS_CLIENT_LIMIT_CLASS_PUBSUB;
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
    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;
    }
}

1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
/* 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
1475 1476
 * output buffer size. The caller can check if the client will be closed
 * checking if the client REDIS_CLOSE_ASAP flag is set.
1477 1478 1479 1480
 *
 * 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. */
1481
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c) {
1482
    redisAssert(c->reply_bytes < ULONG_MAX-(1024*64));
1483
    if (c->reply_bytes == 0 || c->flags & REDIS_CLOSE_ASAP) return;
1484 1485 1486 1487
    if (checkClientOutputBufferLimits(c)) {
        sds client = getClientInfoString(c);

        freeClientAsync(c);
1488
        redisLog(REDIS_WARNING,"Client %s scheduled to be closed ASAP for overcoming of output buffer limits.", client);
1489 1490 1491
        sdsfree(client);
    }
}
A
antirez 已提交
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512

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