networking.c 76.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
#include "server.h"
31
#include "atomicvar.h"
32
#include <sys/uio.h>
33
#include <math.h>
A
antirez 已提交
34
#include <ctype.h>
35

36
static void setProtocolError(const char *errstr, client *c, long pos);
37

38 39 40 41 42 43 44
/* Return the size consumed from the allocator, for the specified SDS string,
 * including internal fragmentation. This function is used in order to compute
 * the client output buffer size. */
size_t sdsZmallocSize(sds s) {
    void *sh = sdsAllocPtr(s);
    return zmalloc_size(sh);
}
45

46 47 48
/* Return the amount of memory used by the sds string at object->ptr
 * for a string object. */
size_t getStringObjectSdsUsedMemory(robj *o) {
A
antirez 已提交
49
    serverAssertWithInfo(NULL,o,o->type == OBJ_STRING);
50
    switch(o->encoding) {
51 52
    case OBJ_ENCODING_RAW: return sdsZmallocSize(o->ptr);
    case OBJ_ENCODING_EMBSTR: return zmalloc_size(o)-sizeof(robj);
53 54 55 56
    default: return 0; /* Just integer encoding for now. */
    }
}

57
/* Client.reply list dup and free methods. */
58
void *dupClientReplyValue(void *o) {
59 60 61 62 63
    return sdsdup(o);
}

void freeClientReplyValue(void *o) {
    sdsfree(o);
64 65 66 67 68 69
}

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

70 71 72 73 74 75 76 77 78 79
/* This function links the client to the global linked list of clients.
 * unlinkClient() does the opposite, among other things. */
void linkClient(client *c) {
    listAddNodeTail(server.clients,c);
    /* Note that we remember the linked list node where the client is stored,
     * this way removing the client in unlinkClient() will not require
     * a linear scan, but just a constant time operation. */
    c->client_list_node = listLast(server.clients);
}

80 81
client *createClient(int fd) {
    client *c = zmalloc(sizeof(client));
82

83
    /* passing -1 as fd it is possible to create a non connected client.
A
antirez 已提交
84
     * This is useful since all the commands needs to be executed
85 86 87 88
     * 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);
89
        anetEnableTcpNoDelay(NULL,fd);
90 91
        if (server.tcpkeepalive)
            anetKeepAlive(NULL,fd,server.tcpkeepalive);
92 93 94 95 96 97 98
        if (aeCreateFileEvent(server.el,fd,AE_READABLE,
            readQueryFromClient, c) == AE_ERR)
        {
            close(fd);
            zfree(c);
            return NULL;
        }
99 100
    }

101
    selectDb(c,0);
102 103 104
    uint64_t client_id;
    atomicGetIncr(server.next_client_id,client_id,1);
    c->id = client_id;
105
    c->fd = fd;
106
    c->name = NULL;
107
    c->bufpos = 0;
108
    c->querybuf = sdsempty();
109
    c->pending_querybuf = sdsempty();
110
    c->querybuf_peak = 0;
111
    c->reqtype = 0;
112 113
    c->argc = 0;
    c->argv = NULL;
114
    c->cmd = c->lastcmd = NULL;
115
    c->multibulklen = 0;
116 117 118
    c->bulklen = -1;
    c->sentlen = 0;
    c->flags = 0;
119
    c->ctime = c->lastinteraction = server.unixtime;
120
    c->authenticated = 0;
A
antirez 已提交
121
    c->replstate = REPL_STATE_NONE;
A
antirez 已提交
122
    c->repl_put_online_on_ack = 0;
123
    c->reploff = 0;
124
    c->read_reploff = 0;
A
antirez 已提交
125 126
    c->repl_ack_off = 0;
    c->repl_ack_time = 0;
A
antirez 已提交
127
    c->slave_listening_port = 0;
128
    c->slave_ip[0] = '\0';
129
    c->slave_capa = SLAVE_CAPA_NONE;
130
    c->reply = listCreate();
131
    c->reply_bytes = 0;
132
    c->obuf_soft_limit_reached_time = 0;
133
    listSetFreeMethod(c->reply,freeClientReplyValue);
134
    listSetDupMethod(c->reply,dupClientReplyValue);
A
antirez 已提交
135
    c->btype = BLOCKED_NONE;
136
    c->bpop.timeout = 0;
137
    c->bpop.keys = dictCreate(&objectKeyPointerValueDictType,NULL);
138
    c->bpop.target = NULL;
139 140
    c->bpop.numreplicas = 0;
    c->bpop.reploffset = 0;
141
    c->woff = 0;
142
    c->watched_keys = listCreate();
143
    c->pubsub_channels = dictCreate(&objectKeyPointerValueDictType,NULL);
144
    c->pubsub_patterns = listCreate();
145
    c->peerid = NULL;
146
    c->client_list_node = NULL;
147
    listSetFreeMethod(c->pubsub_patterns,decrRefCountVoid);
148
    listSetMatchMethod(c->pubsub_patterns,listMatchObjects);
149
    if (fd != -1) linkClient(c);
150 151 152 153
    initClientMultiState(c);
    return c;
}

154 155 156 157
/* 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
158
 * returns C_OK, and make sure to install the write handler in our event
159 160
 * loop so that when the socket is writable new data gets written.
 *
161 162
 * If the client should not receive new data, because it is a fake client
 * (used to load AOF in memory), a master or because the setup of the write
163
 * handler failed, the function returns C_ERR.
164
 *
165
 * The function may return C_OK without actually installing the write
166 167 168
 * event handler in the following cases:
 *
 * 1) The event handler should already be installed since the output buffer
169
 *    already contains something.
170 171
 * 2) The client is a slave but not yet online, so we want to just accumulate
 *    writes in the buffer but not actually sending them yet.
172 173
 *
 * Typically gets called every time a reply is built, before adding more
174
 * data to the clients output buffers. If the function returns C_ERR no
175
 * data should be appended to the output buffers. */
176
int prepareClientToWrite(client *c) {
177 178
    /* If it's the Lua client we always return ok without installing any
     * handler since there is no socket at all. */
A
antirez 已提交
179
    if (c->flags & (CLIENT_LUA|CLIENT_MODULE)) return C_OK;
180

181 182 183
    /* CLIENT REPLY OFF / SKIP handling: don't send replies. */
    if (c->flags & (CLIENT_REPLY_OFF|CLIENT_REPLY_SKIP)) return C_ERR;

A
antirez 已提交
184
    /* Masters don't receive replies, unless CLIENT_MASTER_FORCE_REPLY flag
185
     * is set. */
A
antirez 已提交
186 187
    if ((c->flags & CLIENT_MASTER) &&
        !(c->flags & CLIENT_MASTER_FORCE_REPLY)) return C_ERR;
188

189
    if (c->fd <= 0) return C_ERR; /* Fake client for AOF loading. */
190

191
    /* Schedule the client to write the output buffers to the socket only
192
     * if not already done (there were no pending writes already and the client
193 194 195
     * was yet not flagged), and, for slaves, if the slave can actually
     * receive writes at this stage. */
    if (!clientHasPendingReplies(c) &&
196
        !(c->flags & CLIENT_PENDING_WRITE) &&
A
antirez 已提交
197 198
        (c->replstate == REPL_STATE_NONE ||
         (c->replstate == SLAVE_STATE_ONLINE && !c->repl_put_online_on_ack)))
199
    {
200 201 202 203 204 205 206
        /* Here instead of installing the write handler, we just flag the
         * client and put it into a list of clients that have something
         * to write to the socket. This way before re-entering the event
         * loop, we can try to directly write to the client sockets avoiding
         * a system call. We'll only really install the write handler if
         * we'll not be able to write the whole reply at once. */
        c->flags |= CLIENT_PENDING_WRITE;
207
        listAddNodeHead(server.clients_pending_write,c);
208 209 210
    }

    /* Authorize the caller to queue in the output buffer of this client. */
211
    return C_OK;
212 213
}

214 215 216 217
/* -----------------------------------------------------------------------------
 * Low level functions to add more data to output buffers.
 * -------------------------------------------------------------------------- */

218
int _addReplyToBuffer(client *c, const char *s, size_t len) {
219
    size_t available = sizeof(c->buf)-c->bufpos;
220

A
antirez 已提交
221
    if (c->flags & CLIENT_CLOSE_AFTER_REPLY) return C_OK;
222

223 224
    /* If there already are entries in the reply list, we cannot
     * add anything more to the static buffer. */
225
    if (listLength(c->reply) > 0) return C_ERR;
226 227

    /* Check that the buffer has enough space available for this string. */
228
    if (len > available) return C_ERR;
229

230 231
    memcpy(c->buf+c->bufpos,s,len);
    c->bufpos+=len;
232
    return C_OK;
233 234
}

235
void _addReplyObjectToList(client *c, robj *o) {
A
antirez 已提交
236
    if (c->flags & CLIENT_CLOSE_AFTER_REPLY) return;
237

238
    if (listLength(c->reply) == 0) {
239 240 241
        sds s = sdsdup(o->ptr);
        listAddNodeTail(c->reply,s);
        c->reply_bytes += sdslen(s);
242
    } else {
243 244 245 246 247 248 249 250 251
        listNode *ln = listLast(c->reply);
        sds tail = listNodeValue(ln);

        /* Append to this object when possible. If tail == NULL it was
         * set via addDeferredMultiBulkLength(). */
        if (tail && sdslen(tail)+sdslen(o->ptr) <= PROTO_REPLY_CHUNK_BYTES) {
            tail = sdscatsds(tail,o->ptr);
            listNodeValue(ln) = tail;
            c->reply_bytes += sdslen(o->ptr);
252
        } else {
253 254 255
            sds s = sdsdup(o->ptr);
            listAddNodeTail(c->reply,s);
            c->reply_bytes += sdslen(s);
256 257
        }
    }
258
    asyncCloseClientOnOutputBufferLimitReached(c);
259
}
260

261 262
/* 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. */
263
void _addReplySdsToList(client *c, sds s) {
A
antirez 已提交
264
    if (c->flags & CLIENT_CLOSE_AFTER_REPLY) {
265 266 267
        sdsfree(s);
        return;
    }
268

269
    if (listLength(c->reply) == 0) {
270 271
        listAddNodeTail(c->reply,s);
        c->reply_bytes += sdslen(s);
272
    } else {
273 274 275 276 277 278 279 280 281
        listNode *ln = listLast(c->reply);
        sds tail = listNodeValue(ln);

        /* Append to this object when possible. If tail == NULL it was
         * set via addDeferredMultiBulkLength(). */
        if (tail && sdslen(tail)+sdslen(s) <= PROTO_REPLY_CHUNK_BYTES) {
            tail = sdscatsds(tail,s);
            listNodeValue(ln) = tail;
            c->reply_bytes += sdslen(s);
282
            sdsfree(s);
283
        } else {
284 285
            listAddNodeTail(c->reply,s);
            c->reply_bytes += sdslen(s);
286
        }
287
    }
288
    asyncCloseClientOnOutputBufferLimitReached(c);
289 290
}

291
void _addReplyStringToList(client *c, const char *s, size_t len) {
A
antirez 已提交
292
    if (c->flags & CLIENT_CLOSE_AFTER_REPLY) return;
293

294
    if (listLength(c->reply) == 0) {
295 296 297
        sds node = sdsnewlen(s,len);
        listAddNodeTail(c->reply,node);
        c->reply_bytes += len;
298
    } else {
299 300 301 302 303 304 305 306 307
        listNode *ln = listLast(c->reply);
        sds tail = listNodeValue(ln);

        /* Append to this object when possible. If tail == NULL it was
         * set via addDeferredMultiBulkLength(). */
        if (tail && sdslen(tail)+len <= PROTO_REPLY_CHUNK_BYTES) {
            tail = sdscatlen(tail,s,len);
            listNodeValue(ln) = tail;
            c->reply_bytes += len;
308
        } else {
309 310 311
            sds node = sdsnewlen(s,len);
            listAddNodeTail(c->reply,node);
            c->reply_bytes += len;
312 313
        }
    }
314
    asyncCloseClientOnOutputBufferLimitReached(c);
315
}
316

317 318 319 320 321
/* -----------------------------------------------------------------------------
 * Higher level functions to queue data on the client output buffer.
 * The following functions are the ones that commands implementations will call.
 * -------------------------------------------------------------------------- */

322
void addReply(client *c, robj *obj) {
323
    if (prepareClientToWrite(c) != C_OK) return;
324 325 326 327 328 329 330 331

    /* 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. */
332
    if (sdsEncodedObject(obj)) {
333
        if (_addReplyToBuffer(c,obj->ptr,sdslen(obj->ptr)) != C_OK)
334
            _addReplyObjectToList(c,obj);
335
    } else if (obj->encoding == OBJ_ENCODING_INT) {
336 337 338 339 340 341 342 343
        /* 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);
344
            if (_addReplyToBuffer(c,buf,len) == C_OK)
345 346 347 348
                return;
            /* else... continue with the normal code path, but should never
             * happen actually since we verified there is room. */
        }
349
        obj = getDecodedObject(obj);
350
        if (_addReplyToBuffer(c,obj->ptr,sdslen(obj->ptr)) != C_OK)
351 352
            _addReplyObjectToList(c,obj);
        decrRefCount(obj);
353
    } else {
A
antirez 已提交
354
        serverPanic("Wrong obj->encoding in addReply()");
355 356 357
    }
}

