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