networking.c 52.0 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
    c->io_keys = listCreate();
    c->watched_keys = listCreate();
105
    listSetFreeMethod(c->io_keys,decrRefCountVoid);
106 107
    c->pubsub_channels = dictCreate(&setDictType,NULL);
    c->pubsub_patterns = listCreate();
108
    listSetFreeMethod(c->pubsub_patterns,decrRefCountVoid);
109
    listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
110
    if (fd != -1) listAddNodeTail(server.clients,c);
111 112 113 114
    initClientMultiState(c);
    return c;
}

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

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

158 159 160 161
/* -----------------------------------------------------------------------------
 * Low level functions to add more data to output buffers.
 * -------------------------------------------------------------------------- */

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

165 166
    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return REDIS_OK;

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

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

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

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

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

208 209 210 211
/* 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;
212

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

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

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

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    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++;
        }
    }
489 490 491 492 493

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

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

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

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

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

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

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

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

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

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

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


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

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

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

631 632 633
void freeClient(redisClient *c) {
    listNode *ln;

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

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

653 654 655 656 657 658 659 660 661
    /* 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);
662
    dictRelease(c->bpop.keys);
663 664 665 666 667 668 669 670 671

    /* 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);
672 673 674 675 676 677 678
    /* 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);
    }
679 680 681
    listRelease(c->reply);
    freeClientArgv(c);
    /* Remove from the list of clients */
682 683 684 685 686
    if (c->fd != -1) {
        ln = listSearchKey(server.clients,c);
        redisAssert(ln != NULL);
        listDelNode(server.clients,ln);
    }
687 688 689 690 691 692 693
    /* 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);
    }
694
    listRelease(c->io_keys);
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

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

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

723
    /* Release memory */
724
    if (c->name) decrRefCount(c->name);
725 726 727 728 729
    zfree(c->argv);
    freeClientMultiState(c);
    zfree(c);
}

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

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

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

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

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

787 788 789 790
            /* 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;
791
                c->reply_bytes -= objmem;
792
            }
793
        }
794
        /* Note that we avoid to send more than REDIS_MAX_WRITE_PER_EVENT
795 796 797
         * 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
798 799 800 801 802 803 804
         * 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;
805 806 807 808 809 810 811 812 813 814 815
    }
    if (nwritten == -1) {
        if (errno == EAGAIN) {
            nwritten = 0;
        } else {
            redisLog(REDIS_VERBOSE,
                "Error writing to client: %s", strerror(errno));
            freeClient(c);
            return;
        }
    }
816
    if (totwritten > 0) c->lastinteraction = server.unixtime;
817
    if (c->bufpos == 0 && listLength(c->reply) == 0) {
818 819
        c->sentlen = 0;
        aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
P
Pieter Noordhuis 已提交
820 821

        /* Close connection after entire reply has been sent. */
822
        if (c->flags & REDIS_CLOSE_AFTER_REPLY) freeClient(c);
823 824 825 826 827 828
    }
}

/* resetClient prepare the client to process the next command */
void resetClient(redisClient *c) {
    freeClientArgv(c);
829 830
    c->reqtype = 0;
    c->multibulklen = 0;
831
    c->bulklen = -1;
832 833
    /* We clear the ASKING flag as well if we are not inside a MULTI. */
    if (!(c->flags & REDIS_MULTI)) c->flags &= (~REDIS_ASKING);
834 835
}

836 837 838
int processInlineBuffer(redisClient *c) {
    char *newline = strstr(c->querybuf,"\r\n");
    int argc, j;
839
    sds *argv, aux;
840 841 842
    size_t querylen;

    /* Nothing to do without a \r\n */
843 844 845 846 847
    if (newline == NULL) {
        if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
            addReplyError(c,"Protocol error: too big inline request");
            setProtocolError(c,0);
        }
848
        return REDIS_ERR;
849
    }
850 851 852

    /* Split the input buffer up to the \r\n */
    querylen = newline-(c->querybuf);
853 854 855
    aux = sdsnewlen(c->querybuf,querylen);
    argv = sdssplitargs(aux,&argc);
    sdsfree(aux);
856 857

    /* Leave data after the first line of the query in the buffer */