358
void addReplySds(client *c, sds s) {
359
    if (prepareClientToWrite(c) != C_OK) {
360 361 362 363
        /* The caller expects the sds to be free'd. */
        sdsfree(s);
        return;
    }
364
    if (_addReplyToBuffer(c,s,sdslen(s)) == C_OK) {
365 366
        sdsfree(s);
    } else {
367 368
        /* This method free's the sds when it is no longer needed. */
        _addReplySdsToList(c,s);
369
    }
370 371
}

372 373 374 375 376 377 378 379
/* This low level function just adds whatever protocol you send it to the
 * client buffer, trying the static buffer initially, and using the string
 * of objects if not possible.
 *
 * It is efficient because does not create an SDS object nor an Redis object
 * if not needed. The object will only be created by calling
 * _addReplyStringToList() if we fail to extend the existing tail object
 * in the list of objects. */
380
void addReplyString(client *c, const char *s, size_t len) {
381 382
    if (prepareClientToWrite(c) != C_OK) return;
    if (_addReplyToBuffer(c,s,len) != C_OK)
383
        _addReplyStringToList(c,s,len);
384
}
385

386
void addReplyErrorLength(client *c, const char *s, size_t len) {
387 388 389
    addReplyString(c,"-ERR ",5);
    addReplyString(c,s,len);
    addReplyString(c,"\r\n",2);
390 391 392
    if (c->flags & (CLIENT_MASTER|CLIENT_SLAVE)) {
        char* to = c->flags & CLIENT_MASTER? "master": "slave";
        char* from = c->flags & CLIENT_MASTER? "slave": "master";
393
        char *cmdname = c->lastcmd ? c->lastcmd->name : "<unknown>";
394 395 396
        serverLog(LL_WARNING,"== CRITICAL == This %s is sending an error "
                             "to its %s: '%s' after processing the command "
                             "'%s'", from, to, s, cmdname);
397
    }
398 399
}

400
void addReplyError(client *c, const char *err) {
401
    addReplyErrorLength(c,err,strlen(err));
402
}
403

404
void addReplyErrorFormat(client *c, const char *fmt, ...) {
405
    size_t l, j;
406 407 408 409
    va_list ap;
    va_start(ap,fmt);
    sds s = sdscatvprintf(sdsempty(),fmt,ap);
    va_end(ap);
410 411 412 413 414 415
    /* 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] = ' ';
    }
416
    addReplyErrorLength(c,s,sdslen(s));
417 418 419
    sdsfree(s);
}

420
void addReplyStatusLength(client *c, const char *s, size_t len) {
421 422 423 424 425
    addReplyString(c,"+",1);
    addReplyString(c,s,len);
    addReplyString(c,"\r\n",2);
}

426
void addReplyStatus(client *c, const char *status) {
427
    addReplyStatusLength(c,status,strlen(status));
428 429
}

430
void addReplyStatusFormat(client *c, const char *fmt, ...) {
431 432 433 434
    va_list ap;
    va_start(ap,fmt);
    sds s = sdscatvprintf(sdsempty(),fmt,ap);
    va_end(ap);
435
    addReplyStatusLength(c,s,sdslen(s));
436 437 438
    sdsfree(s);
}

439 440
/* Adds an empty object to the reply list that will contain the multi bulk
 * length, which is not known when this function is called. */
441
void *addDeferredMultiBulkLength(client *c) {
442 443 444
    /* 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. */
445
    if (prepareClientToWrite(c) != C_OK) return NULL;
446
    listAddNodeTail(c->reply,NULL); /* NULL is our placeholder. */
447 448 449
    return listLast(c->reply);
}

G
guiquanz 已提交
450
/* Populate the length object and try gluing it to the next chunk. */
451
void setDeferredMultiBulkLength(client *c, void *node, long length) {
452
    listNode *ln = (listNode*)node;
453
    sds len, next;
454

455 456
    /* Abort when *node is NULL: when the client should not accept writes
     * we return NULL in addDeferredMultiBulkLength() */
457 458
    if (node == NULL) return;

459 460 461
    len = sdscatprintf(sdsnewlen("*",1),"%ld\r\n",length);
    listNodeValue(ln) = len;
    c->reply_bytes += sdslen(len);
462 463
    if (ln->next != NULL) {
        next = listNodeValue(ln->next);
464

465
        /* Only glue when the next node is non-NULL (an sds in this case) */
466 467
        if (next != NULL) {
            len = sdscatsds(len,next);
468
            listDelNode(c->reply,ln->next);
469 470 471
            listNodeValue(ln) = len;
            /* No need to update c->reply_bytes: we are just moving the same
             * amount of bytes from one node to another. */
472
        }
473
    }
474
    asyncCloseClientOnOutputBufferLimitReached(c);
475 476
}

G
guiquanz 已提交
477
/* Add a double as a bulk reply */
478
void addReplyDouble(client *c, double d) {
479 480
    char dbuf[128], sbuf[128];
    int dlen, slen;
481 482 483 484 485 486 487 488 489
    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);
    }
490 491
}

A
antirez 已提交
492 493 494 495 496 497 498 499 500
/* Add a long double as a bulk reply, but uses a human readable formatting
 * of the double instead of exposing the crude behavior of doubles to the
 * dear user. */
void addReplyHumanLongDouble(client *c, long double d) {
    robj *o = createStringObjectFromLongDouble(d,1);
    addReplyBulk(c,o);
    decrRefCount(o);
}

501 502
/* Add a long long as integer reply or bulk len / multi bulk count.
 * Basically this is used to output <prefix><long long><crlf>. */
503
void addReplyLongLongWithPrefix(client *c, long long ll, char prefix) {
504
    char buf[128];
505
    int len;
506 507 508 509

    /* 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. */
A
antirez 已提交
510
    if (prefix == '*' && ll < OBJ_SHARED_BULKHDR_LEN && ll >= 0) {
511 512
        addReply(c,shared.mbulkhdr[ll]);
        return;
A
antirez 已提交
513
    } else if (prefix == '$' && ll < OBJ_SHARED_BULKHDR_LEN && ll >= 0) {
514 515 516 517
        addReply(c,shared.bulkhdr[ll]);
        return;
    }

518
    buf[0] = prefix;
519 520 521
    len = ll2string(buf+1,sizeof(buf)-1,ll);
    buf[len+1] = '\r';
    buf[len+2] = '\n';
522
    addReplyString(c,buf,len+3);
523 524
}

525
void addReplyLongLong(client *c, long long ll) {
526 527 528 529 530
    if (ll == 0)
        addReply(c,shared.czero);
    else if (ll == 1)
        addReply(c,shared.cone);
    else
531
        addReplyLongLongWithPrefix(c,ll,':');
532
}
533

534
void addReplyMultiBulkLen(client *c, long length) {
A
antirez 已提交
535
    if (length < OBJ_SHARED_BULKHDR_LEN)
536 537 538
        addReply(c,shared.mbulkhdr[length]);
    else
        addReplyLongLongWithPrefix(c,length,'*');
539 540
}

541
/* Create the length prefix of a bulk reply, example: $2234 */
542
void addReplyBulkLen(client *c, robj *obj) {
543
    size_t len;
544

545
    if (sdsEncodedObject(obj)) {
546 547 548 549 550 551 552 553 554 555 556 557 558 559
        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++;
        }
    }
560

