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