db.c 38.6 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 "redis.h"
31
#include "cluster.h"
32 33

#include <signal.h>
34
#include <ctype.h>
35

36 37 38
void slotToKeyAdd(robj *key);
void slotToKeyDel(robj *key);
void slotToKeyFlush(void);
39

40 41 42 43 44 45 46
/*-----------------------------------------------------------------------------
 * C-level DB API
 *----------------------------------------------------------------------------*/

robj *lookupKey(redisDb *db, robj *key) {
    dictEntry *de = dictFind(db->dict,key->ptr);
    if (de) {
47
        robj *val = dictGetVal(de);
48

G
guiquanz 已提交
49
        /* Update the access time for the ageing algorithm.
50 51
         * Don't do it if we have a saving child, as this will trigger
         * a copy on write madness. */
A
antirez 已提交
52
        if (server.rdb_child_pid == -1 && server.aof_child_pid == -1)
53
            val->lru = LRU_CLOCK();
54 55 56 57 58 59 60
        return val;
    } else {
        return NULL;
    }
}

robj *lookupKeyRead(redisDb *db, robj *key) {
61 62
    robj *val;

63
    expireIfNeeded(db,key);
64 65 66 67 68 69
    val = lookupKey(db,key);
    if (val == NULL)
        server.stat_keyspace_misses++;
    else
        server.stat_keyspace_hits++;
    return val;
70 71 72
}

robj *lookupKeyWrite(redisDb *db, robj *key) {
73
    expireIfNeeded(db,key);
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
    return lookupKey(db,key);
}

robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply) {
    robj *o = lookupKeyRead(c->db, key);
    if (!o) addReply(c,reply);
    return o;
}

robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply) {
    robj *o = lookupKeyWrite(c->db, key);
    if (!o) addReply(c,reply);
    return o;
}

89
/* Add the key to the DB. It's up to the caller to increment the reference
G
guiquanz 已提交
90
 * counter of the value if needed.
91 92 93 94 95 96
 *
 * The program is aborted if the key already exists. */
void dbAdd(redisDb *db, robj *key, robj *val) {
    sds copy = sdsdup(key->ptr);
    int retval = dictAdd(db->dict, copy, val);

97
    redisAssertWithInfo(NULL,key,retval == REDIS_OK);
98
    if (val->type == REDIS_LIST) signalListAsReady(db, key);
99
    if (server.cluster_enabled) slotToKeyAdd(key);
100 101 102 103 104 105 106 107
 }

/* Overwrite an existing key with a new value. Incrementing the reference
 * count of the new value is up to the caller.
 * This function does not modify the expire time of the existing key.
 *
 * The program is aborted if the key was not already present. */
void dbOverwrite(redisDb *db, robj *key, robj *val) {
A
antirez 已提交
108
    dictEntry *de = dictFind(db->dict,key->ptr);
109

110
    redisAssertWithInfo(NULL,key,de != NULL);
111
    dictReplace(db->dict, key->ptr, val);
112 113
}

114 115
/* High level Set operation. This function can be used in order to set
 * a key, whatever it was existing or not, to a new object.
116
 *
117 118 119 120 121 122
 * 1) The ref count of the value object is incremented.
 * 2) clients WATCHing for the destination key notified.
 * 3) The expire time of the key is reset (the key is made persistent). */
void setKey(redisDb *db, robj *key, robj *val) {
    if (lookupKeyWrite(db,key) == NULL) {
        dbAdd(db,key,val);
123
    } else {
124
        dbOverwrite(db,key,val);
125
    }
126 127
    incrRefCount(val);
    removeExpire(db,key);
128
    signalModifiedKey(db,key);
129 130 131 132 133 134 135 136 137 138 139
}

int dbExists(redisDb *db, robj *key) {
    return dictFind(db->dict,key->ptr) != NULL;
}

/* Return a random key, in form of a Redis object.
 * If there are no keys, NULL is returned.
 *
 * The function makes sure to return keys not already expired. */
robj *dbRandomKey(redisDb *db) {
A
antirez 已提交
140
    dictEntry *de;
141 142 143 144 145 146 147 148

    while(1) {
        sds key;
        robj *keyobj;

        de = dictGetRandomKey(db->dict);
        if (de == NULL) return NULL;

149
        key = dictGetKey(de);
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
        keyobj = createStringObject(key,sdslen(key));
        if (dictFind(db->expires,key)) {
            if (expireIfNeeded(db,keyobj)) {
                decrRefCount(keyobj);
                continue; /* search for another key. This expired. */
            }
        }
        return keyobj;
    }
}

/* Delete a key, value, and associated expiration entry if any, from the DB */
int dbDelete(redisDb *db, robj *key) {
    /* Deleting an entry from the expires dict will not free the sds of
     * the key, because it is shared with the main dictionary. */
    if (dictSize(db->expires) > 0) dictDelete(db->expires,key->ptr);
166
    if (dictDelete(db->dict,key->ptr) == DICT_OK) {
167
        if (server.cluster_enabled) slotToKeyDel(key);
168 169 170 171
        return 1;
    } else {
        return 0;
    }
172 173
}

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
/* Prepare the string object stored at 'key' to be modified destructively
 * to implement commands like SETBIT or APPEND.
 *
 * An object is usually ready to be modified unless one of the two conditions
 * are true:
 *
 * 1) The object 'o' is shared (refcount > 1), we don't want to affect
 *    other users.
 * 2) The object encoding is not "RAW".
 *
 * If the object is found in one of the above conditions (or both) by the
 * function, an unshared / not-encoded copy of the string object is stored
 * at 'key' in the specified 'db'. Otherwise the object 'o' itself is
 * returned.
 *
 * USAGE:
 *
 * The object 'o' is what the caller already obtained by looking up 'key'
 * in 'db', the usage pattern looks like this:
 *
 * o = lookupKeyWrite(db,key);
 * if (checkType(c,o,REDIS_STRING)) return;
 * o = dbUnshareStringValue(db,key,o);
 *
 * At this point the caller is ready to modify the object, for example
 * using an sdscat() call to append some data, or anything else.
 */
