redis.h 54.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*
 * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Redis nor the names of its contributors may be used
 *     to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
#ifndef __REDIS_H
#define __REDIS_H

#include "fmacros.h"
#include "config.h"

#if defined(__sun)
#include "solarisfixes.h"
#endif

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <limits.h>
#include <unistd.h>
#include <errno.h>
47
#include <inttypes.h>
A
antirez 已提交
48
#include <pthread.h>
J
Jonah H. Harris 已提交
49
#include <syslog.h>
A
antirez 已提交
50
#include <netinet/in.h>
51
#include <lua.h>
52
#include <signal.h>
53

54 55 56 57
#include "ae.h"      /* Event driven programming library */
#include "sds.h"     /* Dynamic safe strings */
#include "dict.h"    /* Hash tables */
#include "adlist.h"  /* Linked lists */
58
#include "zmalloc.h" /* total memory usage aware version of malloc/free */
59
#include "anet.h"    /* Networking the easy way */
60
#include "ziplist.h" /* Compact list data structure */
61 62 63
#include "intset.h"  /* Compact integer set structure */
#include "version.h" /* Version macro */
#include "util.h"    /* Misc functions useful in many places */
64 65 66 67 68 69

/* Error codes */
#define REDIS_OK                0
#define REDIS_ERR               -1

/* Static server configuration */
70 71 72
#define REDIS_DEFAULT_HZ        10      /* Time interrupt calls/sec. */
#define REDIS_MIN_HZ            1
#define REDIS_MAX_HZ            500 
73
#define REDIS_SERVERPORT        6379    /* TCP port */
74
#define REDIS_MAXIDLETIME       0       /* default client timeout: infinite */
75 76 77
#define REDIS_DEFAULT_DBNUM     16
#define REDIS_CONFIGLINE_MAX    1024
#define REDIS_EXPIRELOOKUPS_PER_CRON    10 /* lookup 10 expires per loop */
78
#define REDIS_EXPIRELOOKUPS_TIME_PERC   25 /* CPU max % for keys collection */
79
#define REDIS_DBCRON_DBS_PER_CALL 16
80
#define REDIS_MAX_WRITE_PER_EVENT (1024*64)
81
#define REDIS_SHARED_SELECT_CMDS 10
82
#define REDIS_SHARED_INTEGERS 10000
83
#define REDIS_SHARED_BULKHDR_LEN 32
J
Jonah H. Harris 已提交
84
#define REDIS_MAX_LOGMSG_LEN    1024 /* Default maximum length of syslog messages */
85 86 87
#define REDIS_AOF_REWRITE_PERC  100
#define REDIS_AOF_REWRITE_MIN_SIZE (1024*1024)
#define REDIS_AOF_REWRITE_ITEMS_PER_CMD 64
88
#define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000
89
#define REDIS_SLOWLOG_MAX_LEN 128
90
#define REDIS_MAX_CLIENTS 10000
91
#define REDIS_AUTHPASS_MAX_LEN 512
92
#define REDIS_DEFAULT_SLAVE_PRIORITY 100
A
7c6da73  
antirez 已提交
93 94
#define REDIS_REPL_TIMEOUT 60
#define REDIS_REPL_PING_SLAVE_PERIOD 10
95
#define REDIS_RUN_ID_SIZE 40
96
#define REDIS_OPS_SEC_SAMPLES 16
97 98 99
#define REDIS_DEFAULT_REPL_BACKLOG_SIZE (1024*1024)    /* 1mb */
#define REDIS_DEFAULT_REPL_BACKLOG_TIME_LIMIT (60*60)  /* 1 hour */
#define REDIS_REPL_BACKLOG_MIN_SIZE (1024*16)          /* 16k */
100
#define REDIS_BGSAVE_RETRY_DELAY 5 /* Wait a few secs before trying again. */
101 102 103
#define REDIS_DEFAULT_PID_FILE "/var/run/redis.pid"
#define REDIS_DEFAULT_SYSLOG_IDENT "redis"
#define REDIS_DEFAULT_CLUSTER_CONFIG_FILE "nodes.conf"
104

105 106 107 108
/* Protocol and I/O related defines */
#define REDIS_MAX_QUERYBUF_LEN  (1024*1024*1024) /* 1GB max query buffer. */
#define REDIS_IOBUF_LEN         (1024*16)  /* Generic I/O buffer size */
#define REDIS_REPLY_CHUNK_BYTES (16*1024) /* 16k output buffer */
109
#define REDIS_INLINE_MAX_SIZE   (1024*64) /* Max size of inline reads */
110
#define REDIS_MBULK_BIG_ARG     (1024*32)
111
#define REDIS_LONGSTR_SIZE      21          /* Bytes needed for long -> str */
112
#define REDIS_AOF_AUTOSYNC_BYTES (1024*1024*32) /* fdatasync every 32MB */
A
7c6da73  
antirez 已提交
113

114 115 116
/* Hash table parameters */
#define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */

117 118 119 120 121 122 123 124
/* Command flags. Please check the command table defined in the redis.c file
 * for more information about the meaning of every flag. */
#define REDIS_CMD_WRITE 1                   /* "w" flag */
#define REDIS_CMD_READONLY 2                /* "r" flag */
#define REDIS_CMD_DENYOOM 4                 /* "m" flag */
#define REDIS_CMD_FORCE_REPLICATION 8       /* "f" flag */
#define REDIS_CMD_ADMIN 16                  /* "a" flag */
#define REDIS_CMD_PUBSUB 32                 /* "p" flag */
125 126
#define REDIS_CMD_NOSCRIPT  64              /* "s" flag */
#define REDIS_CMD_RANDOM 128                /* "R" flag */
127
#define REDIS_CMD_SORT_FOR_SCRIPT 256       /* "S" flag */
128 129
#define REDIS_CMD_LOADING 512               /* "l" flag */
#define REDIS_CMD_STALE 1024                /* "t" flag */
130
#define REDIS_CMD_SKIP_MONITOR 2048         /* "M" flag */
131 132 133 134 135 136 137

/* Object types */
#define REDIS_STRING 0
#define REDIS_LIST 1
#define REDIS_SET 2
#define REDIS_ZSET 3
#define REDIS_HASH 4
138

139 140 141 142 143 144 145 146 147
/* Objects encoding. Some kind of objects like Strings and Hashes can be
 * internally represented in multiple ways. The 'encoding' field of the object
 * is set to one of this fields for this object. */
#define REDIS_ENCODING_RAW 0     /* Raw representation */
#define REDIS_ENCODING_INT 1     /* Encoded as integer */
#define REDIS_ENCODING_HT 2      /* Encoded as hash table */
#define REDIS_ENCODING_ZIPMAP 3  /* Encoded as zipmap */
#define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
#define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
148
#define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
149
#define REDIS_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
150 151 152 153 154 155 156

/* Defines related to the dump file format. To store 32 bits lengths for short
 * keys requires a lot of space, so we check the most significant 2 bits of
 * the first byte to interpreter the length:
 *
 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
 * 01|000000 00000000 =>  01, the len is 14 byes, 6 bits + 8 bits of next byte
G
guiquanz 已提交
157
 * 10|000000 [32 bit integer] => if it's 10, a full 32 bit len will follow
158 159 160 161
 * 11|000000 this means: specially encoded object will follow. The six bits
 *           number specify the kind of object that follows.
 *           See the REDIS_RDB_ENC_* defines.
 *
G
guiquanz 已提交
162
 * Lengths up to 63 are stored using a single byte, most DB keys, and may
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
 * values, will fit inside. */
