redis.h 53.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
#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>
18
#include <inttypes.h>
A
antirez 已提交
19
#include <pthread.h>
J
Jonah H. Harris 已提交
20
#include <syslog.h>
A
antirez 已提交
21
#include <netinet/in.h>
22
#include <lua.h>
23
#include <signal.h>
24

25 26 27 28
#include "ae.h"      /* Event driven programming library */
#include "sds.h"     /* Dynamic safe strings */
#include "dict.h"    /* Hash tables */
#include "adlist.h"  /* Linked lists */
29
#include "zmalloc.h" /* total memory usage aware version of malloc/free */
30
#include "anet.h"    /* Networking the easy way */
31
#include "ziplist.h" /* Compact list data structure */
32 33 34
#include "intset.h"  /* Compact integer set structure */
#include "version.h" /* Version macro */
#include "util.h"    /* Misc functions useful in many places */
35 36 37 38 39 40

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

/* Static server configuration */
41
#define REDIS_HZ                100     /* Time interrupt calls/sec. */
42
#define REDIS_SERVERPORT        6379    /* TCP port */
43
#define REDIS_MAXIDLETIME       0       /* default client timeout: infinite */
44 45 46
#define REDIS_DEFAULT_DBNUM     16
#define REDIS_CONFIGLINE_MAX    1024
#define REDIS_EXPIRELOOKUPS_PER_CRON    10 /* lookup 10 expires per loop */
47
#define REDIS_EXPIRELOOKUPS_TIME_PERC   25 /* CPU max % for keys collection */
48
#define REDIS_MAX_WRITE_PER_EVENT (1024*64)
49
#define REDIS_SHARED_SELECT_CMDS 10
50
#define REDIS_SHARED_INTEGERS 10000
51
#define REDIS_SHARED_BULKHDR_LEN 32
J
Jonah H. Harris 已提交
52
#define REDIS_MAX_LOGMSG_LEN    1024 /* Default maximum length of syslog messages */
53 54 55
#define REDIS_AOF_REWRITE_PERC  100
#define REDIS_AOF_REWRITE_MIN_SIZE (1024*1024)
#define REDIS_AOF_REWRITE_ITEMS_PER_CMD 64
56
#define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000
57
#define REDIS_SLOWLOG_MAX_LEN 128
58
#define REDIS_MAX_CLIENTS 10000
59
#define REDIS_AUTHPASS_MAX_LEN 512
60

A
7c6da73  
antirez 已提交
61 62
#define REDIS_REPL_TIMEOUT 60
#define REDIS_REPL_PING_SLAVE_PERIOD 10
63

64
#define REDIS_RUN_ID_SIZE 40
65
#define REDIS_OPS_SEC_SAMPLES 16
66

67 68 69 70
/* 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 */
71
#define REDIS_INLINE_MAX_SIZE   (1024*64) /* Max size of inline reads */
72
#define REDIS_MBULK_BIG_ARG     (1024*32)
A
7c6da73  
antirez 已提交
73

74 75 76
/* Hash table parameters */
#define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */

77 78 79 80 81 82 83 84
/* 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 */
85 86
#define REDIS_CMD_NOSCRIPT  64              /* "s" flag */
#define REDIS_CMD_RANDOM 128                /* "R" flag */
87
#define REDIS_CMD_SORT_FOR_SCRIPT 256       /* "S" flag */
88 89
#define REDIS_CMD_LOADING 512               /* "l" flag */
#define REDIS_CMD_STALE 1024                /* "t" flag */
90 91 92 93 94 95 96

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

98 99 100 101 102 103 104 105 106
/* 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 */
107
#define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
108
#define REDIS_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136

/* 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
 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
 * 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.
 *
 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
 * 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 */

137 138 139 140 141
/* 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 */

142 143 144 145 146 147 148
/* Client flags */
#define REDIS_SLAVE 1       /* This client is a slave server */
#define REDIS_MASTER 2      /* This client is a master server */
#define REDIS_MONITOR 4     /* This client is a slave monitor, see MONITOR */
#define REDIS_MULTI 8       /* This client is in a MULTI context */
#define REDIS_BLOCKED 16    /* The client is waiting in a blocking operation */
#define REDIS_DIRTY_CAS 64  /* Watched keys modified. EXEC will fail. */
149
#define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */
150 151
#define REDIS_UNBLOCKED 256 /* This client was unblocked and is stored in
                               server.unblocked_clients */