robj *dbUnshareStringValue(redisDb *db, robj *key, robj *o) {
    redisAssert(o->type == REDIS_STRING);
    if (o->refcount != 1 || o->encoding != REDIS_ENCODING_RAW) {
        robj *decoded = getDecodedObject(o);
        o = createRawStringObject(decoded->ptr, sdslen(decoded->ptr));
        decrRefCount(decoded);
        dbOverwrite(db,key,o);
    }
    return o;
}

212
long long emptyDb(void(callback)(void*)) {
213 214 215 216 217
    int j;
    long long removed = 0;

    for (j = 0; j < server.dbnum; j++) {
        removed += dictSize(server.db[j].dict);
218 219
        dictEmpty(server.db[j].dict,callback);
        dictEmpty(server.db[j].expires,callback);
220
    }
221
    if (server.cluster_enabled) slotToKeyFlush();
222 223 224 225 226 227 228 229 230 231
    return removed;
}

int selectDb(redisClient *c, int id) {
    if (id < 0 || id >= server.dbnum)
        return REDIS_ERR;
    c->db = &server.db[id];
    return REDIS_OK;
}

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
/*-----------------------------------------------------------------------------
 * Hooks for key space changes.
 *
 * Every time a key in the database is modified the function
 * signalModifiedKey() is called.
 *
 * Every time a DB is flushed the function signalFlushDb() is called.
 *----------------------------------------------------------------------------*/

void signalModifiedKey(redisDb *db, robj *key) {
    touchWatchedKey(db,key);
}

void signalFlushedDb(int dbid) {
    touchWatchedKeysOnFlush(dbid);
}

249 250 251 252 253 254
/*-----------------------------------------------------------------------------
 * Type agnostic commands operating on the key space
 *----------------------------------------------------------------------------*/

void flushdbCommand(redisClient *c) {
    server.dirty += dictSize(c->db->dict);
255
    signalFlushedDb(c->db->id);
256 257
    dictEmpty(c->db->dict,NULL);
    dictEmpty(c->db->expires,NULL);
258
    if (server.cluster_enabled) slotToKeyFlush();
259 260 261 262
    addReply(c,shared.ok);
}

void flushallCommand(redisClient *c) {
263
    signalFlushedDb(-1);
264
    server.dirty += emptyDb(NULL);
265
    addReply(c,shared.ok);
A
antirez 已提交
266
    if (server.rdb_child_pid != -1) {
267
        kill(server.rdb_child_pid,SIGUSR1);
A
antirez 已提交
268
        rdbRemoveTempFile(server.rdb_child_pid);
269
    }
270 271 272 273
    if (server.saveparamslen > 0) {
        /* Normally rdbSave() will reset dirty, but we don't want this here
         * as otherwise FLUSHALL will not be replicated nor put into the AOF. */
        int saved_dirty = server.dirty;
A
antirez 已提交
274
        rdbSave(server.rdb_filename);
275 276
        server.dirty = saved_dirty;
    }
277 278 279 280 281 282 283
    server.dirty++;
}

void delCommand(redisClient *c) {
    int deleted = 0, j;

    for (j = 1; j < c->argc; j++) {
284
        expireIfNeeded(c->db,c->argv[j]);
285
        if (dbDelete(c->db,c->argv[j])) {
286
            signalModifiedKey(c->db,c->argv[j]);
287 288
            notifyKeyspaceEvent(REDIS_NOTIFY_GENERIC,
                "del",c->argv[j],c->db->id);
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
            server.dirty++;
            deleted++;
        }
    }
    addReplyLongLong(c,deleted);
}

void existsCommand(redisClient *c) {
    expireIfNeeded(c->db,c->argv[1]);
    if (dbExists(c->db,c->argv[1])) {
        addReply(c, shared.cone);
    } else {
        addReply(c, shared.czero);
    }
}

void selectCommand(redisClient *c) {
306 307 308 309 310
    long id;

    if (getLongFromObjectOrReply(c, c->argv[1], &id,
        "invalid DB index") != REDIS_OK)
        return;
311

312
    if (server.cluster_enabled && id != 0) {
A
antirez 已提交
313 314 315
        addReplyError(c,"SELECT is not allowed in cluster mode");
        return;
    }
316
    if (selectDb(c,id) == REDIS_ERR) {
317
        addReplyError(c,"invalid DB index");
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
    } else {
        addReply(c,shared.ok);
    }
}

void randomkeyCommand(redisClient *c) {
    robj *key;

    if ((key = dbRandomKey(c->db)) == NULL) {
        addReply(c,shared.nullbulk);
        return;
    }

    addReplyBulk(c,key);
    decrRefCount(key);
}

void keysCommand(redisClient *c) {
    dictIterator *di;
    dictEntry *de;
    sds pattern = c->argv[1]->ptr;
A
antirez 已提交
339
    int plen = sdslen(pattern), allkeys;
340
    unsigned long numkeys = 0;
341
    void *replylen = addDeferredMultiBulkLength(c);
342

343
    di = dictGetSafeIterator(c->db->dict);
A
antirez 已提交
344
    allkeys = (pattern[0] == '*' && pattern[1] == '\0');
345
    while((de = dictNext(di)) != NULL) {
346
        sds key = dictGetKey(de);
347 348
        robj *keyobj;

A
antirez 已提交
349
        if (allkeys || stringmatchlen(pattern,plen,key,sdslen(key),0)) {
350 351 352 353 354 355 356 357 358
            keyobj = createStringObject(key,sdslen(key));
            if (expireIfNeeded(c->db,keyobj) == 0) {
                addReplyBulk(c,keyobj);
                numkeys++;
            }
            decrRefCount(keyobj);
        }
    }
    dictReleaseIterator(di);
359
    setDeferredMultiBulkLength(c,replylen,numkeys);
360 361
}

