networking.c 50.3 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 32
#include "redis.h"
#include <sys/uio.h>

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

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

43 44 45 46 47 48 49 50 51 52
void *dupClientReplyValue(void *o) {
    incrRefCount((robj*)o);
    return o;
}

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

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

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

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

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

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

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

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

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

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

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

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

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

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

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

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

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

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

    if (c->flags & REDIS_CLOSE_AFTER_REPLY) return;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

G
guiquanz 已提交
414
/* Add a double as a bulk reply */
415 416 417 418 419 420
void addReplyDouble(redisClient *c, double d) {
    char dbuf[128], sbuf[128];
    int dlen, slen;
    dlen = snprintf(dbuf,sizeof(dbuf),"%.17g",d);
    slen = snprintf(sbuf,sizeof(sbuf),"$%d\r\n%s\r\n",dlen,dbuf);
    addReplyString(c,sbuf,slen);
421 422
}

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

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

440
    buf[0] = prefix;
441 442 443
    len = ll2string(buf+1,sizeof(buf)-1,ll);
    buf[len+1] = '\r';
    buf[len+2] = '\n';
444
    addReplyString(c,buf,len+3);
445 446
}

447
void addReplyLongLong(redisClient *c, long long ll) {
448 449 450 451 452
    if (ll == 0)
        addReply(c,shared.czero);
    else if (ll == 1)
        addReply(c,shared.cone);
    else
453
        addReplyLongLongWithPrefix(c,ll,':');
454
}
455

456
void addReplyMultiBulkLen(redisClient *c, long length) {
457
    addReplyLongLongWithPrefix(c,length,'*');
458 459
}

460
/* Create the length prefix of a bulk reply, example: $2234 */
461
void addReplyBulkLen(redisClient *c, robj *obj) {
462
    size_t len;
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478

    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++;
        }
    }
479
    addReplyLongLongWithPrefix(c,len,'$');
480 481
}

482
/* Add a Redis Object as a bulk reply */
483 484 485 486 487 488
void addReplyBulk(redisClient *c, robj *obj) {
    addReplyBulkLen(c,obj);
    addReply(c,obj);
    addReply(c,shared.crlf);
}

489 490
/* Add a C buffer as bulk reply */
void addReplyBulkCBuffer(redisClient *c, void *p, size_t len) {
491
    addReplyLongLongWithPrefix(c,len,'$');
492 493 494 495 496
    addReplyString(c,p,len);
    addReply(c,shared.crlf);
}

/* Add a C nul term string as bulk reply */
497 498 499 500
void addReplyBulkCString(redisClient *c, char *s) {
    if (s == NULL) {
        addReply(c,shared.nullbulk);
    } else {
501
        addReplyBulkCBuffer(c,s,strlen(s));
502 503 504
    }
}

505 506 507 508 509 510 511 512 513
/* 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);
}

514 515 516 517 518 519 520 521
/* 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;
522
    dst->reply_bytes = src->reply_bytes;
523 524
}

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

553 554 555 556 557 558 559 560 561
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
    int cport, cfd;
    char cip[128];
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);
    REDIS_NOTUSED(privdata);

    cfd = anetTcpAccept(server.neterr, fd, cip, &cport);
    if (cfd == AE_ERR) {
562
        redisLog(REDIS_WARNING,"Accepting client connection: %s", server.neterr);
563 564 565
        return;
    }
    redisLog(REDIS_VERBOSE,"Accepted %s:%d", cip, cport);
566
    acceptCommonHandler(cfd,0);
567 568 569 570 571 572 573 574
}

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

575
    cfd = anetUnixAccept(server.neterr, fd);
576
    if (cfd == AE_ERR) {
577
        redisLog(REDIS_WARNING,"Accepting client connection: %s", server.neterr);
578 579 580
        return;
    }
    redisLog(REDIS_VERBOSE,"Accepted connection to %s", server.unixsocket);
581
    acceptCommonHandler(cfd,REDIS_UNIX_SOCKET);
582 583 584
}


585 586 587 588 589
static void freeClientArgv(redisClient *c) {
    int j;
    for (j = 0; j < c->argc; j++)
        decrRefCount(c->argv[j]);
    c->argc = 0;
590
    c->cmd = NULL;
591 592
}

593 594 595 596 597 598 599 600 601 602
/* 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);
    }
}

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

617 618 619
void freeClient(redisClient *c) {
    listNode *ln;

620 621 622
    /* If this is marked as current client unset it */
    if (server.current_client == c) server.current_client = NULL;

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
    /* 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;
    }

639 640 641 642 643 644 645 646 647
    /* 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);
648
    dictRelease(c->bpop.keys);
649 650 651 652 653 654 655 656 657

    /* 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);
658 659 660 661 662 663 664
    /* 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);
    }
665 666 667
    listRelease(c->reply);
    freeClientArgv(c);
    /* Remove from the list of clients */