A
antirez 已提交
561
    if (len < OBJ_SHARED_BULKHDR_LEN)
562 563 564
        addReply(c,shared.bulkhdr[len]);
    else
        addReplyLongLongWithPrefix(c,len,'$');
565 566
}

567
/* Add a Redis Object as a bulk reply */
568
void addReplyBulk(client *c, robj *obj) {
569 570 571 572 573
    addReplyBulkLen(c,obj);
    addReply(c,obj);
    addReply(c,shared.crlf);
}

574
/* Add a C buffer as bulk reply */
575
void addReplyBulkCBuffer(client *c, const void *p, size_t len) {
576
    addReplyLongLongWithPrefix(c,len,'$');
577 578 579 580
    addReplyString(c,p,len);
    addReply(c,shared.crlf);
}

M
Matt Stancliff 已提交
581
/* Add sds to reply (takes ownership of sds and frees it) */
582
void addReplyBulkSds(client *c, sds s)  {
583
    addReplyLongLongWithPrefix(c,sdslen(s),'$');
M
Matt Stancliff 已提交
584 585 586 587
    addReplySds(c,s);
    addReply(c,shared.crlf);
}

588
/* Add a C nul term string as bulk reply */
589
void addReplyBulkCString(client *c, const char *s) {
590 591 592
    if (s == NULL) {
        addReply(c,shared.nullbulk);
    } else {
593
        addReplyBulkCBuffer(c,s,strlen(s));
594 595 596
    }
}

597
/* Add a long long as a bulk reply */
598
void addReplyBulkLongLong(client *c, long long ll) {
599 600 601 602 603 604 605
    char buf[64];
    int len;

    len = ll2string(buf,64,ll);
    addReplyBulkCBuffer(c,buf,len);
}

606 607 608
/* Copy 'src' client output buffers into 'dst' client output buffers.
 * The function takes care of freeing the old output buffers of the
 * destination client. */
609
void copyClientOutputBuffer(client *dst, client *src) {
610
    listRelease(dst->reply);
611
    dst->sentlen = 0;
612 613 614
    dst->reply = listDup(src->reply);
    memcpy(dst->buf,src->buf,src->bufpos);
    dst->bufpos = src->bufpos;
615
    dst->reply_bytes = src->reply_bytes;
616 617
}

618 619 620 621 622 623
/* Return true if the specified client has pending reply buffers to write to
 * the socket. */
int clientHasPendingReplies(client *c) {
    return c->bufpos || listLength(c->reply);
}

A
antirez 已提交
624
#define MAX_ACCEPTS_PER_CALL 1000
625
static void acceptCommonHandler(int fd, int flags, char *ip) {
626
    client *c;
627
    if ((c = createClient(fd)) == NULL) {
A
antirez 已提交
628
        serverLog(LL_WARNING,
629 630
            "Error registering fd event for the new client: %s (fd=%d)",
            strerror(errno),fd);
631
        close(fd); /* May be already closed, just ignore errors */
632 633 634 635
        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 已提交
636
     * for this condition, since now the socket is already set in non-blocking
637
     * mode and we can send an error for free using the Kernel I/O */
638
    if (listLength(server.clients) > server.maxclients) {
639 640 641 642 643 644
        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... */
        }
645
        server.stat_rejected_conn++;
646 647 648
        freeClient(c);
        return;
    }
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664

    /* If the server is running in protected mode (the default) and there
     * is no password set, nor a specific interface is bound, we don't accept
     * requests from non loopback interfaces. Instead we try to explain the
     * user what to do to fix it if needed. */
    if (server.protected_mode &&
        server.bindaddr_count == 0 &&
        server.requirepass == NULL &&
        !(flags & CLIENT_UNIX_SOCKET) &&
        ip != NULL)
    {
        if (strcmp(ip,"127.0.0.1") && strcmp(ip,"::1")) {
            char *err =
                "-DENIED Redis is running in protected mode because protected "
                "mode is enabled, no bind address was specified, no "
                "authentication password is requested to clients. In this mode "
A
antirez 已提交
665
                "connections are only accepted from the loopback interface. "
666 667 668 669 670
                "If you want to connect from external computers to Redis you "
                "may adopt one of the following solutions: "
                "1) Just disable protected mode sending the command "
                "'CONFIG SET protected-mode no' from the loopback interface "
                "by connecting to Redis from the same host the server is "
671
                "running, however MAKE SURE Redis is not publicly accessible "
672 673 674 675 676 677
                "from internet if you do so. Use CONFIG REWRITE to make this "
                "change permanent. "
                "2) Alternatively you can just disable the protected mode by "
                "editing the Redis configuration file, and setting the protected "
                "mode option to 'no', and then restarting the server. "
                "3) If you started the server manually just for testing, restart "
678
                "it with the '--protected-mode no' option. "
679 680 681 682 683 684 685 686 687 688 689 690
                "4) Setup a bind address or an authentication password. "
                "NOTE: You only need to do one of the above things in order for "
                "the server to start accepting connections from the outside.\r\n";
            if (write(c->fd,err,strlen(err)) == -1) {
                /* Nothing to do, Just to avoid the warning... */
            }
            server.stat_rejected_conn++;
            freeClient(c);
            return;
        }
    }

691
    server.stat_numconnections++;
692
    c->flags |= flags;
693 694
}

695
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
A
antirez 已提交
696
    int cport, cfd, max = MAX_ACCEPTS_PER_CALL;
A
antirez 已提交
697 698 699 700
    char cip[NET_IP_STR_LEN];
    UNUSED(el);
    UNUSED(mask);
    UNUSED(privdata);
701

A
antirez 已提交
702 703 704 705
    while(max--) {
        cfd = anetTcpAccept(server.neterr, fd, cip, sizeof(cip), &cport);
        if (cfd == ANET_ERR) {
            if (errno != EWOULDBLOCK)
A
antirez 已提交
706
                serverLog(LL_WARNING,
A
antirez 已提交
707 708 709
                    "Accepting client connection: %s", server.neterr);
            return;
        }
A
antirez 已提交
710
        serverLog(LL_VERBOSE,"Accepted %s:%d", cip, cport);
711
        acceptCommonHandler(cfd,0,cip);
712 713 714 715
    }
}

void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask) {
A
antirez 已提交
716
    int cfd, max = MAX_ACCEPTS_PER_CALL;
A
antirez 已提交
717 718 719
    UNUSED(el);
    UNUSED(mask);
    UNUSED(privdata);
720

A
antirez 已提交
721 722 723 724
    while(max--) {
        cfd = anetUnixAccept(server.neterr, fd);
        if (cfd == ANET_ERR) {
            if (errno != EWOULDBLOCK)
A
antirez 已提交
725
                serverLog(LL_WARNING,
A
antirez 已提交
726 727 728
                    "Accepting client connection: %s", server.neterr);
            return;
        }
A
antirez 已提交
729
        serverLog(LL_VERBOSE,"Accepted connection to %s", server.unixsocket);
730
        acceptCommonHandler(cfd,CLIENT_UNIX_SOCKET,NULL);
731 732 733
    }
}

734
static void freeClientArgv(client *c) {
735 736 737 738
    int j;
    for (j = 0; j < c->argc; j++)
        decrRefCount(c->argv[j]);
    c->argc = 0;
739
    c->cmd = NULL;
740 741
}

742 743 744 745 746 747
/* 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);
748
        freeClient((client*)ln->value);
749 750 751
    }
}

752 753 754 755
/* Remove the specified client from global lists where the client could
 * be referenced, not including the Pub/Sub channels.
 * This is used by freeClient() and replicationCacheMaster(). */
void unlinkClient(client *c) {
756 757
    listNode *ln;

758
    /* If this is marked as current client unset it. */
759 760
    if (server.current_client == c) server.current_client = NULL;

761 762 763 764 765
    /* Certain operations must be done only if the client has an active socket.
     * If the client was already unlinked or if it's a "fake client" the
     * fd is already set to -1. */
    if (c->fd != -1) {
        /* Remove from the list of active clients. */
766 767 768 769
        if (c->client_list_node) {
            listDelNode(server.clients,c->client_list_node);
            c->client_list_node = NULL;
        }
770 771 772 773 774 775 776 777 778 779 780 781 782

        /* Unregister async I/O handlers and close the socket. */
        aeDeleteFileEvent(server.el,c->fd,AE_READABLE);
        aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
        close(c->fd);
        c->fd = -1;
    }

    /* Remove from the list of pending writes if needed. */
    if (c->flags & CLIENT_PENDING_WRITE) {
        ln = listSearchKey(server.clients_pending_write,c);
        serverAssert(ln != NULL);
        listDelNode(server.clients_pending_write,ln);
783
        c->flags &= ~CLIENT_PENDING_WRITE;
784 785 786 787 788 789 790 791
    }

    /* When client was just unblocked because of a blocking operation,
     * remove it from the list of unblocked clients. */
    if (c->flags & CLIENT_UNBLOCKED) {
        ln = listSearchKey(server.unblocked_clients,c);
        serverAssert(ln != NULL);
        listDelNode(server.unblocked_clients,ln);
792
        c->flags &= ~CLIENT_UNBLOCKED;
793 794 795 796 797 798
    }
}

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

799 800 801 802 803
    /* 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. */
A
antirez 已提交
804 805 806 807 808 809
    if (server.master && c->flags & CLIENT_MASTER) {
        serverLog(LL_WARNING,"Connection with master lost.");
        if (!(c->flags & (CLIENT_CLOSE_AFTER_REPLY|
                          CLIENT_CLOSE_ASAP|
                          CLIENT_BLOCKED|
                          CLIENT_UNBLOCKED)))
810 811 812 813
        {
            replicationCacheMaster(c);
            return;
        }
814 815
    }

816
    /* Log link disconnection with slave */
A
antirez 已提交
817 818
    if ((c->flags & CLIENT_SLAVE) && !(c->flags & CLIENT_MONITOR)) {
        serverLog(LL_WARNING,"Connection with slave %s lost.",
819
            replicationGetSlaveName(c));
820 821
    }

822
    /* Free the query buffer */
823
    sdsfree(c->querybuf);
824
    sdsfree(c->pending_querybuf);
825
    c->querybuf = NULL;
826 827

    /* Deallocate structures used to block on blocking ops. */
A
antirez 已提交
828
    if (c->flags & CLIENT_BLOCKED) unblockClient(c);
829
    dictRelease(c->bpop.keys);