#define REDIS_RDB_6BITLEN 0
#define REDIS_RDB_14BITLEN 1
#define REDIS_RDB_32BITLEN 2
#define REDIS_RDB_ENCVAL 3
#define REDIS_RDB_LENERR UINT_MAX

/* When a length of a string object stored on disk has the first two bits
 * set, the remaining two bits specify a special encoding for the object
 * accordingly to the following defines: */
#define REDIS_RDB_ENC_INT8 0        /* 8 bit signed integer */
#define REDIS_RDB_ENC_INT16 1       /* 16 bit signed integer */
#define REDIS_RDB_ENC_INT32 2       /* 32 bit signed integer */
#define REDIS_RDB_ENC_LZF 3         /* string compressed with FASTLZ */

178 179 180 181 182
/* AOF states */
#define REDIS_AOF_OFF 0             /* AOF is off */
#define REDIS_AOF_ON 1              /* AOF is on */
#define REDIS_AOF_WAIT_REWRITE 2    /* AOF waits rewrite to start appending */

183
/* Client flags */
A
antirez 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197
#define REDIS_SLAVE (1<<0)   /* This client is a slave server */
#define REDIS_MASTER (1<<1)  /* This client is a master server */
#define REDIS_MONITOR (1<<2) /* This client is a slave monitor, see MONITOR */
#define REDIS_MULTI (1<<3)   /* This client is in a MULTI context */
#define REDIS_BLOCKED (1<<4) /* The client is waiting in a blocking operation */
#define REDIS_DIRTY_CAS (1<<5) /* Watched keys modified. EXEC will fail. */
#define REDIS_CLOSE_AFTER_REPLY (1<<6) /* Close after writing entire reply. */
#define REDIS_UNBLOCKED (1<<7) /* This client was unblocked and is stored in
                                  server.unblocked_clients */
#define REDIS_LUA_CLIENT (1<<8) /* This is a non connected client used by Lua */
#define REDIS_ASKING (1<<9)     /* Client issued the ASKING command */
#define REDIS_CLOSE_ASAP (1<<10)/* Close this client ASAP */
#define REDIS_UNIX_SOCKET (1<<11) /* Client connected via Unix domain socket */
#define REDIS_DIRTY_EXEC (1<<12)  /* EXEC will fail for errors while queueing */
198 199 200 201

/* Client request types */
#define REDIS_REQ_INLINE 1
#define REDIS_REQ_MULTIBULK 2
202

203 204 205 206 207
/* Client classes for client limits, currently used only for
 * the max-client-output-buffer limit implementation. */
#define REDIS_CLIENT_LIMIT_CLASS_NORMAL 0
#define REDIS_CLIENT_LIMIT_CLASS_SLAVE 1
#define REDIS_CLIENT_LIMIT_CLASS_PUBSUB 2
208
#define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
209

210
/* Slave replication state - from the point of view of the slave. */
211 212
#define REDIS_REPL_NONE 0 /* No active replication */
#define REDIS_REPL_CONNECT 1 /* Must connect to master */
213
#define REDIS_REPL_CONNECTING 2 /* Connecting to master */
214 215 216
#define REDIS_REPL_RECEIVE_PONG 3 /* Wait for PING reply */
#define REDIS_REPL_TRANSFER 4 /* Receiving .rdb from master */
#define REDIS_REPL_CONNECTED 5 /* Connected to master */
217

218 219
/* Slave replication state - from the point of view of the master.
 * In SEND_BULK and ONLINE state the slave receives new updates
220 221
 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
 * to start the next background saving in order to send updates to it. */
222 223 224 225 226 227 228
#define REDIS_REPL_WAIT_BGSAVE_START 6 /* We need to produce a new RDB file. */
#define REDIS_REPL_WAIT_BGSAVE_END 7 /* Waiting RDB file creation to finish. */
#define REDIS_REPL_SEND_BULK 8 /* Sending RDB file to slave. */
#define REDIS_REPL_ONLINE 9 /* RDB file transmitted, sending just updates. */

/* Synchronous read timeout - slave side */
#define REDIS_REPL_SYNCIO_TIMEOUT 5
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244

/* List related stuff */
#define REDIS_HEAD 0
#define REDIS_TAIL 1

/* Sort operations */
#define REDIS_SORT_GET 0
#define REDIS_SORT_ASC 1
#define REDIS_SORT_DESC 2
#define REDIS_SORTKEY_MAX 1024

/* Log levels */
#define REDIS_DEBUG 0
#define REDIS_VERBOSE 1
#define REDIS_NOTICE 2
#define REDIS_WARNING 3
A
antirez 已提交
245
#define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
246 247 248 249 250 251 252 253

/* Anti-warning macro... */
#define REDIS_NOTUSED(V) ((void) V)

#define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
#define ZSKIPLIST_P 0.25      /* Skiplist P = 1/4 */

/* Append only defines */
254 255 256
#define AOF_FSYNC_NO 0
#define AOF_FSYNC_ALWAYS 1
#define AOF_FSYNC_EVERYSEC 2
257 258

/* Zip structure related defaults */
259 260
#define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
#define REDIS_HASH_MAX_ZIPLIST_VALUE 64
261 262 263
#define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
#define REDIS_LIST_MAX_ZIPLIST_VALUE 64
#define REDIS_SET_MAX_INTSET_ENTRIES 512
264 265
#define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
#define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
266 267 268 269 270 271

/* Sets operations codes */
#define REDIS_OP_UNION 0
#define REDIS_OP_DIFF 1
#define REDIS_OP_INTER 2

272 273 274 275 276 277
/* Redis maxmemory strategies */
#define REDIS_MAXMEMORY_VOLATILE_LRU 0
#define REDIS_MAXMEMORY_VOLATILE_TTL 1
#define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
#define REDIS_MAXMEMORY_ALLKEYS_LRU 3
#define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
278
#define REDIS_MAXMEMORY_NO_EVICTION 5
279

A
antirez 已提交
280
/* Scripting */
281
#define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
282

283 284 285 286
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

287 288 289 290 291
/* SHUTDOWN flags */
#define REDIS_SHUTDOWN_SAVE 1       /* Force SAVE on SHUTDOWN even if no save
                                       points are configured. */
#define REDIS_SHUTDOWN_NOSAVE 2     /* Don't SAVE on SHUTDOWN. */

292 293 294 295 296 297 298
/* Command call flags, see call() function */
#define REDIS_CALL_NONE 0
#define REDIS_CALL_SLOWLOG 1
#define REDIS_CALL_STATS 2
#define REDIS_CALL_PROPAGATE 4
#define REDIS_CALL_FULL (REDIS_CALL_SLOWLOG | REDIS_CALL_STATS | REDIS_CALL_PROPAGATE)

A
antirez 已提交
299 300 301 302 303
/* Command propagation flags, see propagate() function */
#define REDIS_PROPAGATE_NONE 0
#define REDIS_PROPAGATE_AOF 1
#define REDIS_PROPAGATE_REPL 2

304 305 306 307 308 309 310 311 312 313 314 315 316 317
/* Keyspace changes notification classes. Every class is associated with a
 * character for configuration purposes. */
