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

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

redisClient *createClient(int fd) {
54
    redisClient *c = zmalloc(sizeof(redisClient));
55

56 57 58 59 60 61
    /* 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);
62
        anetEnableTcpNoDelay(NULL,fd);
63 64
        if (server.tcpkeepalive)
            anetKeepAlive(NULL,fd,server.tcpkeepalive);
65 66 67 68 69 70 71
        if (aeCreateFileEvent(server.el,fd,AE_READABLE,
            readQueryFromClient, c) == AE_ERR)
        {
            close(fd);
            zfree(c);
            return NULL;
        }
72 73
    }

74 75
    selectDb(c,0);
    c->fd = fd;
76
    c->name = NULL;
77
    c->bufpos = 0;
78
    c->querybuf = sdsempty();
79
    c->querybuf_peak = 0;
80
    c->reqtype = 0;
81 82
    c->argc = 0;
    c->argv = NULL;
83
    c->cmd = c->lastcmd = NULL;
84
    c->multibulklen = 0;
85 86 87
    c->bulklen = -1;
    c->sentlen = 0;
    c->flags = 0;
88
    c->ctime = c->lastinteraction = server.unixtime;
89 90
    c->authenticated = 0;
    c->replstate = REDIS_REPL_NONE;
91
    c->reploff = 0;
A
antirez 已提交
92 93
    c->repl_ack_off = 0;
    c->repl_ack_time = 0;
A
antirez 已提交
94
    c->slave_listening_port = 0;
95
    c->reply = listCreate();
96
    c->reply_bytes = 0;
97
    c->obuf_soft_limit_reached_time = 0;
98
    listSetFreeMethod(c->reply,decrRefCountVoid);
99
    listSetDupMethod(c->reply,dupClientReplyValue);
100
    c->bpop.keys = dictCreate(&setDictType,NULL);
101 102
    c->bpop.timeout = 0;
    c->bpop.target = NULL;
103 104 105
    c->watched_keys = listCreate();
    c->pubsub_channels = dictCreate(&setDictType,NULL);
    c->pubsub_patterns = listCreate();
106
    listSetFreeMethod(c->pubsub_patterns,decrRefCountVoid);
107
    listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
108
    if (fd != -1) listAddNodeTail(server.clients,c);
109 110 111 112
    initClientMultiState(c);
    return c;
}

113 114 115 116 117 118 119
/* 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.
 *
120 121
 * 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
122
 * failed, the function returns REDIS_ERR.
123 124 125 126 127
 *
 * 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) {
128
    if (c->flags & REDIS_LUA_CLIENT) return REDIS_OK;
129 130
    if ((c->flags & REDIS_MASTER) &&
        !(c->flags & REDIS_MASTER_FORCE_REPLY)) return REDIS_ERR;
131
    if (c->fd <= 0) return REDIS_ERR; /* Fake client */
132
    if (c->bufpos == 0 && listLength(c->reply) == 0 &&
133 134 135
        (c->replstate == REDIS_REPL_NONE ||
         c->replstate == REDIS_REPL_ONLINE) &&
        aeCreateFileEvent(server.el, c->fd, AE_WRITABLE,
136 137 138 139
        sendReplyToClient, c) == AE_ERR) return REDIS_ERR;
    return REDIS_OK;
}

140 141 142 143 144 145 146 147 148 149 150 151 152 153
/* 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);
154 155
}

156 157 158 159
/* -----------------------------------------------------------------------------
 * Low level functions to add more data to output buffers.
 * -------------------------------------------------------------------------- */

