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
  24 #include "ae.h"     /* Event driven programming library */
  25 #include "sds.h"    /* Dynamic safe strings */
  26 #include "dict.h"   /* Hash tables */
  27 #include "adlist.h" /* Linked lists */
  28 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
  29 #include "anet.h"   /* Networking the easy way */
  30 #include "zipmap.h" /* Compact string -> string data structure */
  31 #include "ziplist.h" /* Compact list data structure */
  32 #include "intset.h" /* Compact integer set structure */
  33 #include "version.h"
  34 #include "util.h"
  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       (60*5)  /* default client timeout */
  43 #define REDIS_IOBUF_LEN         1024
  44 #define REDIS_LOADBUF_LEN       1024
  45 #define REDIS_STATIC_ARGS       8
  46 #define REDIS_DEFAULT_DBNUM     16
  47 #define REDIS_CONFIGLINE_MAX    1024
  48 #define REDIS_MAX_SYNC_TIME     60      /* Slave can't take more to sync */
  49 #define REDIS_EXPIRELOOKUPS_PER_CRON    10 /* lookup 10 expires per loop */
  50 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
  51 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
  52 #define REDIS_SHARED_INTEGERS 10000
  53 #define REDIS_REPLY_CHUNK_BYTES (5*1500) /* 5 TCP packets with default MTU */
  54 #define REDIS_MAX_LOGMSG_LEN    1024 /* Default maximum length of syslog messages */
  55
  56 /* Hash table parameters */
  57 #define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */
  58
  59 /* Command flags:
  60  *   REDIS_CMD_DENYOOM:
  61  *     Commands marked with this flag will return an error when 'maxmemory' is
  62  *     set and the server is using more than 'maxmemory' bytes of memory.
  63  *     In short: commands with this flag are denied on low memory conditions.
  64  *   REDIS_CMD_FORCE_REPLICATION:
  65  *     Force replication even if dirty is 0. */
  66 #define REDIS_CMD_DENYOOM 4
  67 #define REDIS_CMD_FORCE_REPLICATION 8
  68
  69 /* Object types */
  70 #define REDIS_STRING 0
  71 #define REDIS_LIST 1
  72 #define REDIS_SET 2
  73 #define REDIS_ZSET 3
  74 #define REDIS_HASH 4
  75 #define REDIS_VMPOINTER 8
  76
  77 /* Object types only used for persistence in .rdb files */
  78 #define REDIS_HASH_ZIPMAP 9
  79 #define REDIS_LIST_ZIPLIST 10
  80 #define REDIS_SET_INTSET 11
  81 #define REDIS_ZSET_ZIPLIST 12
  82
  83 /* Objects encoding. Some kind of objects like Strings and Hashes can be
  84  * internally represented in multiple ways. The 'encoding' field of the object
  85  * is set to one of this fields for this object. */
  86 #define REDIS_ENCODING_RAW 0     /* Raw representation */
  87 #define REDIS_ENCODING_INT 1     /* Encoded as integer */
  88 #define REDIS_ENCODING_HT 2      /* Encoded as hash table */
  89 #define REDIS_ENCODING_ZIPMAP 3  /* Encoded as zipmap */
  90 #define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
  91 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
  92 #define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
  93 #define REDIS_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
  94
  95 /* Object types only used for dumping to disk */
  96 #define REDIS_EXPIRETIME 253
  97 #define REDIS_SELECTDB 254
  98 #define REDIS_EOF 255
  99
 100 /* Defines related to the dump file format. To store 32 bits lengths for short
 101  * keys requires a lot of space, so we check the most significant 2 bits of
 102  * the first byte to interpreter the length:
 103  *
 104  * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
 105  * 01|000000 00000000 =>  01, the len is 14 byes, 6 bits + 8 bits of next byte
 106  * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
 107  * 11|000000 this means: specially encoded object will follow. The six bits
 108  *           number specify the kind of object that follows.
 109  *           See the REDIS_RDB_ENC_* defines.
 110  *
 111  * Lenghts up to 63 are stored using a single byte, most DB keys, and may
 112  * values, will fit inside. */
 113 #define REDIS_RDB_6BITLEN 0
 114 #define REDIS_RDB_14BITLEN 1
 115 #define REDIS_RDB_32BITLEN 2
 116 #define REDIS_RDB_ENCVAL 3
 117 #define REDIS_RDB_LENERR UINT_MAX
 118
 119 /* When a length of a string object stored on disk has the first two bits
 120  * set, the remaining two bits specify a special encoding for the object
 121  * accordingly to the following defines: */
 122 #define REDIS_RDB_ENC_INT8 0        /* 8 bit signed integer */
 123 #define REDIS_RDB_ENC_INT16 1       /* 16 bit signed integer */
 124 #define REDIS_RDB_ENC_INT32 2       /* 32 bit signed integer */
 125 #define REDIS_RDB_ENC_LZF 3         /* string compressed with FASTLZ */
 126
 127 /* Scheduled IO opeations flags. */
 128 #define REDIS_IO_LOAD 1
 129 #define REDIS_IO_SAVE 2
 130 #define REDIS_IO_LOADINPROG 4
 131 #define REDIS_IO_SAVEINPROG 8
 132
 133 /* Generic IO flags */
 134 #define REDIS_IO_ONLYLOADS 1
 135 #define REDIS_IO_ASAP 2
 136
 137 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
 138 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
 139
 140 /* Client flags */
 141 #define REDIS_SLAVE 1       /* This client is a slave server */
 142 #define REDIS_MASTER 2      /* This client is a master server */
 143 #define REDIS_MONITOR 4     /* This client is a slave monitor, see MONITOR */
 144 #define REDIS_MULTI 8       /* This client is in a MULTI context */
 145 #define REDIS_BLOCKED 16    /* The client is waiting in a blocking operation */
 146 #define REDIS_IO_WAIT 32    /* The client is waiting for Virtual Memory I/O */
 147 #define REDIS_DIRTY_CAS 64  /* Watched keys modified. EXEC will fail. */
 148 #define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */
 149 #define REDIS_UNBLOCKED 256 /* This client was unblocked and is stored in
 150                                server.unblocked_clients */
 151 #define REDIS_LUA_CLIENT 512 /* This is a non connected client used by Lua */
 152
 153 /* Client request types */
 154 #define REDIS_REQ_INLINE 1
 155 #define REDIS_REQ_MULTIBULK 2
 156
 157 /* Slave replication state - slave side */
 158 #define REDIS_REPL_NONE 0   /* No active replication */
 159 #define REDIS_REPL_CONNECT 1    /* Must connect to master */
 160 #define REDIS_REPL_TRANSFER 2    /* Receiving .rdb from master */
 161 #define REDIS_REPL_CONNECTED 3  /* Connected to master */
 162
 163 /* Slave replication state - from the point of view of master
 164  * Note that in SEND_BULK and ONLINE state the slave receives new updates
 165  * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
 166  * to start the next background saving in order to send updates to it. */
 167 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
 168 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
 169 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
 170 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
 171
 172 /* List related stuff */
 173 #define REDIS_HEAD 0
 174 #define REDIS_TAIL 1
 175
 176 /* Sort operations */
 177 #define REDIS_SORT_GET 0
 178 #define REDIS_SORT_ASC 1
 179 #define REDIS_SORT_DESC 2
 180 #define REDIS_SORTKEY_MAX 1024
 181
 182 /* Log levels */
 183 #define REDIS_DEBUG 0
 184 #define REDIS_VERBOSE 1
 185 #define REDIS_NOTICE 2
 186 #define REDIS_WARNING 3
 187 #define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
 188
 189 /* Anti-warning macro... */
 190 #define REDIS_NOTUSED(V) ((void) V)
 191
 192 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
 193 #define ZSKIPLIST_P 0.25      /* Skiplist P = 1/4 */
 194
 195 /* Append only defines */
 196 #define APPENDFSYNC_NO 0
 197 #define APPENDFSYNC_ALWAYS 1
 198 #define APPENDFSYNC_EVERYSEC 2
 199
 200 /* Zip structure related defaults */
 201 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 512
 202 #define REDIS_HASH_MAX_ZIPMAP_VALUE 64
 203 #define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
 204 #define REDIS_LIST_MAX_ZIPLIST_VALUE 64
 205 #define REDIS_SET_MAX_INTSET_ENTRIES 512
 206 #define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
 207 #define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
 208
 209 /* Sets operations codes */
 210 #define REDIS_OP_UNION 0
 211 #define REDIS_OP_DIFF 1
 212 #define REDIS_OP_INTER 2
 213
 214 /* Redis maxmemory strategies */
 215 #define REDIS_MAXMEMORY_VOLATILE_LRU 0
 216 #define REDIS_MAXMEMORY_VOLATILE_TTL 1
 217 #define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
 218 #define REDIS_MAXMEMORY_ALLKEYS_LRU 3
 219 #define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
 220 #define REDIS_MAXMEMORY_NO_EVICTION 5
 221
 222 /* Diskstore background saving thread states */
 223 #define REDIS_BGSAVE_THREAD_UNACTIVE 0
 224 #define REDIS_BGSAVE_THREAD_ACTIVE 1
 225 #define REDIS_BGSAVE_THREAD_DONE_OK 2
 226 #define REDIS_BGSAVE_THREAD_DONE_ERR 3
 227
 228 /* We can print the stacktrace, so our assert is defined this way: */
 229 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
 230 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
 231 void _redisAssert(char *estr, char *file, int line);
 232 void _redisPanic(char *msg, char *file, int line);
 233
 234 /*-----------------------------------------------------------------------------
 235  * Data types
 236  *----------------------------------------------------------------------------*/
 237
 238 /* A redis object, that is a type able to hold a string / list / set */
 239
 240 /* The actual Redis Object */
 241 #define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
 242 #define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
 243 typedef struct redisObject {
 244     unsigned type:4;
 245     unsigned notused:2;     /* Not used */
 246     unsigned encoding:4;
 247     unsigned lru:22;        /* lru time (relative to server.lruclock) */
 248     int refcount;
 249     void *ptr;
 250     /* VM fields are only allocated if VM is active, otherwise the
 251      * object allocation function will just allocate
 252      * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
 253      * Redis without VM active will not have any overhead. */
 254 } robj;
 255
 256 /* The VM pointer structure - identifies an object in the swap file.
 257  *
 258  * This object is stored in place of the value
 259  * object in the main key->value hash table representing a database.
 260  * Note that the first fields (type, storage) are the same as the redisObject
 261  * structure so that vmPointer strucuters can be accessed even when casted
 262  * as redisObject structures.
 263  *
 264  * This is useful as we don't know if a value object is or not on disk, but we
 265  * are always able to read obj->storage to check this. For vmPointer
 266  * structures "type" is set to REDIS_VMPOINTER (even if without this field
 267  * is still possible to check the kind of object from the value of 'storage').*/
 268 typedef struct vmPointer {
 269     unsigned type:4;
 270     unsigned storage:2; /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
 271     unsigned notused:26;
 272     unsigned int vtype; /* type of the object stored in the swap file */
 273     off_t page;         /* the page at witch the object is stored on disk */
 274     off_t usedpages;    /* number of pages used on disk */
 275 } vmpointer;
 276
 277 /* Macro used to initalize a Redis object allocated on the stack.
 278  * Note that this macro is taken near the structure definition to make sure
 279  * we'll update it when the structure is changed, to avoid bugs like
 280  * bug #85 introduced exactly in this way. */
 281 #define initStaticStringObject(_var,_ptr) do { \
 282     _var.refcount = 1; \
 283     _var.type = REDIS_STRING; \
 284     _var.encoding = REDIS_ENCODING_RAW; \
 285     _var.ptr = _ptr; \
 286 } while(0);
 287
 288 typedef struct redisDb {
 289     dict *dict;                 /* The keyspace for this DB */
 290     dict *expires;              /* Timeout of keys with a timeout set */
 291     dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP) */
 292     dict *io_keys;              /* Keys with clients waiting for DS I/O */
 293     dict *io_negcache;          /* Negative caching for disk store */
 294     dict *io_queued;            /* Queued IO operations hash table */
 295     dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
 296     int id;
 297 } redisDb;
 298
 299 /* Client MULTI/EXEC state */
 300 typedef struct multiCmd {
 301     robj **argv;
 302     int argc;
 303     struct redisCommand *cmd;
 304 } multiCmd;
 305
 306 typedef struct multiState {
 307     multiCmd *commands;     /* Array of MULTI commands */
 308     int count;              /* Total number of MULTI commands */
 309 } multiState;
 310
 311 typedef struct blockingState {
 312     robj **keys;            /* The key we are waiting to terminate a blocking
 313                              * operation such as BLPOP. Otherwise NULL. */
 314     int count;              /* Number of blocking keys */
 315     time_t timeout;         /* Blocking operation timeout. If UNIX current time
 316                              * is >= timeout then the operation timed out. */
 317     robj *target;           /* The key that should receive the element,
 318                              * for BRPOPLPUSH. */
 319 } blockingState;
 320
 321 /* With multiplexing we need to take per-clinet state.
 322  * Clients are taken in a liked list. */
 323 typedef struct redisClient {
 324     int fd;
 325     redisDb *db;
 326     int dictid;
 327     sds querybuf;
 328     int argc;
 329     robj **argv;
 330     int reqtype;
 331     int multibulklen;       /* number of multi bulk arguments left to read */
 332     long bulklen;           /* length of bulk argument in multi bulk request */
 333     list *reply;
 334     int sentlen;
 335     time_t lastinteraction; /* time of the last interaction, used for timeout */
 336     int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
 337     int slaveseldb;         /* slave selected db, if this client is a slave */
 338     int authenticated;      /* when requirepass is non-NULL */
 339     int replstate;          /* replication state if this is a slave */
 340     int repldbfd;           /* replication DB file descriptor */
 341     long repldboff;         /* replication DB file offset */
 342     off_t repldbsize;       /* replication DB file size */
 343     multiState mstate;      /* MULTI/EXEC state */
 344     blockingState bpop;   /* blocking state */
 345     list *io_keys;          /* Keys this client is waiting to be loaded from the
 346                              * swap file in order to continue. */
 347     list *watched_keys;     /* Keys WATCHED for MULTI/EXEC CAS */
 348     dict *pubsub_channels;  /* channels a client is interested in (SUBSCRIBE) */
 349     list *pubsub_patterns;  /* patterns a client is interested in (SUBSCRIBE) */
 350
 351     /* Response buffer */
 352     int bufpos;
 353     char buf[REDIS_REPLY_CHUNK_BYTES];
 354 } redisClient;
 355
 356 struct saveparam {
 357     time_t seconds;
 358     int changes;
 359 };
 360
 361 struct sharedObjectsStruct {
 362     robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
 363     *colon, *nullbulk, *nullmultibulk, *queued,
 364     *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
 365     *outofrangeerr, *loadingerr, *plus,
 366     *select0, *select1, *select2, *select3, *select4,
 367     *select5, *select6, *select7, *select8, *select9,
 368     *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
 369     *mbulk4, *psubscribebulk, *punsubscribebulk,
 370     *integers[REDIS_SHARED_INTEGERS];
 371 };
 372
 373 /* ZSETs use a specialized version of Skiplists */
 374 typedef struct zskiplistNode {
 375     robj *obj;
 376     double score;
 377     struct zskiplistNode *backward;
 378     struct zskiplistLevel {
 379         struct zskiplistNode *forward;
 380         unsigned int span;
 381     } level[];
 382 } zskiplistNode;
 383
 384 typedef struct zskiplist {
 385     struct zskiplistNode *header, *tail;
 386     unsigned long length;
 387     int level;
 388 } zskiplist;
 389
 390 typedef struct zset {
 391     dict *dict;
 392     zskiplist *zsl;
 393 } zset;
 394
 395 /*-----------------------------------------------------------------------------
 396  * Redis cluster data structures
 397  *----------------------------------------------------------------------------*/
 398
 399 #define REDIS_CLUSTER_SLOTS 4096
 400 #define REDIS_CLUSTER_OK 0          /* Everything looks ok */
 401 #define REDIS_CLUSTER_FAIL 1        /* The cluster can't work */
 402 #define REDIS_CLUSTER_NEEDHELP 2    /* The cluster works, but needs some help */
 403 #define REDIS_CLUSTER_NAMELEN 40    /* sha1 hex length */
 404 #define REDIS_CLUSTER_PORT_INCR 10000 /* Cluster port = baseport + PORT_INCR */
 405
 406 struct clusterNode;
 407
 408 /* clusterLink encapsulates everything needed to talk with a remote node. */
 409 typedef struct clusterLink {
 410     int fd;                     /* TCP socket file descriptor */
 411     sds sndbuf;                 /* Packet send buffer */
 412     sds rcvbuf;                 /* Packet reception buffer */
 413     struct clusterNode *node;   /* Node related to this link if any, or NULL */
 414 } clusterLink;
 415
 416 /* Node flags */
 417 #define REDIS_NODE_MASTER 1     /* The node is a master */
 418 #define REDIS_NODE_SLAVE 2      /* The node is a slave */
 419 #define REDIS_NODE_PFAIL 4      /* Failure? Need acknowledge */
 420 #define REDIS_NODE_FAIL 8       /* The node is believed to be malfunctioning */
 421 #define REDIS_NODE_MYSELF 16    /* This node is myself */
 422 #define REDIS_NODE_HANDSHAKE 32 /* We have still to exchange the first ping */
 423 #define REDIS_NODE_NOADDR   64  /* We don't know the address of this node */
 424 #define REDIS_NODE_MEET 128     /* Send a MEET message to this node */
 425 #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"
 426
 427 struct clusterNode {
 428     char name[REDIS_CLUSTER_NAMELEN]; /* Node name, hex string, sha1-size */
 429     int flags;      /* REDIS_NODE_... */
 430     unsigned char slots[REDIS_CLUSTER_SLOTS/8]; /* slots handled by this node */
 431     int numslaves;  /* Number of slave nodes, if this is a master */
 432     struct clusterNode **slaves; /* pointers to slave nodes */
 433     struct clusterNode *slaveof; /* pointer to the master node */
 434     time_t ping_sent;       /* Unix time we sent latest ping */
 435     time_t pong_received;   /* Unix time we received the pong */
 436     char *configdigest;         /* Configuration digest of this node */
 437     time_t configdigest_ts;     /* Configuration digest timestamp */
 438     char ip[16];                /* Latest known IP address of this node */
 439     int port;                   /* Latest known port of this node */
 440     clusterLink *link;          /* TCP/IP link with this node */
 441 };
 442 typedef struct clusterNode clusterNode;
 443
 444 typedef struct {
 445     char *configfile;
 446     clusterNode *myself;  /* This node */
 447     int state;            /* REDIS_CLUSTER_OK, REDIS_CLUSTER_FAIL, ... */
 448     int node_timeout;
 449     dict *nodes;          /* Hash table of name -> clusterNode structures */
 450     clusterNode *migrating_slots_to[REDIS_CLUSTER_SLOTS];
 451     clusterNode *importing_slots_from[REDIS_CLUSTER_SLOTS];
 452     clusterNode *slots[REDIS_CLUSTER_SLOTS];
 453     zskiplist *slots_to_keys;
 454 } clusterState;
 455
 456 /* Redis cluster messages header */
 457
 458 /* Note that the PING, PONG and MEET messages are actually the same exact
 459  * kind of packet. PONG is the reply to ping, in the extact format as a PING,
 460  * while MEET is a special PING that forces the receiver to add the sender
 461  * as a node (if it is not already in the list). */
 462 #define CLUSTERMSG_TYPE_PING 0          /* Ping */
 463 #define CLUSTERMSG_TYPE_PONG 1          /* Pong (reply to Ping) */
 464 #define CLUSTERMSG_TYPE_MEET 2          /* Meet "let's join" message */
 465 #define CLUSTERMSG_TYPE_FAIL 3          /* Mark node xxx as failing */
 466
 467 /* Initially we don't know our "name", but we'll find it once we connect
 468  * to the first node, using the getsockname() function. Then we'll use this
 469  * address for all the next messages. */
 470 typedef struct {
 471     char nodename[REDIS_CLUSTER_NAMELEN];
 472     uint32_t ping_sent;
 473     uint32_t pong_received;
 474     char ip[16];    /* IP address last time it was seen */
 475     uint16_t port;  /* port last time it was seen */
 476     uint16_t flags;
 477     uint32_t notused; /* for 64 bit alignment */
 478 } clusterMsgDataGossip;
 479
 480 typedef struct {
 481     char nodename[REDIS_CLUSTER_NAMELEN];
 482 } clusterMsgDataFail;
 483
 484 union clusterMsgData {
 485     /* PING, MEET and PONG */
 486     struct {
 487         /* Array of N clusterMsgDataGossip structures */
 488         clusterMsgDataGossip gossip[1];
 489     } ping;
 490     /* FAIL */
 491     struct {
 492         clusterMsgDataFail about;
 493     } fail;
 494 };
 495
 496 typedef struct {
 497     uint32_t totlen;    /* Total length of this message */
 498     uint16_t type;      /* Message type */
 499     uint16_t count;     /* Only used for some kind of messages. */
 500     char sender[REDIS_CLUSTER_NAMELEN]; /* Name of the sender node */
 501     unsigned char myslots[REDIS_CLUSTER_SLOTS/8];
 502     char slaveof[REDIS_CLUSTER_NAMELEN];
 503     char configdigest[32];
 504     uint16_t port;      /* Sender TCP base port */
 505     unsigned char state; /* Cluster state from the POV of the sender */
 506     unsigned char notused[5]; /* Reserved for future use. For alignment. */
 507     union clusterMsgData data;
 508 } clusterMsg;
 509
 510 /*-----------------------------------------------------------------------------
 511  * Global server state
 512  *----------------------------------------------------------------------------*/
 513
 514 struct redisServer {
 515     /* General */
 516     pthread_t mainthread;
 517     redisDb *db;
 518     dict *commands;             /* Command table hahs table */
 519     aeEventLoop *el;
 520     /* Networking */
 521     int port;
 522     char *bindaddr;
 523     char *unixsocket;
 524     int ipfd;
 525     int sofd;
 526     int cfd;
 527     list *clients;
 528     list *slaves, *monitors;
 529     char neterr[ANET_ERR_LEN];
 530     /* RDB / AOF loading information */
 531     int loading;
 532     off_t loading_total_bytes;
 533     off_t loading_loaded_bytes;
 534     time_t loading_start_time;
 535     /* Fast pointers to often looked up command */
 536     struct redisCommand *delCommand, *multiCommand;
 537     int cronloops;              /* number of times the cron function run */
 538     time_t lastsave;                /* Unix time of last save succeeede */
 539     /* Fields used only for stats */
 540     time_t stat_starttime;          /* server start time */
 541     long long stat_numcommands;     /* number of processed commands */
 542     long long stat_numconnections;  /* number of connections received */
 543     long long stat_expiredkeys;     /* number of expired keys */
 544     long long stat_evictedkeys;     /* number of evicted keys (maxmemory) */
 545     long long stat_keyspace_hits;   /* number of successful lookups of keys */
 546     long long stat_keyspace_misses; /* number of failed lookups of keys */
 547     size_t stat_peak_memory;        /* max used memory record */
 548     /* Configuration */
 549     int verbosity;
 550     int maxidletime;
 551     int dbnum;
 552     int daemonize;
 553     int appendonly;
 554     int appendfsync;
 555     int no_appendfsync_on_rewrite;
 556     int shutdown_asap;
 557     int activerehashing;
 558     char *requirepass;
 559     /* Persistence */
 560     long long dirty;            /* changes to DB from the last save */
 561     long long dirty_before_bgsave; /* used to restore dirty on failed BGSAVE */
 562     time_t lastfsync;
 563     int appendfd;
 564     int appendseldb;
 565     char *pidfile;
 566     pid_t bgsavechildpid;
 567     pid_t bgrewritechildpid;
 568     int bgsavethread_state;
 569     pthread_mutex_t bgsavethread_mutex;
 570     pthread_t bgsavethread;
 571     sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
 572     sds aofbuf;       /* AOF buffer, written before entering the event loop */
 573     struct saveparam *saveparams;
 574     int saveparamslen;
 575     char *dbfilename;
 576     int rdbcompression;
 577     char *appendfilename;
 578     /* Logging */
 579     char *logfile;
 580     int syslog_enabled;
 581     char *syslog_ident;
 582     int syslog_facility;
 583     /* Replication related */
 584     int isslave;
 585     /* Slave specific fields */
 586     char *masterauth;
 587     char *masterhost;
 588     int masterport;
 589     redisClient *master;    /* client that is master for this slave */
 590     int replstate;          /* replication status if the instance is a slave */
 591     off_t repl_transfer_left;  /* bytes left reading .rdb  */
 592     int repl_transfer_s;    /* slave -> master SYNC socket */
 593     int repl_transfer_fd;   /* slave -> master SYNC temp file descriptor */
 594     char *repl_transfer_tmpfile; /* slave-> master SYNC temp file name */
 595     time_t repl_transfer_lastio; /* unix time of the latest read, for timeout */
 596     int repl_serve_stale_data; /* Serve stale data when link is down? */
 597     /* Limits */
 598     unsigned int maxclients;
 599     unsigned long long maxmemory;
 600     int maxmemory_policy;
 601     int maxmemory_samples;
 602     /* Blocked clients */
 603     unsigned int bpop_blocked_clients;
 604     unsigned int cache_blocked_clients;
 605     list *unblocked_clients; /* list of clients to unblock before next loop */
 606     list *cache_io_queue;    /* IO operations queue */
 607     int cache_flush_delay;   /* seconds to wait before flushing keys */
 608     /* Sort parameters - qsort_r() is only available under BSD so we
 609      * have to take this state global, in order to pass it to sortCompare() */
 610     int sort_desc;
 611     int sort_alpha;
 612     int sort_bypattern;
 613     /* Virtual memory configuration */
 614     int ds_enabled; /* backend disk in redis.conf */
 615     char *ds_path;  /* location of the disk store on disk */
 616     unsigned long long cache_max_memory;
 617     /* Zip structure config */
 618     size_t hash_max_zipmap_entries;
 619     size_t hash_max_zipmap_value;
 620     size_t list_max_ziplist_entries;
 621     size_t list_max_ziplist_value;
 622     size_t set_max_intset_entries;
 623     size_t zset_max_ziplist_entries;
 624     size_t zset_max_ziplist_value;
 625     time_t unixtime;    /* Unix time sampled every second. */
 626     /* Virtual memory I/O threads stuff */
 627     /* An I/O thread process an element taken from the io_jobs queue and
 628      * put the result of the operation in the io_done list. While the
 629      * job is being processed, it's put on io_processing queue. */
 630     list *io_newjobs; /* List of VM I/O jobs yet to be processed */
 631     list *io_processing; /* List of VM I/O jobs being processed */
 632     list *io_processed; /* List of VM I/O jobs already processed */
 633     list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
 634     pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
 635     pthread_cond_t io_condvar; /* I/O threads conditional variable */
 636     pthread_attr_t io_threads_attr; /* attributes for threads creation */
 637     int io_active_threads; /* Number of running I/O threads */
 638     int vm_max_threads; /* Max number of I/O threads running at the same time */
 639     /* Our main thread is blocked on the event loop, locking for sockets ready
 640      * to be read or written, so when a threaded I/O operation is ready to be
 641      * processed by the main thread, the I/O thread will use a unix pipe to
 642      * awake the main thread. The followings are the two pipe FDs. */
 643     int io_ready_pipe_read;
 644     int io_ready_pipe_write;
 645     /* Virtual memory stats */
 646     unsigned long long vm_stats_used_pages;
 647     unsigned long long vm_stats_swapped_objects;
 648     unsigned long long vm_stats_swapouts;
 649     unsigned long long vm_stats_swapins;
 650     /* Pubsub */
 651     dict *pubsub_channels; /* Map channels to list of subscribed clients */
 652     list *pubsub_patterns; /* A list of pubsub_patterns */
 653     /* Misc */
 654     unsigned lruclock:22;        /* clock incrementing every minute, for LRU */
 655     unsigned lruclock_padding:10;
 656     /* Cluster */
 657     int cluster_enabled;
 658     clusterState cluster;
 659     /* Scripting */
 660     lua_State *lua;
 661     redisClient *lua_client;
 662 };
 663
 664 typedef struct pubsubPattern {
 665     redisClient *client;
 666     robj *pattern;
 667 } pubsubPattern;
 668
 669 typedef void redisCommandProc(redisClient *c);
 670 typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
 671 struct redisCommand {
 672     char *name;
 673     redisCommandProc *proc;
 674     int arity;
 675     int flags;
 676     /* Use a function to determine keys arguments in a command line.
 677      * Used both for diskstore preloading and Redis Cluster. */
 678     redisGetKeysProc *getkeys_proc;
 679     /* What keys should be loaded in background when calling this command? */
 680     int firstkey; /* The first argument that's a key (0 = no keys) */
 681     int lastkey;  /* THe last argument that's a key */
 682     int keystep;  /* The step between first and last key */
 683     long long microseconds, calls;
 684 };
 685
 686 struct redisFunctionSym {
 687     char *name;
 688     unsigned long pointer;
 689 };
 690
 691 typedef struct _redisSortObject {
 692     robj *obj;
 693     union {
 694         double score;
 695         robj *cmpobj;
 696     } u;
 697 } redisSortObject;
 698
 699 typedef struct _redisSortOperation {
 700     int type;
 701     robj *pattern;
 702 } redisSortOperation;
 703
 704 /* DIsk store threaded I/O request message */
 705 #define REDIS_IOJOB_LOAD 0
 706 #define REDIS_IOJOB_SAVE 1
 707
 708 typedef struct iojob {
 709     int type;   /* Request type, REDIS_IOJOB_* */
 710     redisDb *db;/* Redis database */
 711     robj *key;  /* This I/O request is about this key */
 712     robj *val;  /* the value to swap for REDIS_IOJOB_SAVE, otherwise this
 713                  * field is populated by the I/O thread for REDIS_IOJOB_LOAD. */
 714     time_t expire; /* Expire time for this key on REDIS_IOJOB_LOAD */
 715 } iojob;
 716
 717 /* IO operations scheduled -- check dscache.c for more info */
 718 typedef struct ioop {
 719     int type;
 720     redisDb *db;
 721     robj *key;
 722     time_t ctime; /* This is the creation time of the entry. */
 723 } ioop;
 724
 725 /* Structure to hold list iteration abstraction. */
 726 typedef struct {
 727     robj *subject;
 728     unsigned char encoding;
 729     unsigned char direction; /* Iteration direction */
 730     unsigned char *zi;
 731     listNode *ln;
 732 } listTypeIterator;
 733
 734 /* Structure for an entry while iterating over a list. */
 735 typedef struct {
 736     listTypeIterator *li;
 737     unsigned char *zi;  /* Entry in ziplist */
 738     listNode *ln;       /* Entry in linked list */
 739 } listTypeEntry;
 740
 741 /* Structure to hold set iteration abstraction. */
 742 typedef struct {
 743     robj *subject;
 744     int encoding;
 745     int ii; /* intset iterator */
 746     dictIterator *di;
 747 } setTypeIterator;
 748
 749 /* Structure to hold hash iteration abstration. Note that iteration over
 750  * hashes involves both fields and values. Because it is possible that
 751  * not both are required, store pointers in the iterator to avoid
 752  * unnecessary memory allocation for fields/values. */
 753 typedef struct {
 754     int encoding;
 755     unsigned char *zi;
 756     unsigned char *zk, *zv;
 757     unsigned int zklen, zvlen;
 758
 759     dictIterator *di;
 760     dictEntry *de;
 761 } hashTypeIterator;
 762
 763 #define REDIS_HASH_KEY 1
 764 #define REDIS_HASH_VALUE 2
 765
 766 /*-----------------------------------------------------------------------------
 767  * Extern declarations
 768  *----------------------------------------------------------------------------*/
 769
 770 extern struct redisServer server;
 771 extern struct sharedObjectsStruct shared;
 772 extern dictType setDictType;
 773 extern dictType zsetDictType;
 774 extern dictType clusterNodesDictType;
 775 extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
 776 dictType hashDictType;
 777
 778 /*-----------------------------------------------------------------------------
 779  * Functions prototypes
 780  *----------------------------------------------------------------------------*/
 781
 782 /* Utils */
 783 long long ustime(void);
 784
 785 /* networking.c -- Networking and Client related operations */
 786 redisClient *createClient(int fd);
 787 void closeTimedoutClients(void);
 788 void freeClient(redisClient *c);
 789 void resetClient(redisClient *c);
 790 void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
 791 void addReply(redisClient *c, robj *obj);
 792 void *addDeferredMultiBulkLength(redisClient *c);
 793 void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
 794 void addReplySds(redisClient *c, sds s);
 795 void processInputBuffer(redisClient *c);
 796 void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 797 void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 798 void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
 799 void addReplyBulk(redisClient *c, robj *obj);
 800 void addReplyBulkCString(redisClient *c, char *s);
 801 void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
 802 void addReplyBulkLongLong(redisClient *c, long long ll);
 803 void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 804 void addReply(redisClient *c, robj *obj);
 805 void addReplySds(redisClient *c, sds s);
 806 void addReplyError(redisClient *c, char *err);
 807 void addReplyStatus(redisClient *c, char *status);
 808 void addReplyDouble(redisClient *c, double d);
 809 void addReplyLongLong(redisClient *c, long long ll);
 810 void addReplyMultiBulkLen(redisClient *c, long length);
 811 void *dupClientReplyValue(void *o);
 812 void getClientsMaxBuffers(unsigned long *longest_output_list,
 813                           unsigned long *biggest_input_buffer);
 814
 815 #ifdef __GNUC__
 816 void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
 817     __attribute__((format(printf, 2, 3)));
 818 void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
 819     __attribute__((format(printf, 2, 3)));
 820 #else
 821 void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
 822 void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
 823 #endif
 824
 825 /* List data type */
 826 void listTypeTryConversion(robj *subject, robj *value);
 827 void listTypePush(robj *subject, robj *value, int where);
 828 robj *listTypePop(robj *subject, int where);
 829 unsigned long listTypeLength(robj *subject);
 830 listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction);
 831 void listTypeReleaseIterator(listTypeIterator *li);
 832 int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
 833 robj *listTypeGet(listTypeEntry *entry);
 834 void listTypeInsert(listTypeEntry *entry, robj *value, int where);
 835 int listTypeEqual(listTypeEntry *entry, robj *o);
 836 void listTypeDelete(listTypeEntry *entry);
 837 void listTypeConvert(robj *subject, int enc);
 838 void unblockClientWaitingData(redisClient *c);
 839 int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
 840 void popGenericCommand(redisClient *c, int where);
 841
 842 /* MULTI/EXEC/WATCH... */
 843 void unwatchAllKeys(redisClient *c);
 844 void initClientMultiState(redisClient *c);
 845 void freeClientMultiState(redisClient *c);
 846 void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
 847 void touchWatchedKey(redisDb *db, robj *key);
 848 void touchWatchedKeysOnFlush(int dbid);
 849
 850 /* Redis object implementation */
 851 void decrRefCount(void *o);
 852 void incrRefCount(robj *o);
 853 void freeStringObject(robj *o);
 854 void freeListObject(robj *o);
 855 void freeSetObject(robj *o);
 856 void freeZsetObject(robj *o);
 857 void freeHashObject(robj *o);
 858 robj *createObject(int type, void *ptr);
 859 robj *createStringObject(char *ptr, size_t len);
 860 robj *dupStringObject(robj *o);
 861 int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
 862 robj *tryObjectEncoding(robj *o);
 863 robj *getDecodedObject(robj *o);
 864 size_t stringObjectLen(robj *o);
 865 robj *createStringObjectFromLongLong(long long value);
 866 robj *createListObject(void);
 867 robj *createZiplistObject(void);
 868 robj *createSetObject(void);
 869 robj *createIntsetObject(void);
 870 robj *createHashObject(void);
 871 robj *createZsetObject(void);
 872 robj *createZsetZiplistObject(void);
 873 int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
 874 int checkType(redisClient *c, robj *o, int type);
 875 int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
 876 int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
 877 int getLongLongFromObject(robj *o, long long *target);
 878 char *strEncoding(int encoding);
 879 int compareStringObjects(robj *a, robj *b);
 880 int equalStringObjects(robj *a, robj *b);
 881 unsigned long estimateObjectIdleTime(robj *o);
 882
 883 /* Synchronous I/O with timeout */
 884 int syncWrite(int fd, char *ptr, ssize_t size, int timeout);
 885 int syncRead(int fd, char *ptr, ssize_t size, int timeout);
 886 int syncReadLine(int fd, char *ptr, ssize_t size, int timeout);
 887 int fwriteBulkString(FILE *fp, char *s, unsigned long len);
 888 int fwriteBulkDouble(FILE *fp, double d);
 889 int fwriteBulkLongLong(FILE *fp, long long l);
 890 int fwriteBulkObject(FILE *fp, robj *obj);
 891 int fwriteBulkCount(FILE *fp, char prefix, int count);
 892
 893 /* Replication */
 894 void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
 895 void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
 896 int syncWithMaster(void);
 897 void updateSlavesWaitingBgsave(int bgsaveerr);
 898 void replicationCron(void);
 899
 900 /* Generic persistence functions */
 901 void startLoading(FILE *fp);
 902 void loadingProgress(off_t pos);
 903 void stopLoading(void);
 904
 905 /* RDB persistence */
 906 int rdbLoad(char *filename);
 907 int rdbSaveBackground(char *filename);
 908 void rdbRemoveTempFile(pid_t childpid);
 909 int rdbSave(char *filename);
 910 int rdbSaveObject(FILE *fp, robj *o);
 911 off_t rdbSavedObjectLen(robj *o);
 912 off_t rdbSavedObjectPages(robj *o);
 913 robj *rdbLoadObject(int type, FILE *fp);
 914 void backgroundSaveDoneHandler(int exitcode, int bysignal);
 915 int rdbSaveKeyValuePair(FILE *fp, robj *key, robj *val, time_t expireitme, time_t now);
 916 int rdbLoadType(FILE *fp);
 917 time_t rdbLoadTime(FILE *fp);
 918 robj *rdbLoadStringObject(FILE *fp);
 919 int rdbSaveType(FILE *fp, unsigned char type);
 920 int rdbSaveLen(FILE *fp, uint32_t len);
 921
 922 /* AOF persistence */
 923 void flushAppendOnlyFile(void);
 924 void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
 925 void aofRemoveTempFile(pid_t childpid);
 926 int rewriteAppendOnlyFileBackground(void);
 927 int loadAppendOnlyFile(char *filename);
 928 void stopAppendOnly(void);
 929 int startAppendOnly(void);
 930 void backgroundRewriteDoneHandler(int exitcode, int bysignal);
 931
 932 /* Sorted sets data type */
 933
 934 /* Struct to hold a inclusive/exclusive range spec. */
 935 typedef struct {
 936     double min, max;
 937     int minex, maxex; /* are min or max exclusive? */
 938 } zrangespec;
 939
 940 zskiplist *zslCreate(void);
 941 void zslFree(zskiplist *zsl);
 942 zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
 943 unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
 944 int zslDelete(zskiplist *zsl, double score, robj *obj);
 945 zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
 946 double zzlGetScore(unsigned char *sptr);
 947 void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
 948 void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
 949 unsigned int zsetLength(robj *zobj);
 950 void zsetConvert(robj *zobj, int encoding);
 951
 952 /* Core functions */
 953 void freeMemoryIfNeeded(void);
 954 int processCommand(redisClient *c);
 955 void setupSignalHandlers(void);
 956 struct redisCommand *lookupCommand(sds name);
 957 struct redisCommand *lookupCommandByCString(char *s);
 958 void call(redisClient *c, struct redisCommand *cmd);
 959 int prepareForShutdown();
 960 void redisLog(int level, const char *fmt, ...);
 961 void usage();
 962 void updateDictResizePolicy(void);
 963 int htNeedsResize(dict *dict);
 964 void oom(const char *msg);
 965 void populateCommandTable(void);
 966 void resetCommandTableStats(void);
 967
 968 /* Disk store */
 969 int dsOpen(void);
 970 int dsClose(void);
 971 int dsSet(redisDb *db, robj *key, robj *val, time_t expire);
 972 robj *dsGet(redisDb *db, robj *key, time_t *expire);
 973 int dsDel(redisDb *db, robj *key);
 974 int dsExists(redisDb *db, robj *key);
 975 void dsFlushDb(int dbid);
 976 int dsRdbSaveBackground(char *filename);
 977 int dsRdbSave(char *filename);
 978
 979 /* Disk Store Cache */
 980 void dsInit(void);
 981 void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
 982 void lockThreadedIO(void);
 983 void unlockThreadedIO(void);
 984 void freeIOJob(iojob *j);
 985 void queueIOJob(iojob *j);
 986 void waitEmptyIOJobsQueue(void);
 987 void processAllPendingIOJobs(void);
 988 int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
 989 int dontWaitForSwappedKey(redisClient *c, robj *key);
 990 void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
 991 int cacheFreeOneEntry(void);
 992 void cacheScheduleIOAddFlag(redisDb *db, robj *key, long flag);
 993 void cacheScheduleIODelFlag(redisDb *db, robj *key, long flag);
 994 int cacheScheduleIOGetFlags(redisDb *db, robj *key);
 995 void cacheScheduleIO(redisDb *db, robj *key, int type);
 996 void cacheCron(void);
 997 int cacheKeyMayExist(redisDb *db, robj *key);
 998 void cacheSetKeyMayExist(redisDb *db, robj *key);
 999 void cacheSetKeyDoesNotExist(redisDb *db, robj *key);