668 669 670 671 672
    if (c->fd != -1) {
        ln = listSearchKey(server.clients,c);
        redisAssert(ln != NULL);
        listDelNode(server.clients,ln);
    }
673 674 675 676 677 678 679
    /* 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);
    }
680
    listRelease(c->io_keys);
681 682
    /* Master/slave cleanup.
     * Case 1: we lost the connection with a slave. */
683 684 685 686 687 688 689
    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);
690 691 692 693 694
        /* 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;
695
        refreshGoodSlavesCount();
696
    }
697 698

    /* Case 2: we lost the connection with the master. */
699
    if (c->flags & REDIS_MASTER) replicationHandleMasterDisconnection();
700 701 702 703 704 705 706 707 708

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

709
    /* Release memory */
710
    if (c->name) decrRefCount(c->name);
711 712 713 714 715
    zfree(c->argv);
    freeClientMultiState(c);
    zfree(c);
}

716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
/* 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);
    }
}

737 738 739
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = privdata;
    int nwritten = 0, totwritten = 0, objlen;
740
    size_t objmem;
741 742 743 744
    robj *o;
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

745 746
    while(c->bufpos > 0 || listLength(c->reply)) {
        if (c->bufpos > 0) {
747 748
            nwritten = write(fd,c->buf+c->sentlen,c->bufpos-c->sentlen);
            if (nwritten <= 0) break;
749 750 751 752 753 754 755 756 757 758 759 760
            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);
761
            objmem = zmalloc_size_sds(o->ptr);
762

763 764 765 766
            if (objlen == 0) {
                listDelNode(c->reply,listFirst(c->reply));
                continue;
            }
767

768 769
            nwritten = write(fd, ((char*)o->ptr)+c->sentlen,objlen-c->sentlen);
            if (nwritten <= 0) break;
770 771
            c->sentlen += nwritten;
            totwritten += nwritten;
772

773 774 775 776
            /* 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;
777
                c->reply_bytes -= objmem;
778
            }
779
        }
780
        /* Note that we avoid to send more than REDIS_MAX_WRITE_PER_EVENT
781 782 783
         * 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
784 785 786 787 788 789 790
         * 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;
791 792 793 794 795 796 797 798 799 800 801
    }
    if (nwritten == -1) {
        if (errno == EAGAIN) {
            nwritten = 0;
        } else {
            redisLog(REDIS_VERBOSE,
                "Error writing to client: %s", strerror(errno));
            freeClient(c);
            return;
        }
    }
802
    if (totwritten > 0) c->lastinteraction = server.unixtime;
803
    if (c->bufpos == 0 && listLength(c->reply) == 0) {
804 805
        c->sentlen = 0;
        aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
P
Pieter Noordhuis 已提交
806 807

        /* Close connection after entire reply has been sent. */
808
        if (c->flags & REDIS_CLOSE_AFTER_REPLY) freeClient(c);
809 810 811 812 813
    }
}

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

816
    freeClientArgv(c);
817 818
    c->reqtype = 0;
    c->multibulklen = 0;
819
    c->bulklen = -1;
820 821 822 823
    /* We clear the ASKING flag as well if we are not inside a MULTI, and
     * if what we just executed is not the ASKING command itself. */
    if (!(c->flags & REDIS_MULTI) && prevcmd != askingCommand)
        c->flags &= (~REDIS_ASKING);
824 825
}

826 827 828 829 830 831 832
int processInlineBuffer(redisClient *c) {
    char *newline = strstr(c->querybuf,"\r\n");
    int argc, j;
    sds *argv;
    size_t querylen;

    /* Nothing to do without a \r\n */
833 834 835 836 837
    if (newline == NULL) {
        if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
            addReplyError(c,"Protocol error: too big inline request");
            setProtocolError(c,0);
        }
838
        return REDIS_ERR;
839
    }
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867

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

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

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

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

/* Helper function. Trims query buffer to make the function that processes
 * multi bulk requests idempotent. */
