src/redis.h

   1 #ifndef __REDIS_H
   2 #define __REDIS_H
   3
   4 #include "fmacros.h"
   5 #include "config.h"
   6
   7 #if defined(__sun)
   8 #include "solarisfixes.h"
   9 #endif
  10
  11 #include <stdio.h>
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <time.h>
  15 #include <limits.h>
  16 #include <unistd.h>
  17 #include <errno.h>
  18 #include <inttypes.h>
  19 #include <pthread.h>
  20 #include <syslog.h>
  21 #include <netinet/in.h>
  22 #include <lua.h>
  23 #include <signal.h>
  24
  25 #include "ae.h"      /* Event driven programming library */
  26 #include "sds.h"     /* Dynamic safe strings */
  27 #include "dict.h"    /* Hash tables */
  28 #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 #include "intset.h"  /* Compact integer set structure */
  33 #include "version.h" /* Version macro */
  34 #include "util.h"    /* Misc functions useful in many places */
  35
  36 /* Error codes */
  37 #define REDIS_OK                0
  38 #define REDIS_ERR               -1
  39
  40 /* Static server configuration */
  41 #define REDIS_SERVERPORT        6379    /* TCP port */
  42 #define REDIS_MAXIDLETIME       0       /* default client timeout: infinite */
  43 #define REDIS_DEFAULT_DBNUM     16
  44 #define REDIS_CONFIGLINE_MAX    1024
  45 #define REDIS_EXPIRELOOKUPS_PER_CRON    10 /* lookup 10 expires per loop */
  46 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
  47 #define REDIS_SHARED_SELECT_CMDS 10
  48 #define REDIS_SHARED_INTEGERS 10000
  49 #define REDIS_SHARED_BULKHDR_LEN 32
  50 #define REDIS_MAX_LOGMSG_LEN    1024 /* Default maximum length of syslog messages */
  51 #define REDIS_AOF_REWRITE_PERC  100
  52 #define REDIS_AOF_REWRITE_MIN_SIZE (1024*1024)
  53 #define REDIS_AOF_REWRITE_ITEMS_PER_CMD 64
  54 #define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000
  55 #define REDIS_SLOWLOG_MAX_LEN 64
  56 #define REDIS_MAX_CLIENTS 10000
  57
  58 #define REDIS_REPL_TIMEOUT 60
  59 #define REDIS_REPL_PING_SLAVE_PERIOD 10
  60
  61 #define REDIS_RUN_ID_SIZE 40
  62 #define REDIS_OPS_SEC_SAMPLES 16
  63
  64 /* Protocol and I/O related defines */
  65 #define REDIS_MAX_QUERYBUF_LEN  (1024*1024*1024) /* 1GB max query buffer. */
  66 #define REDIS_IOBUF_LEN         (1024*16)  /* Generic I/O buffer size */
  67 #define REDIS_REPLY_CHUNK_BYTES (16*1024) /* 16k output buffer */
  68 #define REDIS_INLINE_MAX_SIZE   (1024*64) /* Max size of inline reads */
  69 #define REDIS_MBULK_BIG_ARG     (1024*32)
  70
  71 /* Hash table parameters */
  72 #define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */
  73
  74 /* Command flags. Please check the command table defined in the redis.c file
  75  * for more information about the meaning of every flag. */
  76 #define REDIS_CMD_WRITE 1                   /* "w" flag */
  77 #define REDIS_CMD_READONLY 2                /* "r" flag */
  78 #define REDIS_CMD_DENYOOM 4                 /* "m" flag */
  79 #define REDIS_CMD_FORCE_REPLICATION 8       /* "f" flag */
  80 #define REDIS_CMD_ADMIN 16                  /* "a" flag */
  81 #define REDIS_CMD_PUBSUB 32                 /* "p" flag */
  82 #define REDIS_CMD_NOSCRIPT  64              /* "s" flag */
  83 #define REDIS_CMD_RANDOM 128                /* "R" flag */
  84 #define REDIS_CMD_SORT_FOR_SCRIPT 256       /* "S" flag */
  85
  86 /* Object types */
  87 #define REDIS_STRING 0
  88 #define REDIS_LIST 1
  89 #define REDIS_SET 2
  90 #define REDIS_ZSET 3
  91 #define REDIS_HASH 4
  92 #define REDIS_VMPOINTER 8
  93
  94 /* Objects encoding. Some kind of objects like Strings and Hashes can be
  95  * internally represented in multiple ways. The 'encoding' field of the object
  96  * is set to one of this fields for this object. */
  97 #define REDIS_ENCODING_RAW 0     /* Raw representation */
  98 #define REDIS_ENCODING_INT 1     /* Encoded as integer */
  99 #define REDIS_ENCODING_HT 2      /* Encoded as hash table */
 100 #define REDIS_ENCODING_ZIPMAP 3  /* Encoded as zipmap */
 101 #define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
 102 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
 103 #define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
 104 #define REDIS_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
 105
 106 /* Defines related to the dump file format. To store 32 bits lengths for short
 107  * keys requires a lot of space, so we check the most significant 2 bits of
 108  * the first byte to interpreter the length:
 109  *
 110  * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
 111  * 01|000000 00000000 =>  01, the len is 14 byes, 6 bits + 8 bits of next byte
 112  * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
 113  * 11|000000 this means: specially encoded object will follow. The six bits
 114  *           number specify the kind of object that follows.
 115  *           See the REDIS_RDB_ENC_* defines.
 116  *
 117  * Lenghts up to 63 are stored using a single byte, most DB keys, and may
 118  * values, will fit inside. */
 119 #define REDIS_RDB_6BITLEN 0
 120 #define REDIS_RDB_14BITLEN 1
 121 #define REDIS_RDB_32BITLEN 2
 122 #define REDIS_RDB_ENCVAL 3
 123 #define REDIS_RDB_LENERR UINT_MAX
 124
 125 /* When a length of a string object stored on disk has the first two bits
 126  * set, the remaining two bits specify a special encoding for the object
 127  * accordingly to the following defines: */
 128 #define REDIS_RDB_ENC_INT8 0        /* 8 bit signed integer */
 129 #define REDIS_RDB_ENC_INT16 1       /* 16 bit signed integer */
 130 #define REDIS_RDB_ENC_INT32 2       /* 32 bit signed integer */
 131 #define REDIS_RDB_ENC_LZF 3         /* string compressed with FASTLZ */
 132
 133 /* AOF states */
 134 #define REDIS_AOF_OFF 0             /* AOF is off */
 135 #define REDIS_AOF_ON 1              /* AOF is on */
 136 #define REDIS_AOF_WAIT_REWRITE 2    /* AOF waits rewrite to start appending */
 137
 138 /* Client flags */
 139 #define REDIS_SLAVE 1       /* This client is a slave server */
 140 #define REDIS_MASTER 2      /* This client is a master server */
 141 #define REDIS_MONITOR 4     /* This client is a slave monitor, see MONITOR */
 142 #define REDIS_MULTI 8       /* This client is in a MULTI context */
 143 #define REDIS_BLOCKED 16    /* The client is waiting in a blocking operation */
 144 #define REDIS_DIRTY_CAS 64  /* Watched keys modified. EXEC will fail. */
 145 #define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */
 146 #define REDIS_UNBLOCKED 256 /* This client was unblocked and is stored in
 147                                server.unblocked_clients */
 148 #define REDIS_LUA_CLIENT 512 /* This is a non connected client used by Lua */
 149 #define REDIS_ASKING 1024   /* Client issued the ASKING command */
 150 #define REDIS_CLOSE_ASAP 2048 /* Close this client ASAP */
 151
 152 /* Client request types */
 153 #define REDIS_REQ_INLINE 1
 154 #define REDIS_REQ_MULTIBULK 2
 155
 156 /* Client classes for client limits, currently used only for
 157  * the max-client-output-buffer limit implementation. */
 158 #define REDIS_CLIENT_LIMIT_CLASS_NORMAL 0
 159 #define REDIS_CLIENT_LIMIT_CLASS_SLAVE 1
 160 #define REDIS_CLIENT_LIMIT_CLASS_PUBSUB 2
 161 #define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
 162
 163 /* Slave replication state - slave side */
 164 #define REDIS_REPL_NONE 0 /* No active replication */
 165 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
 166 #define REDIS_REPL_CONNECTING 2 /* Connecting to master */
 167 #define REDIS_REPL_TRANSFER 3 /* Receiving .rdb from master */
 168 #define REDIS_REPL_CONNECTED 4 /* Connected to master */
 169
 170 /* Synchronous read timeout - slave side */
 171 #define REDIS_REPL_SYNCIO_TIMEOUT 5
 172
 173 /* Slave replication state - from the point of view of master
 174  * Note that in SEND_BULK and ONLINE state the slave receives new updates
 175  * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
 176  * to start the next background saving in order to send updates to it. */
 177 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
 178 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
 179 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
 180 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
 181
 182 /* List related stuff */
 183 #define REDIS_HEAD 0
 184 #define REDIS_TAIL 1
 185
 186 /* Sort operations */
 187 #define REDIS_SORT_GET 0
 188 #define REDIS_SORT_ASC 1
 189 #define REDIS_SORT_DESC 2
 190 #define REDIS_SORTKEY_MAX 1024
 191
 192 /* Log levels */
 193 #define REDIS_DEBUG 0
 194 #define REDIS_VERBOSE 1
 195 #define REDIS_NOTICE 2
 196 #define REDIS_WARNING 3
 197 #define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
 198
 199 /* Anti-warning macro... */
 200 #define REDIS_NOTUSED(V) ((void) V)
 201
 202 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
 203 #define ZSKIPLIST_P 0.25      /* Skiplist P = 1/4 */
 204
 205 /* Append only defines */
 206 #define AOF_FSYNC_NO 0
 207 #define AOF_FSYNC_ALWAYS 1
 208 #define AOF_FSYNC_EVERYSEC 2
 209
 210 /* Zip structure related defaults */
 211 #define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
 212 #define REDIS_HASH_MAX_ZIPLIST_VALUE 64
 213 #define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
 214 #define REDIS_LIST_MAX_ZIPLIST_VALUE 64
 215 #define REDIS_SET_MAX_INTSET_ENTRIES 512
 216 #define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
 217 #define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
 218
 219 /* Sets operations codes */
 220 #define REDIS_OP_UNION 0
 221 #define REDIS_OP_DIFF 1
 222 #define REDIS_OP_INTER 2
 223
 224 /* Redis maxmemory strategies */
 225 #define REDIS_MAXMEMORY_VOLATILE_LRU 0
 226 #define REDIS_MAXMEMORY_VOLATILE_TTL 1
 227 #define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
 228 #define REDIS_MAXMEMORY_ALLKEYS_LRU 3
 229 #define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
 230 #define REDIS_MAXMEMORY_NO_EVICTION 5
 231
 232 /* Scripting */
 233 #define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
 234
 235 /* Units */
 236 #define UNIT_SECONDS 0
 237 #define UNIT_MILLISECONDS 1
 238
 239 /* SHUTDOWN flags */
 240 #define REDIS_SHUTDOWN_SAVE 1       /* Force SAVE on SHUTDOWN even if no save
 241                                        points are configured. */
 242 #define REDIS_SHUTDOWN_NOSAVE 2     /* Don't SAVE on SHUTDOWN. */
 243
 244 /* Command call flags, see call() function */
 245 #define REDIS_CALL_NONE 0
 246 #define REDIS_CALL_SLOWLOG 1
 247 #define REDIS_CALL_STATS 2
 248 #define REDIS_CALL_PROPAGATE 4
 249 #define REDIS_CALL_FULL (REDIS_CALL_SLOWLOG | REDIS_CALL_STATS | REDIS_CALL_PROPAGATE)
 250
 251 /* Command propagation flags, see propagate() function */
 252 #define REDIS_PROPAGATE_NONE 0
 253 #define REDIS_PROPAGATE_AOF 1
 254 #define REDIS_PROPAGATE_REPL 2
 255
 256 /* We can print the stacktrace, so our assert is defined this way: */
 257 #define redisAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_redisAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
 258 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
 259 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
 260
 261 /*-----------------------------------------------------------------------------
 262  * Data types
 263  *----------------------------------------------------------------------------*/
 264
 265 /* A redis object, that is a type able to hold a string / list / set */
 266
 267 /* The actual Redis Object */
 268 #define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
 269 #define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
 270 typedef struct redisObject {
 271     unsigned type:4;
 272     unsigned notused:2;     /* Not used */
 273     unsigned encoding:4;
 274     unsigned lru:22;        /* lru time (relative to server.lruclock) */
 275     int refcount;
 276     void *ptr;
 277 } robj;
 278
 279 /* Macro used to initalize a Redis object allocated on the stack.
 280  * Note that this macro is taken near the structure definition to make sure
 281  * we'll update it when the structure is changed, to avoid bugs like
 282  * bug #85 introduced exactly in this way. */
 283 #define initStaticStringObject(_var,_ptr) do { \
 284     _var.refcount = 1; \
 285     _var.type = REDIS_STRING; \
 286     _var.encoding = REDIS_ENCODING_RAW; \
 287     _var.ptr = _ptr; \
 288 } while(0);
 289
 290 typedef struct redisDb {
 291     dict *dict;                 /* The keyspace for this DB */
 292     dict *expires;              /* Timeout of keys with a timeout set */
 293     dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP) */
 294     dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
 295     int id;
 296 } redisDb;
 297
 298 /* Client MULTI/EXEC state */
 299 typedef struct multiCmd {
 300     robj **argv;
 301     int argc;
 302     struct redisCommand *cmd;
 303 } multiCmd;
 304
 305 typedef struct multiState {
 306     multiCmd *commands;     /* Array of MULTI commands */
 307     int count;              /* Total number of MULTI commands */
 308 } multiState;
 309
 310 typedef struct blockingState {
 311     robj **keys;            /* The key we are waiting to terminate a blocking
 312                              * operation such as BLPOP. Otherwise NULL. */
 313     int count;              /* Number of blocking keys */
 314     time_t timeout;         /* Blocking operation timeout. If UNIX current time
 315                              * is >= timeout then the operation timed out. */
 316     robj *target;           /* The key that should receive the element,
 317                              * for BRPOPLPUSH. */
 318 } blockingState;
 319
 320 /* With multiplexing we need to take per-clinet state.
 321  * Clients are taken in a liked list. */
 322 typedef struct redisClient {
 323     int fd;
 324     redisDb *db;
 325     int dictid;
 326     sds querybuf;
 327     size_t querybuf_peak;   /* Recent (100ms or more) peak of querybuf size */
 328     int argc;
 329     robj **argv;
 330     struct redisCommand *cmd, *lastcmd;
 331     int reqtype;
 332     int multibulklen;       /* number of multi bulk arguments left to read */
 333     long bulklen;           /* length of bulk argument in multi bulk request */
 334     list *reply;
 335     unsigned long reply_bytes; /* Tot bytes of objects in reply list */
 336     int sentlen;
 337     time_t ctime;           /* Client creation time */
 338     time_t lastinteraction; /* time of the last interaction, used for timeout */
 339     time_t obuf_soft_limit_reached_time;
 340     int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
 341     int slaveseldb;         /* slave selected db, if this client is a slave */
 342     int authenticated;      /* when requirepass is non-NULL */
 343     int replstate;          /* replication state if this is a slave */
 344     int repldbfd;           /* replication DB file descriptor */
 345     long repldboff;         /* replication DB file offset */
 346     off_t repldbsize;       /* replication DB file size */
 347     multiState mstate;      /* MULTI/EXEC state */
 348     blockingState bpop;   /* blocking state */
 349     list *io_keys;          /* Keys this client is waiting to be loaded from the
 350                              * swap file in order to continue. */
 351     list *watched_keys;     /* Keys WATCHED for MULTI/EXEC CAS */
 352     dict *pubsub_channels;  /* channels a client is interested in (SUBSCRIBE) */
 353     list *pubsub_patterns;  /* patterns a client is interested in (SUBSCRIBE) */
 354
 355     /* Response buffer */
 356     int bufpos;
 357     char buf[REDIS_REPLY_CHUNK_BYTES];
 358 } redisClient;
 359
 360 struct saveparam {
 361     time_t seconds;
 362     int changes;
 363 };
 364
 365 struct sharedObjectsStruct {
 366     robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
 367     *colon, *nullbulk, *nullmultibulk, *queued,
 368     *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
 369     *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
 370     *roslaveerr, *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
 371     *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
 372     *select[REDIS_SHARED_SELECT_CMDS],
 373     *integers[REDIS_SHARED_INTEGERS],
 374     *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
 375     *bulkhdr[REDIS_SHARED_BULKHDR_LEN];  /* "$<value>\r\n" */
 376 };
 377
 378 /* ZSETs use a specialized version of Skiplists */
 379 typedef struct zskiplistNode {
 380     robj *obj;
 381     double score;
 382     struct zskiplistNode *backward;
 383     struct zskiplistLevel {
 384         struct zskiplistNode *forward;
 385         unsigned int span;
 386     } level[];
 387 } zskiplistNode;
 388
 389 typedef struct zskiplist {
 390     struct zskiplistNode *header, *tail;
 391     unsigned long length;
 392     int level;
 393 } zskiplist;
 394
 395 typedef struct zset {
 396     dict *dict;
 397     zskiplist *zsl;
 398 } zset;
 399
 400 typedef struct clientBufferLimitsConfig {
 401     unsigned long long hard_limit_bytes;
 402     unsigned long long soft_limit_bytes;
 403     time_t soft_limit_seconds;
 404 } clientBufferLimitsConfig;
 405
 406 /* The redisOp structure defines a Redis Operation, that is an instance of
 407  * a command with an argument vector, database ID, propagation target
 408  * (REDIS_PROPAGATE_*), and command pointer.
 409  *
 410  * Currently only used to additionally propagate more commands to AOF/Replication
 411  * after the propagation of the executed command. */
 412 typedef struct redisOp {
 413     robj **argv;
 414     int argc, dbid, target;
 415     struct redisCommand *cmd;
 416 } redisOp;
 417
 418 /* Defines an array of Redis operations. There is an API to add to this
 419  * structure in a easy way.
 420  *
 421  * redisOpArrayInit();
 422  * redisOpArrayAppend();
 423  * redisOpArrayFree();
 424  */
 425 typedef struct redisOpArray {
 426     redisOp *ops;
 427     int numops;
 428 } redisOpArray;
 429
 430 /*-----------------------------------------------------------------------------
 431  * Redis cluster data structures
 432  *----------------------------------------------------------------------------*/
 433
 434 #define REDIS_CLUSTER_SLOTS 4096
 435 #define REDIS_CLUSTER_OK 0          /* Everything looks ok */
 436 #define REDIS_CLUSTER_FAIL 1        /* The cluster can't work */
 437 #define REDIS_CLUSTER_NEEDHELP 2    /* The cluster works, but needs some help */
 438 #define REDIS_CLUSTER_NAMELEN 40    /* sha1 hex length */
 439 #define REDIS_CLUSTER_PORT_INCR 10000 /* Cluster port = baseport + PORT_INCR */
 440
 441 struct clusterNode;
 442
 443 /* clusterLink encapsulates everything needed to talk with a remote node. */
 444 typedef struct clusterLink {
 445     int fd;                     /* TCP socket file descriptor */
 446     sds sndbuf;                 /* Packet send buffer */
 447     sds rcvbuf;                 /* Packet reception buffer */
 448     struct clusterNode *node;   /* Node related to this link if any, or NULL */
 449 } clusterLink;
 450
 451 /* Node flags */
 452 #define REDIS_NODE_MASTER 1     /* The node is a master */
 453 #define REDIS_NODE_SLAVE 2      /* The node is a slave */
 454 #define REDIS_NODE_PFAIL 4      /* Failure? Need acknowledge */
 455 #define REDIS_NODE_FAIL 8       /* The node is believed to be malfunctioning */
 456 #define REDIS_NODE_MYSELF 16    /* This node is myself */
 457 #define REDIS_NODE_HANDSHAKE 32 /* We have still to exchange the first ping */
 458 #define REDIS_NODE_NOADDR   64  /* We don't know the address of this node */
 459 #define REDIS_NODE_MEET 128     /* Send a MEET message to this node */
 460 #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"
 461
 462 struct clusterNode {
 463     char name[REDIS_CLUSTER_NAMELEN]; /* Node name, hex string, sha1-size */
 464     int flags;      /* REDIS_NODE_... */
 465     unsigned char slots[REDIS_CLUSTER_SLOTS/8]; /* slots handled by this node */
 466     int numslaves;  /* Number of slave nodes, if this is a master */
 467     struct clusterNode **slaves; /* pointers to slave nodes */
 468     struct clusterNode *slaveof; /* pointer to the master node */
 469     time_t ping_sent;       /* Unix time we sent latest ping */
 470     time_t pong_received;   /* Unix time we received the pong */
 471     char *configdigest;         /* Configuration digest of this node */
 472     time_t configdigest_ts;     /* Configuration digest timestamp */
 473     char ip[16];                /* Latest known IP address of this node */
 474     int port;                   /* Latest known port of this node */
 475     clusterLink *link;          /* TCP/IP link with this node */
 476 };
 477 typedef struct clusterNode clusterNode;
 478
 479 typedef struct {
 480     char *configfile;
 481     clusterNode *myself;  /* This node */
 482     int state;            /* REDIS_CLUSTER_OK, REDIS_CLUSTER_FAIL, ... */
 483     int node_timeout;
 484     dict *nodes;          /* Hash table of name -> clusterNode structures */
 485     clusterNode *migrating_slots_to[REDIS_CLUSTER_SLOTS];
 486     clusterNode *importing_slots_from[REDIS_CLUSTER_SLOTS];
 487     clusterNode *slots[REDIS_CLUSTER_SLOTS];
 488     zskiplist *slots_to_keys;
 489 } clusterState;
 490
 491 /* Redis cluster messages header */
 492
 493 /* Note that the PING, PONG and MEET messages are actually the same exact
 494  * kind of packet. PONG is the reply to ping, in the extact format as a PING,
 495  * while MEET is a special PING that forces the receiver to add the sender
 496  * as a node (if it is not already in the list). */
 497 #define CLUSTERMSG_TYPE_PING 0          /* Ping */
 498 #define CLUSTERMSG_TYPE_PONG 1          /* Pong (reply to Ping) */
 499 #define CLUSTERMSG_TYPE_MEET 2          /* Meet "let's join" message */
 500 #define CLUSTERMSG_TYPE_FAIL 3          /* Mark node xxx as failing */
 501 #define CLUSTERMSG_TYPE_PUBLISH 4       /* Pub/Sub Publish propatagion */
 502
 503 /* Initially we don't know our "name", but we'll find it once we connect
 504  * to the first node, using the getsockname() function. Then we'll use this
 505  * address for all the next messages. */
 506 typedef struct {
 507     char nodename[REDIS_CLUSTER_NAMELEN];
 508     uint32_t ping_sent;
 509     uint32_t pong_received;
 510     char ip[16];    /* IP address last time it was seen */
 511     uint16_t port;  /* port last time it was seen */
 512     uint16_t flags;
 513     uint32_t notused; /* for 64 bit alignment */
 514 } clusterMsgDataGossip;
 515
 516 typedef struct {
 517     char nodename[REDIS_CLUSTER_NAMELEN];
 518 } clusterMsgDataFail;
 519
 520 typedef struct {
 521     uint32_t channel_len;
 522     uint32_t message_len;
 523     unsigned char bulk_data[8]; /* defined as 8 just for alignment concerns. */
 524 } clusterMsgDataPublish;
 525
 526 union clusterMsgData {
 527     /* PING, MEET and PONG */
 528     struct {
 529         /* Array of N clusterMsgDataGossip structures */
 530         clusterMsgDataGossip gossip[1];
 531     } ping;
 532
 533     /* FAIL */
 534     struct {
 535         clusterMsgDataFail about;
 536     } fail;
 537
 538     /* PUBLISH */
 539     struct {
 540         clusterMsgDataPublish msg;
 541     } publish;
 542 };
 543
 544 typedef struct {
 545     uint32_t totlen;    /* Total length of this message */
 546     uint16_t type;      /* Message type */
 547     uint16_t count;     /* Only used for some kind of messages. */
 548     char sender[REDIS_CLUSTER_NAMELEN]; /* Name of the sender node */
 549     unsigned char myslots[REDIS_CLUSTER_SLOTS/8];
 550     char slaveof[REDIS_CLUSTER_NAMELEN];
 551     char configdigest[32];
 552     uint16_t port;      /* Sender TCP base port */
 553     unsigned char state; /* Cluster state from the POV of the sender */
 554     unsigned char notused[5]; /* Reserved for future use. For alignment. */
 555     union clusterMsgData data;
 556 } clusterMsg;
 557
 558 /*-----------------------------------------------------------------------------
 559  * Global server state
 560  *----------------------------------------------------------------------------*/
 561
 562 struct redisServer {
 563     /* General */
 564     redisDb *db;
 565     dict *commands;             /* Command table hahs table */
 566     aeEventLoop *el;
 567     unsigned lruclock:22;       /* Clock incrementing every minute, for LRU */
 568     unsigned lruclock_padding:10;
 569     int shutdown_asap;          /* SHUTDOWN needed ASAP */
 570     int activerehashing;        /* Incremental rehash in serverCron() */
 571     char *requirepass;          /* Pass for AUTH command, or NULL */
 572     char *pidfile;              /* PID file path */
 573     int arch_bits;              /* 32 or 64 depending on sizeof(long) */
 574     int cronloops;              /* Number of times the cron function run */
 575     char runid[REDIS_RUN_ID_SIZE+1];  /* ID always different at every exec. */
 576     /* Networking */
 577     int port;                   /* TCP listening port */
 578     char *bindaddr;             /* Bind address or NULL */
 579     char *unixsocket;           /* UNIX socket path */
 580     mode_t unixsocketperm;      /* UNIX socket permission */
 581     int ipfd;                   /* TCP socket file descriptor */
 582     int sofd;                   /* Unix socket file descriptor */
 583     int cfd;                    /* Cluster bus lisetning socket */
 584     list *clients;              /* List of active clients */
 585     list *clients_to_close;     /* Clients to close asynchronously */
 586     list *slaves, *monitors;    /* List of slaves and MONITORs */
 587     redisClient *current_client; /* Current client, only used on crash report */
 588     char neterr[ANET_ERR_LEN];  /* Error buffer for anet.c */
 589     /* RDB / AOF loading information */
 590     int loading;                /* We are loading data from disk if true */
 591     off_t loading_total_bytes;
 592     off_t loading_loaded_bytes;
 593     time_t loading_start_time;
 594     /* Fast pointers to often looked up command */
 595     struct redisCommand *delCommand, *multiCommand, *lpushCommand;
 596     /* Fields used only for stats */
 597     time_t stat_starttime;          /* Server start time */
 598     long long stat_numcommands;     /* Number of processed commands */
 599     long long stat_numconnections;  /* Number of connections received */
 600     long long stat_expiredkeys;     /* Number of expired keys */
 601     long long stat_evictedkeys;     /* Number of evicted keys (maxmemory) */
 602     long long stat_keyspace_hits;   /* Number of successful lookups of keys */
 603     long long stat_keyspace_misses; /* Number of failed lookups of keys */
 604     size_t stat_peak_memory;        /* Max used memory record */
 605     long long stat_fork_time;       /* Time needed to perform latets fork() */
 606     long long stat_rejected_conn;   /* Clients rejected because of maxclients */
 607     list *slowlog;                  /* SLOWLOG list of commands */
 608     long long slowlog_entry_id;     /* SLOWLOG current entry ID */
 609     long long slowlog_log_slower_than; /* SLOWLOG time limit (to get logged) */
 610     unsigned long slowlog_max_len;     /* SLOWLOG max number of items logged */
 611     /* The following two are used to track instantaneous "load" in terms
 612      * of operations per second. */
 613     long long ops_sec_last_sample_time; /* Timestamp of last sample (in ms) */
 614     long long ops_sec_last_sample_ops;  /* numcommands in last sample */
 615     long long ops_sec_samples[REDIS_OPS_SEC_SAMPLES];
 616     int ops_sec_idx;
 617     /* Configuration */
 618     int verbosity;                  /* Loglevel in redis.conf */
 619     int maxidletime;                /* Client timeout in seconds */
 620     size_t client_max_querybuf_len; /* Limit for client query buffer length */
 621     int dbnum;                      /* Total number of configured DBs */
 622     int daemonize;                  /* True if running as a daemon */
 623     clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES];
 624     /* AOF persistence */
 625     int aof_state;                  /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
 626     int aof_fsync;                  /* Kind of fsync() policy */
 627     char *aof_filename;             /* Name of the AOF file */
 628     int aof_no_fsync_on_rewrite;    /* Don't fsync if a rewrite is in prog. */
 629     int aof_rewrite_perc;           /* Rewrite AOF if % growth is > M and... */
 630     off_t aof_rewrite_min_size;     /* the AOF file is at least N bytes. */
 631     off_t aof_rewrite_base_size;    /* AOF size on latest startup or rewrite. */
 632     off_t aof_current_size;         /* AOF current size. */
 633     int aof_rewrite_scheduled;      /* Rewrite once BGSAVE terminates. */
 634     pid_t aof_child_pid;            /* PID if rewriting process */
 635     sds aof_rewrite_buf; /* buffer taken by parent during oppend only rewrite */
 636     sds aof_buf;      /* AOF buffer, written before entering the event loop */
 637     int aof_fd;       /* File descriptor of currently selected AOF file */
 638     int aof_selected_db; /* Currently selected DB in AOF */
 639     time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
 640     time_t aof_last_fsync;            /* UNIX time of last fsync() */
 641     unsigned long aof_delayed_fsync;  /* delayed AOF fsync() counter */
 642     /* RDB persistence */
 643     long long dirty;                /* Changes to DB from the last save */
 644     long long dirty_before_bgsave;  /* Used to restore dirty on failed BGSAVE */
 645     pid_t rdb_child_pid;            /* PID of RDB saving child */
 646     struct saveparam *saveparams;   /* Save points array for RDB */
 647     int saveparamslen;              /* Number of saving points */
 648     char *rdb_filename;             /* Name of RDB file */
 649     int rdb_compression;            /* Use compression in RDB? */
 650     time_t lastsave;                /* Unix time of last save succeeede */
 651     int lastbgsave_status;          /* REDIS_OK or REDIS_ERR */
 652     int stop_writes_on_bgsave_err;  /* Don't allow writes if can't BGSAVE */
 653     /* Propagation of commands in AOF / replication */
 654     redisOpArray also_propagate;    /* Additional command to propagate. */
 655     /* Logging */
 656     char *logfile;                  /* Path of log file */
 657     int syslog_enabled;             /* Is syslog enabled? */
 658     char *syslog_ident;             /* Syslog ident */
 659     int syslog_facility;            /* Syslog facility */
 660     /* Slave specific fields */
 661     char *masterauth;               /* AUTH with this password with master */
 662     char *masterhost;               /* Hostname of master */
 663     int masterport;                 /* Port of master */
 664     int repl_ping_slave_period;     /* Master pings the salve every N seconds */
 665     int repl_timeout;               /* Timeout after N seconds of master idle */
 666     redisClient *master;     /* Client that is master for this slave */
 667     int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
 668     int repl_state;          /* Replication status if the instance is a slave */
 669     off_t repl_transfer_left;  /* Bytes left reading .rdb  */
 670     int repl_transfer_s;     /* Slave -> Master SYNC socket */
 671     int repl_transfer_fd;    /* Slave -> Master SYNC temp file descriptor */
 672     char *repl_transfer_tmpfile; /* Slave-> master SYNC temp file name */
 673     time_t repl_transfer_lastio; /* Unix time of the latest read, for timeout */
 674     int repl_serve_stale_data; /* Serve stale data when link is down? */
 675     int repl_slave_ro;          /* Slave is read only? */
 676     time_t repl_down_since; /* Unix time at which link with master went down */
 677     /* Limits */
 678     unsigned int maxclients;        /* Max number of simultaneous clients */
 679     unsigned long long maxmemory;   /* Max number of memory bytes to use */
 680     int maxmemory_policy;           /* Policy for key evition */
 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     /* Sort parameters - qsort_r() is only available under BSD so we
 686      * have to take this state global, in order to pass it to sortCompare() */
 687     int sort_dontsort;
 688     int sort_desc;
 689     int sort_alpha;
 690     int sort_bypattern;
 691     /* Zip structure config, see redis.conf for more information  */
 692     size_t hash_max_ziplist_entries;
 693     size_t hash_max_ziplist_value;
 694     size_t list_max_ziplist_entries;
 695     size_t list_max_ziplist_value;
 696     size_t set_max_intset_entries;
 697     size_t zset_max_ziplist_entries;
 698     size_t zset_max_ziplist_value;
 699     time_t unixtime;        /* Unix time sampled every second. */
 700     /* Pubsub */
 701     dict *pubsub_channels;  /* Map channels to list of subscribed clients */
 702     list *pubsub_patterns;  /* A list of pubsub_patterns */
 703     /* Cluster */
 704     int cluster_enabled;    /* Is cluster enabled? */
 705     clusterState cluster;   /* State of the cluster */
 706     /* Scripting */
 707     lua_State *lua; /* The Lua interpreter. We use just one for all clients */
 708     redisClient *lua_client;   /* The "fake client" to query Redis from Lua */
 709     redisClient *lua_caller;   /* The client running EVAL right now, or NULL */
 710     dict *lua_scripts;         /* A dictionary of SHA1 -> Lua scripts */
 711     long long lua_time_limit;  /* Script timeout in seconds */
 712     long long lua_time_start;  /* Start time of script */
 713     int lua_write_dirty;  /* True if a write command was called during the
 714                              execution of the current script. */
 715     int lua_random_dirty; /* True if a random command was called during the
 716                              execution of the current script. */
 717     int lua_timedout;     /* True if we reached the time limit for script
 718                              execution. */
 719     int lua_kill;         /* Kill the script if true. */
 720     /* Assert & bug reportign */
 721     char *assert_failed;
 722     char *assert_file;
 723     int assert_line;
 724     int bug_report_start; /* True if bug report header was already logged. */
 725     int watchdog_period;  /* Software watchdog period in ms. 0 = off */
 726 };
 727
 728 typedef struct pubsubPattern {
 729     redisClient *client;
 730     robj *pattern;
 731 } pubsubPattern;
 732
 733 typedef void redisCommandProc(redisClient *c);
 734 typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
 735 struct redisCommand {
 736     char *name;
 737     redisCommandProc *proc;
 738     int arity;
 739     char *sflags; /* Flags as string represenation, one char per flag. */
 740     int flags;    /* The actual flags, obtained from the 'sflags' field. */
 741     /* Use a function to determine keys arguments in a command line.
 742      * Used for Redis Cluster redirect. */
 743     redisGetKeysProc *getkeys_proc;
 744     /* What keys should be loaded in background when calling this command? */
 745     int firstkey; /* The first argument that's a key (0 = no keys) */
 746     int lastkey;  /* THe last argument that's a key */
 747     int keystep;  /* The step between first and last key */
 748     long long microseconds, calls;
 749 };
 750
 751 struct redisFunctionSym {
 752     char *name;
 753     unsigned long pointer;
 754 };
 755
 756 typedef struct _redisSortObject {
 757     robj *obj;
 758     union {
 759         double score;
 760         robj *cmpobj;
 761     } u;
 762 } redisSortObject;
 763
 764 typedef struct _redisSortOperation {
 765     int type;
 766     robj *pattern;
 767 } redisSortOperation;
 768
 769 /* Structure to hold list iteration abstraction. */
 770 typedef struct {
 771     robj *subject;
 772     unsigned char encoding;
 773     unsigned char direction; /* Iteration direction */
 774     unsigned char *zi;
 775     listNode *ln;
 776 } listTypeIterator;
 777
 778 /* Structure for an entry while iterating over a list. */
 779 typedef struct {
 780     listTypeIterator *li;
 781     unsigned char *zi;  /* Entry in ziplist */
 782     listNode *ln;       /* Entry in linked list */
 783 } listTypeEntry;
 784
 785 /* Structure to hold set iteration abstraction. */
 786 typedef struct {
 787     robj *subject;
 788     int encoding;
 789     int ii; /* intset iterator */
 790     dictIterator *di;
 791 } setTypeIterator;
 792
 793 /* Structure to hold hash iteration abstration. Note that iteration over
 794  * hashes involves both fields and values. Because it is possible that
 795  * not both are required, store pointers in the iterator to avoid
 796  * unnecessary memory allocation for fields/values. */
 797 typedef struct {
 798     robj *subject;
 799     int encoding;
 800
 801     unsigned char *fptr, *vptr;
 802
 803     dictIterator *di;
 804     dictEntry *de;
 805 } hashTypeIterator;
 806
 807 #define REDIS_HASH_KEY 1
 808 #define REDIS_HASH_VALUE 2
 809
 810 /*-----------------------------------------------------------------------------
 811  * Extern declarations
 812  *----------------------------------------------------------------------------*/
 813
 814 extern struct redisServer server;
 815 extern struct sharedObjectsStruct shared;
 816 extern dictType setDictType;
 817 extern dictType zsetDictType;
 818 extern dictType clusterNodesDictType;
 819 extern dictType dbDictType;
 820 extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
 821 extern dictType hashDictType;
 822
 823 /*-----------------------------------------------------------------------------
 824  * Functions prototypes
 825  *----------------------------------------------------------------------------*/
 826
 827 /* Utils */
 828 long long ustime(void);
 829 long long mstime(void);
 830 void getRandomHexChars(char *p, unsigned int len);
 831
 832 /* networking.c -- Networking and Client related operations */
 833 redisClient *createClient(int fd);
 834 void closeTimedoutClients(void);
 835 void freeClient(redisClient *c);
 836 void resetClient(redisClient *c);
 837 void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
 838 void addReply(redisClient *c, robj *obj);
 839 void *addDeferredMultiBulkLength(redisClient *c);
 840 void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
 841 void addReplySds(redisClient *c, sds s);
 842 void processInputBuffer(redisClient *c);
 843 void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 844 void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 845 void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
 846 void addReplyBulk(redisClient *c, robj *obj);
 847 void addReplyBulkCString(redisClient *c, char *s);
 848 void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
 849 void addReplyBulkLongLong(redisClient *c, long long ll);
 850 void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 851 void addReply(redisClient *c, robj *obj);
 852 void addReplySds(redisClient *c, sds s);
 853 void addReplyError(redisClient *c, char *err);
 854 void addReplyStatus(redisClient *c, char *status);
 855 void addReplyDouble(redisClient *c, double d);
 856 void addReplyLongLong(redisClient *c, long long ll);
 857 void addReplyMultiBulkLen(redisClient *c, long length);
 858 void copyClientOutputBuffer(redisClient *dst, redisClient *src);
 859 void *dupClientReplyValue(void *o);
 860 void getClientsMaxBuffers(unsigned long *longest_output_list,
 861                           unsigned long *biggest_input_buffer);
 862 sds getClientInfoString(redisClient *client);
 863 sds getAllClientsInfoString(void);
 864 void rewriteClientCommandVector(redisClient *c, int argc, ...);
 865 void rewriteClientCommandArgument(redisClient *c, int i, robj *newval);
 866 unsigned long getClientOutputBufferMemoryUsage(redisClient *c);
 867 void freeClientsInAsyncFreeQueue(void);
 868 void asyncCloseClientOnOutputBufferLimitReached(redisClient *c);
 869 int getClientLimitClassByName(char *name);
 870 char *getClientLimitClassName(int class);
 871 void flushSlavesOutputBuffers(void);
 872 void disconnectSlaves(void);
 873
 874 #ifdef __GNUC__
 875 void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
 876     __attribute__((format(printf, 2, 3)));
 877 void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
 878     __attribute__((format(printf, 2, 3)));
 879 #else
 880 void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
 881 void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
 882 #endif
 883
 884 /* List data type */
 885 void listTypeTryConversion(robj *subject, robj *value);
 886 void listTypePush(robj *subject, robj *value, int where);
 887 robj *listTypePop(robj *subject, int where);
 888 unsigned long listTypeLength(robj *subject);
 889 listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
 890 void listTypeReleaseIterator(listTypeIterator *li);
 891 int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
 892 robj *listTypeGet(listTypeEntry *entry);
 893 void listTypeInsert(listTypeEntry *entry, robj *value, int where);
 894 int listTypeEqual(listTypeEntry *entry, robj *o);
 895 void listTypeDelete(listTypeEntry *entry);
 896 void listTypeConvert(robj *subject, int enc);
 897 void unblockClientWaitingData(redisClient *c);
 898 int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
 899 void popGenericCommand(redisClient *c, int where);
 900
 901 /* MULTI/EXEC/WATCH... */
 902 void unwatchAllKeys(redisClient *c);
 903 void initClientMultiState(redisClient *c);
 904 void freeClientMultiState(redisClient *c);
 905 void queueMultiCommand(redisClient *c);
 906 void touchWatchedKey(redisDb *db, robj *key);
 907 void touchWatchedKeysOnFlush(int dbid);
 908 void discardTransaction(redisClient *c);
 909
 910 /* Redis object implementation */
 911 void decrRefCount(void *o);
 912 void incrRefCount(robj *o);
 913 robj *resetRefCount(robj *obj);
 914 void freeStringObject(robj *o);
 915 void freeListObject(robj *o);
 916 void freeSetObject(robj *o);
 917 void freeZsetObject(robj *o);
 918 void freeHashObject(robj *o);
 919 robj *createObject(int type, void *ptr);
 920 robj *createStringObject(char *ptr, size_t len);
 921 robj *dupStringObject(robj *o);
 922 int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
 923 robj *tryObjectEncoding(robj *o);
 924 robj *getDecodedObject(robj *o);
 925 size_t stringObjectLen(robj *o);
 926 robj *createStringObjectFromLongLong(long long value);
 927 robj *createStringObjectFromLongDouble(long double value);
 928 robj *createListObject(void);
 929 robj *createZiplistObject(void);
 930 robj *createSetObject(void);
 931 robj *createIntsetObject(void);
 932 robj *createHashObject(void);
 933 robj *createZsetObject(void);
 934 robj *createZsetZiplistObject(void);
 935 int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
 936 int checkType(redisClient *c, robj *o, int type);
 937 int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
 938 int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
 939 int getLongLongFromObject(robj *o, long long *target);
 940 int getLongDoubleFromObject(robj *o, long double *target);
 941 int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
 942 char *strEncoding(int encoding);
 943 int compareStringObjects(robj *a, robj *b);
 944 int equalStringObjects(robj *a, robj *b);
 945 unsigned long estimateObjectIdleTime(robj *o);
 946
 947 /* Synchronous I/O with timeout */
 948 ssize_t syncWrite(int fd, char *ptr, ssize_t size, long long timeout);
 949 ssize_t syncRead(int fd, char *ptr, ssize_t size, long long timeout);
 950 ssize_t syncReadLine(int fd, char *ptr, ssize_t size, long long timeout);
 951
 952 /* Replication */
 953 void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
 954 void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc);
 955 void updateSlavesWaitingBgsave(int bgsaveerr);
 956 void replicationCron(void);
 957
 958 /* Generic persistence functions */
 959 void startLoading(FILE *fp);
 960 void loadingProgress(off_t pos);
 961 void stopLoading(void);
 962
 963 /* RDB persistence */
 964 #include "rdb.h"
 965
 966 /* AOF persistence */
 967 void flushAppendOnlyFile(int force);
 968 void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
 969 void aofRemoveTempFile(pid_t childpid);
 970 int rewriteAppendOnlyFileBackground(void);
 971 int loadAppendOnlyFile(char *filename);
 972 void stopAppendOnly(void);
 973 int startAppendOnly(void);
 974 void backgroundRewriteDoneHandler(int exitcode, int bysignal);
 975
 976 /* Sorted sets data type */
 977
 978 /* Struct to hold a inclusive/exclusive range spec. */
 979 typedef struct {
 980     double min, max;
 981     int minex, maxex; /* are min or max exclusive? */
 982 } zrangespec;
 983
 984 zskiplist *zslCreate(void);
 985 void zslFree(zskiplist *zsl);
 986 zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
 987 unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
 988 int zslDelete(zskiplist *zsl, double score, robj *obj);
 989 zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
 990 double zzlGetScore(unsigned char *sptr);
 991 void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
 992 void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
 993 unsigned int zsetLength(robj *zobj);
 994 void zsetConvert(robj *zobj, int encoding);
 995
 996 /* Core functions */
 997 int freeMemoryIfNeeded(void);
 998 int processCommand(redisClient *c);
 999 void setupSignalHandlers(void);