160
int _addReplyToBuffer(redisClient *c, char *s, size_t len) {
161
    size_t available = sizeof(c->buf)-c->bufpos;
162

163 164
    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return REDIS_OK;

165 166 167 168 169 170
    /* 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;
171

172 173 174
    memcpy(c->buf+c->bufpos,s,len);
    c->bufpos+=len;
    return REDIS_OK;
175 176
}

177 178
void _addReplyObjectToList(redisClient *c, robj *o) {
    robj *tail;
179 180 181

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

182 183 184
    if (listLength(c->reply) == 0) {
        incrRefCount(o);
        listAddNodeTail(c->reply,o);
185
        c->reply_bytes += zmalloc_size_sds(o->ptr);
186 187 188 189 190 191 192
    } 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)
        {
193
            c->reply_bytes -= zmalloc_size_sds(tail->ptr);
194 195
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,o->ptr,sdslen(o->ptr));
196
            c->reply_bytes += zmalloc_size_sds(tail->ptr);
197 198 199
        } else {
            incrRefCount(o);
            listAddNodeTail(c->reply,o);
200
            c->reply_bytes += zmalloc_size_sds(o->ptr);
201 202
        }
    }
203
    asyncCloseClientOnOutputBufferLimitReached(c);
204
}
205

206 207 208 209
/* 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;
210

211 212 213 214
    if (c->flags & REDIS_CLOSE_AFTER_REPLY) {
        sdsfree(s);
        return;
    }
215

216 217
    if (listLength(c->reply) == 0) {
        listAddNodeTail(c->reply,createObject(REDIS_STRING,s));
218
        c->reply_bytes += zmalloc_size_sds(s);
219 220 221 222 223 224 225
    } 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)
        {
226
            c->reply_bytes -= zmalloc_size_sds(tail->ptr);
227 228
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,s,sdslen(s));
229
            c->reply_bytes += zmalloc_size_sds(tail->ptr);
230
            sdsfree(s);
231
        } else {
232
            listAddNodeTail(c->reply,createObject(REDIS_STRING,s));
233
            c->reply_bytes += zmalloc_size_sds(s);
234
        }
235
    }
236
    asyncCloseClientOnOutputBufferLimitReached(c);
237 238 239 240
}

void _addReplyStringToList(redisClient *c, char *s, size_t len) {
    robj *tail;
241 242 243

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

244
    if (listLength(c->reply) == 0) {
245 246 247
        robj *o = createStringObject(s,len);

        listAddNodeTail(c->reply,o);
248
        c->reply_bytes += zmalloc_size_sds(o->ptr);
249
    } else {
250 251 252 253 254 255
        tail = listNodeValue(listLast(c->reply));

        /* Append to this object when possible. */
        if (tail->ptr != NULL &&
            sdslen(tail->ptr)+len <= REDIS_REPLY_CHUNK_BYTES)
        {
256
            c->reply_bytes -= zmalloc_size_sds(tail->ptr);
257 258
            tail = dupLastObjectIfNeeded(c->reply);
            tail->ptr = sdscatlen(tail->ptr,s,len);
259
            c->reply_bytes += zmalloc_size_sds(tail->ptr);
260
        } else {
261 262 263
            robj *o = createStringObject(s,len);

            listAddNodeTail(c->reply,o);
264
            c->reply_bytes += zmalloc_size_sds(o->ptr);
265 266
        }
    }
267
    asyncCloseClientOnOutputBufferLimitReached(c);
268
}
269

270 271 272 273 274
/* -----------------------------------------------------------------------------
 * Higher level functions to queue data on the client output buffer.
 * The following functions are the ones that commands implementations will call.
 * -------------------------------------------------------------------------- */

275
void addReply(redisClient *c, robj *obj) {
276
    if (prepareClientToWrite(c) != REDIS_OK) return;
277 278 279 280 281 282 283 284 285 286 287

    /* 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);
288 289 290 291 292 293 294 295 296 297 298 299 300 301
    } 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. */
        }
302
        obj = getDecodedObject(obj);
303 304 305
        if (_addReplyToBuffer(c,obj->ptr,sdslen(obj->ptr)) != REDIS_OK)
            _addReplyObjectToList(c,obj);
        decrRefCount(obj);
306 307
    } else {
        redisPanic("Wrong obj->encoding in addReply()");
308 309 310 311
    }
}

void addReplySds(redisClient *c, sds s) {
312
    if (prepareClientToWrite(c) != REDIS_OK) {
313 314 315 316
        /* The caller expects the sds to be free'd. */
        sdsfree(s);
        return;
    }
317
    if (_addReplyToBuffer(c,s,sdslen(s)) == REDIS_OK) {
318 319
        sdsfree(s);
    } else {
320 321
        /* This method free's the sds when it is no longer needed. */
        _addReplySdsToList(c,s);
322
    }
323 324
}

325
void addReplyString(redisClient *c, char *s, size_t len) {
326
    if (prepareClientToWrite(c) != REDIS_OK) return;
327 328
    if (_addReplyToBuffer(c,s,len) != REDIS_OK)
        _addReplyStringToList(c,s,len);
329
}
330