static void setProtocolError(redisClient *c, int pos) {
868 869 870 871 872 873
    if (server.verbosity >= REDIS_VERBOSE) {
        sds client = getClientInfoString(c);
        redisLog(REDIS_VERBOSE,
            "Protocol error from client: %s", client);
        sdsfree(client);
    }
874 875 876 877 878 879
    c->flags |= REDIS_CLOSE_AFTER_REPLY;
    c->querybuf = sdsrange(c->querybuf,pos,-1);
}

int processMultibulkBuffer(redisClient *c) {
    char *newline = NULL;
880 881
    int pos = 0, ok;
    long long ll;
882 883 884

    if (c->multibulklen == 0) {
        /* The client should have been reset */
885
        redisAssertWithInfo(c,NULL,c->argc == 0);
886 887

        /* Multi bulk length cannot be read without a \r\n */
888
        newline = strchr(c->querybuf,'\r');
889 890 891 892 893
        if (newline == NULL) {
            if (sdslen(c->querybuf) > REDIS_INLINE_MAX_SIZE) {
                addReplyError(c,"Protocol error: too big mbulk count string");
                setProtocolError(c,0);
            }
894
            return REDIS_ERR;
895
        }
896

P
Pieter Noordhuis 已提交
897 898 899 900
        /* Buffer should also contain \n */
        if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
            return REDIS_ERR;

901 902
        /* We know for sure there is a whole line since newline != NULL,
         * so go ahead and find out the multi bulk length. */
903
        redisAssertWithInfo(c,NULL,c->querybuf[0] == '*');
904 905
        ok = string2ll(c->querybuf+1,newline-(c->querybuf+1),&ll);
        if (!ok || ll > 1024*1024) {
906 907 908
            addReplyError(c,"Protocol error: invalid multibulk length");
            setProtocolError(c,pos);
            return REDIS_ERR;
909
        }
P
Pieter Noordhuis 已提交
910 911 912 913 914 915 916

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

917
        c->multibulklen = ll;
918 919 920 921 922 923

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

924
    redisAssertWithInfo(c,NULL,c->multibulklen > 0);
925 926 927
    while(c->multibulklen) {
        /* Read bulk length if unknown */
        if (c->bulklen == -1) {
928
            newline = strchr(c->querybuf+pos,'\r');
929 930 931 932 933
            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 已提交
934
                break;
935
            }
P
Pieter Noordhuis 已提交
936 937 938

            /* Buffer should also contain \n */
            if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
939
                break;
P
Pieter Noordhuis 已提交
940 941 942 943 944 945 946

            if (c->querybuf[pos] != '$') {
                addReplyErrorFormat(c,
                    "Protocol error: expected '$', got '%c'",
                    c->querybuf[pos]);
                setProtocolError(c,pos);
                return REDIS_ERR;
947
            }
P
Pieter Noordhuis 已提交
948 949 950 951 952 953 954 955 956

            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;
957
            if (ll >= REDIS_MBULK_BIG_ARG) {
958 959 960 961 962 963
                /* If we are going to read a large object from network
                 * try to make it likely that it will start at c->querybuf
                 * boundary so that we can optimized object creation
                 * avoiding a large copy of data. */
                c->querybuf = sdsrange(c->querybuf,pos,-1);
                pos = 0;
A
antirez 已提交
964 965
                /* Hint the sds library about the amount of bytes this string is
                 * going to contain. */
966
                c->querybuf = sdsMakeRoomFor(c->querybuf,ll+2);
A
antirez 已提交
967
            }
P
Pieter Noordhuis 已提交
968
            c->bulklen = ll;
969 970 971 972 973 974 975
        }

        /* Read bulk argument */
        if (sdslen(c->querybuf)-pos < (unsigned)(c->bulklen+2)) {
            /* Not enough data (+2 == trailing \r\n) */
            break;
        } else {
976
            /* Optimization: if the buffer contains JUST our bulk element
977 978 979
             * instead of creating a new object by *copying* the sds we
             * just use the current sds string. */
            if (pos == 0 &&
980
                c->bulklen >= REDIS_MBULK_BIG_ARG &&
981 982 983 984 985 986 987 988 989 990 991 992 993 994
                (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;
            }
995 996 997 998 999 1000
            c->bulklen = -1;
            c->multibulklen--;
        }
    }

    /* Trim to pos */
1001
    if (pos) c->querybuf = sdsrange(c->querybuf,pos,-1);
1002 1003

    /* We're done when c->multibulk == 0 */
1004 1005 1006
    if (c->multibulklen == 0) return REDIS_OK;

    /* Still not read to process the command */
1007 1008 1009 1010 1011 1012
    return REDIS_ERR;
}

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

1016 1017 1018 1019
        /* 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;
1020 1021 1022 1023 1024

        /* Determine request type when unknown. */
        if (!c->reqtype) {
            if (c->querybuf[0] == '*') {
                c->reqtype = REDIS_REQ_MULTIBULK;
1025
            } else {
1026
                c->reqtype = REDIS_REQ_INLINE;
1027 1028
            }
        }
1029 1030 1031 1032 1033 1034 1035

        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");
1036
        }