152
#define REDIS_LUA_CLIENT 512 /* This is a non connected client used by Lua */
153
#define REDIS_ASKING 1024   /* Client issued the ASKING command */
154
#define REDIS_CLOSE_ASAP 2048 /* Close this client ASAP */
155 156 157 158

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

160 161 162 163 164
/* 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
165
#define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
166

167
/* Slave replication state - slave side */
168 169
#define REDIS_REPL_NONE 0 /* No active replication */
#define REDIS_REPL_CONNECT 1 /* Must connect to master */
170 171 172
#define REDIS_REPL_CONNECTING 2 /* Connecting to master */
#define REDIS_REPL_TRANSFER 3 /* Receiving .rdb from master */
#define REDIS_REPL_CONNECTED 4 /* Connected to master */
173

174 175
/* Synchronous read timeout - slave side */
#define REDIS_REPL_SYNCIO_TIMEOUT 5
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

/* Slave replication state - from the point of view of master
 * Note that in SEND_BULK and ONLINE state the slave receives new updates
 * 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. */
#define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
#define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
#define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
#define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */

/* 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 已提交
201
#define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
202 203 204 205 206 207 208 209

/* 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 */
210 211 212
#define AOF_FSYNC_NO 0
#define AOF_FSYNC_ALWAYS 1
#define AOF_FSYNC_EVERYSEC 2
213 214

/* Zip structure related defaults */
215 216
#define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
#define REDIS_HASH_MAX_ZIPLIST_VALUE 64
217 218 219
#define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
#define REDIS_LIST_MAX_ZIPLIST_VALUE 64
#define REDIS_SET_MAX_INTSET_ENTRIES 512
220 221
#define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
#define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
222 223 224 225 226 227

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

228 229 230 231 232 233
/* 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
234
#define REDIS_MAXMEMORY_NO_EVICTION 5
235

A
antirez 已提交
236
/* Scripting */
237
#define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
238

239 240 241 242
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

243 244 245 246 247
/* 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. */

248 249 250 251 252 253 254
/* 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 已提交
255 256 257 258 259
/* Command propagation flags, see propagate() function */
#define REDIS_PROPAGATE_NONE 0
#define REDIS_PROPAGATE_AOF 1
#define REDIS_PROPAGATE_REPL 2

260 261 262 263 264
/* Using the following macro you can run code inside serverCron() with the
 * specified period, specified in milliseconds.
 * The actual resolution depends on REDIS_HZ. */
#define run_with_period(_ms_) if (!(server.cronloops%((_ms_)/(1000/REDIS_HZ))))

265
/* We can print the stacktrace, so our assert is defined this way: */
266
#define redisAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_redisAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
267 268 269 270 271 272 273 274 275 276
#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 */
277
#define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
278
#define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
279 280
typedef struct redisObject {
    unsigned type:4;
281
    unsigned notused:2;     /* Not used */
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
    unsigned encoding:4;
    unsigned lru:22;        /* lru time (relative to server.lruclock) */
    int refcount;
    void *ptr;
} robj;

/* Macro used to initalize a Redis object allocated on the stack.
 * 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) */
    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;

319 320 321 322 323 324 325 326 327 328
typedef struct blockingState {
    robj **keys;            /* The key we are waiting to terminate a blocking
                             * operation such as BLPOP. Otherwise NULL. */
    int count;              /* Number of blocking keys */
    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;

329 330 331 332 333 334 335
/* With multiplexing we need to take per-clinet state.
 * Clients are taken in a liked list. */
typedef struct redisClient {
    int fd;
    redisDb *db;
    int dictid;
    sds querybuf;
336
    size_t querybuf_peak;   /* Recent (100ms or more) peak of querybuf size */
337 338
    int argc;
    robj **argv;
339
    struct redisCommand *cmd, *lastcmd;
340 341 342
    int reqtype;
    int multibulklen;       /* number of multi bulk arguments left to read */
    long bulklen;           /* length of bulk argument in multi bulk request */
343
    list *reply;
344
    unsigned long reply_bytes; /* Tot bytes of objects in reply list */
345
    int sentlen;
346
    time_t ctime;           /* Client creation time */
347
    time_t lastinteraction; /* time of the last interaction, used for timeout */
348
    time_t obuf_soft_limit_reached_time;
349 350 351 352 353 354 355
    int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
    int slaveseldb;         /* slave selected db, if this client is a slave */
    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 */
A
antirez 已提交
356
    int slave_listening_port; /* As configured with: SLAVECONF listening-port */
357
    multiState mstate;      /* MULTI/EXEC state */
358
    blockingState bpop;   /* blocking state */
359 360 361 362 363
    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) */
364 365 366

    /* Response buffer */
    int bufpos;
367
    char buf[REDIS_REPLY_CHUNK_BYTES];
368 369 370 371 372 373 374 375 376 377 378
} 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,
379
    *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