#define REDIS_NOTIFY_KEYSPACE (1<<0)    /* K */
#define REDIS_NOTIFY_KEYEVENT (1<<1)    /* E */
#define REDIS_NOTIFY_GENERIC (1<<2)     /* g */
#define REDIS_NOTIFY_STRING (1<<3)      /* $ */
#define REDIS_NOTIFY_LIST (1<<4)        /* l */
#define REDIS_NOTIFY_SET (1<<5)         /* s */
#define REDIS_NOTIFY_HASH (1<<6)        /* h */
#define REDIS_NOTIFY_ZSET (1<<7)        /* z */
#define REDIS_NOTIFY_EXPIRED (1<<8)     /* x */
#define REDIS_NOTIFY_EVICTED (1<<9)     /* e */
#define REDIS_NOTIFY_ALL (REDIS_NOTIFY_GENERIC | REDIS_NOTIFY_STRING | REDIS_NOTIFY_LIST | REDIS_NOTIFY_SET | REDIS_NOTIFY_HASH | REDIS_NOTIFY_ZSET | REDIS_NOTIFY_EXPIRED | REDIS_NOTIFY_EVICTED)      /* A */

318 319
/* Using the following macro you can run code inside serverCron() with the
 * specified period, specified in milliseconds.
320 321
 * The actual resolution depends on server.hz. */
#define run_with_period(_ms_) if ((_ms_ <= 1000/server.hz) || !(server.cronloops%((_ms_)/(1000/server.hz))))
322

323
/* We can print the stacktrace, so our assert is defined this way: */
324
#define redisAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_redisAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
325 326 327 328 329 330 331 332 333 334
#define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
#define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)

/*-----------------------------------------------------------------------------
 * Data types
 *----------------------------------------------------------------------------*/

/* A redis object, that is a type able to hold a string / list / set */

/* The actual Redis Object */
335
#define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
336
#define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
337 338
typedef struct redisObject {
    unsigned type:4;
339
    unsigned notused:2;     /* Not used */
340 341 342 343 344 345
    unsigned encoding:4;
    unsigned lru:22;        /* lru time (relative to server.lruclock) */
    int refcount;
    void *ptr;
} robj;

G
guiquanz 已提交
346
/* Macro used to initialize a Redis object allocated on the stack.
347 348 349 350 351 352 353 354 355 356 357 358 359 360
 * Note that this macro is taken near the structure definition to make sure
 * we'll update it when the structure is changed, to avoid bugs like
 * bug #85 introduced exactly in this way. */
#define initStaticStringObject(_var,_ptr) do { \
    _var.refcount = 1; \
    _var.type = REDIS_STRING; \
    _var.encoding = REDIS_ENCODING_RAW; \
    _var.ptr = _ptr; \
} while(0);

typedef struct redisDb {
    dict *dict;                 /* The keyspace for this DB */
    dict *expires;              /* Timeout of keys with a timeout set */
    dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP) */
361
    dict *ready_keys;           /* Blocked keys that received a PUSH */
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
    dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
    int id;
} redisDb;

/* Client MULTI/EXEC state */
typedef struct multiCmd {
    robj **argv;
    int argc;
    struct redisCommand *cmd;
} multiCmd;

typedef struct multiState {
    multiCmd *commands;     /* Array of MULTI commands */
    int count;              /* Total number of MULTI commands */
} multiState;

378
typedef struct blockingState {
379
    dict *keys;             /* The keys we are waiting to terminate a blocking
380 381 382 383 384 385 386
                             * operation such as BLPOP. Otherwise NULL. */
    time_t timeout;         /* Blocking operation timeout. If UNIX current time
                             * is >= timeout then the operation timed out. */
    robj *target;           /* The key that should receive the element,
                             * for BRPOPLPUSH. */
} blockingState;

387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
/* The following structure represents a node in the server.ready_keys list,
 * where we accumulate all the keys that had clients blocked with a blocking
 * operation such as B[LR]POP, but received new data in the context of the
 * last executed command.
 *
 * After the execution of every command or script, we run this list to check
 * if as a result we should serve data to clients blocked, unblocking them.
 * Note that server.ready_keys will not have duplicates as there dictionary
 * also called ready_keys in every structure representing a Redis database,
 * where we make sure to remember if a given key was already added in the
 * server.ready_keys list. */
typedef struct readyList {
    redisDb *db;
    robj *key;
} readyList;

G
guiquanz 已提交
403
/* With multiplexing we need to take per-client state.
404 405 406 407 408
 * Clients are taken in a liked list. */
typedef struct redisClient {
    int fd;
    redisDb *db;
    int dictid;
409
    robj *name;             /* As set by CLIENT SETNAME */
410
    sds querybuf;
411
    size_t querybuf_peak;   /* Recent (100ms or more) peak of querybuf size */
412 413
    int argc;
    robj **argv;
414
    struct redisCommand *cmd, *lastcmd;
415 416 417
    int reqtype;
    int multibulklen;       /* number of multi bulk arguments left to read */
    long bulklen;           /* length of bulk argument in multi bulk request */
418
    list *reply;
419
    unsigned long reply_bytes; /* Tot bytes of objects in reply list */
420 421
    int sentlen;            /* Amount of bytes already sent in the current
                               buffer or object being sent. */
422
    time_t ctime;           /* Client creation time */
423
    time_t lastinteraction; /* time of the last interaction, used for timeout */
424
    time_t obuf_soft_limit_reached_time;
425 426 427 428 429 430
    int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
    int authenticated;      /* when requirepass is non-NULL */
    int replstate;          /* replication state if this is a slave */
    int repldbfd;           /* replication DB file descriptor */
    long repldboff;         /* replication DB file offset */
    off_t repldbsize;       /* replication DB file size */
431 432
    long long reploff;      /* replication offset if this is our master */
    char replrunid[REDIS_RUN_ID_SIZE+1]; /* master run id if this is a master */
A
antirez 已提交
433
    int slave_listening_port; /* As configured with: SLAVECONF listening-port */
434
    multiState mstate;      /* MULTI/EXEC state */
435
    blockingState bpop;   /* blocking state */
436 437 438 439 440
    list *io_keys;          /* Keys this client is waiting to be loaded from the
                             * swap file in order to continue. */
    list *watched_keys;     /* Keys WATCHED for MULTI/EXEC CAS */
    dict *pubsub_channels;  /* channels a client is interested in (SUBSCRIBE) */
    list *pubsub_patterns;  /* patterns a client is interested in (SUBSCRIBE) */
441 442 443

    /* Response buffer */
    int bufpos;
444
    char buf[REDIS_REPLY_CHUNK_BYTES];
445 446 447 448 449 450 451 452 453 454 455
} redisClient;

struct saveparam {
    time_t seconds;
    int changes;
};

struct sharedObjectsStruct {
    robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
    *colon, *nullbulk, *nullmultibulk, *queued,
    *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
456
    *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
457
    *masterdownerr, *roslaveerr, *execaborterr, *noautherr,
458
    *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
459
    *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
460
    *lpush,
461
    *select[REDIS_SHARED_SELECT_CMDS],
462 463 464
    *integers[REDIS_SHARED_INTEGERS],
    *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
    *bulkhdr[REDIS_SHARED_BULKHDR_LEN];  /* "$<value>\r\n" */
465 466
};

467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
/* ZSETs use a specialized version of Skiplists */
typedef struct zskiplistNode {
    robj *obj;
    double score;
    struct zskiplistNode *backward;
    struct zskiplistLevel {
        struct zskiplistNode *forward;
        unsigned int span;
    } level[];
} zskiplistNode;