1000 void cacheForcePointInTime(void);
1001
1002 /* Set data type */
1003 robj *setTypeCreate(robj *value);
1004 int setTypeAdd(robj *subject, robj *value);
1005 int setTypeRemove(robj *subject, robj *value);
1006 int setTypeIsMember(robj *subject, robj *value);
1007 setTypeIterator *setTypeInitIterator(robj *subject);
1008 void setTypeReleaseIterator(setTypeIterator *si);
1009 int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
1010 robj *setTypeNextObject(setTypeIterator *si);
1011 int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1012 unsigned long setTypeSize(robj *subject);
1013 void setTypeConvert(robj *subject, int enc);
1014
1015 /* Hash data type */
1016 void convertToRealHash(robj *o);
1017 void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
1018 void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1019 int hashTypeGet(robj *o, robj *key, robj **objval, unsigned char **v, unsigned int *vlen);
1020 robj *hashTypeGetObject(robj *o, robj *key);
1021 int hashTypeExists(robj *o, robj *key);
1022 int hashTypeSet(robj *o, robj *key, robj *value);
1023 int hashTypeDelete(robj *o, robj *key);
1024 unsigned long hashTypeLength(robj *o);
1025 hashTypeIterator *hashTypeInitIterator(robj *subject);
1026 void hashTypeReleaseIterator(hashTypeIterator *hi);
1027 int hashTypeNext(hashTypeIterator *hi);
1028 int hashTypeCurrent(hashTypeIterator *hi, int what, robj **objval, unsigned char **v, unsigned int *vlen);
1029 robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1030 robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
1031
1032 /* Pub / Sub */
1033 int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
1034 int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
1035 void freePubsubPattern(void *p);
1036 int listMatchPubsubPattern(void *a, void *b);
1037
1038 /* Configuration */
1039 void loadServerConfig(char *filename);
1040 void appendServerSaveParams(time_t seconds, int changes);
1041 void resetServerSaveParams();
1042
1043 /* db.c -- Keyspace access API */
1044 int removeExpire(redisDb *db, robj *key);
1045 void propagateExpire(redisDb *db, robj *key);
1046 int expireIfNeeded(redisDb *db, robj *key);
1047 time_t getExpire(redisDb *db, robj *key);
1048 void setExpire(redisDb *db, robj *key, time_t when);
1049 robj *lookupKey(redisDb *db, robj *key);
1050 robj *lookupKeyRead(redisDb *db, robj *key);
1051 robj *lookupKeyWrite(redisDb *db, robj *key);
1052 robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
1053 robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
1054 int dbAdd(redisDb *db, robj *key, robj *val);
1055 int dbReplace(redisDb *db, robj *key, robj *val);
1056 int dbExists(redisDb *db, robj *key);
1057 robj *dbRandomKey(redisDb *db);
1058 int dbDelete(redisDb *db, robj *key);
1059 long long emptyDb();
1060 int selectDb(redisClient *c, int id);
1061 void signalModifiedKey(redisDb *db, robj *key);
1062 void signalFlushedDb(int dbid);
1063 unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
1064
1065 /* API to get key arguments from commands */
1066 #define REDIS_GETKEYS_ALL 0
1067 #define REDIS_GETKEYS_PRELOAD 1
1068 int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
1069 void getKeysFreeResult(int *result);
1070 int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1071 int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1072 int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1073
1074 /* Cluster */
1075 void clusterInit(void);
1076 unsigned short crc16(const char *buf, int len);
1077 unsigned int keyHashSlot(char *key, int keylen);
1078 clusterNode *createClusterNode(char *nodename, int flags);
1079 int clusterAddNode(clusterNode *node);
1080 void clusterCron(void);
1081 clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask);
1082
1083 /* Scripting */
1084 void scriptingInit(void);
1085
1086 /* Git SHA1 */
1087 char *redisGitSHA1(void);
1088 char *redisGitDirty(void);
1089
1090 /* Commands prototypes */
1091 void authCommand(redisClient *c);
1092 void pingCommand(redisClient *c);
1093 void echoCommand(redisClient *c);
1094 void setCommand(redisClient *c);
1095 void setnxCommand(redisClient *c);
1096 void setexCommand(redisClient *c);
1097 void getCommand(redisClient *c);
1098 void delCommand(redisClient *c);
1099 void existsCommand(redisClient *c);
1100 void setbitCommand(redisClient *c);
1101 void getbitCommand(redisClient *c);
1102 void setrangeCommand(redisClient *c);
1103 void getrangeCommand(redisClient *c);
1104 void incrCommand(redisClient *c);
1105 void decrCommand(redisClient *c);
1106 void incrbyCommand(redisClient *c);
1107 void decrbyCommand(redisClient *c);
1108 void selectCommand(redisClient *c);
1109 void randomkeyCommand(redisClient *c);
1110 void keysCommand(redisClient *c);
1111 void dbsizeCommand(redisClient *c);
1112 void lastsaveCommand(redisClient *c);
1113 void saveCommand(redisClient *c);
1114 void bgsaveCommand(redisClient *c);
1115 void bgrewriteaofCommand(redisClient *c);
1116 void shutdownCommand(redisClient *c);
1117 void moveCommand(redisClient *c);
1118 void renameCommand(redisClient *c);
1119 void renamenxCommand(redisClient *c);
1120 void lpushCommand(redisClient *c);
1121 void rpushCommand(redisClient *c);
1122 void lpushxCommand(redisClient *c);
1123 void rpushxCommand(redisClient *c);
1124 void linsertCommand(redisClient *c);
1125 void lpopCommand(redisClient *c);
1126 void rpopCommand(redisClient *c);
1127 void llenCommand(redisClient *c);
1128 void lindexCommand(redisClient *c);
1129 void lrangeCommand(redisClient *c);
1130 void ltrimCommand(redisClient *c);
1131 void typeCommand(redisClient *c);
1132 void lsetCommand(redisClient *c);
1133 void saddCommand(redisClient *c);
1134 void sremCommand(redisClient *c);
1135 void smoveCommand(redisClient *c);
1136 void sismemberCommand(redisClient *c);
1137 void scardCommand(redisClient *c);
1138 void spopCommand(redisClient *c);
1139 void srandmemberCommand(redisClient *c);
1140 void sinterCommand(redisClient *c);
1141 void sinterstoreCommand(redisClient *c);
1142 void sunionCommand(redisClient *c);
1143 void sunionstoreCommand(redisClient *c);
1144 void sdiffCommand(redisClient *c);
1145 void sdiffstoreCommand(redisClient *c);
1146 void syncCommand(redisClient *c);
1147 void flushdbCommand(redisClient *c);
1148 void flushallCommand(redisClient *c);
1149 void sortCommand(redisClient *c);
1150 void lremCommand(redisClient *c);
1151 void rpoplpushCommand(redisClient *c);
1152 void infoCommand(redisClient *c);
1153 void mgetCommand(redisClient *c);
1154 void monitorCommand(redisClient *c);
1155 void expireCommand(redisClient *c);
1156 void expireatCommand(redisClient *c);
1157 void getsetCommand(redisClient *c);
1158 void ttlCommand(redisClient *c);
1159 void persistCommand(redisClient *c);
1160 void slaveofCommand(redisClient *c);
1161 void debugCommand(redisClient *c);
1162 void msetCommand(redisClient *c);
1163 void msetnxCommand(redisClient *c);
1164 void zaddCommand(redisClient *c);
1165 void zincrbyCommand(redisClient *c);
1166 void zrangeCommand(redisClient *c);
1167 void zrangebyscoreCommand(redisClient *c);
1168 void zrevrangebyscoreCommand(redisClient *c);
1169 void zcountCommand(redisClient *c);
1170 void zrevrangeCommand(redisClient *c);
1171 void zcardCommand(redisClient *c);
1172 void zremCommand(redisClient *c);
1173 void zscoreCommand(redisClient *c);
1174 void zremrangebyscoreCommand(redisClient *c);
1175 void multiCommand(redisClient *c);
1176 void execCommand(redisClient *c);
1177 void discardCommand(redisClient *c);
1178 void blpopCommand(redisClient *c);
1179 void brpopCommand(redisClient *c);
1180 void brpoplpushCommand(redisClient *c);
1181 void appendCommand(redisClient *c);
1182 void strlenCommand(redisClient *c);
1183 void zrankCommand(redisClient *c);
1184 void zrevrankCommand(redisClient *c);
1185 void hsetCommand(redisClient *c);
1186 void hsetnxCommand(redisClient *c);
1187 void hgetCommand(redisClient *c);
1188 void hmsetCommand(redisClient *c);
1189 void hmgetCommand(redisClient *c);
1190 void hdelCommand(redisClient *c);
1191 void hlenCommand(redisClient *c);
1192 void zremrangebyrankCommand(redisClient *c);
1193 void zunionstoreCommand(redisClient *c);
1194 void zinterstoreCommand(redisClient *c);
1195 void hkeysCommand(redisClient *c);
1196 void hvalsCommand(redisClient *c);
1197 void hgetallCommand(redisClient *c);
1198 void hexistsCommand(redisClient *c);
1199 void configCommand(redisClient *c);
1200 void hincrbyCommand(redisClient *c);
1201 void subscribeCommand(redisClient *c);
1202 void unsubscribeCommand(redisClient *c);
1203 void psubscribeCommand(redisClient *c);
1204 void punsubscribeCommand(redisClient *c);
1205 void publishCommand(redisClient *c);
1206 void watchCommand(redisClient *c);
1207 void unwatchCommand(redisClient *c);
1208 void clusterCommand(redisClient *c);
1209 void restoreCommand(redisClient *c);
1210 void migrateCommand(redisClient *c);
1211 void dumpCommand(redisClient *c);
1212 void objectCommand(redisClient *c);
1213 void clientCommand(redisClient *c);
1214 void evalCommand(redisClient *c);
1215
1216 #if defined(__GNUC__)
1217 void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1218 void free(void *ptr) __attribute__ ((deprecated));
1219 void *malloc(size_t size) __attribute__ ((deprecated));
1220 void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1221 #endif
1222
1223 #endif