362 363
/* This callback is used by scanGenericCommand in order to collect elements
 * returned by the dictionary iterator into a list. */
P
Pieter Noordhuis 已提交
364
void scanCallback(void *privdata, const dictEntry *de) {
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
    void **pd = (void**) privdata;
    list *keys = pd[0];
    robj *o = pd[1];
    robj *key, *val = NULL;

    if (o == NULL) {
        sds sdskey = dictGetKey(de);
        key = createStringObject(sdskey, sdslen(sdskey));
    } else if (o->type == REDIS_SET) {
        key = dictGetKey(de);
        incrRefCount(key);
    } else if (o->type == REDIS_HASH) {
        key = dictGetKey(de);
        incrRefCount(key);
        val = dictGetVal(de);
        incrRefCount(val);
    } else if (o->type == REDIS_ZSET) {
        key = dictGetKey(de);
        incrRefCount(key);
        val = createStringObjectFromLongDouble(*(double*)dictGetVal(de));
    } else {
        redisPanic("Type not handled in SCAN callback.");
    }

    listAddNodeTail(keys, key);
    if (val) listAddNodeTail(keys, val);
P
Pieter Noordhuis 已提交
391 392
}

393
/* Try to parse a SCAN cursor stored at object 'o':
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
 * if the cursor is valid, store it as unsigned integer into *cursor and
 * returns REDIS_OK. Otherwise return REDIS_ERR and send an error to the
 * client. */
int parseScanCursorOrReply(redisClient *c, robj *o, unsigned long *cursor) {
    char *eptr;

    /* Use strtoul() because we need an *unsigned* long, so
     * getLongLongFromObject() does not cover the whole cursor space. */
    errno = 0;
    *cursor = strtoul(o->ptr, &eptr, 10);
    if (isspace(((char*)o->ptr)[0]) || eptr[0] != '\0' || errno == ERANGE)
    {
        addReplyError(c, "invalid cursor");
        return REDIS_ERR;
    }
    return REDIS_OK;
}

412
/* This command implements SCAN, HSCAN and SSCAN commands.
413
 * If object 'o' is passed, then it must be a Hash or Set object, otherwise
414 415 416 417 418 419 420
 * if 'o' is NULL the command will operate on the dictionary associated with
 * the current database.
 *
 * When 'o' is not NULL the function assumes that the first argument in
 * the client arguments vector is a key so it skips it before iterating
 * in order to parse options.
 *
421
 * In the case of a Hash object the function returns both the field and value
422
 * of every element on the Hash. */