331
void addReplyErrorLength(redisClient *c, char *s, size_t len) {
332 333 334
    addReplyString(c,"-ERR ",5);
    addReplyString(c,s,len);
    addReplyString(c,"\r\n",2);
335 336
}

337
void addReplyError(redisClient *c, char *err) {
338
    addReplyErrorLength(c,err,strlen(err));
339
}
340

341
void addReplyErrorFormat(redisClient *c, const char *fmt, ...) {
342
    size_t l, j;
343 344 345 346
    va_list ap;
    va_start(ap,fmt);
    sds s = sdscatvprintf(sdsempty(),fmt,ap);
    va_end(ap);
347 348 349 350 351 352
    /* 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] = ' ';
    }
353
    addReplyErrorLength(c,s,sdslen(s));
354 355 356
    sdsfree(s);
}

357
void addReplyStatusLength(redisClient *c, char *s, size_t len) {
358 359 360 361 362 363
    addReplyString(c,"+",1);
    addReplyString(c,s,len);
    addReplyString(c,"\r\n",2);
}

void addReplyStatus(redisClient *c, char *status) {
364
    addReplyStatusLength(c,status,strlen(status));
365 366 367 368 369 370 371
}

void addReplyStatusFormat(redisClient *c, const char *fmt, ...) {
    va_list ap;
    va_start(ap,fmt);
    sds s = sdscatvprintf(sdsempty(),fmt,ap);
    va_end(ap);
372
    addReplyStatusLength(c,s,sdslen(s));
373 374 375
    sdsfree(s);
}

376 377 378
/* 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) {
379 380 381
    /* 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. */
382
    if (prepareClientToWrite(c) != REDIS_OK) return NULL;
383
    listAddNodeTail(c->reply,createObject(REDIS_STRING,NULL));
384 385 386
    return listLast(c->reply);
}

G
guiquanz 已提交
387
/* Populate the length object and try gluing it to the next chunk. */
388 389 390 391 392 393 394 395 396
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);
397
    c->reply_bytes += zmalloc_size_sds(len->ptr);
398 399
    if (ln->next != NULL) {
        next = listNodeValue(ln->next);
400

401
        /* Only glue when the next node is non-NULL (an sds in this case) */
402
        if (next->ptr != NULL) {
403 404
            c->reply_bytes -= zmalloc_size_sds(len->ptr);
            c->reply_bytes -= zmalloc_size_sds(next->ptr);
405
            len->ptr = sdscatlen(len->ptr,next->ptr,sdslen(next->ptr));
406
            c->reply_bytes += zmalloc_size_sds(len->ptr);
407 408
            listDelNode(c->reply,ln->next);
        }
409
    }
410
    asyncCloseClientOnOutputBufferLimitReached(c);
411 412
}

G
guiquanz 已提交
413
/* Add a double as a bulk reply */
414 415 416
void addReplyDouble(redisClient *c, double d) {
    char dbuf[128], sbuf[128];
    int dlen, slen;
417 418 419 420 421 422 423 424 425
    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);
    }
426 427
}

428 429
/* Add a long long as integer reply or bulk len / multi bulk count.
 * Basically this is used to output <prefix><long long><crlf>. */
430
void addReplyLongLongWithPrefix(redisClient *c, long long ll, char prefix) {
431
    char buf[128];
432
    int len;
433 434 435 436 437 438 439 440 441 442 443 444

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

445
    buf[0] = prefix;
446 447 448
    len = ll2string(buf+1,sizeof(buf)-1,ll);
    buf[len+1] = '\r';
    buf[len+2] = '\n';
449
    addReplyString(c,buf,len+3);
450 451
}

452
void addReplyLongLong(redisClient *c, long long ll) {
453 454 455 456 457
    if (ll == 0)
        addReply(c,shared.czero);
    else if (ll == 1)
        addReply(c,shared.cone);
    else
458
        addReplyLongLongWithPrefix(c,ll,':');
459
}
460

461
void addReplyMultiBulkLen(redisClient *c, long length) {
462 463 464 465
    if (length < REDIS_SHARED_BULKHDR_LEN)
        addReply(c,shared.mbulkhdr[length]);
    else
        addReplyLongLongWithPrefix(c,length,'*');
466 467
}

468
/* Create the length prefix of a bulk reply, example: $2234 */
469
void addReplyBulkLen(redisClient *c, robj *obj) {
470
    size_t len;
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486

    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++;
        }
    }
487 488 489 490 491

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