typedef struct zskiplist {
    struct zskiplistNode *header, *tail;
    unsigned long length;
    int level;
} zskiplist;

typedef struct zset {
    dict *dict;
    zskiplist *zsl;
} zset;

489
typedef struct clientBufferLimitsConfig {
490 491
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
492 493 494
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

495 496
extern clientBufferLimitsConfig clientBufferLimitsDefaults[REDIS_CLIENT_LIMIT_NUM_CLASSES];

497 498 499 500 501 502 503
/* The redisOp structure defines a Redis Operation, that is an instance of
 * a command with an argument vector, database ID, propagation target
 * (REDIS_PROPAGATE_*), and command pointer.
 *
 * Currently only used to additionally propagate more commands to AOF/Replication
 * after the propagation of the executed command. */
typedef struct redisOp {
504 505 506
    robj **argv;
    int argc, dbid, target;
    struct redisCommand *cmd;
507 508 509 510 511 512 513 514 515 516 517 518 519
} redisOp;

/* Defines an array of Redis operations. There is an API to add to this
 * structure in a easy way.
 *
 * redisOpArrayInit();
 * redisOpArrayAppend();
 * redisOpArrayFree();
 */
typedef struct redisOpArray {
    redisOp *ops;
    int numops;
} redisOpArray;
520

A
antirez 已提交
521 522 523 524
/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

525
struct redisServer {
526
    /* General */
527
    char *configfile;           /* Absolute config file path, or NULL */
528
    int hz;                     /* serverCron() calls frequency in hertz */
529
    redisDb *db;
530 531
    dict *commands;             /* Command table */
    dict *orig_commands;        /* Command table before command renaming. */
532
    aeEventLoop *el;
533 534 535 536 537 538
    unsigned lruclock:22;       /* Clock incrementing every minute, for LRU */
    unsigned lruclock_padding:10;
    int shutdown_asap;          /* SHUTDOWN needed ASAP */
    int activerehashing;        /* Incremental rehash in serverCron() */
    char *requirepass;          /* Pass for AUTH command, or NULL */
    char *pidfile;              /* PID file path */
539
    int arch_bits;              /* 32 or 64 depending on sizeof(long) */
540
    int cronloops;              /* Number of times the cron function run */
A
antirez 已提交
541
    char runid[REDIS_RUN_ID_SIZE+1];  /* ID always different at every exec. */
542
    int sentinel_mode;          /* True if this instance is a Sentinel. */
543
    /* Networking */
544 545 546 547 548 549 550
    int port;                   /* TCP listening port */
    char *bindaddr;             /* Bind address or NULL */
    char *unixsocket;           /* UNIX socket path */
    mode_t unixsocketperm;      /* UNIX socket permission */
    int ipfd;                   /* TCP socket file descriptor */
    int sofd;                   /* Unix socket file descriptor */
    list *clients;              /* List of active clients */
551
    list *clients_to_close;     /* Clients to close asynchronously */
552
    list *slaves, *monitors;    /* List of slaves and MONITORs */
553
    redisClient *current_client; /* Current client, only used on crash report */
554
    char neterr[ANET_ERR_LEN];  /* Error buffer for anet.c */
555
    /* RDB / AOF loading information */
556
    int loading;                /* We are loading data from disk if true */
557 558 559
    off_t loading_total_bytes;
    off_t loading_loaded_bytes;
    time_t loading_start_time;
560
    /* Fast pointers to often looked up command */
561 562
    struct redisCommand *delCommand, *multiCommand, *lpushCommand, *lpopCommand,
                        *rpopCommand;
563
    /* Fields used only for stats */
564 565 566 567 568 569 570 571
    time_t stat_starttime;          /* Server start time */
    long long stat_numcommands;     /* Number of processed commands */
    long long stat_numconnections;  /* Number of connections received */
    long long stat_expiredkeys;     /* Number of expired keys */
    long long stat_evictedkeys;     /* Number of evicted keys (maxmemory) */
    long long stat_keyspace_hits;   /* Number of successful lookups of keys */
    long long stat_keyspace_misses; /* Number of failed lookups of keys */
    size_t stat_peak_memory;        /* Max used memory record */
G
guiquanz 已提交
572
    long long stat_fork_time;       /* Time needed to perform latest fork() */
573
    long long stat_rejected_conn;   /* Clients rejected because of maxclients */
574 575 576
    long long stat_sync_full;       /* Number of full resyncs with slaves. */
    long long stat_sync_partial_ok; /* Number of accepted PSYNC requests. */
    long long stat_sync_partial_err;/* Number of unaccepted PSYNC requests. */
577 578 579 580
    list *slowlog;                  /* SLOWLOG list of commands */
    long long slowlog_entry_id;     /* SLOWLOG current entry ID */
    long long slowlog_log_slower_than; /* SLOWLOG time limit (to get logged) */
    unsigned long slowlog_max_len;     /* SLOWLOG max number of items logged */
581 582 583 584 585 586
    /* The following two are used to track instantaneous "load" in terms
     * of operations per second. */
    long long ops_sec_last_sample_time; /* Timestamp of last sample (in ms) */
    long long ops_sec_last_sample_ops;  /* numcommands in last sample */
    long long ops_sec_samples[REDIS_OPS_SEC_SAMPLES];
    int ops_sec_idx;
587
    /* Configuration */
588 589
    int verbosity;                  /* Loglevel in redis.conf */
    int maxidletime;                /* Client timeout in seconds */
590
    int tcpkeepalive;               /* Set SO_KEEPALIVE if non-zero. */
A
antirez 已提交
591
    int active_expire_enabled;      /* Can be disabled for testing purposes. */
592 593 594
    size_t client_max_querybuf_len; /* Limit for client query buffer length */
    int dbnum;                      /* Total number of configured DBs */
    int daemonize;                  /* True if running as a daemon */
595
    clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES];
596 597
    /* AOF persistence */
    int aof_state;                  /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
598 599 600 601 602 603 604 605
    int aof_fsync;                  /* Kind of fsync() policy */
    char *aof_filename;             /* Name of the AOF file */
    int aof_no_fsync_on_rewrite;    /* Don't fsync if a rewrite is in prog. */
    int aof_rewrite_perc;           /* Rewrite AOF if % growth is > M and... */
    off_t aof_rewrite_min_size;     /* the AOF file is at least N bytes. */
    off_t aof_rewrite_base_size;    /* AOF size on latest startup or rewrite. */
    off_t aof_current_size;         /* AOF current size. */
    int aof_rewrite_scheduled;      /* Rewrite once BGSAVE terminates. */
A
antirez 已提交
606
    pid_t aof_child_pid;            /* PID if rewriting process */
607
    list *aof_rewrite_buf_blocks;   /* Hold changes during an AOF rewrite. */
A
antirez 已提交
608 609 610
    sds aof_buf;      /* AOF buffer, written before entering the event loop */
    int aof_fd;       /* File descriptor of currently selected AOF file */
    int aof_selected_db; /* Currently selected DB in AOF */
611
    time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
A
antirez 已提交
612
    time_t aof_last_fsync;            /* UNIX time of last fsync() */
613 614
    time_t aof_rewrite_time_last;   /* Time used by last AOF rewrite run. */
    time_t aof_rewrite_time_start;  /* Current AOF rewrite start time. */
615
    int aof_lastbgrewrite_status;   /* REDIS_OK or REDIS_ERR */
616
    unsigned long aof_delayed_fsync;  /* delayed AOF fsync() counter */
617
    int aof_rewrite_incremental_fsync;/* fsync incrementally while rewriting? */
618 619 620
    /* RDB persistence */
    long long dirty;                /* Changes to DB from the last save */
    long long dirty_before_bgsave;  /* Used to restore dirty on failed BGSAVE */
A
antirez 已提交
621
    pid_t rdb_child_pid;            /* PID of RDB saving child */
622 623
    struct saveparam *saveparams;   /* Save points array for RDB */
    int saveparamslen;              /* Number of saving points */
A
antirez 已提交
624 625
    char *rdb_filename;             /* Name of RDB file */
    int rdb_compression;            /* Use compression in RDB? */
626
    int rdb_checksum;               /* Use RDB checksum? */
G
guiquanz 已提交
627
    time_t lastsave;                /* Unix time of last successful save */
628
    time_t lastbgsave_try;          /* Unix time of last attempted bgsave */
629 630
    time_t rdb_save_time_last;      /* Time used by last RDB save run. */
    time_t rdb_save_time_start;     /* Current RDB save start time. */
631
    int lastbgsave_status;          /* REDIS_OK or REDIS_ERR */
632
    int stop_writes_on_bgsave_err;  /* Don't allow writes if can't BGSAVE */
633
    /* Propagation of commands in AOF / replication */
634
    redisOpArray also_propagate;    /* Additional command to propagate. */
635
    /* Logging */
636 637 638 639
    char *logfile;                  /* Path of log file */
    int syslog_enabled;             /* Is syslog enabled? */
    char *syslog_ident;             /* Syslog ident */
    int syslog_facility;            /* Syslog facility */
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
    /* Replication (master) */
    int slaveseldb;                 /* Last SELECTed DB in replication output */
    long long master_repl_offset;   /* Global replication offset */
    int repl_ping_slave_period;     /* Master pings the slave every N seconds */
    char *repl_backlog;             /* Replication backlog for partial syncs */
    long long repl_backlog_size;    /* Backlog circular buffer size */
    long long repl_backlog_histlen; /* Backlog actual data length */
    long long repl_backlog_idx;     /* Backlog circular buffer current offset */
    long long repl_backlog_off;     /* Replication offset of first byte in the
                                       backlog buffer. */
    time_t repl_backlog_time_limit; /* Time without slaves after the backlog
                                       gets released. */
    time_t repl_no_slaves_since;    /* We have no slaves since that time.
                                       Only valid if server.slaves len is 0. */
    /* Replication (slave) */
655 656 657 658 659
    char *masterauth;               /* AUTH with this password with master */
    char *masterhost;               /* Hostname of master */
    int masterport;                 /* Port of master */
    int repl_timeout;               /* Timeout after N seconds of master idle */
    redisClient *master;     /* Client that is master for this slave */
660
    redisClient *cached_master; /* Cached master to be reused for PSYNC. */
661
    int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
A
antirez 已提交
662
    int repl_state;          /* Replication status if the instance is a slave */
663 664 665
    off_t repl_transfer_size; /* Size of RDB to read from master during sync. */
    off_t repl_transfer_read; /* Amount of RDB read from master during sync. */
    off_t repl_transfer_last_fsync_off; /* Offset when we fsync-ed last time. */
666 667 668 669
    int repl_transfer_s;     /* Slave -> Master SYNC socket */
    int repl_transfer_fd;    /* Slave -> Master SYNC temp file descriptor */
    char *repl_transfer_tmpfile; /* Slave-> master SYNC temp file name */
    time_t repl_transfer_lastio; /* Unix time of the latest read, for timeout */
670
    int repl_serve_stale_data; /* Serve stale data when link is down? */
671
    int repl_slave_ro;          /* Slave is read only? */
672
    time_t repl_down_since; /* Unix time at which link with master went down */
673
    int repl_disable_tcp_nodelay;   /* Disable TCP_NODELAY after SYNC? */
674
    int slave_priority;             /* Reported in INFO and used by Sentinel. */
675 676
    char repl_master_runid[REDIS_RUN_ID_SIZE+1];  /* Master run id for PSYNC. */
    long long repl_master_initial_offset;         /* Master PSYNC offset. */
677
    /* Limits */
678 679
    unsigned int maxclients;        /* Max number of simultaneous clients */
    unsigned long long maxmemory;   /* Max number of memory bytes to use */
G
guiquanz 已提交
680
    int maxmemory_policy;           /* Policy for key eviction */
681
    int maxmemory_samples;          /* Pricision of random sampling */
682
    /* Blocked clients */
683
    unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */
684
    list *unblocked_clients; /* list of clients to unblock before next loop */
685
    list *ready_keys;        /* List of readyList structures for BLPOP & co */
686 687 688 689 690
    /* Sort parameters - qsort_r() is only available under BSD so we
     * have to take this state global, in order to pass it to sortCompare() */
    int sort_desc;
    int sort_alpha;
    int sort_bypattern;
691
    /* Zip structure config, see redis.conf for more information  */
692 693
    size_t hash_max_ziplist_entries;
    size_t hash_max_ziplist_value;
694 695
    size_t list_max_ziplist_entries;
    size_t list_max_ziplist_value;
696
    size_t set_max_intset_entries;
697 698
    size_t zset_max_ziplist_entries;
    size_t zset_max_ziplist_value;
699
    time_t unixtime;        /* Unix time sampled every second. */
700
    /* Pubsub */
701 702
    dict *pubsub_channels;  /* Map channels to list of subscribed clients */
    list *pubsub_patterns;  /* A list of pubsub_patterns */
703 704
    int notify_keyspace_events; /* Events to propagate via Pub/Sub. This is an
                                   xor of REDIS_NOTIFY... flags. */
705
    /* Scripting */
706
    lua_State *lua; /* The Lua interpreter. We use just one for all clients */
707 708 709 710 711
    redisClient *lua_client;   /* The "fake client" to query Redis from Lua */
    redisClient *lua_caller;   /* The client running EVAL right now, or NULL */
    dict *lua_scripts;         /* A dictionary of SHA1 -> Lua scripts */
    long long lua_time_limit;  /* Script timeout in seconds */
    long long lua_time_start;  /* Start time of script */
712 713
    int lua_write_dirty;  /* True if a write command was called during the
                             execution of the current script. */
714
    int lua_random_dirty; /* True if a random command was called during the
715
                             execution of the current script. */
716 717
    int lua_timedout;     /* True if we reached the time limit for script
                             execution. */
718
    int lua_kill;         /* Kill the script if true. */
G
guiquanz 已提交
719
    /* Assert & bug reporting */
A
antirez 已提交
720 721 722
    char *assert_failed;
    char *assert_file;
    int assert_line;
723
    int bug_report_start; /* True if bug report header was already logged. */
A
antirez 已提交
724
    int watchdog_period;  /* Software watchdog period in ms. 0 = off */
725 726 727 728 729 730 731 732
};