830 831 832 833

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

835 836 837 838 839
    /* Unsubscribe from all the pubsub channels */
    pubsubUnsubscribeAllChannels(c,0);
    pubsubUnsubscribeAllPatterns(c,0);
    dictRelease(c->pubsub_channels);
    listRelease(c->pubsub_patterns);
840

841
    /* Free data structures. */
842 843
    listRelease(c->reply);
    freeClientArgv(c);
844

845 846 847 848
    /* Unlink the client: this will close the socket, remove the I/O
     * handlers, and remove references of the client from different
     * places where active clients may be referenced. */
    unlinkClient(c);
849 850 851

    /* Master/slave cleanup Case 1:
     * we lost the connection with a slave. */
A
antirez 已提交
852 853
    if (c->flags & CLIENT_SLAVE) {
        if (c->replstate == SLAVE_STATE_SEND_BULK) {
854 855 856
            if (c->repldbfd != -1) close(c->repldbfd);
            if (c->replpreamble) sdsfree(c->replpreamble);
        }
A
antirez 已提交
857
        list *l = (c->flags & CLIENT_MONITOR) ? server.monitors : server.slaves;
858
        ln = listSearchKey(l,c);
A
antirez 已提交
859
        serverAssert(ln != NULL);
860
        listDelNode(l,ln);
861 862 863
        /* We need to remember the time when we started to have zero
         * attached slaves, as after some time we'll free the replication
         * backlog. */
A
antirez 已提交
864
        if (c->flags & CLIENT_SLAVE && listLength(server.slaves) == 0)
865
            server.repl_no_slaves_since = server.unixtime;
866
        refreshGoodSlavesCount();
867
    }
868

869 870
    /* Master/slave cleanup Case 2:
     * we lost the connection with the master. */
A
antirez 已提交
871
    if (c->flags & CLIENT_MASTER) replicationHandleMasterDisconnection();
872 873 874

    /* If this client was scheduled for async freeing we need to remove it
     * from the queue. */
A
antirez 已提交
875
    if (c->flags & CLIENT_CLOSE_ASAP) {
876
        ln = listSearchKey(server.clients_to_close,c);
A
antirez 已提交
877
        serverAssert(ln != NULL);
878 879 880
        listDelNode(server.clients_to_close,ln);
    }

881 882
    /* Release other dynamically allocated client structure fields,
     * and finally release the client structure itself. */
883
    if (c->name) decrRefCount(c->name);
884 885
    zfree(c->argv);
    freeClientMultiState(c);
886
    sdsfree(c->peerid);
887 888 889
    zfree(c);
}

890 891 892 893
/* 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. */
894
void freeClientAsync(client *c) {
A
antirez 已提交
895 896
    if (c->flags & CLIENT_CLOSE_ASAP || c->flags & CLIENT_LUA) return;
    c->flags |= CLIENT_CLOSE_ASAP;
897 898 899 900 901 902
    listAddNodeTail(server.clients_to_close,c);
}

void freeClientsInAsyncFreeQueue(void) {
    while (listLength(server.clients_to_close)) {
        listNode *ln = listFirst(server.clients_to_close);
903
        client *c = listNodeValue(ln);
904

A
antirez 已提交
905
        c->flags &= ~CLIENT_CLOSE_ASAP;
906 907 908 909 910
        freeClient(c);
        listDelNode(server.clients_to_close,ln);
    }
}

911 912
/* Write data in output buffers to client. Return C_OK if the client
 * is still valid after the call, C_ERR if it was freed. */
913
int writeToClient(int fd, client *c, int handler_installed) {
914 915
    ssize_t nwritten = 0, totwritten = 0;
    size_t objlen;
916
    sds o;
917

918
    while(clientHasPendingReplies(c)) {
919
        if (c->bufpos > 0) {
920 921
            nwritten = write(fd,c->buf+c->sentlen,c->bufpos-c->sentlen);
            if (nwritten <= 0) break;
922 923 924 925 926
            c->sentlen += nwritten;
            totwritten += nwritten;

            /* If the buffer was sent, set bufpos to zero to continue with
             * the remainder of the reply. */
927
            if ((int)c->sentlen == c->bufpos) {
928 929 930 931 932
                c->bufpos = 0;
                c->sentlen = 0;
            }
        } else {
            o = listNodeValue(listFirst(c->reply));
933
            objlen = sdslen(o);
934

935 936 937 938
            if (objlen == 0) {
                listDelNode(c->reply,listFirst(c->reply));
                continue;
            }
939

940
            nwritten = write(fd, o + c->sentlen, objlen - c->sentlen);
941
            if (nwritten <= 0) break;
942 943
            c->sentlen += nwritten;
            totwritten += nwritten;
944

945 946 947 948
            /* 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;
949
                c->reply_bytes -= objlen;
950 951 952 953
                /* If there are no longer objects in the list, we expect
                 * the count of reply bytes to be exactly zero. */
                if (listLength(c->reply) == 0)
                    serverAssert(c->reply_bytes == 0);
954
            }
955
        }
A
antirez 已提交
956
        /* Note that we avoid to send more than NET_MAX_WRITES_PER_EVENT
957 958 959
         * 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
960 961 962
         * scenario think about 'KEYS *' against the loopback interface).
         *
         * However if we are over the maxmemory limit we ignore that and
963 964 965 966 967
         * just deliver as much data as it is possible to deliver.
         *
         * Moreover, we also send as much as possible if the client is
         * a slave (otherwise, on high-speed traffic, the replication
         * buffer will grow indefinitely) */
A
antirez 已提交
968
        if (totwritten > NET_MAX_WRITES_PER_EVENT &&
969
            (server.maxmemory == 0 ||
970 971
             zmalloc_used_memory() < server.maxmemory) &&
            !(c->flags & CLIENT_SLAVE)) break;
972
    }
973
    server.stat_net_output_bytes += totwritten;
974 975 976 977
    if (nwritten == -1) {
        if (errno == EAGAIN) {
            nwritten = 0;
        } else {
A
antirez 已提交
978
            serverLog(LL_VERBOSE,
979 980
                "Error writing to client: %s", strerror(errno));
            freeClient(c);
981
            return C_ERR;
982 983
        }
    }
A
antirez 已提交
984 985 986 987 988
    if (totwritten > 0) {
        /* For clients representing masters we don't count sending data
         * as an interaction, since we always send REPLCONF ACK commands
         * that take some time to just fill the socket output buffer.
         * We just rely on data / pings received for timeout detection. */
A
antirez 已提交
989
        if (!(c->flags & CLIENT_MASTER)) c->lastinteraction = server.unixtime;
A
antirez 已提交
990
    }
991
    if (!clientHasPendingReplies(c)) {
992
        c->sentlen = 0;
993
        if (handler_installed) aeDeleteFileEvent(server.el,c->fd,AE_WRITABLE);
P
Pieter Noordhuis 已提交
994 995

        /* Close connection after entire reply has been sent. */
996 997 998 999
        if (c->flags & CLIENT_CLOSE_AFTER_REPLY) {
            freeClient(c);
            return C_ERR;
        }
1000
    }
1001 1002 1003 1004 1005 1006 1007
    return C_OK;
}

/* Write event handler. Just send data to the client. */
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask) {
    UNUSED(el);
    UNUSED(mask);
1008
    writeToClient(fd,privdata,1);
1009 1010
}

1011 1012 1013 1014
/* This function is called just before entering the event loop, in the hope
 * we can just write the replies to the client output buffer without any
 * need to use a syscall in order to install the writable event handler,
 * get it called, and so forth. */
1015
int handleClientsWithPendingWrites(void) {
1016 1017
    listIter li;
    listNode *ln;
1018
    int processed = listLength(server.clients_pending_write);
1019 1020 1021 1022 1023 1024 1025 1026

    listRewind(server.clients_pending_write,&li);
    while((ln = listNext(&li))) {
        client *c = listNodeValue(ln);
        c->flags &= ~CLIENT_PENDING_WRITE;
        listDelNode(server.clients_pending_write,ln);

        /* Try to write buffers to the client socket. */
1027
        if (writeToClient(c->fd,c,0) == C_ERR) continue;
1028

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
        /* If after the synchronous writes above we still have data to
         * output to the client, we need to install the writable handler. */
        if (clientHasPendingReplies(c)) {
            int ae_flags = AE_WRITABLE;
            /* For the fsync=always policy, we want that a given FD is never
             * served for reading and writing in the same event loop iteration,
             * so that in the middle of receiving the query, and serving it
             * to the client, we'll call beforeSleep() that will do the
             * actual fsync of AOF to disk. AE_BARRIER ensures that. */
            if (server.aof_state == AOF_ON &&
                server.aof_fsync == AOF_FSYNC_ALWAYS)
            {
                ae_flags |= AE_BARRIER;
            }
1043
            if (aeCreateFileEvent(server.el, c->fd, ae_flags,
1044
                sendReplyToClient, c) == AE_ERR)
1045 1046 1047
            {
                    freeClientAsync(c);
            }
1048 1049
        }
    }
1050
    return processed;
1051 1052
}

1053
/* resetClient prepare the client to process the next command */
1054
void resetClient(client *c) {
1055 1056
    redisCommandProc *prevcmd = c->cmd ? c->cmd->proc : NULL;

1057
    freeClientArgv(c);
1058 1059
    c->reqtype = 0;
    c->multibulklen = 0;
1060
    c->bulklen = -1;
1061

1062 1063
    /* 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. */
A
antirez 已提交
1064
    if (!(c->flags & CLIENT_MULTI) && prevcmd != askingCommand)
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
        c->flags &= ~CLIENT_ASKING;

    /* Remove the CLIENT_REPLY_SKIP flag if any so that the reply
     * to the next command will be sent, but set the flag if the command
     * we just processed was "CLIENT REPLY SKIP". */
    c->flags &= ~CLIENT_REPLY_SKIP;
    if (c->flags & CLIENT_REPLY_SKIP_NEXT) {
        c->flags |= CLIENT_REPLY_SKIP;
        c->flags &= ~CLIENT_REPLY_SKIP_NEXT;
    }
1075 1076
}

1077 1078 1079 1080 1081 1082 1083
/* Like processMultibulkBuffer(), but for the inline protocol instead of RESP,
 * this function consumes the client query buffer and creates a command ready
 * to be executed inside the client structure. Returns C_OK if the command
 * is ready to be executed, or C_ERR if there is still protocol to read to
 * have a well formed command. The function also returns C_ERR when there is
 * a protocol error: in such a case the client structure is setup to reply
 * with the error and close the connection. */