494
/* Add a Redis Object as a bulk reply */
495 496 497 498 499 500
void addReplyBulk(redisClient *c, robj *obj) {
    addReplyBulkLen(c,obj);
    addReply(c,obj);
    addReply(c,shared.crlf);
}

501 502
/* Add a C buffer as bulk reply */
void addReplyBulkCBuffer(redisClient *c, void *p, size_t len) {
503
    addReplyLongLongWithPrefix(c,len,'$');
504 505 506 507 508
    addReplyString(c,p,len);
    addReply(c,shared.crlf);
}

/* Add a C nul term string as bulk reply */
509 510 511 512
void addReplyBulkCString(redisClient *c, char *s) {
    if (s == NULL) {
        addReply(c,shared.nullbulk);
    } else {
513
        addReplyBulkCBuffer(c,s,strlen(s));
514 515 516
    }
}

517 518 519 520 521 522 523 524 525
/* 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);
}

526 527 528 529 530 531 532 533
/* 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;
534
    dst->reply_bytes = src->reply_bytes;
535 536
}

537
static void acceptCommonHandler(int fd, int flags) {
538
    redisClient *c;
539
    if ((c = createClient(fd)) == NULL) {
540 541 542
        redisLog(REDIS_WARNING,
            "Error registering fd event for the new client: %s (fd=%d)",
            strerror(errno),fd);
543
        close(fd); /* May be already closed, just ignore errors */
544 545 546 547
        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 已提交
548
     * for this condition, since now the socket is already set in non-blocking
549
     * mode and we can send an error for free using the Kernel I/O */
550
    if (listLength(server.clients) > server.maxclients) {
551 552 553 554 555 556
        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... */
        }
557
        server.stat_rejected_conn++;
558 559 560 561
        freeClient(c);
        return;
    }
    server.stat_numconnections++;
562
    c->flags |= flags;
563 564
}

565 566
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    int cport, cfd;
567
    char cip[REDIS_IP_STR_LEN];
568 569 570 571
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

572
    cfd = anetTcpAccept(server.neterr, fd, cip, sizeof(cip), &cport);
573
    if (cfd == AE_ERR) {
574
        redisLog(REDIS_WARNING,"Accepting client connection: %s", server.neterr);
575 576 577
        return;
    }
    redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
578
    acceptCommonHandler(cfd,0);
579 580 581 582 583 584 585 586
}

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

587
    cfd = anetUnixAccept(server.neterr, fd);
588
    if (cfd == AE_ERR) {
589
        redisLog(REDIS_WARNING,"Accepting client connection: %s", server.neterr);
590 591 592
        return;
    }
    redisLog(REDIS_VERBOSE,"Accepted connection to %s", server.unixsocket);
593
    acceptCommonHandler(cfd,REDIS_UNIX_SOCKET);
594 595 596
}


597 598 599 600 601
static void freeClientArgv(redisClient *c) {
    int j;
    for (j = 0; j < c->argc; j++)
        decrRefCount(c->argv[j]);
    c->argc = 0;
602
    c->cmd = NULL;
603 604
}

605 606 607 608 609 610 611 612 613 614
/* 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);
    }
}

615 616 617 618 619 620 621 622 623 624 625 626 627 628
/* 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();
}

629 630 631
void freeClient(redisClient *c) {
    listNode *ln;

632 633 634
    /* If this is marked as current client unset it */
    if (server.current_client == c) server.current_client = NULL;

635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
    /* 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;
    }

651
    /* Free the query buffer */
652 653
    sdsfree(c->querybuf);
    c->querybuf = NULL;
654 655

    /* Deallocate structures used to block on blocking ops. */
656 657
    if (c->flags & REDIS_BLOCKED)
        unblockClientWaitingData(c);
658
    dictRelease(c->bpop.keys);
659 660 661 662

    /* UNWATCH all the keys */
    unwatchAllKeys(c);
    listRelease(c->watched_keys);
663

664 665 666 667 668
    /* Unsubscribe from all the pubsub channels */
    pubsubUnsubscribeAllChannels(c,0);
    pubsubUnsubscribeAllPatterns(c,0);
    dictRelease(c->pubsub_channels);
    listRelease(c->pubsub_patterns);
669

670 671 672 673 674 675 676
    /* 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);
    }
677 678
    listRelease(c->reply);
    freeClientArgv(c);
679

680
    /* Remove from the list of clients */
