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