423
void scanGenericCommand(redisClient *c, robj *o, unsigned long cursor) {
P
Pieter Noordhuis 已提交
424 425
    int i, j;
    list *keys = listCreate();
426
    listNode *node, *nextnode;
427
    long count = 10;
P
Pieter Noordhuis 已提交
428
    sds pat;
429
    int patlen, use_pattern = 0;
430 431 432 433 434 435 436 437 438
    dict *ht;

    /* Object must be NULL (to iterate keys names), or the type of the object
     * must be Set, Sorted Set, or Hash. */
    redisAssert(o == NULL || o->type == REDIS_SET || o->type == REDIS_HASH ||
                o->type == REDIS_ZSET);

    /* Set i to the first option argument. The previous one is the cursor. */
    i = (o == NULL) ? 2 : 3; /* Skip the key argument if needed. */
P
Pieter Noordhuis 已提交
439

440
    /* Step 1: Parse options. */
P
Pieter Noordhuis 已提交
441 442 443
    while (i < c->argc) {
        j = c->argc - i;
        if (!strcasecmp(c->argv[i]->ptr, "count") && j >= 2) {
A
antirez 已提交
444 445 446
            if (getLongFromObjectOrReply(c, c->argv[i+1], &count, NULL)
                != REDIS_OK)
            {
P
Pieter Noordhuis 已提交
447 448 449 450 451 452 453 454 455
                goto cleanup;
            }

            if (count < 1) {
                addReply(c,shared.syntaxerr);
                goto cleanup;
            }

            i += 2;
456
        } else if (!strcasecmp(c->argv[i]->ptr, "match") && j >= 2) {
P
Pieter Noordhuis 已提交
457 458 459
            pat = c->argv[i+1]->ptr;
            patlen = sdslen(pat);

460 461 462
            /* The pattern always matches if it is exactly "*", so it is
             * equivalent to disabling it. */
            use_pattern = !(pat[0] == '*' && patlen == 1);
P
Pieter Noordhuis 已提交
463 464 465 466 467 468 469 470

            i += 2;
        } else {
            addReply(c,shared.syntaxerr);
            goto cleanup;
        }
    }

471 472 473
    /* Step 2: Iterate the collection.
     *
     * Note that if the object is encoded with a ziplist, intset, or any other
474
     * representation that is not a hash table, we are sure that it is also
475 476 477 478
     * composed of a small number of elements. So to avoid taking state we
     * just return everything inside the object in a single call, setting the
     * cursor to zero to signal the end of the iteration. */

479
    /* Handle the case of a hash table. */
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
    ht = NULL;
    if (o == NULL) {
        ht = c->db->dict;
    } else if (o->type == REDIS_SET && o->encoding == REDIS_ENCODING_HT) {
        ht = o->ptr;
    } else if (o->type == REDIS_HASH && o->encoding == REDIS_ENCODING_HT) {
        ht = o->ptr;
        count *= 2; /* We return key / value for this type. */
    } else if (o->type == REDIS_ZSET && o->encoding == REDIS_ENCODING_SKIPLIST) {
        zset *zs = o->ptr;
        ht = zs->dict;
        count *= 2; /* We return key / value for this type. */
    }

    if (ht) {
        void *privdata[2];
496 497 498 499 500
        /* We set the max number of iterations to ten times the specified
         * COUNT, so if the hash table is in a pathological state (very
         * sparsely populated) we avoid to block too much time at the cost
         * of returning no or very few elements. */
        long maxiterations = count*10;
501 502 503 504 505 506 507 508

        /* We pass two pointers to the callback: the list to which it will
         * add new elements, and the object containing the dictionary so that
         * it is possible to fetch more data in a type-dependent way. */
        privdata[0] = keys;
        privdata[1] = o;
        do {
            cursor = dictScan(ht, cursor, scanCallback, privdata);
509 510 511
        } while (cursor &&
              maxiterations-- &&
              listLength(keys) < (unsigned long)count);
512 513
    } else if (o->type == REDIS_SET) {
        int pos = 0;
514
        int64_t ll;
515 516 517

        while(intsetGet(o->ptr,pos++,&ll))
            listAddNodeTail(keys,createStringObjectFromLongLong(ll));
518
        cursor = 0;
519 520 521 522 523 524 525 526 527 528 529
    } else if (o->type == REDIS_HASH || o->type == REDIS_ZSET) {
        unsigned char *p = ziplistIndex(o->ptr,0);
        unsigned char *vstr;
        unsigned int vlen;
        long long vll;

        while(p) {
            ziplistGet(p,&vstr,&vlen,&vll);
            listAddNodeTail(keys,
                (vstr != NULL) ? createStringObject((char*)vstr,vlen) :
                                 createStringObjectFromLongLong(vll));
A
antirez 已提交
530
            p = ziplistNext(o->ptr,p);
531
        }
532
        cursor = 0;
533 534 535
    } else {
        redisPanic("Not handled encoding in SCAN.");
    }
P
Pieter Noordhuis 已提交
536

537
    /* Step 3: Filter elements. */
538 539 540 541
    node = listFirst(keys);
    while (node) {
        robj *kobj = listNodeValue(node);
        nextnode = listNextNode(node);
542 543 544
        int filter = 0;

        /* Filter element if it does not match the pattern. */
545
        if (!filter && use_pattern) {
546 547 548 549 550 551 552 553 554 555 556 557
            if (sdsEncodedObject(kobj)) {
                if (!stringmatchlen(pat, patlen, kobj->ptr, sdslen(kobj->ptr), 0))
                    filter = 1;
            } else {
                char buf[REDIS_LONGSTR_SIZE];
                int len;

                redisAssert(kobj->encoding == REDIS_ENCODING_INT);
                len = ll2string(buf,sizeof(buf),(long)kobj->ptr);
                if (!stringmatchlen(pat, patlen, buf, len, 0)) filter = 1;
            }
        }
P
Pieter Noordhuis 已提交
558

559 560 561 562 563
        /* Filter element if it is an expired key. */
        if (!filter && o == NULL && expireIfNeeded(c->db, kobj)) filter = 1;

        /* Remove the element and its associted value if needed. */
        if (filter) {
P
Pieter Noordhuis 已提交
564
            decrRefCount(kobj);
565
            listDelNode(keys, node);
A
antirez 已提交
566 567
        }

568
        /* If this is a hash or a sorted set, we have a flat list of
A
antirez 已提交
569 570 571 572 573 574
         * key-value elements, so if this element was filtered, remove the
         * value, or skip it if it was not filtered: we only match keys. */
        if (o && (o->type == REDIS_ZSET || o->type == REDIS_HASH)) {
            node = nextnode;
            nextnode = listNextNode(node);
            if (filter) {
575 576 577 578
                kobj = listNodeValue(node);
                decrRefCount(kobj);
                listDelNode(keys, node);
            }
P
Pieter Noordhuis 已提交
579
        }
580
        node = nextnode;
P
Pieter Noordhuis 已提交
581 582
    }

583
    /* Step 4: Reply to the client. */
P
Pieter Noordhuis 已提交
584
    addReplyMultiBulkLen(c, 2);
585
    addReplyBulkLongLong(c,cursor);
P
Pieter Noordhuis 已提交
586 587

    addReplyMultiBulkLen(c, listLength(keys));
588 589
    while ((node = listFirst(keys)) != NULL) {
        robj *kobj = listNodeValue(node);
P
Pieter Noordhuis 已提交
590 591
        addReplyBulk(c, kobj);
        decrRefCount(kobj);
592
        listDelNode(keys, node);
P
Pieter Noordhuis 已提交
593 594 595
    }

cleanup:
596
    listSetFreeMethod(keys,decrRefCountVoid);
P
Pieter Noordhuis 已提交
597 598 599
    listRelease(keys);
}

600 601
/* The SCAN command completely relies on scanGenericCommand. */
void scanCommand(redisClient *c) {
602 603 604
    unsigned long cursor;
    if (parseScanCursorOrReply(c,c->argv[1],&cursor) == REDIS_ERR) return;
    scanGenericCommand(c,NULL,cursor);
605 606
}

607
void dbsizeCommand(redisClient *c) {
608
    addReplyLongLong(c,dictSize(c->db->dict));
609 610 611
}

void lastsaveCommand(redisClient *c) {
612
    addReplyLongLong(c,server.lastsave);
613 614 615 616 617 618 619 620
}

void typeCommand(redisClient *c) {
    robj *o;
    char *type;

    o = lookupKeyRead(c->db,c->argv[1]);
    if (o == NULL) {
621
        type = "none";
622 623
    } else {
        switch(o->type) {
624 625 626 627 628 629
        case REDIS_STRING: type = "string"; break;
        case REDIS_LIST: type = "list"; break;
        case REDIS_SET: type = "set"; break;
        case REDIS_ZSET: type = "zset"; break;
        case REDIS_HASH: type = "hash"; break;
        default: type = "unknown"; break;
630 631
        }
    }
632
    addReplyStatus(c,type);
633 634 635
}