681 682 683 684 685
    if (c->fd != -1) {
        ln = listSearchKey(server.clients,c);
        redisAssert(ln != NULL);
        listDelNode(server.clients,ln);
    }
686

687
    /* When client was just unblocked because of a blocking operation,
A
antirez 已提交
688
     * remove it from the list of unblocked clients. */
689 690 691 692 693
    if (c->flags & REDIS_UNBLOCKED) {
        ln = listSearchKey(server.unblocked_clients,c);
        redisAssert(ln != NULL);
        listDelNode(server.unblocked_clients,ln);
    }
694 695 696

    /* Master/slave cleanup Case 1:
     * we lost the connection with a slave. */
697 698 699 700 701 702 703
    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);
704 705 706 707 708
        /* 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;
709
        refreshGoodSlavesCount();
710
    }
711

712 713
    /* Master/slave cleanup Case 2:
     * we lost the connection with the master. */
714
    if (c->flags & REDIS_MASTER) replicationHandleMasterDisconnection();
715 716 717 718 719 720 721 722 723

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

724 725
    /* Release other dynamically allocated client structure fields,
     * and finally release the client structure itself. */
726
    if (c->name) decrRefCount(c->name);
727 728 729 730 731
    zfree(c->argv);
    freeClientMultiState(c);
    zfree(c);
}

732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
/* 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);
    }
}

753 754 755
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = privdata;
    int nwritten = 0, totwritten = 0, objlen;
756
    size_t objmem;
757 758 759 760
    robj *o;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

761 762
    while(c->bufpos > 0 || listLength(c->reply)) {
        if (c->bufpos > 0) {
763 764
            nwritten = write(fd,c->buf+c->sentlen,c->bufpos-c->sentlen);
            if (nwritten <= 0) break;
765 766 767 768 769 770 771 772 773 774 775 776
            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);
777
            objmem = zmalloc_size_sds(o->ptr);
778

779 780 781 782
            if (objlen == 0) {
                listDelNode(c->reply,listFirst(c->reply));
                continue;
            }
783

784 785
            nwritten = write(fd, ((char*)o->ptr)+c->sentlen,objlen-c->sentlen);
            if (nwritten <= 0) break;
786 787
            c->sentlen += nwritten;
            totwritten += nwritten;
788

789 790 791 792
            /* 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;
793
                c->reply_bytes -= objmem;
794
            }
795
        }
796
        /* Note that we avoid to send more than REDIS_MAX_WRITE_PER_EVENT
797 798 799
         * 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
800 801 802 803 804 805 806
         * 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;
807 808 809 810 811 812 813 814 815 816 817
    }
    if (nwritten == -1) {
        if (errno == EAGAIN) {
            nwritten = 0;
        } else {
            redisLog(REDIS_VERBOSE,
                "Error writing to client: %s", strerror(errno));
            freeClient(c);
            return;
        }
    }
A
antirez 已提交
818 819 820 821 822 823 824
    if (totwritten > 0) {
        /* For clients representing masters we don't count sending data
         * as an interaction, since we always send REPLCONF ACK commands
         * that take some time to just fill the socket output buffer.
         * We just rely on data / pings received for timeout detection. */
        if (!(c->flags & REDIS_MASTER)) c->lastinteraction = server.unixtime;
    }
825
    if (c->bufpos == 0 && listLength(c->reply) == 0) {
826 827
        c->sentlen = 0;
        aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
P
Pieter Noordhuis 已提交
828 829

        /* Close connection after entire reply has been sent. */
830
        if (c->flags & REDIS_CLOSE_AFTER_REPLY) freeClient(c);
831 832 833 834 835 836
    }
}

/* resetClient prepare the client to process the next command */
void resetClient(redisClient *c) {
    freeClientArgv(c);
837 838
    c->reqtype = 0;
    c->multibulklen = 0;
839
    c->bulklen = -1;
840 841
    /* We clear the ASKING flag as well if we are not inside a MULTI. */
    if (!(c->flags & REDIS_MULTI)) c->flags &= (~REDIS_ASKING);
842 843
}

844 845 846
int processInlineBuffer(redisClient *c) {
    char *newline = strstr(c->querybuf,"\r\n");
    int argc, j;
847
    sds *argv, aux;
848 849 850
    size_t querylen;

    /* Nothing to do without a \r\n */
851 852 853 854 855
    if (newline == NULL) {
        if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
            addReplyError(c,"Protocol error: too big inline request");
            setProtocolError(c,0);
        }
856
        return REDIS_ERR;
857
    }