380 381
    *masterdownerr, *roslaveerr,
    *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
382 383
    *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
    *select[REDIS_SHARED_SELECT_CMDS],
384 385 386
    *integers[REDIS_SHARED_INTEGERS],
    *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
    *bulkhdr[REDIS_SHARED_BULKHDR_LEN];  /* "$<value>\r\n" */
387 388
};

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
/* 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;

411
typedef struct clientBufferLimitsConfig {
412 413
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
414 415 416
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

417 418 419 420 421 422 423
/* 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 {
424 425 426
    robj **argv;
    int argc, dbid, target;
    struct redisCommand *cmd;
427 428 429 430 431 432 433 434 435 436 437 438 439
} 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;
440

A
antirez 已提交
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
/*-----------------------------------------------------------------------------
 * Redis cluster data structures
 *----------------------------------------------------------------------------*/

#define REDIS_CLUSTER_SLOTS 4096
#define REDIS_CLUSTER_OK 0          /* Everything looks ok */
#define REDIS_CLUSTER_FAIL 1        /* The cluster can't work */
#define REDIS_CLUSTER_NEEDHELP 2    /* The cluster works, but needs some help */
#define REDIS_CLUSTER_NAMELEN 40    /* sha1 hex length */
#define REDIS_CLUSTER_PORT_INCR 10000 /* Cluster port = baseport + PORT_INCR */

struct clusterNode;

/* clusterLink encapsulates everything needed to talk with a remote node. */
typedef struct clusterLink {
    int fd;                     /* TCP socket file descriptor */
    sds sndbuf;                 /* Packet send buffer */
    sds rcvbuf;                 /* Packet reception buffer */
    struct clusterNode *node;   /* Node related to this link if any, or NULL */
} clusterLink;

/* Node flags */
#define REDIS_NODE_MASTER 1     /* The node is a master */
#define REDIS_NODE_SLAVE 2      /* The node is a slave */
#define REDIS_NODE_PFAIL 4      /* Failure? Need acknowledge */
#define REDIS_NODE_FAIL 8       /* The node is believed to be malfunctioning */
#define REDIS_NODE_MYSELF 16    /* This node is myself */
#define REDIS_NODE_HANDSHAKE 32 /* We have still to exchange the first ping */
#define REDIS_NODE_NOADDR   64  /* We don't know the address of this node */
#define REDIS_NODE_MEET 128     /* Send a MEET message to this node */
#define REDIS_NODE_NULL_NAME "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"

struct clusterNode {
    char name[REDIS_CLUSTER_NAMELEN]; /* Node name, hex string, sha1-size */
    int flags;      /* REDIS_NODE_... */
    unsigned char slots[REDIS_CLUSTER_SLOTS/8]; /* slots handled by this node */
    int numslaves;  /* Number of slave nodes, if this is a master */
    struct clusterNode **slaves; /* pointers to slave nodes */
    struct clusterNode *slaveof; /* pointer to the master node */
    time_t ping_sent;       /* Unix time we sent latest ping */
    time_t pong_received;   /* Unix time we received the pong */
    char *configdigest;         /* Configuration digest of this node */
    time_t configdigest_ts;     /* Configuration digest timestamp */
    char ip[16];                /* Latest known IP address of this node */
    int port;                   /* Latest known port of this node */
    clusterLink *link;          /* TCP/IP link with this node */
};
typedef struct clusterNode clusterNode;

typedef struct {
491
    char *configfile;
A
antirez 已提交
492 493 494 495 496 497 498
    clusterNode *myself;  /* This node */
    int state;            /* REDIS_CLUSTER_OK, REDIS_CLUSTER_FAIL, ... */
    int node_timeout;
    dict *nodes;          /* Hash table of name -> clusterNode structures */
    clusterNode *migrating_slots_to[REDIS_CLUSTER_SLOTS];
    clusterNode *importing_slots_from[REDIS_CLUSTER_SLOTS];
    clusterNode *slots[REDIS_CLUSTER_SLOTS];
499
    zskiplist *slots_to_keys;
A
antirez 已提交
500 501 502 503 504 505 506 507 508 509 510 511
} clusterState;

/* Redis cluster messages header */

/* Note that the PING, PONG and MEET messages are actually the same exact
 * kind of packet. PONG is the reply to ping, in the extact format as a PING,
 * while MEET is a special PING that forces the receiver to add the sender
 * as a node (if it is not already in the list). */