858
    sdsrange(c->querybuf,querylen+2,-1);
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879

    /* 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) {
880 881 882 883 884 885
    if (server.verbosity >= REDIS_VERBOSE) {
        sds client = getClientInfoString(c);
        redisLog(REDIS_VERBOSE,
            "Protocol error from client: %s", client);
        sdsfree(client);
    }
886
    c->flags |= REDIS_CLOSE_AFTER_REPLY;
887
    sdsrange(c->querybuf,pos,-1);
888 889 890 891
}

int processMultibulkBuffer(redisClient *c) {
    char *newline = NULL;
892 893
    int pos = 0, ok;
    long long ll;
894 895 896

    if (c->multibulklen == 0) {
        /* The client should have been reset */
897
        redisAssertWithInfo(c,NULL,c->argc == 0);
898 899

        /* Multi bulk length cannot be read without a \r\n */
900
        newline = strchr(c->querybuf,'\r');
901 902 903 904 905
        if (newline == NULL) {
            if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
                addReplyError(c,"Protocol error: too big mbulk count string");
                setProtocolError(c,0);
            }
906
            return REDIS_ERR;
907
        }
908

P
Pieter Noordhuis 已提交
909 910 911 912
        /* Buffer should also contain \n */
        if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
            return REDIS_ERR;

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

        pos = (newline-c->querybuf)+2;
        if (ll <= 0) {
925
            sdsrange(c->querybuf,pos,-1);
P
Pieter Noordhuis 已提交
926 927 928
            return REDIS_OK;
        }

929
        c->multibulklen = ll;
930 931 932 933 934 935

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

936
    redisAssertWithInfo(c,NULL,c->multibulklen > 0);
937 938 939
    while(c->multibulklen) {
        /* Read bulk length if unknown */
        if (c->bulklen == -1) {
940
            newline = strchr(c->querybuf+pos,'\r');
941 942 943 944 945
            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 已提交
946
                break;
947
            }
P
Pieter Noordhuis 已提交
948 949 950

            /* Buffer should also contain \n */
            if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
951
                break;
P
Pieter Noordhuis 已提交
952 953 954 955 956 957 958

            if (c->querybuf[pos] != '$') {
                addReplyErrorFormat(c,
                    "Protocol error: expected '$', got '%c'",
                    c->querybuf[pos]);
                setProtocolError(c,pos);
                return REDIS_ERR;
959
            }
P
Pieter Noordhuis 已提交
960 961 962 963 964 965 966 967 968

            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;
969
            if (ll >= REDIS_MBULK_BIG_ARG) {
970 971
                /* If we are going to read a large object from network
                 * try to make it likely that it will start at c->querybuf
972
                 * boundary so that we can optimize object creation
973
                 * avoiding a large copy of data. */
974
                sdsrange(c->querybuf,pos,-1);
975
                pos = 0;
A
antirez 已提交
976 977
                /* Hint the sds library about the amount of bytes this string is
                 * going to contain. */
978
                c->querybuf = sdsMakeRoomFor(c->querybuf,ll+2-sdslen(c->querybuf));
A
antirez 已提交
979
            }
P
Pieter Noordhuis 已提交
980
            c->bulklen = ll;
981 982 983 984 985 986 987
        }

        /* Read bulk argument */
        if (sdslen(c->querybuf)-pos < (unsigned)(c->bulklen+2)) {
            /* Not enough data (+2 == trailing \r\n) */
            break;
        } else {
988
            /* Optimization: if the buffer contains JUST our bulk element
989 990 991
             * instead of creating a new object by *copying* the sds we
             * just use the current sds string. */
            if (pos == 0 &&
992
                c->bulklen >= REDIS_MBULK_BIG_ARG &&
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
                (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;
            }
1007 1008 1009 1010 1011 1012
            c->bulklen = -1;
            c->multibulklen--;
        }
    }

    /* Trim to pos */
1013
    if (pos) sdsrange(c->querybuf,pos,-1);
1014 1015

    /* We're done when c->multibulk == 0 */
1016 1017 1018
    if (c->multibulklen == 0) return REDIS_OK;

    /* Still not read to process the command */