858 859 860

    /* Split the input buffer up to the \r\n */
    querylen = newline-(c->querybuf);
861 862 863
    aux = sdsnewlen(c->querybuf,querylen);
    argv = sdssplitargs(aux,&argc);
    sdsfree(aux);
864 865

    /* Leave data after the first line of the query in the buffer */
866
    sdsrange(c->querybuf,querylen+2,-1);
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887

    /* 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) {
888 889 890 891 892 893
    if (server.verbosity >= REDIS_VERBOSE) {
        sds client = getClientInfoString(c);
        redisLog(REDIS_VERBOSE,
            "Protocol error from client: %s", client);
        sdsfree(client);
    }
894
    c->flags |= REDIS_CLOSE_AFTER_REPLY;
895
    sdsrange(c->querybuf,pos,-1);
896 897 898 899
}

int processMultibulkBuffer(redisClient *c) {
    char *newline = NULL;
900 901
    int pos = 0, ok;
    long long ll;
902 903 904

    if (c->multibulklen == 0) {
        /* The client should have been reset */
905
        redisAssertWithInfo(c,NULL,c->argc == 0);
906 907

        /* Multi bulk length cannot be read without a \r\n */
908
        newline = strchr(c->querybuf,'\r');
909 910 911 912 913
        if (newline == NULL) {
            if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
                addReplyError(c,"Protocol error: too big mbulk count string");
                setProtocolError(c,0);
            }
914
            return REDIS_ERR;
915
        }
916

P
Pieter Noordhuis 已提交
917 918 919 920
        /* Buffer should also contain \n */
        if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
            return REDIS_ERR;

921 922
        /* We know for sure there is a whole line since newline != NULL,
         * so go ahead and find out the multi bulk length. */
923
        redisAssertWithInfo(c,NULL,c->querybuf[0] == '*');
924 925
        ok = string2ll(c->querybuf+1,newline-(c->querybuf+1),&ll);
        if (!ok || ll > 1024*1024) {
926 927 928
            addReplyError(c,"Protocol error: invalid multibulk length");
            setProtocolError(c,pos);
            return REDIS_ERR;
929
        }
P
Pieter Noordhuis 已提交
930 931 932

        pos = (newline-c->querybuf)+2;
        if (ll <= 0) {
933
            sdsrange(c->querybuf,pos,-1);
P
Pieter Noordhuis 已提交
934 935 936
            return REDIS_OK;
        }

937
        c->multibulklen = ll;
938 939 940 941 942 943

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

944
    redisAssertWithInfo(c,NULL,c->multibulklen > 0);
945 946 947
    while(c->multibulklen) {
        /* Read bulk length if unknown */
        if (c->bulklen == -1) {
948
            newline = strchr(c->querybuf+pos,'\r');
949 950 951 952 953
            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 已提交
954
                break;
955
            }
P
Pieter Noordhuis 已提交
956 957 958

            /* Buffer should also contain \n */
            if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
959
                break;
P
Pieter Noordhuis 已提交
960 961 962 963 964 965 966

            if (c->querybuf[pos] != '$') {
                addReplyErrorFormat(c,
                    "Protocol error: expected '$', got '%c'",
                    c->querybuf[pos]);
                setProtocolError(c,pos);
                return REDIS_ERR;
967
            }
P
Pieter Noordhuis 已提交
968 969 970 971 972 973 974 975 976

            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;
977
            if (ll >= REDIS_MBULK_BIG_ARG) {
978 979
                size_t qblen;

980 981
                /* If we are going to read a large object from network
                 * try to make it likely that it will start at c->querybuf
982
                 * boundary so that we can optimize object creation
983
                 * avoiding a large copy of data. */
984
                sdsrange(c->querybuf,pos,-1);
985
                pos = 0;
986
                qblen = sdslen(c->querybuf);
A
antirez 已提交
987 988
                /* Hint the sds library about the amount of bytes this string is
                 * going to contain. */
989 990
                if (qblen < ll+2)
                    c->querybuf = sdsMakeRoomFor(c->querybuf,ll+2-qblen);
A
antirez 已提交
991
            }
P
Pieter Noordhuis 已提交
992
            c->bulklen = ll;
993 994 995 996 997 998 999
        }

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

    /* Trim to pos */