#define CLUSTERMSG_TYPE_PING 0          /* Ping */
#define CLUSTERMSG_TYPE_PONG 1          /* Pong (reply to Ping) */
#define CLUSTERMSG_TYPE_MEET 2          /* Meet "let's join" message */
#define CLUSTERMSG_TYPE_FAIL 3          /* Mark node xxx as failing */
512
#define CLUSTERMSG_TYPE_PUBLISH 4       /* Pub/Sub Publish propatagion */
A
antirez 已提交
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530

/* Initially we don't know our "name", but we'll find it once we connect
 * to the first node, using the getsockname() function. Then we'll use this
 * address for all the next messages. */
typedef struct {
    char nodename[REDIS_CLUSTER_NAMELEN];
    uint32_t ping_sent;
    uint32_t pong_received;
    char ip[16];    /* IP address last time it was seen */
    uint16_t port;  /* port last time it was seen */
    uint16_t flags;
    uint32_t notused; /* for 64 bit alignment */
} clusterMsgDataGossip;

typedef struct {
    char nodename[REDIS_CLUSTER_NAMELEN];
} clusterMsgDataFail;

531 532 533 534 535 536
typedef struct {
    uint32_t channel_len;
    uint32_t message_len;
    unsigned char bulk_data[8]; /* defined as 8 just for alignment concerns. */
} clusterMsgDataPublish;

A
antirez 已提交
537 538 539 540 541 542
union clusterMsgData {
    /* PING, MEET and PONG */
    struct {
        /* Array of N clusterMsgDataGossip structures */
        clusterMsgDataGossip gossip[1];
    } ping;
543

A
antirez 已提交
544 545 546 547
    /* FAIL */
    struct {
        clusterMsgDataFail about;
    } fail;
548 549 550 551 552

    /* PUBLISH */
    struct {
        clusterMsgDataPublish msg;
    } publish;
A
antirez 已提交
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
};

typedef struct {
    uint32_t totlen;    /* Total length of this message */
    uint16_t type;      /* Message type */
    uint16_t count;     /* Only used for some kind of messages. */
    char sender[REDIS_CLUSTER_NAMELEN]; /* Name of the sender node */
    unsigned char myslots[REDIS_CLUSTER_SLOTS/8];
    char slaveof[REDIS_CLUSTER_NAMELEN];
    char configdigest[32];
    uint16_t port;      /* Sender TCP base port */
    unsigned char state; /* Cluster state from the POV of the sender */
    unsigned char notused[5]; /* Reserved for future use. For alignment. */
    union clusterMsgData data;
} clusterMsg;

/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

573
struct redisServer {
574 575 576 577
    /* General */
    redisDb *db;
    dict *commands;             /* Command table hahs table */
    aeEventLoop *el;
578 579 580 581 582 583
    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 */
584
    int arch_bits;              /* 32 or 64 depending on sizeof(long) */
585
    int cronloops;              /* Number of times the cron function run */
A
antirez 已提交
586
    char runid[REDIS_RUN_ID_SIZE+1];  /* ID always different at every exec. */
587
    int sentinel_mode;          /* True if this instance is a Sentinel. */
588
    /* Networking */
589 590 591 592 593 594 595 596
    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 */
    int cfd;                    /* Cluster bus lisetning socket */
    list *clients;              /* List of active clients */
597
    list *clients_to_close;     /* Clients to close asynchronously */
598
    list *slaves, *monitors;    /* List of slaves and MONITORs */
599
    redisClient *current_client; /* Current client, only used on crash report */
600
    char neterr[ANET_ERR_LEN];  /* Error buffer for anet.c */
601
    /* RDB / AOF loading information */
602
    int loading;                /* We are loading data from disk if true */
603 604 605
    off_t loading_total_bytes;
    off_t loading_loaded_bytes;
    time_t loading_start_time;
606
    /* Fast pointers to often looked up command */
607
    struct redisCommand *delCommand, *multiCommand, *lpushCommand;
608
    /* Fields used only for stats */
609 610 611 612 613 614 615 616 617 618 619 620 621 622
    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 */
    long long stat_fork_time;       /* Time needed to perform latets fork() */
    long long stat_rejected_conn;   /* Clients rejected because of maxclients */
    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 */
623 624 625 626 627 628
    /* 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;
629
    /* Configuration */
630 631 632 633 634
    int verbosity;                  /* Loglevel in redis.conf */
    int maxidletime;                /* Client timeout in seconds */
    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 */
635
    clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES];