1000 struct redisCommand *lookupCommand(sds name);
1001 struct redisCommand *lookupCommandByCString(char *s);
1002 void call(redisClient *c, int flags);
1003 void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1004 void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
1005 int prepareForShutdown();
1006 void redisLog(int level, const char *fmt, ...);
1007 void redisLogRaw(int level, const char *msg);
1008 void redisLogFromHandler(int level, const char *msg);
1009 void usage();
1010 void updateDictResizePolicy(void);
1011 int htNeedsResize(dict *dict);
1012 void oom(const char *msg);
1013 void populateCommandTable(void);
1014 void resetCommandTableStats(void);
1015
1016 /* Set data type */
1017 robj *setTypeCreate(robj *value);
1018 int setTypeAdd(robj *subject, robj *value);
1019 int setTypeRemove(robj *subject, robj *value);
1020 int setTypeIsMember(robj *subject, robj *value);
1021 setTypeIterator *setTypeInitIterator(robj *subject);
1022 void setTypeReleaseIterator(setTypeIterator *si);
1023 int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
1024 robj *setTypeNextObject(setTypeIterator *si);
1025 int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1026 unsigned long setTypeSize(robj *subject);
1027 void setTypeConvert(robj *subject, int enc);
1028
1029 /* Hash data type */
1030 void hashTypeConvert(robj *o, int enc);
1031 void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
1032 void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1033 robj *hashTypeGetObject(robj *o, robj *key);
1034 int hashTypeExists(robj *o, robj *key);
1035 int hashTypeSet(robj *o, robj *key, robj *value);
1036 int hashTypeDelete(robj *o, robj *key);
1037 unsigned long hashTypeLength(robj *o);
1038 hashTypeIterator *hashTypeInitIterator(robj *subject);
1039 void hashTypeReleaseIterator(hashTypeIterator *hi);
1040 int hashTypeNext(hashTypeIterator *hi);
1041 void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what,
1042                                 unsigned char **vstr,
1043                                 unsigned int *vlen,
1044                                 long long *vll);
1045 void hashTypeCurrentFromHashTable(hashTypeIterator *hi, int what, robj **dst);
1046 robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1047 robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
1048
1049 /* Pub / Sub */
1050 int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
1051 int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
1052 void freePubsubPattern(void *p);
1053 int listMatchPubsubPattern(void *a, void *b);
1054 int pubsubPublishMessage(robj *channel, robj *message);
1055
1056 /* Configuration */
1057 void loadServerConfig(char *filename, char *options);
1058 void appendServerSaveParams(time_t seconds, int changes);
1059 void resetServerSaveParams();
1060
1061 /* db.c -- Keyspace access API */
1062 int removeExpire(redisDb *db, robj *key);
1063 void propagateExpire(redisDb *db, robj *key);
1064 int expireIfNeeded(redisDb *db, robj *key);
1065 long long getExpire(redisDb *db, robj *key);
1066 void setExpire(redisDb *db, robj *key, long long when);
1067 robj *lookupKey(redisDb *db, robj *key);
1068 robj *lookupKeyRead(redisDb *db, robj *key);
1069 robj *lookupKeyWrite(redisDb *db, robj *key);
1070 robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
1071 robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
1072 void dbAdd(redisDb *db, robj *key, robj *val);
1073 void dbOverwrite(redisDb *db, robj *key, robj *val);
1074 void setKey(redisDb *db, robj *key, robj *val);
1075 int dbExists(redisDb *db, robj *key);
1076 robj *dbRandomKey(redisDb *db);
1077 int dbDelete(redisDb *db, robj *key);
1078 long long emptyDb();
1079 int selectDb(redisClient *c, int id);
1080 void signalModifiedKey(redisDb *db, robj *key);
1081 void signalFlushedDb(int dbid);
1082 unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
1083
1084 /* API to get key arguments from commands */
1085 #define REDIS_GETKEYS_ALL 0
1086 #define REDIS_GETKEYS_PRELOAD 1
1087 int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
1088 void getKeysFreeResult(int *result);
1089 int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1090 int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1091 int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1092
1093 /* Cluster */
1094 void clusterInit(void);
1095 unsigned short crc16(const char *buf, int len);
1096 unsigned int keyHashSlot(char *key, int keylen);
1097 clusterNode *createClusterNode(char *nodename, int flags);
1098 int clusterAddNode(clusterNode *node);
1099 void clusterCron(void);
1100 clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask);
1101 void clusterPropagatePublish(robj *channel, robj *message);
1102
1103 /* Scripting */
1104 void scriptingInit(void);
1105
1106 /* Git SHA1 */
1107 char *redisGitSHA1(void);
1108 char *redisGitDirty(void);
1109
1110 /* Commands prototypes */
1111 void authCommand(redisClient *c);
1112 void pingCommand(redisClient *c);
1113 void echoCommand(redisClient *c);
1114 void setCommand(redisClient *c);
1115 void setnxCommand(redisClient *c);
1116 void setexCommand(redisClient *c);
1117 void psetexCommand(redisClient *c);
1118 void getCommand(redisClient *c);
1119 void delCommand(redisClient *c);
1120 void existsCommand(redisClient *c);
1121 void setbitCommand(redisClient *c);
1122 void getbitCommand(redisClient *c);
1123 void setrangeCommand(redisClient *c);
1124 void getrangeCommand(redisClient *c);
1125 void incrCommand(redisClient *c);
1126 void decrCommand(redisClient *c);
1127 void incrbyCommand(redisClient *c);
1128 void decrbyCommand(redisClient *c);
1129 void incrbyfloatCommand(redisClient *c);
1130 void selectCommand(redisClient *c);
1131 void randomkeyCommand(redisClient *c);
1132 void keysCommand(redisClient *c);
1133 void dbsizeCommand(redisClient *c);
1134 void lastsaveCommand(redisClient *c);
1135 void saveCommand(redisClient *c);
1136 void bgsaveCommand(redisClient *c);
1137 void bgrewriteaofCommand(redisClient *c);
1138 void shutdownCommand(redisClient *c);
1139 void moveCommand(redisClient *c);
1140 void renameCommand(redisClient *c);
1141 void renamenxCommand(redisClient *c);
1142 void lpushCommand(redisClient *c);
1143 void rpushCommand(redisClient *c);
1144 void lpushxCommand(redisClient *c);
1145 void rpushxCommand(redisClient *c);
1146 void linsertCommand(redisClient *c);
1147 void lpopCommand(redisClient *c);
1148 void rpopCommand(redisClient *c);
1149 void llenCommand(redisClient *c);
1150 void lindexCommand(redisClient *c);
1151 void lrangeCommand(redisClient *c);
1152 void ltrimCommand(redisClient *c);
1153 void typeCommand(redisClient *c);
1154 void lsetCommand(redisClient *c);
1155 void saddCommand(redisClient *c);
1156 void sremCommand(redisClient *c);
1157 void smoveCommand(redisClient *c);
1158 void sismemberCommand(redisClient *c);
1159 void scardCommand(redisClient *c);
1160 void spopCommand(redisClient *c);
1161 void srandmemberCommand(redisClient *c);
1162 void sinterCommand(redisClient *c);
1163 void sinterstoreCommand(redisClient *c);
1164 void sunionCommand(redisClient *c);
1165 void sunionstoreCommand(redisClient *c);
1166 void sdiffCommand(redisClient *c);
1167 void sdiffstoreCommand(redisClient *c);
1168 void syncCommand(redisClient *c);
1169 void flushdbCommand(redisClient *c);
1170 void flushallCommand(redisClient *c);
1171 void sortCommand(redisClient *c);
1172 void lremCommand(redisClient *c);
1173 void rpoplpushCommand(redisClient *c);
1174 void infoCommand(redisClient *c);
1175 void mgetCommand(redisClient *c);
1176 void monitorCommand(redisClient *c);
1177 void expireCommand(redisClient *c);
1178 void expireatCommand(redisClient *c);
1179 void pexpireCommand(redisClient *c);
1180 void pexpireatCommand(redisClient *c);
1181 void getsetCommand(redisClient *c);
1182 void ttlCommand(redisClient *c);
1183 void pttlCommand(redisClient *c);
1184 void persistCommand(redisClient *c);
1185 void slaveofCommand(redisClient *c);
1186 void debugCommand(redisClient *c);
1187 void msetCommand(redisClient *c);
1188 void msetnxCommand(redisClient *c);
1189 void zaddCommand(redisClient *c);
1190 void zincrbyCommand(redisClient *c);
1191 void zrangeCommand(redisClient *c);
1192 void zrangebyscoreCommand(redisClient *c);
1193 void zrevrangebyscoreCommand(redisClient *c);
1194 void zcountCommand(redisClient *c);
1195 void zrevrangeCommand(redisClient *c);
1196 void zcardCommand(redisClient *c);
1197 void zremCommand(redisClient *c);
1198 void zscoreCommand(redisClient *c);
1199 void zremrangebyscoreCommand(redisClient *c);
1200 void multiCommand(redisClient *c);
1201 void execCommand(redisClient *c);
1202 void discardCommand(redisClient *c);
1203 void blpopCommand(redisClient *c);
1204 void brpopCommand(redisClient *c);
1205 void brpoplpushCommand(redisClient *c);
1206 void appendCommand(redisClient *c);
1207 void strlenCommand(redisClient *c);
1208 void zrankCommand(redisClient *c);
1209 void zrevrankCommand(redisClient *c);
1210 void hsetCommand(redisClient *c);
1211 void hsetnxCommand(redisClient *c);
1212 void hgetCommand(redisClient *c);
1213 void hmsetCommand(redisClient *c);
1214 void hmgetCommand(redisClient *c);
1215 void hdelCommand(redisClient *c);
1216 void hlenCommand(redisClient *c);
1217 void zremrangebyrankCommand(redisClient *c);
1218 void zunionstoreCommand(redisClient *c);
1219 void zinterstoreCommand(redisClient *c);
1220 void hkeysCommand(redisClient *c);
1221 void hvalsCommand(redisClient *c);
1222 void hgetallCommand(redisClient *c);
1223 void hexistsCommand(redisClient *c);
1224 void configCommand(redisClient *c);
1225 void hincrbyCommand(redisClient *c);
1226 void hincrbyfloatCommand(redisClient *c);
1227 void subscribeCommand(redisClient *c);
1228 void unsubscribeCommand(redisClient *c);
1229 void psubscribeCommand(redisClient *c);
1230 void punsubscribeCommand(redisClient *c);
1231 void publishCommand(redisClient *c);
1232 void watchCommand(redisClient *c);
1233 void unwatchCommand(redisClient *c);
1234 void clusterCommand(redisClient *c);
1235 void restoreCommand(redisClient *c);
1236 void migrateCommand(redisClient *c);
1237 void askingCommand(redisClient *c);
1238 void dumpCommand(redisClient *c);
1239 void objectCommand(redisClient *c);
1240 void clientCommand(redisClient *c);
1241 void evalCommand(redisClient *c);
1242 void evalShaCommand(redisClient *c);
1243 void scriptCommand(redisClient *c);
1244 void timeCommand(redisClient *c);
1245
1246 #if defined(__GNUC__)
1247 void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1248 void free(void *ptr) __attribute__ ((deprecated));
1249 void *malloc(size_t size) __attribute__ ((deprecated));
1250 void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1251 #endif
1252
1253 /* Debugging stuff */
1254 void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1255 void _redisAssert(char *estr, char *file, int line);
1256 void _redisPanic(char *msg, char *file, int line);
1257 void bugReportStart(void);
1258 void redisLogObjectDebugInfo(robj *o);
1259 void sigsegvHandler(int sig, siginfo_t *info, void *secret);
1260 sds genRedisInfoString(char *section);
1261 void enableWatchdog(int period);
1262 void disableWatchdog(void);
1263 void watchdogScheduleSignal(int period);
1264 #endif