1025
    if (pos) sdsrange(c->querybuf,pos,-1);
1026 1027

    /* We're done when c->multibulk == 0 */
1028 1029 1030
    if (c->multibulklen == 0) return REDIS_OK;

    /* Still not read to process the command */
1031 1032 1033 1034 1035 1036
    return REDIS_ERR;
}

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

1040 1041 1042 1043
        /* 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;
1044 1045 1046 1047 1048

        /* Determine request type when unknown. */
        if (!c->reqtype) {
            if (c->querybuf[0] == '*') {
                c->reqtype = REDIS_REQ_MULTIBULK;
1049
            } else {
1050
                c->reqtype = REDIS_REQ_INLINE;
1051 1052
            }
        }
1053 1054 1055 1056 1057 1058 1059

        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");
1060
        }
1061 1062

        /* Multibulk processing could see a <= 0 length. */
1063 1064 1065 1066 1067 1068 1069
        if (c->argc == 0) {
            resetClient(c);
        } else {
            /* Only reset the client when the command was executed. */
            if (processCommand(c) == REDIS_OK)
                resetClient(c);
        }
1070 1071 1072 1073 1074
    }
}

void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = (redisClient*) privdata;
1075
    int nread, readlen;
1076
    size_t qblen;
1077 1078 1079
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1080
    server.current_client = c;
1081 1082
    readlen = REDIS_IOBUF_LEN;
    /* If this is a multi bulk request, and we are processing a bulk reply
1083 1084 1085
     * 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
1086 1087 1088
     * processMultiBulkBuffer() can avoid copying buffers to create the
     * Redis Object representing the argument. */
    if (c->reqtype == REDIS_REQ_MULTIBULK && c->multibulklen && c->bulklen != -1
1089
        && c->bulklen >= REDIS_MBULK_BIG_ARG)
1090 1091 1092 1093 1094 1095
    {
        int remaining = (unsigned)(c->bulklen+2)-sdslen(c->querybuf);

        if (remaining < readlen) readlen = remaining;
    }

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

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

1153
/* This is a helper function for getClientPeerId().
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
 * 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 已提交
1164 1165 1166 1167 1168 1169 1170 1171
/* 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 已提交
1172 1173 1174 1175 1176 1177
 * 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 已提交
1178 1179 1180 1181 1182 1183
    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 已提交
1184
        return REDIS_OK;
A
antirez 已提交
1185 1186
    } else {
        /* TCP client. */
A
antirez 已提交
1187
        int retval = anetPeerToString(client->fd,ip,sizeof(ip),&port);
1188
        formatPeerId(peerid,peerid_len,ip,port);
A
antirez 已提交
1189
        return (retval == -1) ? REDIS_ERR : REDIS_OK;
A
antirez 已提交
1190 1191 1192
    }
}

1193 1194
/* Turn a Redis client into an sds string representing its state. */
sds getClientInfoString(redisClient *client) {
A
antirez 已提交
1195
    char peerid[REDIS_PEER_ID_LEN], flags[16], events[3], *p;
1196
    int emask;
1197

A
antirez 已提交
1198
    getClientPeerId(client,peerid,sizeof(peerid));
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
    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';
1212
    if (client->flags & REDIS_CLOSE_ASAP) *p++ = 'A';
1213
    if (client->flags & REDIS_UNIX_SOCKET) *p++ = 'U';
1214
    if (p == flags) *p++ = 'N';
1215
    *p++ = '\0';
1216 1217 1218 1219 1220 1221

    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';
1222
    return sdscatprintf(sdsempty(),
A
antirez 已提交
1223 1224
        "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,
1225 1226
        client->fd,
        client->name ? (char*)client->name->ptr : "",
1227 1228
        (long)(server.unixtime - client->ctime),
        (long)(server.unixtime - client->lastinteraction),
1229 1230 1231
        flags,
        client->db->id,
        (int) dictSize(client->pubsub_channels),
1232
        (int) listLength(client->pubsub_patterns),
1233
        (client->flags & REDIS_MULTI) ? client->mstate.count : -1,
1234
        (unsigned long) sdslen(client->querybuf),
1235
        (unsigned long) sdsavail(client->querybuf),
1236
        (unsigned long) client->bufpos,
1237
        (unsigned long) listLength(client->reply),
1238
        getClientOutputBufferMemoryUsage(client),
1239 1240
        events,
        client->lastcmd ? client->lastcmd->name : "NULL");
1241 1242
}