typedef struct pubsubPattern {
    redisClient *client;
    robj *pattern;
} pubsubPattern;

typedef void redisCommandProc(redisClient *c);
733
typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
734 735 736 737
struct redisCommand {
    char *name;
    redisCommandProc *proc;
    int arity;
G
guiquanz 已提交
738
    char *sflags; /* Flags as string representation, one char per flag. */
739
    int flags;    /* The actual flags, obtained from the 'sflags' field. */
740
    /* Use a function to determine keys arguments in a command line. */
741
    redisGetKeysProc *getkeys_proc;
742
    /* What keys should be loaded in background when calling this command? */
743
    int firstkey; /* The first argument that's a key (0 = no keys) */
G
guiquanz 已提交
744
    int lastkey;  /* The last argument that's a key */
745
    int keystep;  /* The step between first and last key */
746
    long long microseconds, calls;
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
};

struct redisFunctionSym {
    char *name;
    unsigned long pointer;
};

typedef struct _redisSortObject {
    robj *obj;
    union {
        double score;
        robj *cmpobj;
    } u;
} redisSortObject;

typedef struct _redisSortOperation {
    int type;
    robj *pattern;
} redisSortOperation;

/* Structure to hold list iteration abstraction. */
typedef struct {
    robj *subject;
    unsigned char encoding;
    unsigned char direction; /* Iteration direction */
    unsigned char *zi;
    listNode *ln;
} listTypeIterator;