void shutdownCommand(redisClient *c) {
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
    int flags = 0;

    if (c->argc > 2) {
        addReply(c,shared.syntaxerr);
        return;
    } else if (c->argc == 2) {
        if (!strcasecmp(c->argv[1]->ptr,"nosave")) {
            flags |= REDIS_SHUTDOWN_NOSAVE;
        } else if (!strcasecmp(c->argv[1]->ptr,"save")) {
            flags |= REDIS_SHUTDOWN_SAVE;
        } else {
            addReply(c,shared.syntaxerr);
            return;
        }
    }
651 652
    /* When SHUTDOWN is called while the server is loading a dataset in
     * memory we need to make sure no attempt is performed to save
A
antirez 已提交
653
     * the dataset on shutdown (otherwise it could overwrite the current DB
654 655 656 657
     * with half-read data).
     *
     * Also when in Sentinel mode clear the SAVE flag and force NOSAVE. */
    if (server.loading || server.sentinel_mode)
A
antirez 已提交
658
        flags = (flags & ~REDIS_SHUTDOWN_SAVE) | REDIS_SHUTDOWN_NOSAVE;
659
    if (prepareForShutdown(flags) == REDIS_OK) exit(0);
660
    addReplyError(c,"Errors trying to SHUTDOWN. Check logs.");
661 662 663 664
}

void renameGenericCommand(redisClient *c, int nx) {
    robj *o;
665
    long long expire;
666 667 668 669 670 671 672 673 674 675 676

    /* To use the same key as src and dst is probably an error */
    if (sdscmp(c->argv[1]->ptr,c->argv[2]->ptr) == 0) {
        addReply(c,shared.sameobjecterr);
        return;
    }

    if ((o = lookupKeyWriteOrReply(c,c->argv[1],shared.nokeyerr)) == NULL)
        return;

    incrRefCount(o);
677
    expire = getExpire(c->db,c->argv[1]);
678
    if (lookupKeyWrite(c->db,c->argv[2]) != NULL) {
679 680 681 682 683
        if (nx) {
            decrRefCount(o);
            addReply(c,shared.czero);
            return;
        }
A
antirez 已提交
684 685
        /* Overwrite: delete the old key before creating the new one
         * with the same name. */
686
        dbDelete(c->db,c->argv[2]);
687
    }
688 689
    dbAdd(c->db,c->argv[2],o);
    if (expire != -1) setExpire(c->db,c->argv[2],expire);
690
    dbDelete(c->db,c->argv[1]);
691 692
    signalModifiedKey(c->db,c->argv[1]);
    signalModifiedKey(c->db,c->argv[2]);
693 694 695 696
    notifyKeyspaceEvent(REDIS_NOTIFY_GENERIC,"rename_from",
        c->argv[1],c->db->id);
    notifyKeyspaceEvent(REDIS_NOTIFY_GENERIC,"rename_to",
        c->argv[2],c->db->id);
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
    server.dirty++;
    addReply(c,nx ? shared.cone : shared.ok);
}

void renameCommand(redisClient *c) {
    renameGenericCommand(c,0);
}

void renamenxCommand(redisClient *c) {
    renameGenericCommand(c,1);
}

void moveCommand(redisClient *c) {
    robj *o;
    redisDb *src, *dst;
    int srcid;
M
Matt Stancliff 已提交
713
    long long dbid;
714

A
antirez 已提交
715 716 717 718 719
    if (server.cluster_enabled) {
        addReplyError(c,"MOVE is not allowed in cluster mode");
        return;
    }

720 721 722
    /* Obtain source and target DB pointers */
    src = c->db;
    srcid = c->db->id;
M
Matt Stancliff 已提交
723 724 725 726 727

    if (getLongLongFromObject(c->argv[2],&dbid) == REDIS_ERR ||
        dbid < INT_MIN || dbid > INT_MAX ||
        selectDb(c,dbid) == REDIS_ERR)
    {
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
        addReply(c,shared.outofrangeerr);
        return;
    }
    dst = c->db;
    selectDb(c,srcid); /* Back to the source DB */

    /* If the user is moving using as target the same
     * DB as the source DB it is probably an error. */
    if (src == dst) {
        addReply(c,shared.sameobjecterr);
        return;
    }

    /* Check if the element exists and get a reference */
    o = lookupKeyWrite(c->db,c->argv[1]);
    if (!o) {
        addReply(c,shared.czero);
        return;
    }

748 749
    /* Return zero if the key already exists in the target DB */
    if (lookupKeyWrite(dst,c->argv[1]) != NULL) {
750 751 752
        addReply(c,shared.czero);
        return;
    }
753
    dbAdd(dst,c->argv[1],o);
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
    incrRefCount(o);

    /* OK! key moved, free the entry in the source DB */
    dbDelete(src,c->argv[1]);
    server.dirty++;
    addReply(c,shared.cone);
}

/*-----------------------------------------------------------------------------
 * Expires API
 *----------------------------------------------------------------------------*/

int removeExpire(redisDb *db, robj *key) {
    /* An expire may only be removed if there is a corresponding entry in the
     * main dict. Otherwise, the key will never be freed. */
769
    redisAssertWithInfo(NULL,key,dictFind(db->dict,key->ptr) != NULL);
A
antirez 已提交
770
    return dictDelete(db->expires,key->ptr) == DICT_OK;
771 772
}

773 774
void setExpire(redisDb *db, robj *key, long long when) {
    dictEntry *kde, *de;
775 776

    /* Reuse the sds from the main dict in the expire dict */
777 778 779 780
    kde = dictFind(db->dict,key->ptr);
    redisAssertWithInfo(NULL,key,kde != NULL);
    de = dictReplaceRaw(db->expires,dictGetKey(kde));
    dictSetSignedIntegerVal(de,when);
781 782 783 784
}