1243 1244 1245 1246 1247 1248 1249 1250
sds getAllClientsInfoString(void) {
    listNode *ln;
    listIter li;
    redisClient *client;
    sds o = sdsempty();

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

1253
        client = listNodeValue(ln);
1254 1255 1256
        cs = getClientInfoString(client);
        o = sdscatsds(o,cs);
        sdsfree(cs);
1257 1258 1259 1260 1261
        o = sdscatlen(o,"\n",1);
    }
    return o;
}

A
antirez 已提交
1262
void clientCommand(redisClient *c) {
A
antirez 已提交
1263 1264 1265 1266
    listNode *ln;
    listIter li;
    redisClient *client;

A
antirez 已提交
1267
    if (!strcasecmp(c->argv[1]->ptr,"list") && c->argc == 2) {
1268
        sds o = getAllClientsInfoString();
A
antirez 已提交
1269 1270
        addReplyBulkCBuffer(c,o,sdslen(o));
        sdsfree(o);
A
antirez 已提交
1271 1272 1273
    } else if (!strcasecmp(c->argv[1]->ptr,"kill") && c->argc == 3) {
        listRewind(server.clients,&li);
        while ((ln = listNext(&li)) != NULL) {
A
antirez 已提交
1274
            char peerid[REDIS_PEER_ID_LEN];
A
antirez 已提交
1275 1276

            client = listNodeValue(ln);
A
antirez 已提交
1277 1278 1279
            if (getClientPeerId(client,peerid,sizeof(peerid)) == REDIS_ERR)
                continue;
            if (strcmp(peerid,c->argv[2]->ptr) == 0) {
A
antirez 已提交
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
                addReply(c,shared.ok);
                if (c == client) {
                    client->flags |= REDIS_CLOSE_AFTER_REPLY;
                } else {
                    freeClient(client);
                }
                return;
            }
        }
        addReplyError(c,"No such client");
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
    } 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 已提交
1307
            if (p[j] < '!' || p[j] > '~') { /* ASCII is assumed. */
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
                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 已提交
1323
    } else {
B
bitterb 已提交
1324
        addReplyError(c, "Syntax error, try CLIENT (LIST | KILL ip:port | GETNAME | SETNAME connection-name)");
A
antirez 已提交
1325 1326
    }
}
1327

1328 1329 1330
/* 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. */
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352
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;
1353
    c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
1354
    redisAssertWithInfo(c,NULL,c->cmd != NULL);
1355 1356
    va_end(ap);
}
1357 1358 1359 1360 1361 1362

/* 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;
   
1363
    redisAssertWithInfo(c,NULL,i < c->argc);
1364 1365 1366 1367 1368 1369 1370
    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) {
1371
        c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
1372
        redisAssertWithInfo(c,NULL,c->cmd != NULL);
1373 1374
    }
}
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387

/* 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 已提交
1388
 * enforcing the client output length limits. */
1389
unsigned long getClientOutputBufferMemoryUsage(redisClient *c) {
1390
    unsigned long list_item_size = sizeof(listNode)+sizeof(robj);
1391 1392 1393

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

1395
/* Get the class of a client, used in order to enforce limits to different
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
 * 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;
}
1409

1410 1411 1412
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;
1413
    else if (!strcasecmp(name,"pubsub")) return REDIS_CLIENT_LIMIT_CLASS_PUBSUB;
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
    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;
    }
}

1426 1427 1428 1429 1430 1431 1432 1433 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
/* 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
1467 1468
 * output buffer size. The caller can check if the client will be closed
 * checking if the client REDIS_CLOSE_ASAP flag is set.
1469 1470 1471 1472
 *
 * 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. */
1473
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c) {
1474
    redisAssert(c->reply_bytes < ULONG_MAX-(1024*64));
1475
    if (c->reply_bytes == 0 || c->flags & REDIS_CLOSE_ASAP) return;
1476 1477 1478 1479
    if (checkClientOutputBufferLimits(c)) {
        sds client = getClientInfoString(c);

        freeClientAsync(c);
1480
        redisLog(REDIS_WARNING,"Client %s scheduled to be closed ASAP for overcoming of output buffer limits.", client);
1481 1482 1483
        sdsfree(client);
    }
}
A
antirez 已提交
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504

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