1084
int processInlineBuffer(client *c) {
1085
    char *newline;
1086
    int argc, j, linefeed_chars = 1;
1087
    sds *argv, aux;
1088
    size_t querylen;
1089

1090 1091 1092
    /* Search for end of line */
    newline = strchr(c->querybuf,'\n');

1093
    /* Nothing to do without a \r\n */
1094
    if (newline == NULL) {
A
antirez 已提交
1095
        if (sdslen(c->querybuf) > PROTO_INLINE_MAX_SIZE) {
1096
            addReplyError(c,"Protocol error: too big inline request");
A
antirez 已提交
1097
            setProtocolError("too big inline request",c,0);
1098
        }
1099
        return C_ERR;
1100
    }
1101

1102 1103
    /* Handle the \r\n case. */
    if (newline && newline != c->querybuf && *(newline-1) == '\r')
1104
        newline--, linefeed_chars++;
1105

1106 1107
    /* Split the input buffer up to the \r\n */
    querylen = newline-(c->querybuf);
1108 1109 1110
    aux = sdsnewlen(c->querybuf,querylen);
    argv = sdssplitargs(aux,&argc);
    sdsfree(aux);
1111 1112
    if (argv == NULL) {
        addReplyError(c,"Protocol error: unbalanced quotes in request");
A
antirez 已提交
1113
        setProtocolError("unbalanced quotes in inline request",c,0);
1114
        return C_ERR;
1115
    }
1116

1117 1118 1119
    /* Newline from slaves can be used to refresh the last ACK time.
     * This is useful for a slave to ping back while loading a big
     * RDB file. */
A
antirez 已提交
1120
    if (querylen == 0 && c->flags & CLIENT_SLAVE)
1121 1122
        c->repl_ack_time = server.unixtime;

1123
    /* Leave data after the first line of the query in the buffer */
1124
    sdsrange(c->querybuf,querylen+linefeed_chars,-1);
1125 1126

    /* Setup argv array on client structure */
1127 1128 1129 1130
    if (argc) {
        if (c->argv) zfree(c->argv);
        c->argv = zmalloc(sizeof(robj*)*argc);
    }
1131 1132 1133 1134

    /* Create redis objects for all arguments. */
    for (c->argc = 0, j = 0; j < argc; j++) {
        if (sdslen(argv[j])) {
1135
            c->argv[c->argc] = createObject(OBJ_STRING,argv[j]);
1136 1137 1138 1139 1140 1141
            c->argc++;
        } else {
            sdsfree(argv[j]);
        }
    }
    zfree(argv);
1142
    return C_OK;
1143 1144 1145 1146
}

/* Helper function. Trims query buffer to make the function that processes
 * multi bulk requests idempotent. */
A
antirez 已提交
1147
#define PROTO_DUMP_LEN 128
1148
static void setProtocolError(const char *errstr, client *c, long pos) {
A
antirez 已提交
1149
    if (server.verbosity <= LL_VERBOSE) {
1150
        sds client = catClientInfoString(sdsempty(),c);
A
antirez 已提交
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167

        /* Sample some protocol to given an idea about what was inside. */
        char buf[256];
        if (sdslen(c->querybuf) < PROTO_DUMP_LEN) {
            snprintf(buf,sizeof(buf),"Query buffer during protocol error: '%s'", c->querybuf);
        } else {
            snprintf(buf,sizeof(buf),"Query buffer during protocol error: '%.*s' (... more %zu bytes ...) '%.*s'", PROTO_DUMP_LEN/2, c->querybuf, sdslen(c->querybuf)-PROTO_DUMP_LEN, PROTO_DUMP_LEN/2, c->querybuf+sdslen(c->querybuf)-PROTO_DUMP_LEN/2);
        }

        /* Remove non printable chars. */
        char *p = buf;
        while (*p != '\0') {
            if (!isprint(*p)) *p = '.';
            p++;
        }

        /* Log all the client and protocol info. */
A
antirez 已提交
1168
        serverLog(LL_VERBOSE,
A
antirez 已提交
1169
            "Protocol error (%s) from client: %s. %s", errstr, client, buf);
1170 1171
        sdsfree(client);
    }
A
antirez 已提交
1172
    c->flags |= CLIENT_CLOSE_AFTER_REPLY;
1173
    sdsrange(c->querybuf,pos,-1);
1174 1175
}

1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
/* Process the query buffer for client 'c', setting up the client argument
 * vector for command execution. Returns C_OK if after running the function
 * the client has a well-formed ready to be processed command, otherwise
 * C_ERR if there is still to read more buffer to get the full command.
 * The function also returns C_ERR when there is a protocol error: in such a
 * case the client structure is setup to reply with the error and close
 * the connection.
 *
 * This function is called if processInputBuffer() detects that the next
 * command is in RESP format, so the first byte in the command is found
 * to be '*'. Otherwise for inline commands processInlineBuffer() is called. */