/* Structure for an entry while iterating over a list. */
typedef struct {
    listTypeIterator *li;
    unsigned char *zi;  /* Entry in ziplist */
    listNode *ln;       /* Entry in linked list */
} listTypeEntry;

783 784 785 786 787 788
/* Structure to hold set iteration abstraction. */
typedef struct {
    robj *subject;
    int encoding;
    int ii; /* intset iterator */
    dictIterator *di;
789
} setTypeIterator;
790

G
guiquanz 已提交
791
/* Structure to hold hash iteration abstraction. Note that iteration over
792 793 794 795
 * hashes involves both fields and values. Because it is possible that
 * not both are required, store pointers in the iterator to avoid
 * unnecessary memory allocation for fields/values. */
typedef struct {
796
    robj *subject;
797
    int encoding;
798 799

    unsigned char *fptr, *vptr;
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815

    dictIterator *di;
    dictEntry *de;
} hashTypeIterator;

#define REDIS_HASH_KEY 1
#define REDIS_HASH_VALUE 2

/*-----------------------------------------------------------------------------
 * Extern declarations
 *----------------------------------------------------------------------------*/

extern struct redisServer server;
extern struct sharedObjectsStruct shared;
extern dictType setDictType;
extern dictType zsetDictType;
816
extern dictType dbDictType;
A
antirez 已提交
817
extern dictType shaScriptObjectDictType;
818
extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
819
extern dictType hashDictType;
820 821 822 823 824

/*-----------------------------------------------------------------------------
 * Functions prototypes
 *----------------------------------------------------------------------------*/

825 826
/* Utils */
long long ustime(void);
827
long long mstime(void);
828
void getRandomHexChars(char *p, unsigned int len);
829
uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
830
void exitFromChild(int retcode);
831
void redisSetProcTitle(char *title);
832

833 834 835 836
/* networking.c -- Networking and Client related operations */
redisClient *createClient(int fd);
void closeTimedoutClients(void);
void freeClient(redisClient *c);
837
void freeClientAsync(redisClient *c);
838 839 840
void resetClient(redisClient *c);
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
void addReply(redisClient *c, robj *obj);
841 842
void *addDeferredMultiBulkLength(redisClient *c);
void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
843 844
void addReplySds(redisClient *c, sds s);
void processInputBuffer(redisClient *c);
845 846
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
847 848 849
void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
void addReplyBulk(redisClient *c, robj *obj);
void addReplyBulkCString(redisClient *c, char *s);
850 851
void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
void addReplyBulkLongLong(redisClient *c, long long ll);
852 853 854
void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void addReply(redisClient *c, robj *obj);
void addReplySds(redisClient *c, sds s);
855 856
void addReplyError(redisClient *c, char *err);
void addReplyStatus(redisClient *c, char *status);
857 858
void addReplyDouble(redisClient *c, double d);
void addReplyLongLong(redisClient *c, long long ll);
859
void addReplyMultiBulkLen(redisClient *c, long length);
860
void copyClientOutputBuffer(redisClient *dst, redisClient *src);
861
void *dupClientReplyValue(void *o);
862 863
void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer);
864
sds getClientInfoString(redisClient *client);
865
sds getAllClientsInfoString(void);
866
void rewriteClientCommandVector(redisClient *c, int argc, ...);
867
void rewriteClientCommandArgument(redisClient *c, int i, robj *newval);
868
unsigned long getClientOutputBufferMemoryUsage(redisClient *c);
869
void freeClientsInAsyncFreeQueue(void);
870
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c);
871 872
int getClientLimitClassByName(char *name);
char *getClientLimitClassName(int class);
A
antirez 已提交
873
void flushSlavesOutputBuffers(void);
874
void disconnectSlaves(void);
875

876 877 878 879 880 881 882 883 884 885
#ifdef __GNUC__
void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
#else
void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
#endif

886 887 888 889 890
/* List data type */
void listTypeTryConversion(robj *subject, robj *value);
void listTypePush(robj *subject, robj *value, int where);
robj *listTypePop(robj *subject, int where);
unsigned long listTypeLength(robj *subject);
891
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
892 893 894 895 896 897 898 899
void listTypeReleaseIterator(listTypeIterator *li);
int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
robj *listTypeGet(listTypeEntry *entry);
void listTypeInsert(listTypeEntry *entry, robj *value, int where);
int listTypeEqual(listTypeEntry *entry, robj *o);
void listTypeDelete(listTypeEntry *entry);
void listTypeConvert(robj *subject, int enc);
void unblockClientWaitingData(redisClient *c);
900
void handleClientsBlockedOnLists(void);
901 902 903 904 905 906
void popGenericCommand(redisClient *c, int where);

/* MULTI/EXEC/WATCH... */
void unwatchAllKeys(redisClient *c);
void initClientMultiState(redisClient *c);
void freeClientMultiState(redisClient *c);
907
void queueMultiCommand(redisClient *c);
908 909
void touchWatchedKey(redisDb *db, robj *key);
void touchWatchedKeysOnFlush(int dbid);
910
void discardTransaction(redisClient *c);
A
antirez 已提交
911
void flagTransaction(redisClient *c);
912 913

/* Redis object implementation */
914 915
void decrRefCount(robj *o);
void decrRefCountVoid(void *o);
916
void incrRefCount(robj *o);
917
robj *resetRefCount(robj *obj);
918 919 920 921 922 923 924 925
void freeStringObject(robj *o);
void freeListObject(robj *o);
void freeSetObject(robj *o);
void freeZsetObject(robj *o);
void freeHashObject(robj *o);
robj *createObject(int type, void *ptr);
robj *createStringObject(char *ptr, size_t len);
robj *dupStringObject(robj *o);
926
int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
927 928 929 930
robj *tryObjectEncoding(robj *o);
robj *getDecodedObject(robj *o);
size_t stringObjectLen(robj *o);
robj *createStringObjectFromLongLong(long long value);
A
antirez 已提交
931
robj *createStringObjectFromLongDouble(long double value);
932 933 934
robj *createListObject(void);
robj *createZiplistObject(void);
robj *createSetObject(void);
935
robj *createIntsetObject(void);
936 937
robj *createHashObject(void);
robj *createZsetObject(void);
938
robj *createZsetZiplistObject(void);
939 940 941 942 943
int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
int checkType(redisClient *c, robj *o, int type);
int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
int getLongLongFromObject(robj *o, long long *target);
A
antirez 已提交
944 945
int getLongDoubleFromObject(robj *o, long double *target);
int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
946 947 948
char *strEncoding(int encoding);
int compareStringObjects(robj *a, robj *b);
int equalStringObjects(robj *a, robj *b);
949
unsigned long estimateObjectIdleTime(robj *o);
950