636 637
    /* AOF persistence */
    int aof_state;                  /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
638 639 640 641 642 643 644 645
    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 已提交
646
    pid_t aof_child_pid;            /* PID if rewriting process */
647
    list *aof_rewrite_buf_blocks;   /* Hold changes during an AOF rewrite. */
A
antirez 已提交
648 649 650
    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 */
651
    time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
A
antirez 已提交
652
    time_t aof_last_fsync;            /* UNIX time of last fsync() */
653 654
    time_t aof_rewrite_time_last;   /* Time used by last AOF rewrite run. */
    time_t aof_rewrite_time_start;  /* Current AOF rewrite start time. */
655
    int aof_lastbgrewrite_status;   /* REDIS_OK or REDIS_ERR */
656
    unsigned long aof_delayed_fsync;  /* delayed AOF fsync() counter */
657 658 659
    /* 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 已提交
660
    pid_t rdb_child_pid;            /* PID of RDB saving child */
661 662
    struct saveparam *saveparams;   /* Save points array for RDB */
    int saveparamslen;              /* Number of saving points */
A
antirez 已提交
663 664
    char *rdb_filename;             /* Name of RDB file */
    int rdb_compression;            /* Use compression in RDB? */
665
    int rdb_checksum;               /* Use RDB checksum? */
666
    time_t lastsave;                /* Unix time of last save succeeede */
667 668
    time_t rdb_save_time_last;      /* Time used by last RDB save run. */
    time_t rdb_save_time_start;     /* Current RDB save start time. */
669
    int lastbgsave_status;          /* REDIS_OK or REDIS_ERR */
670
    int stop_writes_on_bgsave_err;  /* Don't allow writes if can't BGSAVE */
671
    /* Propagation of commands in AOF / replication */
672
    redisOpArray also_propagate;    /* Additional command to propagate. */
673
    /* Logging */
674 675 676 677
    char *logfile;                  /* Path of log file */
    int syslog_enabled;             /* Is syslog enabled? */
    char *syslog_ident;             /* Syslog ident */
    int syslog_facility;            /* Syslog facility */
678
    /* Slave specific fields */
679 680 681 682 683 684 685
    char *masterauth;               /* AUTH with this password with master */
    char *masterhost;               /* Hostname of master */
    int masterport;                 /* Port of master */
    int repl_ping_slave_period;     /* Master pings the salve every N seconds */
    int repl_timeout;               /* Timeout after N seconds of master idle */
    redisClient *master;     /* Client that is master for this slave */
    int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
A
antirez 已提交
686
    int repl_state;          /* Replication status if the instance is a slave */
687 688 689 690 691
    off_t repl_transfer_left;  /* Bytes left reading .rdb  */
    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 */
692
    int repl_serve_stale_data; /* Serve stale data when link is down? */
693
    int repl_slave_ro;          /* Slave is read only? */
694
    time_t repl_down_since; /* Unix time at which link with master went down */
695
    /* Limits */
696 697 698 699
    unsigned int maxclients;        /* Max number of simultaneous clients */
    unsigned long long maxmemory;   /* Max number of memory bytes to use */
    int maxmemory_policy;           /* Policy for key evition */
    int maxmemory_samples;          /* Pricision of random sampling */
700
    /* Blocked clients */
701
    unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */
702
    list *unblocked_clients; /* list of clients to unblock before next loop */
703 704
    /* Sort parameters - qsort_r() is only available under BSD so we
     * have to take this state global, in order to pass it to sortCompare() */
705
    int sort_dontsort;
706 707 708
    int sort_desc;
    int sort_alpha;
    int sort_bypattern;
709
    /* Zip structure config, see redis.conf for more information  */
710 711
    size_t hash_max_ziplist_entries;
    size_t hash_max_ziplist_value;
712 713
    size_t list_max_ziplist_entries;
    size_t list_max_ziplist_value;
714
    size_t set_max_intset_entries;
715 716
    size_t zset_max_ziplist_entries;
    size_t zset_max_ziplist_value;
717
    time_t unixtime;        /* Unix time sampled every second. */
718
    /* Pubsub */
719 720
    dict *pubsub_channels;  /* Map channels to list of subscribed clients */
    list *pubsub_patterns;  /* A list of pubsub_patterns */
721
    /* Cluster */
722 723
    int cluster_enabled;    /* Is cluster enabled? */
    clusterState cluster;   /* State of the cluster */
724
    /* Scripting */
725
    lua_State *lua; /* The Lua interpreter. We use just one for all clients */