1187
int processMultibulkBuffer(client *c) {
1188
    char *newline = NULL;
1189 1190
    long pos = 0;
    int ok;
1191
    long long ll;
1192 1193 1194

    if (c->multibulklen == 0) {
        /* The client should have been reset */
A
antirez 已提交
1195
        serverAssertWithInfo(c,NULL,c->argc == 0);
1196 1197

        /* Multi bulk length cannot be read without a \r\n */
1198
        newline = strchr(c->querybuf,'\r');
1199
        if (newline == NULL) {
A
antirez 已提交
1200
            if (sdslen(c->querybuf) > PROTO_INLINE_MAX_SIZE) {
1201
                addReplyError(c,"Protocol error: too big mbulk count string");
A
antirez 已提交
1202
                setProtocolError("too big mbulk count string",c,0);
1203
            }
1204
            return C_ERR;
1205
        }
1206

P
Pieter Noordhuis 已提交
1207 1208
        /* Buffer should also contain \n */
        if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
1209
            return C_ERR;
P
Pieter Noordhuis 已提交
1210

1211 1212
        /* We know for sure there is a whole line since newline != NULL,
         * so go ahead and find out the multi bulk length. */
A
antirez 已提交
1213
        serverAssertWithInfo(c,NULL,c->querybuf[0] == '*');
1214 1215
        ok = string2ll(c->querybuf+1,newline-(c->querybuf+1),&ll);
        if (!ok || ll > 1024*1024) {
1216
            addReplyError(c,"Protocol error: invalid multibulk length");
A
antirez 已提交
1217
            setProtocolError("invalid mbulk count",c,pos);
1218
            return C_ERR;
1219
        }
P
Pieter Noordhuis 已提交
1220 1221 1222

        pos = (newline-c->querybuf)+2;
        if (ll <= 0) {
1223
            sdsrange(c->querybuf,pos,-1);
1224
            return C_OK;
P
Pieter Noordhuis 已提交
1225 1226
        }

1227
        c->multibulklen = ll;
1228 1229 1230 1231 1232 1233

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

A
antirez 已提交
1234
    serverAssertWithInfo(c,NULL,c->multibulklen > 0);
1235 1236 1237
    while(c->multibulklen) {
        /* Read bulk length if unknown */
        if (c->bulklen == -1) {
1238
            newline = strchr(c->querybuf+pos,'\r');
1239
            if (newline == NULL) {
A
antirez 已提交
1240
                if (sdslen(c->querybuf) > PROTO_INLINE_MAX_SIZE) {
1241 1242
                    addReplyError(c,
                        "Protocol error: too big bulk count string");
A
antirez 已提交
1243
                    setProtocolError("too big bulk count string",c,0);
1244
                    return C_ERR;
1245
                }
P
Pieter Noordhuis 已提交
1246
                break;
1247
            }
P
Pieter Noordhuis 已提交
1248 1249 1250

            /* Buffer should also contain \n */
            if (newline-(c->querybuf) > ((signed)sdslen(c->querybuf)-2))
1251
                break;
P
Pieter Noordhuis 已提交
1252 1253 1254 1255 1256

            if (c->querybuf[pos] != '$') {
                addReplyErrorFormat(c,
                    "Protocol error: expected '$', got '%c'",
                    c->querybuf[pos]);
A
antirez 已提交
1257
                setProtocolError("expected $ but got something else",c,pos);
1258
                return C_ERR;
1259
            }
P
Pieter Noordhuis 已提交
1260 1261

            ok = string2ll(c->querybuf+pos+1,newline-(c->querybuf+pos+1),&ll);
1262
            if (!ok || ll < 0 || ll > server.proto_max_bulk_len) {
P
Pieter Noordhuis 已提交
1263
                addReplyError(c,"Protocol error: invalid bulk length");
A
antirez 已提交
1264
                setProtocolError("invalid bulk length",c,pos);
1265
                return C_ERR;
P
Pieter Noordhuis 已提交
1266 1267 1268
            }

            pos += newline-(c->querybuf+pos)+2;
A
antirez 已提交
1269
            if (ll >= PROTO_MBULK_BIG_ARG) {
1270 1271
                size_t qblen;

1272 1273
                /* If we are going to read a large object from network
                 * try to make it likely that it will start at c->querybuf
1274
                 * boundary so that we can optimize object creation
1275
                 * avoiding a large copy of data. */
1276
                sdsrange(c->querybuf,pos,-1);
1277
                pos = 0;
1278
                qblen = sdslen(c->querybuf);
A
antirez 已提交
1279 1280
                /* Hint the sds library about the amount of bytes this string is
                 * going to contain. */
1281
                if (qblen < (size_t)ll+2)
1282
                    c->querybuf = sdsMakeRoomFor(c->querybuf,ll+2-qblen);
A
antirez 已提交
1283
            }
P
Pieter Noordhuis 已提交
1284
            c->bulklen = ll;
1285 1286 1287
        }

        /* Read bulk argument */
1288
        if (sdslen(c->querybuf)-pos < (size_t)(c->bulklen+2)) {
1289 1290 1291
            /* Not enough data (+2 == trailing \r\n) */
            break;
        } else {
1292
            /* Optimization: if the buffer contains JUST our bulk element
1293 1294 1295
             * instead of creating a new object by *copying* the sds we
             * just use the current sds string. */
            if (pos == 0 &&
A
antirez 已提交
1296
                c->bulklen >= PROTO_MBULK_BIG_ARG &&
1297
                sdslen(c->querybuf) == (size_t)(c->bulklen+2))
1298
            {
1299
                c->argv[c->argc++] = createObject(OBJ_STRING,c->querybuf);
1300 1301 1302
                sdsIncrLen(c->querybuf,-2); /* remove CRLF */
                /* Assume that if we saw a fat argument we'll see another one
                 * likely... */
O
Oran Agra 已提交
1303 1304
                c->querybuf = sdsnewlen(NULL,c->bulklen+2);
                sdsclear(c->querybuf);
1305 1306 1307 1308 1309 1310
                pos = 0;
            } else {
                c->argv[c->argc++] =
                    createStringObject(c->querybuf+pos,c->bulklen);
                pos += c->bulklen+2;
            }
1311 1312 1313 1314 1315 1316
            c->bulklen = -1;
            c->multibulklen--;
        }
    }

    /* Trim to pos */
1317
    if (pos) sdsrange(c->querybuf,pos,-1);
1318 1319

    /* We're done when c->multibulk == 0 */
1320
    if (c->multibulklen == 0) return C_OK;
1321

1322
    /* Still not ready to process the command */
1323
    return C_ERR;
1324 1325
}

1326 1327 1328 1329
/* This function is called every time, in the client structure 'c', there is
 * more query buffer to process, because we read more data from the socket
 * or because a client was blocked and later reactivated, so there could be
 * pending query buffer, already representing a full command, to process. */
1330
void processInputBuffer(client *c) {
1331
    server.current_client = c;
1332 1333
    /* Keep processing while there is something in the input buffer */
    while(sdslen(c->querybuf)) {
1334
        /* Return if clients are paused. */
A
antirez 已提交
1335
        if (!(c->flags & CLIENT_SLAVE) && clientsArePaused()) break;
1336

1337
        /* Immediately abort if the client is in the middle of something. */
A
antirez 已提交
1338
        if (c->flags & CLIENT_BLOCKED) break;
1339

A
antirez 已提交
1340
        /* CLIENT_CLOSE_AFTER_REPLY closes the connection once the reply is
1341
         * written to the client. Make sure to not let the reply grow after
1342 1343 1344 1345
         * this flag has been set (i.e. don't process more commands).
         *
         * The same applies for clients we want to terminate ASAP. */
        if (c->flags & (CLIENT_CLOSE_AFTER_REPLY|CLIENT_CLOSE_ASAP)) break;
1346 1347 1348 1349

        /* Determine request type when unknown. */
        if (!c->reqtype) {
            if (c->querybuf[0] == '*') {
A
antirez 已提交
1350
                c->reqtype = PROTO_REQ_MULTIBULK;
1351
            } else {
A
antirez 已提交
1352
                c->reqtype = PROTO_REQ_INLINE;
1353 1354
            }
        }
1355

A
antirez 已提交
1356
        if (c->reqtype == PROTO_REQ_INLINE) {
1357
            if (processInlineBuffer(c) != C_OK) break;
A
antirez 已提交
1358
        } else if (c->reqtype == PROTO_REQ_MULTIBULK) {
1359
            if (processMultibulkBuffer(c) != C_OK) break;
1360
        } else {
A
antirez 已提交
1361
            serverPanic("Unknown request type");
1362
        }
1363 1364

        /* Multibulk processing could see a <= 0 length. */
1365 1366 1367 1368
        if (c->argc == 0) {
            resetClient(c);
        } else {
            /* Only reset the client when the command was executed. */
1369 1370 1371 1372 1373
            if (processCommand(c) == C_OK) {
                if (c->flags & CLIENT_MASTER && !(c->flags & CLIENT_MULTI)) {
                    /* Update the applied replication offset of our master. */
                    c->reploff = c->read_reploff - sdslen(c->querybuf);
                }
1374 1375 1376 1377 1378 1379 1380

                /* Don't reset the client structure for clients blocked in a
                 * module blocking command, so that the reply callback will
                 * still be able to access the client argv and argc field.
                 * The client will be reset in unblockClientFromModule(). */
                if (!(c->flags & CLIENT_BLOCKED) || c->btype != BLOCKED_MODULE)
                    resetClient(c);
1381
            }
1382 1383 1384
            /* freeMemoryIfNeeded may flush slave output buffers. This may
             * result into a slave, that may be the active client, to be
             * freed. */
O
Oran Agra 已提交
1385
            if (server.current_client == NULL) break;
1386
        }
1387
    }
1388
    server.current_client = NULL;
1389 1390 1391
}

void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask) {
1392
    client *c = (client*) privdata;
1393
    int nread, readlen;
1394
    size_t qblen;
A
antirez 已提交
1395 1396
    UNUSED(el);
    UNUSED(mask);
1397

A
antirez 已提交
1398
    readlen = PROTO_IOBUF_LEN;
1399
    /* If this is a multi bulk request, and we are processing a bulk reply
1400 1401 1402
     * 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
1403 1404
     * processMultiBulkBuffer() can avoid copying buffers to create the
     * Redis Object representing the argument. */
A
antirez 已提交
1405 1406
    if (c->reqtype == PROTO_REQ_MULTIBULK && c->multibulklen && c->bulklen != -1
        && c->bulklen >= PROTO_MBULK_BIG_ARG)
1407
    {
1408
        ssize_t remaining = (size_t)(c->bulklen+2)-sdslen(c->querybuf);
1409 1410 1411 1412

        if (remaining < readlen) readlen = remaining;
    }

1413
    qblen = sdslen(c->querybuf);
1414
    if (c->querybuf_peak < qblen) c->querybuf_peak = qblen;
1415 1416
    c->querybuf = sdsMakeRoomFor(c->querybuf, readlen);
    nread = read(fd, c->querybuf+qblen, readlen);
1417 1418
    if (nread == -1) {
        if (errno == EAGAIN) {
1419
            return;
1420
        } else {
A
antirez 已提交
1421
            serverLog(LL_VERBOSE, "Reading from client: %s",strerror(errno));
1422 1423 1424 1425
            freeClient(c);
            return;
        }
    } else if (nread == 0) {
A
antirez 已提交
1426
        serverLog(LL_VERBOSE, "Client closed connection");
1427 1428
        freeClient(c);
        return;
1429 1430 1431 1432 1433 1434
    } else if (c->flags & CLIENT_MASTER) {
        /* Append the query buffer to the pending (not applied) buffer
         * of the master. We'll use this buffer later in order to have a
         * copy of the string applied by the last command executed. */
        c->pending_querybuf = sdscatlen(c->pending_querybuf,
                                        c->querybuf+qblen,nread);
1435
    }
1436 1437 1438

    sdsIncrLen(c->querybuf,nread);
    c->lastinteraction = server.unixtime;
1439
    if (c->flags & CLIENT_MASTER) c->read_reploff += nread;
1440
    server.stat_net_input_bytes += nread;
1441
    if (sdslen(c->querybuf) > server.client_max_querybuf_len) {
1442
        sds ci = catClientInfoString(sdsempty(),c), bytes = sdsempty();
1443 1444

        bytes = sdscatrepr(bytes,c->querybuf,64);
A
antirez 已提交
1445
        serverLog(LL_WARNING,"Closing client that reached max query buffer length: %s (qbuf initial bytes: %s)", ci, bytes);
1446
        sdsfree(ci);
1447
        sdsfree(bytes);
1448 1449 1450
        freeClient(c);
        return;
    }
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469

    /* Time to process the buffer. If the client is a master we need to
     * compute the difference between the applied offset before and after
     * processing the buffer, to understand how much of the replication stream
     * was actually applied to the master state: this quantity, and its
     * corresponding part of the replication stream, will be propagated to
     * the sub-slaves and to the replication backlog. */
    if (!(c->flags & CLIENT_MASTER)) {
        processInputBuffer(c);
    } else {
        size_t prev_offset = c->reploff;
        processInputBuffer(c);
        size_t applied = c->reploff - prev_offset;
        if (applied) {
            replicationFeedSlavesFromMasterStream(server.slaves,
                    c->pending_querybuf, applied);
            sdsrange(c->pending_querybuf,applied,-1);
        }
    }
1470
}
1471 1472 1473

void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer) {
1474
    client *c;
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
    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;
}

A
antirez 已提交
1490
/* A Redis "Peer ID" is a colon separated ip:port pair.
G
Gregory Petrosyan 已提交
1491
 * For IPv4 it's in the form x.y.z.k:port, example: "127.0.0.1:1234".
A
antirez 已提交
1492
 * For IPv6 addresses we use [] around the IP part, like in "[::1]:1234".
G
Gregory Petrosyan 已提交
1493
 * For Unix sockets we use path:0, like in "/tmp/redis:0".
A
antirez 已提交
1494
 *
A
antirez 已提交
1495
 * A Peer ID always fits inside a buffer of NET_PEER_ID_LEN bytes, including
A
antirez 已提交
1496 1497
 * the null term.
 *
A
antirez 已提交
1498 1499 1500
 * 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). */
1501
void genClientPeerId(client *client, char *peerid,
M
Matt Stancliff 已提交
1502
                            size_t peerid_len) {
A
antirez 已提交
1503
    if (client->flags & CLIENT_UNIX_SOCKET) {
A
antirez 已提交
1504 1505 1506 1507
        /* Unix socket client. */
        snprintf(peerid,peerid_len,"%s:0",server.unixsocket);
    } else {
        /* TCP client. */
M
Matt Stancliff 已提交
1508
        anetFormatPeer(client->fd,peerid,peerid_len);
A
antirez 已提交
1509 1510 1511
    }
}

1512
/* This function returns the client peer id, by creating and caching it
G
Gregory Petrosyan 已提交
1513
 * if client->peerid is NULL, otherwise returning the cached value.
1514 1515
 * The Peer ID never changes during the life of the client, however it
 * is expensive to compute. */
1516
char *getClientPeerId(client *c) {
A
antirez 已提交
1517
    char peerid[NET_PEER_ID_LEN];
1518 1519 1520 1521 1522 1523 1524 1525 1526 1527

    if (c->peerid == NULL) {
        genClientPeerId(c,peerid,sizeof(peerid));
        c->peerid = sdsnew(peerid);
    }
    return c->peerid;
}

/* Concatenate a string representing the state of a client in an human
 * readable format, into the sds string 's'. */