/* Return the expire time of the specified key, or -1 if no expire
 * is associated with this key (i.e. the key is non volatile) */
785
long long getExpire(redisDb *db, robj *key) {
786 787 788 789 790 791 792 793
    dictEntry *de;

    /* No expire? return ASAP */
    if (dictSize(db->expires) == 0 ||
       (de = dictFind(db->expires,key->ptr)) == NULL) return -1;

    /* The entry was found in the expire dict, this means it should also
     * be present in the main dict (safety check). */
794
    redisAssertWithInfo(NULL,key,dictFind(db->dict,key->ptr) != NULL);
795
    return dictGetSignedIntegerVal(de);
796 797
}

798 799 800 801 802 803 804 805 806 807 808
/* Propagate expires into slaves and the AOF file.
 * When a key expires in the master, a DEL operation for this key is sent
 * to all the slaves and the AOF file if enabled.
 *
 * This way the key expiry is centralized in one place, and since both
 * AOF and the master->slave link guarantee operation ordering, everything
 * will be consistent even if we allow write operations against expiring
 * keys. */
void propagateExpire(redisDb *db, robj *key) {
    robj *argv[2];

809
    argv[0] = shared.del;
810
    argv[1] = key;
811 812
    incrRefCount(argv[0]);
    incrRefCount(argv[1]);
813

814
    if (server.aof_state != REDIS_AOF_OFF)
815
        feedAppendOnlyFile(server.delCommand,db->id,argv,2);
816
    replicationFeedSlaves(server.slaves,db->id,argv,2);
817

818 819
    decrRefCount(argv[0]);
    decrRefCount(argv[1]);
820 821
}

822
int expireIfNeeded(redisDb *db, robj *key) {
823 824
    mstime_t when = getExpire(db,key);
    mstime_t now;
825

826 827
    if (when < 0) return 0; /* No expire for this key */

828 829 830
    /* Don't expire anything while loading. It will be done later. */
    if (server.loading) return 0;

831 832 833 834 835 836 837
    /* If we are in the context of a Lua script, we claim that time is
     * blocked to when the Lua script started. This way a key can expire
     * only the first time it is accessed and not in the middle of the
     * script execution, making propagation to slaves / AOF consistent.
     * See issue #1525 on Github for more information. */
    now = server.lua_caller ? server.lua_time_start : mstime();

838 839 840 841
    /* If we are running in the context of a slave, return ASAP:
     * the slave key expiration is controlled by the master that will
     * send us synthesized DEL operations for expired keys.
     *
842
     * Still we try to return the right information to the caller,
843 844
     * that is, 0 if we think the key should be still valid, 1 if
     * we think the key is expired at this time. */
845
    if (server.masterhost != NULL) return now > when;
846

847
    /* Return when this key has not expired */
848
    if (now <= when) return 0;
849 850 851

    /* Delete the key */
    server.stat_expiredkeys++;
852
    propagateExpire(db,key);
853 854
    notifyKeyspaceEvent(REDIS_NOTIFY_EXPIRED,
        "expired",key,db->id);
855 856 857 858 859 860 861
    return dbDelete(db,key);
}

/*-----------------------------------------------------------------------------
 * Expires Commands
 *----------------------------------------------------------------------------*/

862 863 864 865 866 867
/* This is the generic command implementation for EXPIRE, PEXPIRE, EXPIREAT
 * and PEXPIREAT. Because the commad second argument may be relative or absolute
 * the "basetime" argument is used to signal what the base time is (either 0
 * for *AT variants of the command, or the current time for relative expires).
 *
 * unit is either UNIT_SECONDS or UNIT_MILLISECONDS, and is only used for
G
guiquanz 已提交
868
 * the argv[2] parameter. The basetime is always specified in milliseconds. */
869
void expireGenericCommand(redisClient *c, long long basetime, int unit) {
870
    robj *key = c->argv[1], *param = c->argv[2];
871
    long long when; /* unix time in milliseconds when the key will expire. */
872

873
    if (getLongLongFromObjectOrReply(c, param, &when, NULL) != REDIS_OK)
874
        return;
875

876 877
    if (unit == UNIT_SECONDS) when *= 1000;
    when += basetime;
878

879 880
    /* No key, return zero. */
    if (lookupKeyRead(c->db,key) == NULL) {
881 882 883
        addReply(c,shared.czero);
        return;
    }
884

885 886 887 888 889 890
    /* EXPIRE with negative TTL, or EXPIREAT with a timestamp into the past
     * should never be executed as a DEL when load the AOF or in the context
     * of a slave instance.
     *
     * Instead we take the other branch of the IF statement setting an expire
     * (possibly in the past) and wait for an explicit DEL from the master. */
891
    if (when <= mstime() && !server.loading && !server.masterhost) {
892 893
        robj *aux;

894
        redisAssertWithInfo(c,key,dbDelete(c->db,key));
895 896 897 898 899 900
        server.dirty++;

        /* Replicate/AOF this as an explicit DEL. */
        aux = createStringObject("DEL",3);
        rewriteClientCommandVector(c,2,aux,key);
        decrRefCount(aux);
901
        signalModifiedKey(c->db,key);
902
        notifyKeyspaceEvent(REDIS_NOTIFY_GENERIC,"del",key,c->db->id);
903
        addReply(c, shared.cone);
904 905
        return;
    } else {
906
        setExpire(c->db,key,when);
907
        addReply(c,shared.cone);
908
        signalModifiedKey(c->db,key);
909
        notifyKeyspaceEvent(REDIS_NOTIFY_GENERIC,"expire",key,c->db->id);
910
        server.dirty++;
911 912 913 914 915
        return;
    }
}