726 727 728 729 730
    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 */
731 732
    int lua_write_dirty;  /* True if a write command was called during the
                             execution of the current script. */
733
    int lua_random_dirty; /* True if a random command was called during the
734
                             execution of the current script. */
735 736
    int lua_timedout;     /* True if we reached the time limit for script
                             execution. */
737
    int lua_kill;         /* Kill the script if true. */
A
antirez 已提交
738 739 740 741
    /* Assert & bug reportign */
    char *assert_failed;
    char *assert_file;
    int assert_line;
742
    int bug_report_start; /* True if bug report header was already logged. */
A
antirez 已提交
743
    int watchdog_period;  /* Software watchdog period in ms. 0 = off */
744 745 746 747 748 749 750 751
};

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

typedef void redisCommandProc(redisClient *c);
752
typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
753 754 755 756
struct redisCommand {
    char *name;
    redisCommandProc *proc;
    int arity;
757 758
    char *sflags; /* Flags as string represenation, one char per flag. */
    int flags;    /* The actual flags, obtained from the 'sflags' field. */
759
    /* Use a function to determine keys arguments in a command line.
A
antirez 已提交
760
     * Used for Redis Cluster redirect. */
761
    redisGetKeysProc *getkeys_proc;
762
    /* What keys should be loaded in background when calling this command? */
763 764 765
    int firstkey; /* The first argument that's a key (0 = no keys) */
    int lastkey;  /* THe last argument that's a key */
    int keystep;  /* The step between first and last key */
766
    long long microseconds, calls;
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
};

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;

803 804 805 806 807 808
/* Structure to hold set iteration abstraction. */
typedef struct {
    robj *subject;
    int encoding;
    int ii; /* intset iterator */
    dictIterator *di;
809
} setTypeIterator;
810

811 812 813 814 815
/* Structure to hold hash iteration abstration. Note that iteration over
 * 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 {
816
    robj *subject;
817
    int encoding;
818 819

    unsigned char *fptr, *vptr;
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835

    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;
A
antirez 已提交
836
extern dictType clusterNodesDictType;
837
extern dictType dbDictType;
838
extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
839
extern dictType hashDictType;
840 841 842 843 844

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

845 846
/* Utils */
long long ustime(void);
847
long long mstime(void);
848
void getRandomHexChars(char *p, unsigned int len);
849
uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
850
void exitFromChild(int retcode);
851

852 853 854 855 856 857 858
/* networking.c -- Networking and Client related operations */
redisClient *createClient(int fd);
void closeTimedoutClients(void);
void freeClient(redisClient *c);
void resetClient(redisClient *c);
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
void addReply(redisClient *c, robj *obj);
859 860
void *addDeferredMultiBulkLength(redisClient *c);
void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
861 862
void addReplySds(redisClient *c, sds s);
void processInputBuffer(redisClient *c);
863 864
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
865 866 867
void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
void addReplyBulk(redisClient *c, robj *obj);
void addReplyBulkCString(redisClient *c, char *s);
868 869
void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
void addReplyBulkLongLong(redisClient *c, long long ll);
870 871 872
void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void addReply(redisClient *c, robj *obj);
void addReplySds(redisClient *c, sds s);
873 874
void addReplyError(redisClient *c, char *err);
void addReplyStatus(redisClient *c, char *status);
875 876
void addReplyDouble(redisClient *c, double d);
void addReplyLongLong(redisClient *c, long long ll);
877
void addReplyMultiBulkLen(redisClient *c, long length);
878
void copyClientOutputBuffer(redisClient *dst, redisClient *src);
879
void *dupClientReplyValue(void *o);
880 881
void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer);
882
sds getClientInfoString(redisClient *client);
883
sds getAllClientsInfoString(void);
884
void rewriteClientCommandVector(redisClient *c, int argc, ...);
885
void rewriteClientCommandArgument(redisClient *c, int i, robj *newval);
886
unsigned long getClientOutputBufferMemoryUsage(redisClient *c);
887
void freeClientsInAsyncFreeQueue(void);
888
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c);
889 890
int getClientLimitClassByName(char *name);
char *getClientLimitClassName(int class);
A
antirez 已提交
891
void flushSlavesOutputBuffers(void);
892
void disconnectSlaves(void);
893

894 895 896 897 898 899 900 901 902 903
#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