1528
sds catClientInfoString(sds s, client *client) {
1529
    char flags[16], events[3], *p;
1530
    int emask;
1531 1532

    p = flags;
A
antirez 已提交
1533 1534
    if (client->flags & CLIENT_SLAVE) {
        if (client->flags & CLIENT_MONITOR)
1535 1536 1537 1538
            *p++ = 'O';
        else
            *p++ = 'S';
    }
A
antirez 已提交
1539 1540 1541 1542 1543 1544 1545 1546 1547
    if (client->flags & CLIENT_MASTER) *p++ = 'M';
    if (client->flags & CLIENT_MULTI) *p++ = 'x';
    if (client->flags & CLIENT_BLOCKED) *p++ = 'b';
    if (client->flags & CLIENT_DIRTY_CAS) *p++ = 'd';
    if (client->flags & CLIENT_CLOSE_AFTER_REPLY) *p++ = 'c';
    if (client->flags & CLIENT_UNBLOCKED) *p++ = 'u';
    if (client->flags & CLIENT_CLOSE_ASAP) *p++ = 'A';
    if (client->flags & CLIENT_UNIX_SOCKET) *p++ = 'U';
    if (client->flags & CLIENT_READONLY) *p++ = 'r';
1548
    if (p == flags) *p++ = 'N';
1549
    *p++ = '\0';
1550 1551 1552 1553 1554 1555

    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';
1556
    return sdscatfmt(s,
1557 1558
        "id=%U addr=%s fd=%i name=%s age=%I idle=%I flags=%s db=%i sub=%i psub=%i multi=%i qbuf=%U qbuf-free=%U obl=%U oll=%U omem=%U events=%s cmd=%s",
        (unsigned long long) client->id,
1559
        getClientPeerId(client),
1560 1561
        client->fd,
        client->name ? (char*)client->name->ptr : "",
1562 1563
        (long long)(server.unixtime - client->ctime),
        (long long)(server.unixtime - client->lastinteraction),
1564 1565 1566
        flags,
        client->db->id,
        (int) dictSize(client->pubsub_channels),
1567
        (int) listLength(client->pubsub_patterns),
A
antirez 已提交
1568
        (client->flags & CLIENT_MULTI) ? client->mstate.count : -1,
1569 1570 1571 1572 1573
        (unsigned long long) sdslen(client->querybuf),
        (unsigned long long) sdsavail(client->querybuf),
        (unsigned long long) client->bufpos,
        (unsigned long long) listLength(client->reply),
        (unsigned long long) getClientOutputBufferMemoryUsage(client),
1574 1575
        events,
        client->lastcmd ? client->lastcmd->name : "NULL");
1576 1577
}

1578 1579 1580
sds getAllClientsInfoString(void) {
    listNode *ln;
    listIter li;
1581
    client *client;
O
Oran Agra 已提交
1582 1583
    sds o = sdsnewlen(NULL,200*listLength(server.clients));
    sdsclear(o);
1584 1585 1586
    listRewind(server.clients,&li);
    while ((ln = listNext(&li)) != NULL) {
        client = listNodeValue(ln);
1587
        o = catClientInfoString(o,client);
1588 1589 1590 1591 1592
        o = sdscatlen(o,"\n",1);
    }
    return o;
}

1593
void clientCommand(client *c) {
A
antirez 已提交
1594 1595
    listNode *ln;
    listIter li;
1596
    client *client;
A
antirez 已提交
1597

A
antirez 已提交
1598
    if (!strcasecmp(c->argv[1]->ptr,"list") && c->argc == 2) {
A
antirez 已提交
1599
        /* CLIENT LIST */
1600
        sds o = getAllClientsInfoString();
A
antirez 已提交
1601 1602
        addReplyBulkCBuffer(c,o,sdslen(o));
        sdsfree(o);
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
    } else if (!strcasecmp(c->argv[1]->ptr,"reply") && c->argc == 3) {
        /* CLIENT REPLY ON|OFF|SKIP */
        if (!strcasecmp(c->argv[2]->ptr,"on")) {
            c->flags &= ~(CLIENT_REPLY_SKIP|CLIENT_REPLY_OFF);
            addReply(c,shared.ok);
        } else if (!strcasecmp(c->argv[2]->ptr,"off")) {
            c->flags |= CLIENT_REPLY_OFF;
        } else if (!strcasecmp(c->argv[2]->ptr,"skip")) {
            if (!(c->flags & CLIENT_REPLY_OFF))
                c->flags |= CLIENT_REPLY_SKIP_NEXT;
        } else {
            addReply(c,shared.syntaxerr);
            return;
        }
A
antirez 已提交
1617 1618
    } else if (!strcasecmp(c->argv[1]->ptr,"kill")) {
        /* CLIENT KILL <ip:port>
A
antirez 已提交
1619
         * CLIENT KILL <option> [value] ... <option> [value] */
A
antirez 已提交
1620 1621 1622
        char *addr = NULL;
        int type = -1;
        uint64_t id = 0;
A
antirez 已提交
1623 1624
        int skipme = 1;
        int killed = 0, close_this_client = 0;
A
antirez 已提交
1625 1626

        if (c->argc == 3) {
A
antirez 已提交
1627
            /* Old style syntax: CLIENT KILL <addr> */
A
antirez 已提交
1628
            addr = c->argv[2]->ptr;
1629
            skipme = 0; /* With the old form, you can kill yourself. */
A
antirez 已提交
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
        } else if (c->argc > 3) {
            int i = 2; /* Next option index. */

            /* New style syntax: parse options. */
            while(i < c->argc) {
                int moreargs = c->argc > i+1;

                if (!strcasecmp(c->argv[i]->ptr,"id") && moreargs) {
                    long long tmp;

                    if (getLongLongFromObjectOrReply(c,c->argv[i+1],&tmp,NULL)
1641
                        != C_OK) return;
A
antirez 已提交
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
                    id = tmp;
                } else if (!strcasecmp(c->argv[i]->ptr,"type") && moreargs) {
                    type = getClientTypeByName(c->argv[i+1]->ptr);
                    if (type == -1) {
                        addReplyErrorFormat(c,"Unknown client type '%s'",
                            (char*) c->argv[i+1]->ptr);
                        return;
                    }
                } else if (!strcasecmp(c->argv[i]->ptr,"addr") && moreargs) {
                    addr = c->argv[i+1]->ptr;
                } else if (!strcasecmp(c->argv[i]->ptr,"skipme") && moreargs) {
                    if (!strcasecmp(c->argv[i+1]->ptr,"yes")) {
                        skipme = 1;
                    } else if (!strcasecmp(c->argv[i+1]->ptr,"no")) {
                        skipme = 0;
                    } else {
                        addReply(c,shared.syntaxerr);
                        return;
                    }
                } else {
                    addReply(c,shared.syntaxerr);
A
antirez 已提交
1663 1664
                    return;
                }
A
antirez 已提交
1665
                i += 2;
A
antirez 已提交
1666 1667 1668 1669 1670 1671 1672
            }
        } else {
            addReply(c,shared.syntaxerr);
            return;
        }

        /* Iterate clients killing all the matching clients. */
A
antirez 已提交
1673 1674 1675
        listRewind(server.clients,&li);
        while ((ln = listNext(&li)) != NULL) {
            client = listNodeValue(ln);
A
antirez 已提交
1676
            if (addr && strcmp(getClientPeerId(client),addr) != 0) continue;
A
antirez 已提交
1677
            if (type != -1 && getClientType(client) != type) continue;
A
antirez 已提交
1678
            if (id != 0 && client->id != id) continue;
A
antirez 已提交
1679
            if (c == client && skipme) continue;
A
antirez 已提交
1680 1681 1682

            /* Kill it. */
            if (c == client) {
1683
                close_this_client = 1;
A
antirez 已提交
1684 1685
            } else {
                freeClient(client);
A
antirez 已提交
1686
            }
A
antirez 已提交
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
            killed++;
        }

        /* Reply according to old/new format. */
        if (c->argc == 3) {
            if (killed == 0)
                addReplyError(c,"No such client");
            else
                addReply(c,shared.ok);
        } else {
            addReplyLongLong(c,killed);
A
antirez 已提交
1698
        }
1699 1700 1701

        /* If this client has to be closed, flag it as CLOSE_AFTER_REPLY
         * only after we queued the reply to its output buffers. */
A
antirez 已提交
1702
        if (close_this_client) c->flags |= CLIENT_CLOSE_AFTER_REPLY;
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719
    } 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 已提交
1720
            if (p[j] < '!' || p[j] > '~') { /* ASCII is assumed. */
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
                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);
1736 1737 1738 1739
    } else if (!strcasecmp(c->argv[1]->ptr,"pause") && c->argc == 3) {
        long long duration;

        if (getTimeoutFromObjectOrReply(c,c->argv[2],&duration,UNIT_MILLISECONDS)
1740
                                        != C_OK) return;
1741 1742
        pauseClients(duration);
        addReply(c,shared.ok);
A
antirez 已提交
1743
    } else {
O
oranagra 已提交
1744
        addReplyError(c, "Syntax error, try CLIENT (LIST | KILL | GETNAME | SETNAME | PAUSE | REPLY)");
A
antirez 已提交
1745 1746
    }
}
1747

1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767
/* This callback is bound to POST and "Host:" command names. Those are not
 * really commands, but are used in security attacks in order to talk to
 * Redis instances via HTTP, with a technique called "cross protocol scripting"
 * which exploits the fact that services like Redis will discard invalid
 * HTTP headers and will process what follows.
 *
 * As a protection against this attack, Redis will terminate the connection
 * when a POST or "Host:" header is seen, and will log the event from
 * time to time (to avoid creating a DOS as a result of too many logs). */
void securityWarningCommand(client *c) {
    static time_t logged_time;
    time_t now = time(NULL);

    if (labs(now-logged_time) > 60) {
        serverLog(LL_WARNING,"Possible SECURITY ATTACK detected. It looks like somebody is sending POST or Host: commands to Redis. This is likely due to an attacker attempting to use Cross Protocol Scripting to compromise your Redis instance. Connection aborted.");
        logged_time = now;
    }
    freeClientAsync(c);
}

1768 1769 1770
/* 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. */
1771
void rewriteClientCommandVector(client *c, int argc, ...) {
1772 1773 1774 1775 1776 1777 1778 1779
    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;
1780

1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
        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;
1793
    c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
A
antirez 已提交
1794
    serverAssertWithInfo(c,NULL,c->cmd != NULL);
1795 1796
    va_end(ap);
}
1797

