src/redis.h

   1 #ifndef __REDIS_H
   2 #define __REDIS_H
   3
   4 #include "fmacros.h"
   5 #include "config.h"
   6
   7 #if defined(__sun)
   8 #include "solarisfixes.h"
   9 #endif
  10
  11 #include <stdio.h>
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <time.h>
  15 #include <limits.h>
  16 #include <unistd.h>
  17 #include <errno.h>
  18 #include <inttypes.h>
  19 #include <pthread.h>
  20 #include <syslog.h>
  21 #include <netinet/in.h>
  22 #include <lua.h>
  23 #include <signal.h>
  24
  25 #include "ae.h"      /* Event driven programming library */
  26 #include "sds.h"     /* Dynamic safe strings */
  27 #include "dict.h"    /* Hash tables */
  28 #include "adlist.h"  /* Linked lists */
  29 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
  30 #include "anet.h"    /* Networking the easy way */
  31 #include "zipmap.h"  /* Compact string -> string data structure */
  32 #include "ziplist.h" /* Compact list data structure */
  33 #include "intset.h"  /* Compact integer set structure */
  34 #include "version.h" /* Version macro */
  35 #include "util.h"    /* Misc functions useful in many places */
  36
  37 /* Error codes */
  38 #define REDIS_OK                0
  39 #define REDIS_ERR               -1
  40
  41 /* Static server configuration */
  42 #define REDIS_SERVERPORT        6379    /* TCP port */
  43 #define REDIS_MAXIDLETIME       0       /* default client timeout: infinite */
  44 #define REDIS_DEFAULT_DBNUM     16
  45 #define REDIS_CONFIGLINE_MAX    1024
  46 #define REDIS_EXPIRELOOKUPS_PER_CRON    10 /* lookup 10 expires per loop */
  47 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
  48 #define REDIS_SHARED_INTEGERS 10000
  49 #define REDIS_MAX_LOGMSG_LEN    1024 /* Default maximum length of syslog messages */
  50 #define REDIS_AOF_REWRITE_PERC  100
  51 #define REDIS_AOF_REWRITE_MIN_SIZE (1024*1024)
  52 #define REDIS_AOF_REWRITE_ITEMS_PER_CMD 64
  53 #define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000
  54 #define REDIS_SLOWLOG_MAX_LEN 64
  55 #define REDIS_MAX_CLIENTS 10000
  56
  57 #define REDIS_REPL_TIMEOUT 60
  58 #define REDIS_REPL_PING_SLAVE_PERIOD 10
  59
  60 /* Protocol and I/O related defines */
  61 #define REDIS_MAX_QUERYBUF_LEN  (1024*1024*1024) /* 1GB max query buffer. */
  62 #define REDIS_IOBUF_LEN         (1024*16)  /* Generic I/O buffer size */
  63 #define REDIS_REPLY_CHUNK_BYTES (16*1024) /* 16k output buffer */
  64 #define REDIS_INLINE_MAX_SIZE   (1024*64) /* Max size of inline reads */
  65 #define REDIS_MBULK_BIG_ARG     (1024*32)
  66
  67 /* Hash table parameters */
  68 #define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */
  69
  70 /* Command flags. Please check the command table defined in the redis.c file
  71  * for more information about the meaning of every flag. */
  72 #define REDIS_CMD_WRITE 1                   /* "w" flag */
  73 #define REDIS_CMD_READONLY 2                /* "r" flag */
  74 #define REDIS_CMD_DENYOOM 4                 /* "m" flag */
  75 #define REDIS_CMD_FORCE_REPLICATION 8       /* "f" flag */
  76 #define REDIS_CMD_ADMIN 16                  /* "a" flag */
  77 #define REDIS_CMD_PUBSUB 32                 /* "p" flag */
  78 #define REDIS_CMD_NOSCRIPT  64              /* "s" flag */
  79 #define REDIS_CMD_RANDOM 128                /* "R" flag */
  80
  81 /* Object types */
  82 #define REDIS_STRING 0
  83 #define REDIS_LIST 1
  84 #define REDIS_SET 2
  85 #define REDIS_ZSET 3
  86 #define REDIS_HASH 4
  87 #define REDIS_VMPOINTER 8
  88
  89 /* Objects encoding. Some kind of objects like Strings and Hashes can be
  90  * internally represented in multiple ways. The 'encoding' field of the object
  91  * is set to one of this fields for this object. */
  92 #define REDIS_ENCODING_RAW 0     /* Raw representation */
  93 #define REDIS_ENCODING_INT 1     /* Encoded as integer */
  94 #define REDIS_ENCODING_HT 2      /* Encoded as hash table */
  95 #define REDIS_ENCODING_ZIPMAP 3  /* Encoded as zipmap */
  96 #define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
  97 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
  98 #define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
  99 #define REDIS_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
 100
 101 /* Defines related to the dump file format. To store 32 bits lengths for short
 102  * keys requires a lot of space, so we check the most significant 2 bits of
 103  * the first byte to interpreter the length:
 104  *
 105  * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
 106  * 01|000000 00000000 =>  01, the len is 14 byes, 6 bits + 8 bits of next byte
 107  * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
 108  * 11|000000 this means: specially encoded object will follow. The six bits
 109  *           number specify the kind of object that follows.
 110  *           See the REDIS_RDB_ENC_* defines.
 111  *
 112  * Lenghts up to 63 are stored using a single byte, most DB keys, and may
 113  * values, will fit inside. */
 114 #define REDIS_RDB_6BITLEN 0
 115 #define REDIS_RDB_14BITLEN 1
 116 #define REDIS_RDB_32BITLEN 2
 117 #define REDIS_RDB_ENCVAL 3
 118 #define REDIS_RDB_LENERR UINT_MAX
 119
 120 /* When a length of a string object stored on disk has the first two bits
 121  * set, the remaining two bits specify a special encoding for the object
 122  * accordingly to the following defines: */
 123 #define REDIS_RDB_ENC_INT8 0        /* 8 bit signed integer */
 124 #define REDIS_RDB_ENC_INT16 1       /* 16 bit signed integer */
 125 #define REDIS_RDB_ENC_INT32 2       /* 32 bit signed integer */
 126 #define REDIS_RDB_ENC_LZF 3         /* string compressed with FASTLZ */
 127
 128 /* AOF states */
 129 #define REDIS_AOF_OFF 0             /* AOF is off */
 130 #define REDIS_AOF_ON 1              /* AOF is on */
 131 #define REDIS_AOF_WAIT_REWRITE 2    /* AOF waits rewrite to start appending */
 132
 133 /* Client flags */
 134 #define REDIS_SLAVE 1       /* This client is a slave server */
 135 #define REDIS_MASTER 2      /* This client is a master server */
 136 #define REDIS_MONITOR 4     /* This client is a slave monitor, see MONITOR */
 137 #define REDIS_MULTI 8       /* This client is in a MULTI context */
 138 #define REDIS_BLOCKED 16    /* The client is waiting in a blocking operation */
 139 #define REDIS_DIRTY_CAS 64  /* Watched keys modified. EXEC will fail. */
 140 #define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */
 141 #define REDIS_UNBLOCKED 256 /* This client was unblocked and is stored in
 142                                server.unblocked_clients */
 143 #define REDIS_LUA_CLIENT 512 /* This is a non connected client used by Lua */
 144 #define REDIS_ASKING 1024   /* Client issued the ASKING command */
 145
 146 /* Client request types */
 147 #define REDIS_REQ_INLINE 1
 148 #define REDIS_REQ_MULTIBULK 2
 149
 150 /* Slave replication state - slave side */
 151 #define REDIS_REPL_NONE 0 /* No active replication */
 152 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
 153 #define REDIS_REPL_CONNECTING 2 /* Connecting to master */
 154 #define REDIS_REPL_TRANSFER 3 /* Receiving .rdb from master */
 155 #define REDIS_REPL_CONNECTED 4 /* Connected to master */
 156
 157 /* Synchronous read timeout - slave side */
 158 #define REDIS_REPL_SYNCIO_TIMEOUT 5
 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 AOF_FSYNC_NO 0
 194 #define AOF_FSYNC_ALWAYS 1
 195 #define AOF_FSYNC_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 /* Scripting */
 220 #define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
 221
 222 /* Units */
 223 #define UNIT_SECONDS 0
 224 #define UNIT_MILLISECONDS 1
 225
 226 /* SHUTDOWN flags */
 227 #define REDIS_SHUTDOWN_SAVE 1       /* Force SAVE on SHUTDOWN even if no save
 228                                        points are configured. */
 229 #define REDIS_SHUTDOWN_NOSAVE 2     /* Don't SAVE on SHUTDOWN. */
 230
 231 /* We can print the stacktrace, so our assert is defined this way: */
 232 #define redisAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_redisAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
 233 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
 234 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
 235
 236 /*-----------------------------------------------------------------------------
 237  * Data types
 238  *----------------------------------------------------------------------------*/
 239
 240 /* A redis object, that is a type able to hold a string / list / set */
 241
 242 /* The actual Redis Object */
 243 #define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
 244 #define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
 245 typedef struct redisObject {
 246     unsigned type:4;
 247     unsigned notused:2;     /* Not used */
 248     unsigned encoding:4;
 249     unsigned lru:22;        /* lru time (relative to server.lruclock) */
 250     int refcount;
 251     void *ptr;
 252 } robj;
 253
 254 /* Macro used to initalize a Redis object allocated on the stack.
 255  * Note that this macro is taken near the structure definition to make sure
 256  * we'll update it when the structure is changed, to avoid bugs like
 257  * bug #85 introduced exactly in this way. */
 258 #define initStaticStringObject(_var,_ptr) do { \
 259     _var.refcount = 1; \
 260     _var.type = REDIS_STRING; \
 261     _var.encoding = REDIS_ENCODING_RAW; \
 262     _var.ptr = _ptr; \
 263 } while(0);
 264
 265 typedef struct redisDb {
 266     dict *dict;                 /* The keyspace for this DB */
 267     dict *expires;              /* Timeout of keys with a timeout set */
 268     dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP) */
 269     dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
 270     int id;
 271 } redisDb;
 272
 273 /* Client MULTI/EXEC state */
 274 typedef struct multiCmd {
 275     robj **argv;
 276     int argc;
 277     struct redisCommand *cmd;
 278 } multiCmd;
 279
 280 typedef struct multiState {
 281     multiCmd *commands;     /* Array of MULTI commands */
 282     int count;              /* Total number of MULTI commands */
 283 } multiState;
 284
 285 typedef struct blockingState {
 286     robj **keys;            /* The key we are waiting to terminate a blocking
 287                              * operation such as BLPOP. Otherwise NULL. */
 288     int count;              /* Number of blocking keys */
 289     time_t timeout;         /* Blocking operation timeout. If UNIX current time
 290                              * is >= timeout then the operation timed out. */
 291     robj *target;           /* The key that should receive the element,
 292                              * for BRPOPLPUSH. */
 293 } blockingState;
 294
 295 /* With multiplexing we need to take per-clinet state.
 296  * Clients are taken in a liked list. */
 297 typedef struct redisClient {
 298     int fd;
 299     redisDb *db;
 300     int dictid;
 301     sds querybuf;
 302     int argc;
 303     robj **argv;
 304     struct redisCommand *cmd, *lastcmd;
 305     int reqtype;
 306     int multibulklen;       /* number of multi bulk arguments left to read */
 307     long bulklen;           /* length of bulk argument in multi bulk request */
 308     list *reply;
 309     int sentlen;
 310     time_t lastinteraction; /* time of the last interaction, used for timeout */
 311     int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
 312     int slaveseldb;         /* slave selected db, if this client is a slave */
 313     int authenticated;      /* when requirepass is non-NULL */
 314     int replstate;          /* replication state if this is a slave */
 315     int repldbfd;           /* replication DB file descriptor */
 316     long repldboff;         /* replication DB file offset */
 317     off_t repldbsize;       /* replication DB file size */
 318     multiState mstate;      /* MULTI/EXEC state */
 319     blockingState bpop;   /* blocking state */
 320     list *io_keys;          /* Keys this client is waiting to be loaded from the
 321                              * swap file in order to continue. */
 322     list *watched_keys;     /* Keys WATCHED for MULTI/EXEC CAS */
 323     dict *pubsub_channels;  /* channels a client is interested in (SUBSCRIBE) */
 324     list *pubsub_patterns;  /* patterns a client is interested in (SUBSCRIBE) */
 325
 326     /* Response buffer */
 327     int bufpos;
 328     char buf[REDIS_REPLY_CHUNK_BYTES];
 329 } redisClient;
 330
 331 struct saveparam {
 332     time_t seconds;
 333     int changes;
 334 };
 335
 336 struct sharedObjectsStruct {
 337     robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
 338     *colon, *nullbulk, *nullmultibulk, *queued,
 339     *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
 340     *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *plus,
 341     *select0, *select1, *select2, *select3, *select4,
 342     *select5, *select6, *select7, *select8, *select9,
 343     *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
 344     *mbulk4, *psubscribebulk, *punsubscribebulk,
 345     *integers[REDIS_SHARED_INTEGERS];
 346 };
 347
 348 /* ZSETs use a specialized version of Skiplists */
 349 typedef struct zskiplistNode {
 350     robj *obj;
 351     double score;
 352     struct zskiplistNode *backward;
 353     struct zskiplistLevel {
 354         struct zskiplistNode *forward;
 355         unsigned int span;
 356     } level[];
 357 } zskiplistNode;
 358
 359 typedef struct zskiplist {
 360     struct zskiplistNode *header, *tail;
 361     unsigned long length;
 362     int level;
 363 } zskiplist;
 364
 365 typedef struct zset {
 366     dict *dict;
 367     zskiplist *zsl;
 368 } zset;
 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     zskiplist *slots_to_keys;
 429 } clusterState;
 430
 431 /* Redis cluster messages header */
 432
 433 /* Note that the PING, PONG and MEET messages are actually the same exact
 434  * kind of packet. PONG is the reply to ping, in the extact format as a PING,
 435  * while MEET is a special PING that forces the receiver to add the sender
 436  * as a node (if it is not already in the list). */
 437 #define CLUSTERMSG_TYPE_PING 0          /* Ping */
 438 #define CLUSTERMSG_TYPE_PONG 1          /* Pong (reply to Ping) */
 439 #define CLUSTERMSG_TYPE_MEET 2          /* Meet "let's join" message */
 440 #define CLUSTERMSG_TYPE_FAIL 3          /* Mark node xxx as failing */
 441 #define CLUSTERMSG_TYPE_PUBLISH 4       /* Pub/Sub Publish propatagion */
 442
 443 /* Initially we don't know our "name", but we'll find it once we connect
 444  * to the first node, using the getsockname() function. Then we'll use this
 445  * address for all the next messages. */
 446 typedef struct {
 447     char nodename[REDIS_CLUSTER_NAMELEN];
 448     uint32_t ping_sent;
 449     uint32_t pong_received;
 450     char ip[16];    /* IP address last time it was seen */
 451     uint16_t port;  /* port last time it was seen */
 452     uint16_t flags;
 453     uint32_t notused; /* for 64 bit alignment */
 454 } clusterMsgDataGossip;
 455
 456 typedef struct {
 457     char nodename[REDIS_CLUSTER_NAMELEN];
 458 } clusterMsgDataFail;
 459
 460 typedef struct {
 461     uint32_t channel_len;
 462     uint32_t message_len;
 463     unsigned char bulk_data[8]; /* defined as 8 just for alignment concerns. */
 464 } clusterMsgDataPublish;
 465
 466 union clusterMsgData {
 467     /* PING, MEET and PONG */
 468     struct {
 469         /* Array of N clusterMsgDataGossip structures */
 470         clusterMsgDataGossip gossip[1];
 471     } ping;
 472
 473     /* FAIL */
 474     struct {
 475         clusterMsgDataFail about;
 476     } fail;
 477
 478     /* PUBLISH */
 479     struct {
 480         clusterMsgDataPublish msg;
 481     } publish;
 482 };
 483
 484 typedef struct {
 485     uint32_t totlen;    /* Total length of this message */
 486     uint16_t type;      /* Message type */
 487     uint16_t count;     /* Only used for some kind of messages. */
 488     char sender[REDIS_CLUSTER_NAMELEN]; /* Name of the sender node */
 489     unsigned char myslots[REDIS_CLUSTER_SLOTS/8];
 490     char slaveof[REDIS_CLUSTER_NAMELEN];
 491     char configdigest[32];
 492     uint16_t port;      /* Sender TCP base port */
 493     unsigned char state; /* Cluster state from the POV of the sender */
 494     unsigned char notused[5]; /* Reserved for future use. For alignment. */
 495     union clusterMsgData data;
 496 } clusterMsg;
 497
 498 /*-----------------------------------------------------------------------------
 499  * Global server state
 500  *----------------------------------------------------------------------------*/
 501
 502 struct redisServer {
 503     /* General */
 504     redisDb *db;
 505     dict *commands;             /* Command table hahs table */
 506     aeEventLoop *el;
 507     unsigned lruclock:22;       /* Clock incrementing every minute, for LRU */
 508     unsigned lruclock_padding:10;
 509     int shutdown_asap;          /* SHUTDOWN needed ASAP */
 510     int activerehashing;        /* Incremental rehash in serverCron() */
 511     char *requirepass;          /* Pass for AUTH command, or NULL */
 512     char *pidfile;              /* PID file path */
 513     /* Networking */
 514     int port;                   /* TCP listening port */
 515     char *bindaddr;             /* Bind address or NULL */
 516     char *unixsocket;           /* UNIX socket path */
 517     mode_t unixsocketperm;      /* UNIX socket permission */
 518     int ipfd;                   /* TCP socket file descriptor */
 519     int sofd;                   /* Unix socket file descriptor */
 520     int cfd;                    /* Cluster bus lisetning socket */
 521     list *clients;              /* List of active clients */
 522     list *slaves, *monitors;    /* List of slaves and MONITORs */
 523     redisClient *current_client; /* Current client, only used on crash report */
 524     char neterr[ANET_ERR_LEN];  /* Error buffer for anet.c */
 525     /* RDB / AOF loading information */
 526     int loading;                /* We are loading data from disk if true */
 527     off_t loading_total_bytes;
 528     off_t loading_loaded_bytes;
 529     time_t loading_start_time;
 530     /* Fast pointers to often looked up command */
 531     struct redisCommand *delCommand, *multiCommand;
 532     int cronloops;                  /* Number of times the cron function run */
 533     time_t lastsave;                /* Unix time of last save succeeede */
 534     /* Fields used only for stats */
 535     time_t stat_starttime;          /* Server start time */
 536     long long stat_numcommands;     /* Number of processed commands */
 537     long long stat_numconnections;  /* Number of connections received */
 538     long long stat_expiredkeys;     /* Number of expired keys */
 539     long long stat_evictedkeys;     /* Number of evicted keys (maxmemory) */
 540     long long stat_keyspace_hits;   /* Number of successful lookups of keys */
 541     long long stat_keyspace_misses; /* Number of failed lookups of keys */
 542     size_t stat_peak_memory;        /* Max used memory record */
 543     long long stat_fork_time;       /* Time needed to perform latets fork() */
 544     long long stat_rejected_conn;   /* Clients rejected because of maxclients */
 545     list *slowlog;                  /* SLOWLOG list of commands */
 546     long long slowlog_entry_id;     /* SLOWLOG current entry ID */
 547     long long slowlog_log_slower_than; /* SLOWLOG time limit (to get logged) */
 548     unsigned long slowlog_max_len;     /* SLOWLOG max number of items logged */
 549     /* Configuration */
 550     int verbosity;                  /* Loglevel in redis.conf */
 551     int maxidletime;                /* Client timeout in seconds */
 552     size_t client_max_querybuf_len; /* Limit for client query buffer length */
 553     int dbnum;                      /* Total number of configured DBs */
 554     int daemonize;                  /* True if running as a daemon */
 555     /* AOF persistence */
 556     int aof_state;                  /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
 557     int aof_fsync;                  /* Kind of fsync() policy */
 558     char *aof_filename;             /* Name of the AOF file */
 559     int aof_no_fsync_on_rewrite;    /* Don't fsync if a rewrite is in prog. */
 560     int aof_rewrite_perc;           /* Rewrite AOF if % growth is > M and... */
 561     off_t aof_rewrite_min_size;     /* the AOF file is at least N bytes. */
 562     off_t aof_rewrite_base_size;    /* AOF size on latest startup or rewrite. */
 563     off_t aof_current_size;         /* AOF current size. */
 564     int aof_rewrite_scheduled;      /* Rewrite once BGSAVE terminates. */
 565     pid_t aof_child_pid;            /* PID if rewriting process */
 566     sds aof_rewrite_buf; /* buffer taken by parent during oppend only rewrite */
 567     sds aof_buf;      /* AOF buffer, written before entering the event loop */
 568     int aof_fd;       /* File descriptor of currently selected AOF file */
 569     int aof_selected_db; /* Currently selected DB in AOF */
 570     time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
 571     time_t aof_last_fsync;            /* UNIX time of last fsync() */
 572     /* RDB persistence */
 573     long long dirty;                /* Changes to DB from the last save */
 574     long long dirty_before_bgsave;  /* Used to restore dirty on failed BGSAVE */
 575     pid_t rdb_child_pid;            /* PID of RDB saving child */
 576     struct saveparam *saveparams;   /* Save points array for RDB */
 577     int saveparamslen;              /* Number of saving points */
 578     char *rdb_filename;             /* Name of RDB file */
 579     int rdb_compression;            /* Use compression in RDB? */
 580     /* Logging */
 581     char *logfile;                  /* Path of log file */
 582     int syslog_enabled;             /* Is syslog enabled? */
 583     char *syslog_ident;             /* Syslog ident */
 584     int syslog_facility;            /* Syslog facility */
 585     /* Slave specific fields */
 586     char *masterauth;               /* AUTH with this password with master */
 587     char *masterhost;               /* Hostname of master */
 588     int masterport;                 /* Port of master */
 589     int repl_ping_slave_period;     /* Master pings the salve every N seconds */
 590     int repl_timeout;               /* Timeout after N seconds of master idle */
 591     redisClient *master;     /* Client that is master for this slave */
 592     int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
 593     int repl_state;          /* Replication status if the instance is a slave */
 594     off_t repl_transfer_left;  /* Bytes left reading .rdb  */
 595     int repl_transfer_s;     /* Slave -> Master SYNC socket */
 596     int repl_transfer_fd;    /* Slave -> Master SYNC temp file descriptor */
 597     char *repl_transfer_tmpfile; /* Slave-> master SYNC temp file name */
 598     time_t repl_transfer_lastio; /* Unix time of the latest read, for timeout */
 599     int repl_serve_stale_data; /* Serve stale data when link is down? */
 600     time_t repl_down_since; /* Unix time at which link with master went down */
 601     /* Limits */
 602     unsigned int maxclients;        /* Max number of simultaneous clients */
 603     unsigned long long maxmemory;   /* Max number of memory bytes to use */
 604     int maxmemory_policy;           /* Policy for key evition */
 605     int maxmemory_samples;          /* Pricision of random sampling */
 606     /* Blocked clients */
 607     unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */
 608     list *unblocked_clients; /* list of clients to unblock before next loop */
 609     /* Sort parameters - qsort_r() is only available under BSD so we
 610      * have to take this state global, in order to pass it to sortCompare() */
 611     int sort_desc;
 612     int sort_alpha;
 613     int sort_bypattern;
 614     /* Zip structure config, see redis.conf for more information  */
 615     size_t hash_max_zipmap_entries;
 616     size_t hash_max_zipmap_value;
 617     size_t list_max_ziplist_entries;
 618     size_t list_max_ziplist_value;
 619     size_t set_max_intset_entries;
 620     size_t zset_max_ziplist_entries;
 621     size_t zset_max_ziplist_value;
 622     time_t unixtime;        /* Unix time sampled every second. */
 623     /* Pubsub */
 624     dict *pubsub_channels;  /* Map channels to list of subscribed clients */
 625     list *pubsub_patterns;  /* A list of pubsub_patterns */
 626     /* Cluster */
 627     int cluster_enabled;    /* Is cluster enabled? */
 628     clusterState cluster;   /* State of the cluster */
 629     /* Scripting */
 630     lua_State *lua; /* The Lua interpreter. We use just one for all clients */
 631     redisClient *lua_client;   /* The "fake client" to query Redis from Lua */
 632     redisClient *lua_caller;   /* The client running EVAL right now, or NULL */
 633     dict *lua_scripts;         /* A dictionary of SHA1 -> Lua scripts */
 634     long long lua_time_limit;  /* Script timeout in seconds */
 635     long long lua_time_start;  /* Start time of script */
 636     int lua_write_dirty;  /* True if a write command was called during the
 637                              execution of the current script. */
 638     int lua_random_dirty; /* True if a random command was called during the
 639                              execution of the current script. */
 640     int lua_timedout;     /* True if we reached the time limit for script
 641                              execution. */
 642     int lua_kill;         /* Kill the script if true. */
 643     /* Assert & bug reportign */
 644     char *assert_failed;
 645     char *assert_file;
 646     int assert_line;
 647     int bug_report_start; /* True if bug report header was already logged. */
 648 };
 649
 650 typedef struct pubsubPattern {
 651     redisClient *client;
 652     robj *pattern;
 653 } pubsubPattern;
 654
 655 typedef void redisCommandProc(redisClient *c);
 656 typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
 657 struct redisCommand {
 658     char *name;
 659     redisCommandProc *proc;
 660     int arity;
 661     char *sflags; /* Flags as string represenation, one char per flag. */
 662     int flags;    /* The actual flags, obtained from the 'sflags' field. */
 663     /* Use a function to determine keys arguments in a command line.
 664      * Used for Redis Cluster redirect. */
 665     redisGetKeysProc *getkeys_proc;
 666     /* What keys should be loaded in background when calling this command? */
 667     int firstkey; /* The first argument that's a key (0 = no keys) */
 668     int lastkey;  /* THe last argument that's a key */
 669     int keystep;  /* The step between first and last key */
 670     long long microseconds, calls;
 671 };
 672
 673 struct redisFunctionSym {
 674     char *name;
 675     unsigned long pointer;
 676 };
 677
 678 typedef struct _redisSortObject {
 679     robj *obj;
 680     union {
 681         double score;
 682         robj *cmpobj;
 683     } u;
 684 } redisSortObject;
 685
 686 typedef struct _redisSortOperation {
 687     int type;
 688     robj *pattern;
 689 } redisSortOperation;
 690
 691 /* Structure to hold list iteration abstraction. */
 692 typedef struct {
 693     robj *subject;
 694     unsigned char encoding;
 695     unsigned char direction; /* Iteration direction */
 696     unsigned char *zi;
 697     listNode *ln;
 698 } listTypeIterator;
 699
 700 /* Structure for an entry while iterating over a list. */
 701 typedef struct {
 702     listTypeIterator *li;
 703     unsigned char *zi;  /* Entry in ziplist */
 704     listNode *ln;       /* Entry in linked list */
 705 } listTypeEntry;
 706
 707 /* Structure to hold set iteration abstraction. */
 708 typedef struct {
 709     robj *subject;
 710     int encoding;
 711     int ii; /* intset iterator */
 712     dictIterator *di;
 713 } setTypeIterator;
 714
 715 /* Structure to hold hash iteration abstration. Note that iteration over
 716  * hashes involves both fields and values. Because it is possible that
 717  * not both are required, store pointers in the iterator to avoid
 718  * unnecessary memory allocation for fields/values. */
 719 typedef struct {
 720     int encoding;
 721     unsigned char *zi;
 722     unsigned char *zk, *zv;
 723     unsigned int zklen, zvlen;
 724
 725     dictIterator *di;
 726     dictEntry *de;
 727 } hashTypeIterator;
 728
 729 #define REDIS_HASH_KEY 1
 730 #define REDIS_HASH_VALUE 2
 731
 732 /*-----------------------------------------------------------------------------
 733  * Extern declarations
 734  *----------------------------------------------------------------------------*/
 735
 736 extern struct redisServer server;
 737 extern struct sharedObjectsStruct shared;
 738 extern dictType setDictType;
 739 extern dictType zsetDictType;
 740 extern dictType clusterNodesDictType;
 741 extern dictType dbDictType;
 742 extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
 743 dictType hashDictType;
 744
 745 /*-----------------------------------------------------------------------------
 746  * Functions prototypes
 747  *----------------------------------------------------------------------------*/
 748
 749 /* Utils */
 750 long long ustime(void);
 751 long long mstime(void);
 752
 753 /* networking.c -- Networking and Client related operations */
 754 redisClient *createClient(int fd);
 755 void closeTimedoutClients(void);
 756 void freeClient(redisClient *c);
 757 void resetClient(redisClient *c);
 758 void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
 759 void addReply(redisClient *c, robj *obj);
 760 void *addDeferredMultiBulkLength(redisClient *c);
 761 void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
 762 void addReplySds(redisClient *c, sds s);
 763 void processInputBuffer(redisClient *c);
 764 void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 765 void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 766 void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
 767 void addReplyBulk(redisClient *c, robj *obj);
 768 void addReplyBulkCString(redisClient *c, char *s);
 769 void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
 770 void addReplyBulkLongLong(redisClient *c, long long ll);
 771 void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 772 void addReply(redisClient *c, robj *obj);
 773 void addReplySds(redisClient *c, sds s);
 774 void addReplyError(redisClient *c, char *err);
 775 void addReplyStatus(redisClient *c, char *status);
 776 void addReplyDouble(redisClient *c, double d);
 777 void addReplyLongLong(redisClient *c, long long ll);
 778 void addReplyMultiBulkLen(redisClient *c, long length);
 779 void copyClientOutputBuffer(redisClient *dst, redisClient *src);
 780 void *dupClientReplyValue(void *o);
 781 void getClientsMaxBuffers(unsigned long *longest_output_list,
 782                           unsigned long *biggest_input_buffer);
 783 sds getClientInfoString(redisClient *client);
 784 sds getAllClientsInfoString(void);
 785 void rewriteClientCommandVector(redisClient *c, int argc, ...);
 786 void rewriteClientCommandArgument(redisClient *c, int i, robj *newval);
 787
 788 #ifdef __GNUC__
 789 void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
 790     __attribute__((format(printf, 2, 3)));
 791 void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
 792     __attribute__((format(printf, 2, 3)));
 793 #else
 794 void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
 795 void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
 796 #endif
 797
 798 /* List data type */
 799 void listTypeTryConversion(robj *subject, robj *value);
 800 void listTypePush(robj *subject, robj *value, int where);
 801 robj *listTypePop(robj *subject, int where);
 802 unsigned long listTypeLength(robj *subject);
 803 listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction);
 804 void listTypeReleaseIterator(listTypeIterator *li);
 805 int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
 806 robj *listTypeGet(listTypeEntry *entry);
 807 void listTypeInsert(listTypeEntry *entry, robj *value, int where);
 808 int listTypeEqual(listTypeEntry *entry, robj *o);
 809 void listTypeDelete(listTypeEntry *entry);
 810 void listTypeConvert(robj *subject, int enc);
 811 void unblockClientWaitingData(redisClient *c);
 812 int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
 813 void popGenericCommand(redisClient *c, int where);
 814
 815 /* MULTI/EXEC/WATCH... */
 816 void unwatchAllKeys(redisClient *c);
 817 void initClientMultiState(redisClient *c);
 818 void freeClientMultiState(redisClient *c);
 819 void queueMultiCommand(redisClient *c);
 820 void touchWatchedKey(redisDb *db, robj *key);
 821 void touchWatchedKeysOnFlush(int dbid);
 822
 823 /* Redis object implementation */
 824 void decrRefCount(void *o);
 825 void incrRefCount(robj *o);
 826 robj *resetRefCount(robj *obj);
 827 void freeStringObject(robj *o);
 828 void freeListObject(robj *o);
 829 void freeSetObject(robj *o);
 830 void freeZsetObject(robj *o);
 831 void freeHashObject(robj *o);
 832 robj *createObject(int type, void *ptr);
 833 robj *createStringObject(char *ptr, size_t len);
 834 robj *dupStringObject(robj *o);
 835 int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
 836 robj *tryObjectEncoding(robj *o);
 837 robj *getDecodedObject(robj *o);
 838 size_t stringObjectLen(robj *o);
 839 robj *createStringObjectFromLongLong(long long value);
 840 robj *createStringObjectFromLongDouble(long double value);
 841 robj *createListObject(void);
 842 robj *createZiplistObject(void);
 843 robj *createSetObject(void);
 844 robj *createIntsetObject(void);
 845 robj *createHashObject(void);
 846 robj *createZsetObject(void);
 847 robj *createZsetZiplistObject(void);
 848 int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
 849 int checkType(redisClient *c, robj *o, int type);
 850 int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
 851 int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
 852 int getLongLongFromObject(robj *o, long long *target);
 853 int getLongDoubleFromObject(robj *o, long double *target);
 854 int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
 855 char *strEncoding(int encoding);
 856 int compareStringObjects(robj *a, robj *b);
 857 int equalStringObjects(robj *a, robj *b);
 858 unsigned long estimateObjectIdleTime(robj *o);
 859
 860 /* Synchronous I/O with timeout */
 861 int syncWrite(int fd, char *ptr, ssize_t size, int timeout);
 862 int syncRead(int fd, char *ptr, ssize_t size, int timeout);
 863 int syncReadLine(int fd, char *ptr, ssize_t size, int timeout);
 864
 865 /* Replication */
 866 void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
 867 void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
 868 void updateSlavesWaitingBgsave(int bgsaveerr);
 869 void replicationCron(void);
 870
 871 /* Generic persistence functions */
 872 void startLoading(FILE *fp);
 873 void loadingProgress(off_t pos);
 874 void stopLoading(void);
 875
 876 /* RDB persistence */
 877 #include "rdb.h"
 878
 879 /* AOF persistence */
 880 void flushAppendOnlyFile(int force);
 881 void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
 882 void aofRemoveTempFile(pid_t childpid);
 883 int rewriteAppendOnlyFileBackground(void);
 884 int loadAppendOnlyFile(char *filename);
 885 void stopAppendOnly(void);
 886 int startAppendOnly(void);
 887 void backgroundRewriteDoneHandler(int exitcode, int bysignal);
 888
 889 /* Sorted sets data type */
 890
 891 /* Struct to hold a inclusive/exclusive range spec. */
 892 typedef struct {
 893     double min, max;
 894     int minex, maxex; /* are min or max exclusive? */
 895 } zrangespec;
 896
 897 zskiplist *zslCreate(void);
 898 void zslFree(zskiplist *zsl);
 899 zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
 900 unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
 901 int zslDelete(zskiplist *zsl, double score, robj *obj);
 902 zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
 903 double zzlGetScore(unsigned char *sptr);
 904 void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
 905 void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
 906 unsigned int zsetLength(robj *zobj);
 907 void zsetConvert(robj *zobj, int encoding);
 908
 909 /* Core functions */
 910 void freeMemoryIfNeeded(void);
 911 int processCommand(redisClient *c);
 912 void setupSignalHandlers(void);
 913 struct redisCommand *lookupCommand(sds name);
 914 struct redisCommand *lookupCommandByCString(char *s);
 915 void call(redisClient *c);
 916 int prepareForShutdown();
 917 void redisLog(int level, const char *fmt, ...);
 918 void redisLogRaw(int level, const char *msg);
 919 void usage();
 920 void updateDictResizePolicy(void);
 921 int htNeedsResize(dict *dict);
 922 void oom(const char *msg);
 923 void populateCommandTable(void);
 924 void resetCommandTableStats(void);
 925
 926 /* Set data type */
 927 robj *setTypeCreate(robj *value);
 928 int setTypeAdd(robj *subject, robj *value);
 929 int setTypeRemove(robj *subject, robj *value);
 930 int setTypeIsMember(robj *subject, robj *value);
 931 setTypeIterator *setTypeInitIterator(robj *subject);
 932 void setTypeReleaseIterator(setTypeIterator *si);
 933 int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
 934 robj *setTypeNextObject(setTypeIterator *si);
 935 int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
 936 unsigned long setTypeSize(robj *subject);
 937 void setTypeConvert(robj *subject, int enc);
 938
 939 /* Hash data type */
 940 void convertToRealHash(robj *o);
 941 void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
 942 void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
 943 int hashTypeGet(robj *o, robj *key, robj **objval, unsigned char **v, unsigned int *vlen);
 944 robj *hashTypeGetObject(robj *o, robj *key);
 945 int hashTypeExists(robj *o, robj *key);
 946 int hashTypeSet(robj *o, robj *key, robj *value);
 947 int hashTypeDelete(robj *o, robj *key);
 948 unsigned long hashTypeLength(robj *o);
 949 hashTypeIterator *hashTypeInitIterator(robj *subject);
 950 void hashTypeReleaseIterator(hashTypeIterator *hi);
 951 int hashTypeNext(hashTypeIterator *hi);
 952 int hashTypeCurrent(hashTypeIterator *hi, int what, robj **objval, unsigned char **v, unsigned int *vlen);
 953 robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
 954 robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
 955
 956 /* Pub / Sub */
 957 int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
 958 int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
 959 void freePubsubPattern(void *p);
 960 int listMatchPubsubPattern(void *a, void *b);
 961 int pubsubPublishMessage(robj *channel, robj *message);
 962
 963 /* Configuration */
 964 void loadServerConfig(char *filename, char *options);
 965 void appendServerSaveParams(time_t seconds, int changes);
 966 void resetServerSaveParams();
 967
 968 /* db.c -- Keyspace access API */
 969 int removeExpire(redisDb *db, robj *key);
 970 void propagateExpire(redisDb *db, robj *key);
 971 int expireIfNeeded(redisDb *db, robj *key);
 972 long long getExpire(redisDb *db, robj *key);
 973 void setExpire(redisDb *db, robj *key, long long when);
 974 robj *lookupKey(redisDb *db, robj *key);
 975 robj *lookupKeyRead(redisDb *db, robj *key);
 976 robj *lookupKeyWrite(redisDb *db, robj *key);
 977 robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
 978 robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
 979 void dbAdd(redisDb *db, robj *key, robj *val);
 980 void dbOverwrite(redisDb *db, robj *key, robj *val);
 981 void setKey(redisDb *db, robj *key, robj *val);
 982 int dbExists(redisDb *db, robj *key);
 983 robj *dbRandomKey(redisDb *db);
 984 int dbDelete(redisDb *db, robj *key);
 985 long long emptyDb();
 986 int selectDb(redisClient *c, int id);
 987 void signalModifiedKey(redisDb *db, robj *key);
 988 void signalFlushedDb(int dbid);
 989 unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
 990
 991 /* API to get key arguments from commands */
 992 #define REDIS_GETKEYS_ALL 0
 993 #define REDIS_GETKEYS_PRELOAD 1
 994 int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
 995 void getKeysFreeResult(int *result);
 996 int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
 997 int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
 998 int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
 999
