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