1019 1020 1021 1022 1023 1024
    return REDIS_ERR;
}

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

1028 1029 1030 1031
        /* 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;
1032 1033 1034 1035 1036

        /* Determine request type when unknown. */
        if (!c->reqtype) {
            if (c->querybuf[0] == '*') {
                c->reqtype = REDIS_REQ_MULTIBULK;
1037
            } else {
1038
                c->reqtype = REDIS_REQ_INLINE;
1039 1040
            }
        }
1041 1042 1043 1044 1045 1046 1047

        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");
1048
        }
1049 1050

        /* Multibulk processing could see a <= 0 length. */
1051 1052 1053 1054 1055 1056 1057
        if (c->argc == 0) {
            resetClient(c);
        } else {
            /* Only reset the client when the command was executed. */
            if (processCommand(c) == REDIS_OK)
                resetClient(c);
        }
1058 1059 1060 1061 1062
    }
}

void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = (redisClient*) privdata;
1063
    int nread, readlen;
1064
    size_t qblen;
1065 1066 1067
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1068
    server.current_client = c;
1069 1070
    readlen = REDIS_IOBUF_LEN;
    /* If this is a multi bulk request, and we are processing a bulk reply
1071 1072 1073
     * 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
1074 1075 1076
     * processMultiBulkBuffer() can avoid copying buffers to create the
     * Redis Object representing the argument. */
    if (c->reqtype == REDIS_REQ_MULTIBULK && c->multibulklen && c->bulklen != -1
1077
        && c->bulklen >= REDIS_MBULK_BIG_ARG)
1078 1079 1080 1081 1082 1083
    {
        int remaining = (unsigned)(c->bulklen+2)-sdslen(c->querybuf);

        if (remaining < readlen) readlen = remaining;
    }

1084
    qblen = sdslen(c->querybuf);
1085
    if (c->querybuf_peak < qblen) c->querybuf_peak = qblen;
1086 1087
    c->querybuf = sdsMakeRoomFor(c->querybuf, readlen);
    nread = read(fd, c->querybuf+qblen, readlen);
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
    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) {
1102
        sdsIncrLen(c->querybuf,nread);
1103
        c->lastinteraction = server.unixtime;
1104
        if (c->flags & REDIS_MASTER) c->reploff += nread;
1105
    } else {
1106
        server.current_client = NULL;
1107 1108
        return;
    }
1109
    if (sdslen(c->querybuf) > server.client_max_querybuf_len) {
1110 1111 1112 1113
        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);
1114
        sdsfree(ci);
1115
        sdsfree(bytes);
1116 1117 1118
        freeClient(c);
        return;
    }
1119
    processInputBuffer(c);
1120
    server.current_client = NULL;
1121
}
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140

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

1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
/* 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 已提交
1152 1153 1154 1155 1156 1157 1158 1159
/* 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 已提交
1160 1161 1162 1163 1164 1165
 * 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 已提交
1166 1167 1168 1169 1170 1171
    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 已提交
1172
        return REDIS_OK;
A
antirez 已提交
1173 1174
    } else {
        /* TCP client. */
A
antirez 已提交
1175
        int retval = anetPeerToString(client->fd,ip,sizeof(ip),&port);
1176
        formatPeerId(peerid,peerid_len,ip,port);
A
antirez 已提交
1177
        return (retval == -1) ? REDIS_ERR : REDIS_OK;
A
antirez 已提交
1178 1179 1180
    }
}