1000 /* Cluster */
1001 void clusterInit(void);
1002 unsigned short crc16(const char *buf, int len);
1003 unsigned int keyHashSlot(char *key, int keylen);
1004 clusterNode *createClusterNode(char *nodename, int flags);
1005 int clusterAddNode(clusterNode *node);
1006 void clusterCron(void);
1007 clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask);
1008 void clusterPropagatePublish(robj *channel, robj *message);
1009
1010 /* Scripting */
1011 void scriptingInit(void);
1012
1013 /* Git SHA1 */
1014 char *redisGitSHA1(void);
1015 char *redisGitDirty(void);
1016
1017 /* Commands prototypes */
1018 void authCommand(redisClient *c);
1019 void pingCommand(redisClient *c);
1020 void echoCommand(redisClient *c);
1021 void setCommand(redisClient *c);
1022 void setnxCommand(redisClient *c);
1023 void setexCommand(redisClient *c);
1024 void psetexCommand(redisClient *c);
1025 void getCommand(redisClient *c);
1026 void delCommand(redisClient *c);
1027 void existsCommand(redisClient *c);
1028 void setbitCommand(redisClient *c);
1029 void getbitCommand(redisClient *c);
1030 void setrangeCommand(redisClient *c);
1031 void getrangeCommand(redisClient *c);
1032 void incrCommand(redisClient *c);
1033 void decrCommand(redisClient *c);
1034 void incrbyCommand(redisClient *c);
1035 void decrbyCommand(redisClient *c);
1036 void incrbyfloatCommand(redisClient *c);
1037 void selectCommand(redisClient *c);
1038 void randomkeyCommand(redisClient *c);
1039 void keysCommand(redisClient *c);
1040 void dbsizeCommand(redisClient *c);
1041 void lastsaveCommand(redisClient *c);
1042 void saveCommand(redisClient *c);
1043 void bgsaveCommand(redisClient *c);
1044 void bgrewriteaofCommand(redisClient *c);
1045 void shutdownCommand(redisClient *c);
1046 void moveCommand(redisClient *c);
1047 void renameCommand(redisClient *c);
1048 void renamenxCommand(redisClient *c);
1049 void lpushCommand(redisClient *c);
1050 void rpushCommand(redisClient *c);
1051 void lpushxCommand(redisClient *c);
1052 void rpushxCommand(redisClient *c);
1053 void linsertCommand(redisClient *c);
1054 void lpopCommand(redisClient *c);
1055 void rpopCommand(redisClient *c);
1056 void llenCommand(redisClient *c);
1057 void lindexCommand(redisClient *c);
1058 void lrangeCommand(redisClient *c);
1059 void ltrimCommand(redisClient *c);
1060 void typeCommand(redisClient *c);
1061 void lsetCommand(redisClient *c);
1062 void saddCommand(redisClient *c);
1063 void sremCommand(redisClient *c);
1064 void smoveCommand(redisClient *c);
1065 void sismemberCommand(redisClient *c);
1066 void scardCommand(redisClient *c);
1067 void spopCommand(redisClient *c);
1068 void srandmemberCommand(redisClient *c);
1069 void sinterCommand(redisClient *c);
1070 void sinterstoreCommand(redisClient *c);
1071 void sunionCommand(redisClient *c);
1072 void sunionstoreCommand(redisClient *c);
1073 void sdiffCommand(redisClient *c);
1074 void sdiffstoreCommand(redisClient *c);
1075 void syncCommand(redisClient *c);
1076 void flushdbCommand(redisClient *c);
1077 void flushallCommand(redisClient *c);
1078 void sortCommand(redisClient *c);
1079 void lremCommand(redisClient *c);
1080 void rpoplpushCommand(redisClient *c);
1081 void infoCommand(redisClient *c);
1082 void mgetCommand(redisClient *c);
1083 void monitorCommand(redisClient *c);
1084 void expireCommand(redisClient *c);
1085 void expireatCommand(redisClient *c);
1086 void pexpireCommand(redisClient *c);
1087 void pexpireatCommand(redisClient *c);
1088 void getsetCommand(redisClient *c);
1089 void ttlCommand(redisClient *c);
1090 void pttlCommand(redisClient *c);
1091 void persistCommand(redisClient *c);
1092 void slaveofCommand(redisClient *c);
1093 void debugCommand(redisClient *c);
1094 void msetCommand(redisClient *c);
1095 void msetnxCommand(redisClient *c);
1096 void zaddCommand(redisClient *c);
1097 void zincrbyCommand(redisClient *c);
1098 void zrangeCommand(redisClient *c);
1099 void zrangebyscoreCommand(redisClient *c);
1100 void zrevrangebyscoreCommand(redisClient *c);
1101 void zcountCommand(redisClient *c);
1102 void zrevrangeCommand(redisClient *c);
1103 void zcardCommand(redisClient *c);
1104 void zremCommand(redisClient *c);
1105 void zscoreCommand(redisClient *c);
1106 void zremrangebyscoreCommand(redisClient *c);
1107 void multiCommand(redisClient *c);
1108 void execCommand(redisClient *c);
1109 void discardCommand(redisClient *c);
1110 void blpopCommand(redisClient *c);
1111 void brpopCommand(redisClient *c);
1112 void brpoplpushCommand(redisClient *c);
1113 void appendCommand(redisClient *c);
1114 void strlenCommand(redisClient *c);
1115 void zrankCommand(redisClient *c);
1116 void zrevrankCommand(redisClient *c);
1117 void hsetCommand(redisClient *c);
1118 void hsetnxCommand(redisClient *c);
1119 void hgetCommand(redisClient *c);
1120 void hmsetCommand(redisClient *c);
1121 void hmgetCommand(redisClient *c);
1122 void hdelCommand(redisClient *c);
1123 void hlenCommand(redisClient *c);
1124 void zremrangebyrankCommand(redisClient *c);
1125 void zunionstoreCommand(redisClient *c);
1126 void zinterstoreCommand(redisClient *c);
1127 void hkeysCommand(redisClient *c);
1128 void hvalsCommand(redisClient *c);
1129 void hgetallCommand(redisClient *c);
1130 void hexistsCommand(redisClient *c);
1131 void configCommand(redisClient *c);
1132 void hincrbyCommand(redisClient *c);
1133 void hincrbyfloatCommand(redisClient *c);
1134 void subscribeCommand(redisClient *c);
1135 void unsubscribeCommand(redisClient *c);
1136 void psubscribeCommand(redisClient *c);
1137 void punsubscribeCommand(redisClient *c);
1138 void publishCommand(redisClient *c);
1139 void watchCommand(redisClient *c);
1140 void unwatchCommand(redisClient *c);
1141 void clusterCommand(redisClient *c);
1142 void restoreCommand(redisClient *c);
1143 void migrateCommand(redisClient *c);
1144 void askingCommand(redisClient *c);
1145 void dumpCommand(redisClient *c);
1146 void objectCommand(redisClient *c);
1147 void clientCommand(redisClient *c);
1148 void evalCommand(redisClient *c);
1149 void evalShaCommand(redisClient *c);
1150 void scriptCommand(redisClient *c);
1151
1152 #if defined(__GNUC__)
1153 void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1154 void free(void *ptr) __attribute__ ((deprecated));
1155 void *malloc(size_t size) __attribute__ ((deprecated));
1156 void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1157 #endif
1158
1159 /* Debugging stuff */
1160 void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1161 void _redisAssert(char *estr, char *file, int line);
1162 void _redisPanic(char *msg, char *file, int line);
1163 void bugReportStart(void);
1164 void redisLogObjectDebugInfo(robj *o);
1165 void sigsegvHandler(int sig, siginfo_t *info, void *secret);
1166 sds genRedisInfoString(char *section);
1167 #endif