951
/* Synchronous I/O with timeout */
952 953 954
ssize_t syncWrite(int fd, char *ptr, ssize_t size, long long timeout);
ssize_t syncRead(int fd, char *ptr, ssize_t size, long long timeout);
ssize_t syncReadLine(int fd, char *ptr, ssize_t size, long long timeout);
955

956 957
/* Replication */
void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
958
void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc);
959
void updateSlavesWaitingBgsave(int bgsaveerr);
960
void replicationCron(void);
961 962 963
void replicationHandleMasterDisconnection(void);
void replicationCacheMaster(redisClient *c);
void resizeReplicationBacklog(long long newsize);
964

965 966 967 968 969
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

970
/* RDB persistence */
971
#include "rdb.h"
972 973

/* AOF persistence */
974
void flushAppendOnlyFile(int force);
975 976 977 978 979 980
void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
void aofRemoveTempFile(pid_t childpid);
int rewriteAppendOnlyFileBackground(void);
int loadAppendOnlyFile(char *filename);
void stopAppendOnly(void);
int startAppendOnly(void);
981
void backgroundRewriteDoneHandler(int exitcode, int bysignal);
982 983
void aofRewriteBufferReset(void);
unsigned long aofRewriteBufferSize(void);
984 985

/* Sorted sets data type */
986 987 988 989 990 991 992

/* Struct to hold a inclusive/exclusive range spec. */
typedef struct {
    double min, max;
    int minex, maxex; /* are min or max exclusive? */
} zrangespec;

993 994
zskiplist *zslCreate(void);
void zslFree(zskiplist *zsl);
995
zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
996
unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
997 998
int zslDelete(zskiplist *zsl, double score, robj *obj);
zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
999 1000 1001
double zzlGetScore(unsigned char *sptr);
void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
1002 1003
unsigned int zsetLength(robj *zobj);
void zsetConvert(robj *zobj, int encoding);
1004 1005

/* Core functions */
1006
int freeMemoryIfNeeded(void);
1007
int processCommand(redisClient *c);
1008
void setupSignalHandlers(void);
1009 1010
struct redisCommand *lookupCommand(sds name);
struct redisCommand *lookupCommandByCString(char *s);
1011
struct redisCommand *lookupCommandOrOriginal(sds name);
1012
void call(redisClient *c, int flags);
A
antirez 已提交
1013
void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1014
void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
1015
int prepareForShutdown();
1016 1017 1018 1019
#ifdef __GNUC__
void redisLog(int level, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
#else
1020
void redisLog(int level, const char *fmt, ...);
1021
#endif
1022
void redisLogRaw(int level, const char *msg);
A
antirez 已提交
1023
void redisLogFromHandler(int level, const char *msg);
1024 1025 1026 1027
void usage();
void updateDictResizePolicy(void);
int htNeedsResize(dict *dict);
void oom(const char *msg);
1028
void populateCommandTable(void);
1029
void resetCommandTableStats(void);
1030

1031 1032 1033 1034 1035
/* Set data type */
robj *setTypeCreate(robj *value);
int setTypeAdd(robj *subject, robj *value);
int setTypeRemove(robj *subject, robj *value);
int setTypeIsMember(robj *subject, robj *value);
1036 1037
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
1038 1039
int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
robj *setTypeNextObject(setTypeIterator *si);
A
antirez 已提交
1040
int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1041 1042 1043
unsigned long setTypeSize(robj *subject);
void setTypeConvert(robj *subject, int enc);

1044
/* Hash data type */
1045
void hashTypeConvert(robj *o, int enc);
1046 1047
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1048
robj *hashTypeGetObject(robj *o, robj *key);
1049 1050 1051 1052 1053 1054 1055
int hashTypeExists(robj *o, robj *key);
int hashTypeSet(robj *o, robj *key, robj *value);
int hashTypeDelete(robj *o, robj *key);
unsigned long hashTypeLength(robj *o);
hashTypeIterator *hashTypeInitIterator(robj *subject);
void hashTypeReleaseIterator(hashTypeIterator *hi);
int hashTypeNext(hashTypeIterator *hi);
1056 1057 1058 1059 1060
void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what,
                                unsigned char **vstr,
                                unsigned int *vlen,
                                long long *vll);
void hashTypeCurrentFromHashTable(hashTypeIterator *hi, int what, robj **dst);
A
antirez 已提交
1061
robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1062 1063 1064 1065 1066 1067 1068
robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);

/* Pub / Sub */
int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
void freePubsubPattern(void *p);
int listMatchPubsubPattern(void *a, void *b);
1069
int pubsubPublishMessage(robj *channel, robj *message);
1070 1071 1072 1073 1074

/* Keyspace events notification */
void notifyKeyspaceEvent(int type, char *event, robj *key, int dbid);
int keyspaceEventsStringToFlags(char *classes);
sds keyspaceEventsFlagsToString(int flags);
1075 1076

/* Configuration */
1077
void loadServerConfig(char *filename, char *options);
1078 1079 1080 1081 1082
void appendServerSaveParams(time_t seconds, int changes);
void resetServerSaveParams();

/* db.c -- Keyspace access API */
int removeExpire(redisDb *db, robj *key);
1083
void propagateExpire(redisDb *db, robj *key);
1084
int expireIfNeeded(redisDb *db, robj *key);
1085 1086
long long getExpire(redisDb *db, robj *key);
void setExpire(redisDb *db, robj *key, long long when);
1087 1088 1089 1090 1091
robj *lookupKey(redisDb *db, robj *key);
robj *lookupKeyRead(redisDb *db, robj *key);
robj *lookupKeyWrite(redisDb *db, robj *key);
robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
1092 1093 1094
void dbAdd(redisDb *db, robj *key, robj *val);
void dbOverwrite(redisDb *db, robj *key, robj *val);
void setKey(redisDb *db, robj *key, robj *val);
1095 1096 1097 1098 1099
int dbExists(redisDb *db, robj *key);
robj *dbRandomKey(redisDb *db);
int dbDelete(redisDb *db, robj *key);
long long emptyDb();
int selectDb(redisClient *c, int id);
1100 1101
void signalModifiedKey(redisDb *db, robj *key);
void signalFlushedDb(int dbid);
A
antirez 已提交
1102
unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
1103

1104 1105 1106 1107 1108 1109 1110 1111 1112
/* API to get key arguments from commands */
#define REDIS_GETKEYS_ALL 0
#define REDIS_GETKEYS_PRELOAD 1
int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
void getKeysFreeResult(int *result);
int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);

1113 1114 1115 1116 1117 1118
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);

1119 1120 1121
/* Scripting */
void scriptingInit(void);

1122 1123 1124
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);
1125
uint64_t redisBuildId(void);
1126 1127 1128 1129 1130 1131 1132 1133