1037 1038

        /* Multibulk processing could see a <= 0 length. */
1039 1040 1041 1042 1043 1044 1045
        if (c->argc == 0) {
            resetClient(c);
        } else {
            /* Only reset the client when the command was executed. */
            if (processCommand(c) == REDIS_OK)
                resetClient(c);
        }
1046 1047 1048 1049 1050
    }
}

void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    redisClient *c = (redisClient*) privdata;
1051
    int nread, readlen;
1052
    size_t qblen;
1053 1054 1055
    REDIS_NOTUSED(el);
    REDIS_NOTUSED(mask);

1056
    server.current_client = c;
1057 1058
    readlen = REDIS_IOBUF_LEN;
    /* If this is a multi bulk request, and we are processing a bulk reply
1059 1060 1061
     * 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
1062 1063 1064
     * processMultiBulkBuffer() can avoid copying buffers to create the
     * Redis Object representing the argument. */
    if (c->reqtype == REDIS_REQ_MULTIBULK && c->multibulklen && c->bulklen != -1
1065
        && c->bulklen >= REDIS_MBULK_BIG_ARG)
1066 1067 1068 1069 1070 1071
    {
        int remaining = (unsigned)(c->bulklen+2)-sdslen(c->querybuf);

        if (remaining < readlen) readlen = remaining;
    }

1072
    qblen = sdslen(c->querybuf);
1073
    if (c->querybuf_peak < qblen) c->querybuf_peak = qblen;
1074 1075
    c->querybuf = sdsMakeRoomFor(c->querybuf, readlen);
    nread = read(fd, c->querybuf+qblen, readlen);
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
    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) {
1090
        sdsIncrLen(c->querybuf,nread);
1091
        c->lastinteraction = server.unixtime;
1092
        if (c->flags & REDIS_MASTER) c->reploff += nread;
1093
    } else {
1094
        server.current_client = NULL;
1095 1096
        return;
    }
1097
    if (sdslen(c->querybuf) > server.client_max_querybuf_len) {
1098 1099 1100 1101
        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);
1102
        sdsfree(ci);
1103
        sdsfree(bytes);
1104 1105 1106
        freeClient(c);
        return;
    }
1107
    processInputBuffer(c);
1108
    server.current_client = NULL;
1109
}
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128

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

1129 1130
/* Turn a Redis client into an sds string representing its state. */
sds getClientInfoString(redisClient *client) {
1131
    char ip[32], flags[16], events[3], *p;
1132
    int port = 0; /* initialized to zero for the unix socket case. */
1133
    int emask;
1134

1135 1136
    if (!(client->flags & REDIS_UNIX_SOCKET))
        anetPeerToString(client->fd,ip,&port);
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
    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';
1150
    if (client->flags & REDIS_CLOSE_ASAP) *p++ = 'A';
1151
    if (client->flags & REDIS_UNIX_SOCKET) *p++ = 'U';
1152
    if (p == flags) *p++ = 'N';
1153
    *p++ = '\0';
1154 1155 1156 1157 1158 1159

    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';
1160
    return sdscatprintf(sdsempty(),
1161
        "addr=%s:%d 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",
1162
        (client->flags & REDIS_UNIX_SOCKET) ? server.unixsocket : ip,
1163 1164 1165
        port,
        client->fd,
        client->name ? (char*)client->name->ptr : "",
1166 1167
        (long)(server.unixtime - client->ctime),
        (long)(server.unixtime - client->lastinteraction),
1168 1169 1170
        flags,
        client->db->id,
        (int) dictSize(client->pubsub_channels),
1171
        (int) listLength(client->pubsub_patterns),
1172
        (client->flags & REDIS_MULTI) ? client->mstate.count : -1,
1173
        (unsigned long) sdslen(client->querybuf),
1174
        (unsigned long) sdsavail(client->querybuf),
1175
        (unsigned long) client->bufpos,
1176
        (unsigned long) listLength(client->reply),
1177
        getClientOutputBufferMemoryUsage(client),
1178 1179
        events,
        client->lastcmd ? client->lastcmd->name : "NULL");
1180 1181
}