1181 1182
/* Turn a Redis client into an sds string representing its state. */
sds getClientInfoString(redisClient *client) {
A
antirez 已提交
1183
    char peerid[REDIS_PEER_ID_LEN], flags[16], events[3], *p;
1184
    int emask;
1185

A
antirez 已提交
1186
    getClientPeerId(client,peerid,sizeof(peerid));
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
    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';
1200
    if (client->flags & REDIS_CLOSE_ASAP) *p++ = 'A';
1201
    if (client->flags & REDIS_UNIX_SOCKET) *p++ = 'U';
1202
    if (p == flags) *p++ = 'N';
1203
    *p++ = '\0';
1204 1205 1206 1207 1208 1209

    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';
1210
    return sdscatprintf(sdsempty(),
A
antirez 已提交
1211 1212
        "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,
1213 1214
        client->fd,
        client->name ? (char*)client->name->ptr : "",
1215 1216
        (long)(server.unixtime - client->ctime),
        (long)(server.unixtime - client->lastinteraction),
1217 1218 1219
        flags,
        client->db->id,
        (int) dictSize(client->pubsub_channels),
1220
        (int) listLength(client->pubsub_patterns),
1221
        (client->flags & REDIS_MULTI) ? client->mstate.count : -1,
1222
        (unsigned long) sdslen(client->querybuf),
1223
        (unsigned long) sdsavail(client->querybuf),
1224
        (unsigned long) client->bufpos,
1225
        (unsigned long) listLength(client->reply),
1226
        getClientOutputBufferMemoryUsage(client),
1227 1228
        events,
        client->lastcmd ? client->lastcmd->name : "NULL");
1229 1230
}

1231 1232 1233 1234 1235 1236 1237 1238
sds getAllClientsInfoString(void) {
    listNode *ln;
    listIter li;
    redisClient *client;
    sds o = sdsempty();

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

1241
        client = listNodeValue(ln);
1242 1243 1244
        cs = getClientInfoString(client);
        o = sdscatsds(o,cs);
        sdsfree(cs);
1245 1246 1247 1248 1249
        o = sdscatlen(o,"\n",1);
    }
    return o;
}

A
antirez 已提交
1250
void clientCommand(redisClient *c) {
A
antirez 已提交
1251 1252 1253 1254
    listNode *ln;
    listIter li;
    redisClient *client;

A
antirez 已提交
1255
    if (!strcasecmp(c->argv[1]->ptr,"list") && c->argc == 2) {
1256
        sds o = getAllClientsInfoString();
A
antirez 已提交
1257 1258
        addReplyBulkCBuffer(c,o,sdslen(o));
        sdsfree(o);
A
antirez 已提交
1259 1260 1261
    } else if (!strcasecmp(c->argv[1]->ptr,"kill") && c->argc == 3) {
        listRewind(server.clients,&li);
        while ((ln = listNext(&li)) != NULL) {
A
antirez 已提交
1262
            char peerid[REDIS_PEER_ID_LEN];
A
antirez 已提交
1263 1264

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

1316 1317 1318
/* 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. */
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
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;
1341
    c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
1342
    redisAssertWithInfo(c,NULL,c->cmd != NULL);
1343 1344
    va_end(ap);
}
1345 1346 1347 1348 1349 1350

/* 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;
   
1351
    redisAssertWithInfo(c,NULL,i < c->argc);
1352 1353 1354 1355 1356 1357 1358
    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) {
1359
        c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
1360
        redisAssertWithInfo(c,NULL,c->cmd != NULL);
1361 1362
    }
}
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375

/* 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 已提交
1376
 * enforcing the client output length limits. */
1377
unsigned long getClientOutputBufferMemoryUsage(redisClient *c) {
1378
    unsigned long list_item_size = sizeof(listNode)+sizeof(robj);
1379 1380 1381

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

1383
/* Get the class of a client, used in order to enforce limits to different
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
 * 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;
}
1397

1398 1399 1400
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;
1401
    else if (!strcasecmp(name,"pubsub")) return REDIS_CLIENT_LIMIT_CLASS_PUBSUB;
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413
    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;
    }
}

1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 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
/* 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
1455 1456
 * output buffer size. The caller can check if the client will be closed
 * checking if the client REDIS_CLOSE_ASAP flag is set.
1457 1458 1459 1460
 *
 * 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. */
1461
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c) {
1462
    redisAssert(c->reply_bytes < ULONG_MAX-(1024*64));
1463
    if (c->reply_bytes == 0 || c->flags & REDIS_CLOSE_ASAP) return;
1464 1465 1466 1467
    if (checkClientOutputBufferLimits(c)) {
        sds client = getClientInfoString(c);

        freeClientAsync(c);
1468
        redisLog(REDIS_WARNING,"Client %s scheduled to be closed ASAP for overcoming of output buffer limits.", client);
1469 1470 1471
        sdsfree(client);
    }
}
A
antirez 已提交
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492

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