/* Commands prototypes */
void authCommand(redisClient *c);
void pingCommand(redisClient *c);
void echoCommand(redisClient *c);
void setCommand(redisClient *c);
void setnxCommand(redisClient *c);
void setexCommand(redisClient *c);
1134
void psetexCommand(redisClient *c);
1135 1136 1137
void getCommand(redisClient *c);
void delCommand(redisClient *c);
void existsCommand(redisClient *c);
P
Pieter Noordhuis 已提交
1138 1139
void setbitCommand(redisClient *c);
void getbitCommand(redisClient *c);
1140
void setrangeCommand(redisClient *c);
1141
void getrangeCommand(redisClient *c);
1142 1143 1144 1145
void incrCommand(redisClient *c);
void decrCommand(redisClient *c);
void incrbyCommand(redisClient *c);
void decrbyCommand(redisClient *c);
A
antirez 已提交
1146
void incrbyfloatCommand(redisClient *c);
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
void selectCommand(redisClient *c);
void randomkeyCommand(redisClient *c);
void keysCommand(redisClient *c);
void dbsizeCommand(redisClient *c);
void lastsaveCommand(redisClient *c);
void saveCommand(redisClient *c);
void bgsaveCommand(redisClient *c);
void bgrewriteaofCommand(redisClient *c);
void shutdownCommand(redisClient *c);
void moveCommand(redisClient *c);
void renameCommand(redisClient *c);
void renamenxCommand(redisClient *c);
void lpushCommand(redisClient *c);
void rpushCommand(redisClient *c);
void lpushxCommand(redisClient *c);
void rpushxCommand(redisClient *c);
void linsertCommand(redisClient *c);
void lpopCommand(redisClient *c);
void rpopCommand(redisClient *c);
void llenCommand(redisClient *c);
void lindexCommand(redisClient *c);
void lrangeCommand(redisClient *c);
void ltrimCommand(redisClient *c);
void typeCommand(redisClient *c);
void lsetCommand(redisClient *c);
void saddCommand(redisClient *c);
void sremCommand(redisClient *c);
void smoveCommand(redisClient *c);
void sismemberCommand(redisClient *c);
void scardCommand(redisClient *c);
void spopCommand(redisClient *c);
void srandmemberCommand(redisClient *c);
void sinterCommand(redisClient *c);
void sinterstoreCommand(redisClient *c);
void sunionCommand(redisClient *c);
void sunionstoreCommand(redisClient *c);
void sdiffCommand(redisClient *c);
void sdiffstoreCommand(redisClient *c);
void syncCommand(redisClient *c);
void flushdbCommand(redisClient *c);
void flushallCommand(redisClient *c);
void sortCommand(redisClient *c);
void lremCommand(redisClient *c);
1190
void rpoplpushCommand(redisClient *c);
1191 1192 1193 1194 1195
void infoCommand(redisClient *c);
void mgetCommand(redisClient *c);
void monitorCommand(redisClient *c);
void expireCommand(redisClient *c);
void expireatCommand(redisClient *c);
1196 1197
void pexpireCommand(redisClient *c);
void pexpireatCommand(redisClient *c);
1198 1199
void getsetCommand(redisClient *c);
void ttlCommand(redisClient *c);
1200
void pttlCommand(redisClient *c);
A
antirez 已提交
1201
void persistCommand(redisClient *c);
1202 1203 1204 1205 1206 1207 1208 1209
void slaveofCommand(redisClient *c);
void debugCommand(redisClient *c);
void msetCommand(redisClient *c);
void msetnxCommand(redisClient *c);
void zaddCommand(redisClient *c);
void zincrbyCommand(redisClient *c);
void zrangeCommand(redisClient *c);
void zrangebyscoreCommand(redisClient *c);
1210
void zrevrangebyscoreCommand(redisClient *c);
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
void zcountCommand(redisClient *c);
void zrevrangeCommand(redisClient *c);
void zcardCommand(redisClient *c);
void zremCommand(redisClient *c);
void zscoreCommand(redisClient *c);
void zremrangebyscoreCommand(redisClient *c);
void multiCommand(redisClient *c);
void execCommand(redisClient *c);
void discardCommand(redisClient *c);
void blpopCommand(redisClient *c);
void brpopCommand(redisClient *c);
D
Damian Janowski &amp; Michel Martens 已提交
1222
void brpoplpushCommand(redisClient *c);
1223
void appendCommand(redisClient *c);
A
antirez 已提交
1224
void strlenCommand(redisClient *c);
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
void zrankCommand(redisClient *c);
void zrevrankCommand(redisClient *c);
void hsetCommand(redisClient *c);
void hsetnxCommand(redisClient *c);
void hgetCommand(redisClient *c);
void hmsetCommand(redisClient *c);
void hmgetCommand(redisClient *c);
void hdelCommand(redisClient *c);
void hlenCommand(redisClient *c);
void zremrangebyrankCommand(redisClient *c);
void zunionstoreCommand(redisClient *c);
void zinterstoreCommand(redisClient *c);
void hkeysCommand(redisClient *c);
void hvalsCommand(redisClient *c);
void hgetallCommand(redisClient *c);
void hexistsCommand(redisClient *c);
void configCommand(redisClient *c);
void hincrbyCommand(redisClient *c);
A
antirez 已提交
1243
void hincrbyfloatCommand(redisClient *c);
1244 1245 1246 1247 1248 1249 1250
void subscribeCommand(redisClient *c);
void unsubscribeCommand(redisClient *c);
void psubscribeCommand(redisClient *c);
void punsubscribeCommand(redisClient *c);
void publishCommand(redisClient *c);
void watchCommand(redisClient *c);
void unwatchCommand(redisClient *c);
A
antirez 已提交
1251 1252
void restoreCommand(redisClient *c);
void migrateCommand(redisClient *c);
1253
void dumpCommand(redisClient *c);
A
antirez 已提交
1254
void objectCommand(redisClient *c);
A
antirez 已提交
1255
void clientCommand(redisClient *c);
1256
void evalCommand(redisClient *c);
A
antirez 已提交
1257
void evalShaCommand(redisClient *c);
1258
void scriptCommand(redisClient *c);
A
antirez 已提交
1259
void timeCommand(redisClient *c);
A
antirez 已提交
1260 1261
void bitopCommand(redisClient *c);
void bitcountCommand(redisClient *c);
A
antirez 已提交
1262
void replconfCommand(redisClient *c);
1263

1264 1265 1266 1267 1268 1269 1270
#if defined(__GNUC__)
void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
void free(void *ptr) __attribute__ ((deprecated));
void *malloc(size_t size) __attribute__ ((deprecated));
void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
#endif

1271
/* Debugging stuff */
1272
void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1273 1274
void _redisAssert(char *estr, char *file, int line);
void _redisPanic(char *msg, char *file, int line);
A
antirez 已提交
1275
void bugReportStart(void);
1276
void redisLogObjectDebugInfo(robj *o);
1277 1278
void sigsegvHandler(int sig, siginfo_t *info, void *secret);
sds genRedisInfoString(char *section);
A
antirez 已提交
1279 1280 1281
void enableWatchdog(int period);
void disableWatchdog(void);
void watchdogScheduleSignal(int period);
1282
void redisLogHexDump(int level, char *descr, void *value, size_t len);
1283 1284 1285 1286 1287 1288

#define redisDebug(fmt, ...) \
    printf("DEBUG %s:%d > " fmt "\n", __FILE__, __LINE__, __VA_ARGS__)
#define redisDebugMark() \
    printf("-- MARK %s:%d --\n", __FILE__, __LINE__)

1289
#endif