void expireCommand(redisClient *c) {
916
    expireGenericCommand(c,mstime(),UNIT_SECONDS);
917 918 919
}

void expireatCommand(redisClient *c) {
920
    expireGenericCommand(c,0,UNIT_SECONDS);
921 922
}

923
void pexpireCommand(redisClient *c) {
924
    expireGenericCommand(c,mstime(),UNIT_MILLISECONDS);
925
}
926

927
void pexpireatCommand(redisClient *c) {
928
    expireGenericCommand(c,0,UNIT_MILLISECONDS);
929 930 931 932
}

void ttlGenericCommand(redisClient *c, int output_ms) {
    long long expire, ttl = -1;
933

934
    /* If the key does not exist at all, return -2 */
A
antirez 已提交
935
    if (lookupKeyRead(c->db,c->argv[1]) == NULL) {
936 937 938 939 940
        addReplyLongLong(c,-2);
        return;
    }
    /* The key exists. Return -1 if it has no expire, or the actual
     * TTL value otherwise. */
A
antirez 已提交
941
    expire = getExpire(c->db,c->argv[1]);
942
    if (expire != -1) {
943
        ttl = expire-mstime();
A
antirez 已提交
944
        if (ttl < 0) ttl = 0;
945
    }
946 947 948
    if (ttl == -1) {
        addReplyLongLong(c,-1);
    } else {
949
        addReplyLongLong(c,output_ms ? ttl : ((ttl+500)/1000));
950
    }
951
}
A
antirez 已提交
952

953 954 955 956 957 958 959 960
void ttlCommand(redisClient *c) {
    ttlGenericCommand(c, 0);
}

void pttlCommand(redisClient *c) {
    ttlGenericCommand(c, 1);
}

A
antirez 已提交
961 962 963 964 965 966 967
void persistCommand(redisClient *c) {
    dictEntry *de;

    de = dictFind(c->db->dict,c->argv[1]->ptr);
    if (de == NULL) {
        addReply(c,shared.czero);
    } else {
A
antirez 已提交
968
        if (removeExpire(c->db,c->argv[1])) {
A
antirez 已提交
969
            addReply(c,shared.cone);
A
antirez 已提交
970 971
            server.dirty++;
        } else {
A
antirez 已提交
972
            addReply(c,shared.czero);
A
antirez 已提交
973
        }
A
antirez 已提交
974 975
    }
}
976 977 978 979 980

/* -----------------------------------------------------------------------------
 * API to get key arguments from commands
 * ---------------------------------------------------------------------------*/

981 982
/* The base case is to use the keys position as given in the command table
 * (firstkey, lastkey, step). */
983 984 985 986 987 988 989 990 991 992 993 994 995
int *getKeysUsingCommandTable(struct redisCommand *cmd,robj **argv, int argc, int *numkeys) {
    int j, i = 0, last, *keys;
    REDIS_NOTUSED(argv);

    if (cmd->firstkey == 0) {
        *numkeys = 0;
        return NULL;
    }
    last = cmd->lastkey;
    if (last < 0) last = argc+last;
    keys = zmalloc(sizeof(int)*((last - cmd->firstkey)+1));
    for (j = cmd->firstkey; j <= last; j += cmd->keystep) {
        redisAssert(j < argc);
996
        keys[i++] = j;
997
    }
998
    *numkeys = i;
999 1000 1001
    return keys;
}

1002 1003 1004 1005 1006 1007 1008 1009
/* Return all the arguments that are keys in the command passed via argc / argv.
 *
 * The command returns the positions of all the key arguments inside the array,
 * so the actual return value is an heap allocated array of integers. The
 * length of the array is returned by reference into *numkeys.
 *
 * 'cmd' must be point to the corresponding entry into the redisCommand
 * table, according to the command name in argv[0].
1010 1011 1012
 *
 * This function uses the command table if a command-specific helper function
 * is not required, otherwise it calls the command-specific function. */
1013
int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys) {
1014
    if (cmd->getkeys_proc) {
1015
        return cmd->getkeys_proc(cmd,argv,argc,numkeys);
1016 1017 1018 1019 1020
    } else {
        return getKeysUsingCommandTable(cmd,argv,argc,numkeys);
    }
}

1021
/* Free the result of getKeysFromCommand. */
1022 1023 1024 1025
void getKeysFreeResult(int *result) {
    zfree(result);
}

1026 1027 1028 1029
/* Helper function to extract keys from following commands:
 * ZUNIONSTORE <destkey> <num-keys> <key> <key> ... <key> <options>
 * ZINTERSTORE <destkey> <num-keys> <key> <key> ... <key> <options> */
int *zunionInterGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys) {
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
    int i, num, *keys;
    REDIS_NOTUSED(cmd);

    num = atoi(argv[2]->ptr);
    /* Sanity check. Don't return any key if the command is going to
     * reply with syntax error. */
    if (num > (argc-3)) {
        *numkeys = 0;
        return NULL;
    }
1040 1041

    /* Keys in z{union,inter}store come from two places:
1042 1043
     * argv[1] = storage key,
     * argv[3...n] = keys to intersect */
1044 1045 1046
    keys = zmalloc(sizeof(int)*(num+1));

    /* Add all key positions for argv[3...n] to keys[] */
1047
    for (i = 0; i < num; i++) keys[i] = 3+i;
1048

1049
    /* Finally add the argv[1] key position (the storage key target). */
1050 1051
    keys[num] = 1;
    *numkeys = num+1;  /* Total keys = {union,inter} keys + storage key */
1052 1053
    return keys;
}
1054

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
/* Helper function to extract keys from the following commands:
 * EVAL <script> <num-keys> <key> <key> ... <key> [more stuff]
 * EVALSHA <script> <num-keys> <key> <key> ... <key> [more stuff] */
