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