904 905 906 907 908
/* 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);
909
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
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);
int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
void popGenericCommand(redisClient *c, int where);

/* MULTI/EXEC/WATCH... */
void unwatchAllKeys(redisClient *c);
void initClientMultiState(redisClient *c);
void freeClientMultiState(redisClient *c);
925
void queueMultiCommand(redisClient *c);
926 927
void touchWatchedKey(redisDb *db, robj *key);
void touchWatchedKeysOnFlush(int dbid);
928
void discardTransaction(redisClient *c);
929 930 931 932

/* Redis object implementation */
void decrRefCount(void *o);
void incrRefCount(robj *o);
933
robj *resetRefCount(robj *obj);
934 935 936 937 938 939 940 941
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);
942
int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
943 944 945 946
robj *tryObjectEncoding(robj *o);
robj *getDecodedObject(robj *o);
size_t stringObjectLen(robj *o);
robj *createStringObjectFromLongLong(long long value);
A
antirez 已提交
947
robj *createStringObjectFromLongDouble(long double value);
948 949 950
robj *createListObject(void);
robj *createZiplistObject(void);
robj *createSetObject(void);
951
robj *createIntsetObject(void);
952 953
robj *createHashObject(void);
robj *createZsetObject(void);
954
robj *createZsetZiplistObject(void);
955 956 957 958 959
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 已提交
960 961
int getLongDoubleFromObject(robj *o, long double *target);
int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
962 963 964
char *strEncoding(int encoding);
int compareStringObjects(robj *a, robj *b);
int equalStringObjects(robj *a, robj *b);
965
unsigned long estimateObjectIdleTime(robj *o);
966

967
/* Synchronous I/O with timeout */
968 969 970
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);
971

972 973
/* Replication */
void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
974
void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc);
975
void updateSlavesWaitingBgsave(int bgsaveerr);
976
void replicationCron(void);
977

978 979 980 981 982
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

983
/* RDB persistence */
984
#include "rdb.h"
985 986

/* AOF persistence */
987
void flushAppendOnlyFile(int force);
988 989 990 991 992 993
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);
994
void backgroundRewriteDoneHandler(int exitcode, int bysignal);
995 996
void aofRewriteBufferReset(void);
unsigned long aofRewriteBufferSize(void);
997 998

/* Sorted sets data type */
999 1000 1001 1002 1003 1004 1005

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

1006 1007
zskiplist *zslCreate(void);
void zslFree(zskiplist *zsl);
1008
zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
1009
unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
1010 1011
int zslDelete(zskiplist *zsl, double score, robj *obj);
zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
1012 1013 1014
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);
1015 1016
unsigned int zsetLength(robj *zobj);
void zsetConvert(robj *zobj, int encoding);
1017 1018

/* Core functions */
1019
int freeMemoryIfNeeded(void);
1020
int processCommand(redisClient *c);
1021
void setupSignalHandlers(void);
1022 1023
struct redisCommand *lookupCommand(sds name);
struct redisCommand *lookupCommandByCString(char *s);
1024
void call(redisClient *c, int flags);
A
antirez 已提交
1025
void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1026
void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
1027 1028
int prepareForShutdown();
void redisLog(int level, const char *fmt, ...);
1029
void redisLogRaw(int level, const char *msg);
A
antirez 已提交
1030
void redisLogFromHandler(int level, const char *msg);
1031 1032 1033 1034
void usage();
void updateDictResizePolicy(void);
int htNeedsResize(dict *dict);
void oom(const char *msg);
1035
void populateCommandTable(void);
1036
void resetCommandTableStats(void);
1037

1038 1039 1040 1041 1042
/* 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);
1043 1044
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
1045 1046
int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
robj *setTypeNextObject(setTypeIterator *si);
A
antirez 已提交
1047
int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1048 1049 1050
unsigned long setTypeSize(robj *subject);
void setTypeConvert(robj *subject, int enc);

1051
/* Hash data type */
1052
void hashTypeConvert(robj *o, int enc);
1053 1054
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1055
robj *hashTypeGetObject(robj *o, robj *key);
1056 1057 1058 1059 1060 1061 1062
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);
1063 1064 1065 1066 1067
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 已提交
1068
robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1069 1070 1071 1072 1073 1074 1075
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);
1076
int pubsubPublishMessage(robj *channel, robj *message);
1077 1078

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