1182 1183 1184 1185 1186 1187 1188 1189
sds getAllClientsInfoString(void) {
    listNode *ln;
    listIter li;
    redisClient *client;
    sds o = sdsempty();

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

1192
        client = listNodeValue(ln);
1193 1194 1195
        cs = getClientInfoString(client);
        o = sdscatsds(o,cs);
        sdsfree(cs);
1196 1197 1198 1199 1200
        o = sdscatlen(o,"\n",1);
    }
    return o;
}

A
antirez 已提交
1201
void clientCommand(redisClient *c) {
A
antirez 已提交
1202 1203 1204 1205
    listNode *ln;
    listIter li;
    redisClient *client;

A
antirez 已提交
1206
    if (!strcasecmp(c->argv[1]->ptr,"list") && c->argc == 2) {
1207
        sds o = getAllClientsInfoString();
A
antirez 已提交
1208 1209
        addReplyBulkCBuffer(c,o,sdslen(o));
        sdsfree(o);
A
antirez 已提交
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
    } else if (!strcasecmp(c->argv[1]->ptr,"kill") && c->argc == 3) {
        listRewind(server.clients,&li);
        while ((ln = listNext(&li)) != NULL) {
            char ip[32], addr[64];
            int port;

            client = listNodeValue(ln);
            if (anetPeerToString(client->fd,ip,&port) == -1) continue;
            snprintf(addr,sizeof(addr),"%s:%d",ip,port);
            if (strcmp(addr,c->argv[2]->ptr) == 0) {
                addReply(c,shared.ok);
                if (c == client) {
                    client->flags |= REDIS_CLOSE_AFTER_REPLY;
                } else {
                    freeClient(client);
                }
                return;
            }
        }
        addReplyError(c,"No such client");
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
    } 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 已提交
1247
            if (p[j] < '!' || p[j] > '~') { /* ASCII is assumed. */
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
                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 已提交
1263
    } else {
B
bitterb 已提交
1264
        addReplyError(c, "Syntax error, try CLIENT (LIST | KILL ip:port | GETNAME | SETNAME connection-name)");
A
antirez 已提交
1265 1266
    }
}
1267

1268 1269 1270
/* 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. */
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
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;
1293
    c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
1294
    redisAssertWithInfo(c,NULL,c->cmd != NULL);
1295 1296
    va_end(ap);
}
1297 1298 1299 1300 1301 1302

/* 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;
   
1303
    redisAssertWithInfo(c,NULL,i < c->argc);
1304 1305 1306 1307 1308 1309 1310
    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) {
1311
        c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
1312
        redisAssertWithInfo(c,NULL,c->cmd != NULL);
1313 1314
    }
}
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327

/* 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 已提交
1328
 * enforcing the client output length limits. */
1329
unsigned long getClientOutputBufferMemoryUsage(redisClient *c) {
1330
    unsigned long list_item_size = sizeof(listNode)+sizeof(robj);
1331 1332 1333

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

1335
/* Get the class of a client, used in order to enforce limits to different
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
 * 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;
}
1349

1350 1351 1352
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;
1353
    else if (!strcasecmp(name,"pubsub")) return REDIS_CLIENT_LIMIT_CLASS_PUBSUB;
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
    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;
    }
}

1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406
/* 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
1407 1408
 * output buffer size. The caller can check if the client will be closed
 * checking if the client REDIS_CLOSE_ASAP flag is set.
1409 1410 1411 1412
 *
 * 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. */
1413
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c) {
1414
    redisAssert(c->reply_bytes < ULONG_MAX-(1024*64));
1415
    if (c->reply_bytes == 0 || c->flags & REDIS_CLOSE_ASAP) return;
1416 1417 1418 1419
    if (checkClientOutputBufferLimits(c)) {
        sds client = getClientInfoString(c);

        freeClientAsync(c);
1420
        redisLog(REDIS_WARNING,"Client %s scheduled to be closed ASAP for overcoming of output buffer limits.", client);
1421 1422 1423
        sdsfree(client);
    }
}
A
antirez 已提交
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444

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