1798
/* Completely replace the client command vector with the provided one. */
1799
void replaceClientCommandVector(client *c, int argc, robj **argv) {
1800 1801 1802 1803 1804
    freeClientArgv(c);
    zfree(c->argv);
    c->argv = argv;
    c->argc = argc;
    c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
A
antirez 已提交
1805
    serverAssertWithInfo(c,NULL,c->cmd != NULL);
1806 1807
}

1808
/* Rewrite a single item in the command vector.
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818
 * The new val ref count is incremented, and the old decremented.
 *
 * It is possible to specify an argument over the current size of the
 * argument vector: in this case the array of objects gets reallocated
 * and c->argc set to the max value. However it's up to the caller to
 *
 * 1. Make sure there are no "holes" and all the arguments are set.
 * 2. If the original argument vector was longer than the one we
 *    want to end with, it's up to the caller to set c->argc and
 *    free the no longer used objects on c->argv. */
1819
void rewriteClientCommandArgument(client *c, int i, robj *newval) {
1820
    robj *oldval;
1821

1822 1823 1824 1825 1826
    if (i >= c->argc) {
        c->argv = zrealloc(c->argv,sizeof(robj*)*(i+1));
        c->argc = i+1;
        c->argv[i] = NULL;
    }
1827 1828 1829
    oldval = c->argv[i];
    c->argv[i] = newval;
    incrRefCount(newval);
1830
    if (oldval) decrRefCount(oldval);
1831 1832 1833

    /* If this is the command name make sure to fix c->cmd. */
    if (i == 0) {
1834
        c->cmd = lookupCommandOrOriginal(c->argv[0]->ptr);
A
antirez 已提交
1835
        serverAssertWithInfo(c,NULL,c->cmd != NULL);
1836 1837
    }
}
1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850

/* 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 已提交
1851
 * enforcing the client output length limits. */
1852
unsigned long getClientOutputBufferMemoryUsage(client *c) {
1853 1854 1855
    unsigned long list_item_size = sizeof(listNode)+5;
    /* The +5 above means we assume an sds16 hdr, may not be true
     * but is not going to be a problem. */
1856 1857 1858

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

1860
/* Get the class of a client, used in order to enforce limits to different
1861 1862 1863
 * classes of clients.
 *
 * The function will return one of the following:
A
antirez 已提交
1864 1865 1866
 * CLIENT_TYPE_NORMAL -> Normal client
 * CLIENT_TYPE_SLAVE  -> Slave or client executing MONITOR command
 * CLIENT_TYPE_PUBSUB -> Client subscribed to Pub/Sub channels
A
antirez 已提交
1867
 * CLIENT_TYPE_MASTER -> The client representing our replication master.
1868
 */
1869
int getClientType(client *c) {
A
antirez 已提交
1870
    if (c->flags & CLIENT_MASTER) return CLIENT_TYPE_MASTER;
A
antirez 已提交
1871 1872
    if ((c->flags & CLIENT_SLAVE) && !(c->flags & CLIENT_MONITOR))
        return CLIENT_TYPE_SLAVE;
A
antirez 已提交
1873
    if (c->flags & CLIENT_PUBSUB) return CLIENT_TYPE_PUBSUB;
A
antirez 已提交
1874
    return CLIENT_TYPE_NORMAL;
1875
}
1876

A
antirez 已提交
1877
int getClientTypeByName(char *name) {
A
antirez 已提交
1878 1879 1880
    if (!strcasecmp(name,"normal")) return CLIENT_TYPE_NORMAL;
    else if (!strcasecmp(name,"slave")) return CLIENT_TYPE_SLAVE;
    else if (!strcasecmp(name,"pubsub")) return CLIENT_TYPE_PUBSUB;
A
antirez 已提交
1881
    else if (!strcasecmp(name,"master")) return CLIENT_TYPE_MASTER;
1882 1883 1884
    else return -1;
}

A
antirez 已提交
1885
char *getClientTypeName(int class) {
1886
    switch(class) {
A
antirez 已提交
1887 1888 1889
    case CLIENT_TYPE_NORMAL: return "normal";
    case CLIENT_TYPE_SLAVE:  return "slave";
    case CLIENT_TYPE_PUBSUB: return "pubsub";
A
antirez 已提交
1890
    case CLIENT_TYPE_MASTER: return "master";
A
antirez 已提交
1891
    default:                       return NULL;
1892 1893 1894
    }
}

1895 1896 1897 1898 1899 1900
/* 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. */
1901
int checkClientOutputBufferLimits(client *c) {
1902 1903 1904
    int soft = 0, hard = 0, class;
    unsigned long used_mem = getClientOutputBufferMemoryUsage(c);

A
antirez 已提交
1905
    class = getClientType(c);
A
antirez 已提交
1906 1907 1908 1909
    /* For the purpose of output buffer limiting, masters are handled
     * like normal clients. */
    if (class == CLIENT_TYPE_MASTER) class = CLIENT_TYPE_NORMAL;

1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
    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
1940
 * output buffer size. The caller can check if the client will be closed
A
antirez 已提交
1941
 * checking if the client CLIENT_CLOSE_ASAP flag is set.
1942 1943 1944 1945
 *
 * 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. */
1946
void asyncCloseClientOnOutputBufferLimitReached(client *c) {
A
antirez 已提交
1947
    serverAssert(c->reply_bytes < SIZE_MAX-(1024*64));
A
antirez 已提交
1948
    if (c->reply_bytes == 0 || c->flags & CLIENT_CLOSE_ASAP) return;
1949
    if (checkClientOutputBufferLimits(c)) {
1950
        sds client = catClientInfoString(sdsempty(),c);
1951 1952

        freeClientAsync(c);
A
antirez 已提交
1953
        serverLog(LL_WARNING,"Client %s scheduled to be closed ASAP for overcoming of output buffer limits.", client);
1954 1955 1956
        sdsfree(client);
    }
}
A
antirez 已提交
1957 1958

/* Helper function used by freeMemoryIfNeeded() in order to flush slaves
1959 1960 1961
 * output buffers without returning control to the event loop.
 * This is also called by SHUTDOWN for a best-effort attempt to send
 * slaves the latest writes. */
A
antirez 已提交
1962 1963 1964 1965 1966 1967
void flushSlavesOutputBuffers(void) {
    listIter li;
    listNode *ln;

    listRewind(server.slaves,&li);
    while((ln = listNext(&li))) {
1968
        client *slave = listNodeValue(ln);
A
antirez 已提交
1969 1970
        int events;

1971 1972 1973 1974 1975 1976
        /* Note that the following will not flush output buffers of slaves
         * in STATE_ONLINE but having put_online_on_ack set to true: in this
         * case the writable event is never installed, since the purpose
         * of put_online_on_ack is to postpone the moment it is installed.
         * This is what we want since slaves in this state should not receive
         * writes before the first ACK. */
A
antirez 已提交
1977 1978
        events = aeGetFileEvents(server.el,slave->fd);
        if (events & AE_WRITABLE &&
A
antirez 已提交
1979
            slave->replstate == SLAVE_STATE_ONLINE &&
1980
            clientHasPendingReplies(slave))
A
antirez 已提交
1981
        {
1982
            writeToClient(slave->fd,slave,0);
A
antirez 已提交
1983 1984 1985
        }
    }
}
1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012

/* Pause clients up to the specified unixtime (in ms). While clients
 * are paused no command is processed from clients, so the data set can't
 * change during that time.
 *
 * However while this function pauses normal and Pub/Sub clients, slaves are
 * still served, so this function can be used on server upgrades where it is
 * required that slaves process the latest bytes from the replication stream
 * before being turned to masters.
 *
 * This function is also internally used by Redis Cluster for the manual
 * failover procedure implemented by CLUSTER FAILOVER.
 *
 * The function always succeed, even if there is already a pause in progress.
 * In such a case, the pause is extended if the duration is more than the
 * time left for the previous duration. However if the duration is smaller
 * than the time left for the previous pause, no change is made to the
 * left duration. */
void pauseClients(mstime_t end) {
    if (!server.clients_paused || end > server.clients_pause_end_time)
        server.clients_pause_end_time = end;
    server.clients_paused = 1;
}

/* Return non-zero if clients are currently paused. As a side effect the
 * function checks if the pause time was reached and clear it. */
int clientsArePaused(void) {
2013 2014 2015
    if (server.clients_paused &&
        server.clients_pause_end_time < server.mstime)
    {
2016 2017
        listNode *ln;
        listIter li;
2018
        client *c;
2019 2020 2021 2022 2023 2024 2025 2026 2027

        server.clients_paused = 0;

        /* Put all the clients in the unblocked clients queue in order to
         * force the re-processing of the input buffer if any. */
        listRewind(server.clients,&li);
        while ((ln = listNext(&li)) != NULL) {
            c = listNodeValue(ln);

2028 2029
            /* Don't touch slaves and blocked clients. The latter pending
             * requests be processed when unblocked. */
A
antirez 已提交
2030 2031
            if (c->flags & (CLIENT_SLAVE|CLIENT_BLOCKED)) continue;
            c->flags |= CLIENT_UNBLOCKED;
2032 2033 2034 2035 2036
            listAddNodeTail(server.unblocked_clients,c);
        }
    }
    return server.clients_paused;
}
2037 2038 2039 2040 2041 2042 2043 2044

/* This function is called by Redis in order to process a few events from
 * time to time while blocked into some not interruptible operation.
 * This allows to reply to clients with the -LOADING error while loading the
 * data set at startup or after a full resynchronization with the master
 * and so forth.
 *
 * It calls the event loop in order to process a few events. Specifically we
O
Oran Agra 已提交
2045
 * try to call the event loop 4 times as long as we receive acknowledge that
2046 2047 2048 2049 2050 2051 2052 2053
 * some event was processed, in order to go forward with the accept, read,
 * write, close sequence needed to serve a client.
 *
 * The function returns the total number of events processed. */
int processEventsWhileBlocked(void) {
    int iterations = 4; /* See the function top-comment. */
    int count = 0;
    while (iterations--) {
2054 2055 2056
        int events = 0;
        events += aeProcessEvents(server.el, AE_FILE_EVENTS|AE_DONT_WAIT);
        events += handleClientsWithPendingWrites();
2057 2058 2059 2060 2061
        if (!events) break;
        count += events;
    }
    return count;
}