/* db.c -- Keyspace access API */
int removeExpire(redisDb *db, robj *key);
1085
void propagateExpire(redisDb *db, robj *key);
1086
int expireIfNeeded(redisDb *db, robj *key);
1087 1088
long long getExpire(redisDb *db, robj *key);
void setExpire(redisDb *db, robj *key, long long when);
1089 1090 1091 1092 1093
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);
1094 1095 1096
void dbAdd(redisDb *db, robj *key, robj *val);
void dbOverwrite(redisDb *db, robj *key, robj *val);
void setKey(redisDb *db, robj *key, robj *val);
1097 1098 1099 1100 1101
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);
1102 1103
void signalModifiedKey(redisDb *db, robj *key);
void signalFlushedDb(int dbid);
A
antirez 已提交
1104
unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
1105

1106 1107 1108 1109 1110 1111 1112 1113 1114
/* 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);

A
antirez 已提交
1115 1116 1117 1118 1119 1120 1121
/* Cluster */
void clusterInit(void);
unsigned short crc16(const char *buf, int len);
unsigned int keyHashSlot(char *key, int keylen);
clusterNode *createClusterNode(char *nodename, int flags);
int clusterAddNode(clusterNode *node);
void clusterCron(void);
1122
clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask);
1123
void clusterPropagatePublish(robj *channel, robj *message);
A
antirez 已提交
1124

1125 1126 1127 1128 1129 1130
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);

1131 1132 1133
/* Scripting */
void scriptingInit(void);

1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);

/* 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);
1145
void psetexCommand(redisClient *c);
1146 1147 1148
void getCommand(redisClient *c);
void delCommand(redisClient *c);
void existsCommand(redisClient *c);
P
Pieter Noordhuis 已提交
1149 1150
void setbitCommand(redisClient *c);
void getbitCommand(redisClient *c);
1151
void setrangeCommand(redisClient *c);
1152
void getrangeCommand(redisClient *c);
1153 1154 1155 1156
void incrCommand(redisClient *c);
void decrCommand(redisClient *c);
void incrbyCommand(redisClient *c);
void decrbyCommand(redisClient *c);
A
antirez 已提交
1157
void incrbyfloatCommand(redisClient *c);
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 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
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);
1201
void rpoplpushCommand(redisClient *c);
1202 1203 1204 1205 1206
void infoCommand(redisClient *c);
void mgetCommand(redisClient *c);
void monitorCommand(redisClient *c);
void expireCommand(redisClient *c);
void expireatCommand(redisClient *c);
1207 1208
void pexpireCommand(redisClient *c);
void pexpireatCommand(redisClient *c);
1209 1210
void getsetCommand(redisClient *c);
void ttlCommand(redisClient *c);
1211
void pttlCommand(redisClient *c);
A
antirez 已提交
1212
void persistCommand(redisClient *c);
1213 1214 1215 1216 1217 1218 1219 1220
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);
1221
void zrevrangebyscoreCommand(redisClient *c);
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
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 已提交
1233
void brpoplpushCommand(redisClient *c);
1234
void appendCommand(redisClient *c);
A
antirez 已提交
1235
void strlenCommand(redisClient *c);
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
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 已提交
1254
void hincrbyfloatCommand(redisClient *c);
1255 1256 1257 1258 1259 1260 1261
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 已提交
1262 1263 1264
void clusterCommand(redisClient *c);
void restoreCommand(redisClient *c);
void migrateCommand(redisClient *c);
1265
void askingCommand(redisClient *c);
1266
void dumpCommand(redisClient *c);
A
antirez 已提交
1267
void objectCommand(redisClient *c);
A
antirez 已提交
1268
void clientCommand(redisClient *c);
1269
void evalCommand(redisClient *c);
A
antirez 已提交
1270
void evalShaCommand(redisClient *c);
1271
void scriptCommand(redisClient *c);
A
antirez 已提交
1272
void timeCommand(redisClient *c);
A
antirez 已提交
1273 1274
void bitopCommand(redisClient *c);
void bitcountCommand(redisClient *c);
A
antirez 已提交
1275
void replconfCommand(redisClient *c);
1276

1277 1278 1279 1280 1281 1282 1283
#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

1284
/* Debugging stuff */
1285
void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1286 1287
void _redisAssert(char *estr, char *file, int line);
void _redisPanic(char *msg, char *file, int line);
A
antirez 已提交
1288
void bugReportStart(void);
1289
void redisLogObjectDebugInfo(robj *o);
1290 1291
void sigsegvHandler(int sig, siginfo_t *info, void *secret);
sds genRedisInfoString(char *section);
A
antirez 已提交
1292 1293 1294
void enableWatchdog(int period);
void disableWatchdog(void);
void watchdogScheduleSignal(int period);
1295
void redisLogHexDump(int level, char *descr, void *value, size_t len);
1296 1297 1298 1299 1300 1301

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

1302
#endif