int *evalGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys) {
    int i, num, *keys;
    REDIS_NOTUSED(cmd);

    num = atoi(argv[2]->ptr);
    /* Sanity check. Don't return any key if the command is going to
     * reply with syntax error. */
    if (num > (argc-3)) {
        *numkeys = 0;
        return NULL;
    }

    keys = zmalloc(sizeof(int)*num);
1071
    *numkeys = num;
1072 1073 1074 1075 1076 1077 1078

    /* Add all key positions for argv[3...n] to keys[] */
    for (i = 0; i < num; i++) keys[i] = 3+i;

    return keys;
}

1079 1080 1081 1082 1083 1084 1085 1086
/* Helper function to extract keys from the SORT command.
 *
 * SORT <sort-key> ... STORE <store-key> ...
 *
 * The first argument of SORT is always a key, however a list of options
 * follow in SQL-alike style. Here we parse just the minimum in order to
 * correctly identify keys in the "STORE" option. */
int *sortGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys) {
M
Matt Stancliff 已提交
1087
    int i, j, num, *keys, found_store = 0;
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
    REDIS_NOTUSED(cmd);

    num = 0;
    keys = zmalloc(sizeof(int)*2); /* Alloc 2 places for the worst case. */

    keys[num++] = 1; /* <sort-key> is always present. */

    /* Search for STORE option. By default we consider options to don't
     * have arguments, so if we find an unknown option name we scan the
     * next. However there are options with 1 or 2 arguments, so we
     * provide a list here in order to skip the right number of args. */
    struct {
        char *name;
        int skip;
    } skiplist[] = {
        {"limit", 2},
        {"get", 1},
        {"by", 1},
        {NULL, 0} /* End of elements. */
    };

    for (i = 2; i < argc; i++) {
        for (j = 0; skiplist[j].name != NULL; j++) {
            if (!strcasecmp(argv[i]->ptr,skiplist[j].name)) {
                i += skiplist[j].skip;
                break;
            } else if (!strcasecmp(argv[i]->ptr,"store") && i+1 < argc) {
1115 1116 1117
                /* Note: we don't increment "num" here and continue the loop
                 * to be sure to process the *last* "STORE" option if multiple
                 * ones are provided. This is same behavior as SORT. */
M
Matt Stancliff 已提交
1118
                found_store = 1;
1119
                keys[num] = i+1; /* <store-key> */
1120 1121 1122 1123
                break;
            }
        }
    }
M
Matt Stancliff 已提交
1124
    *numkeys = num + found_store;
1125 1126 1127
    return keys;
}

1128 1129 1130
/* Slot to Key API. This is used by Redis Cluster in order to obtain in
 * a fast way a key that belongs to a specified hash slot. This is useful
 * while rehashing the cluster. */
1131
void slotToKeyAdd(robj *key) {
1132 1133
    unsigned int hashslot = keyHashSlot(key->ptr,sdslen(key->ptr));

1134
    zslInsert(server.cluster->slots_to_keys,hashslot,key);
1135 1136 1137
    incrRefCount(key);
}

1138
void slotToKeyDel(robj *key) {
1139 1140
    unsigned int hashslot = keyHashSlot(key->ptr,sdslen(key->ptr));

1141
    zslDelete(server.cluster->slots_to_keys,hashslot,key);
1142 1143
}

1144
void slotToKeyFlush(void) {
1145 1146 1147 1148
    zslFree(server.cluster->slots_to_keys);
    server.cluster->slots_to_keys = zslCreate();
}

1149
unsigned int getKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count) {
1150 1151
    zskiplistNode *n;
    zrangespec range;
A
antirez 已提交
1152
    int j = 0;
1153 1154 1155

    range.min = range.max = hashslot;
    range.minex = range.maxex = 0;
1156

1157
    n = zslFirstInRange(server.cluster->slots_to_keys, &range);
A
antirez 已提交
1158 1159 1160 1161 1162
    while(n && n->score == hashslot && count--) {
        keys[j++] = n->obj;
        n = n->level[0].forward;
    }
    return j;
1163
}
1164

1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
/* Remove all the keys in the specified hash slot.
 * The number of removed items is returned. */
unsigned int delKeysInSlot(unsigned int hashslot) {
    zskiplistNode *n;
    zrangespec range;
    int j = 0;

    range.min = range.max = hashslot;
    range.minex = range.maxex = 0;

    n = zslFirstInRange(server.cluster->slots_to_keys, &range);
    while(n && n->score == hashslot) {
        robj *key = n->obj;
        n = n->level[0].forward; /* Go to the next item before freeing it. */
        incrRefCount(key); /* Protect the object while freeing it. */
        dbDelete(&server.db[0],key);
        decrRefCount(key);
        j++;
    }
    return j;
}

1187
unsigned int countKeysInSlot(unsigned int hashslot) {
1188 1189
    zskiplist *zsl = server.cluster->slots_to_keys;
    zskiplistNode *zn;
1190
    zrangespec range;
1191
    int rank, count = 0;
1192 1193 1194

    range.min = range.max = hashslot;
    range.minex = range.maxex = 0;
1195 1196

    /* Find first element in range */
1197
    zn = zslFirstInRange(zsl, &range);
1198 1199 1200 1201 1202 1203 1204

    /* Use rank of first element, if any, to determine preliminary count */
    if (zn != NULL) {
        rank = zslGetRank(zsl, zn->score, zn->obj);
        count = (zsl->length - (rank - 1));

        /* Find last element in range */
1205
        zn = zslLastInRange(zsl, &range);
1206 1207 1208 1209 1210 1211

        /* Use rank of last element, if any, to determine the actual count */
        if (zn != NULL) {
            rank = zslGetRank(zsl, zn->score, zn->obj);
            count -= (zsl->length - rank);
        }
1212
    }
1213
    return count;
1214
}