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
  21 #include "ae.h"     /* Event driven programming library */
  22 #include "sds.h"    /* Dynamic safe strings */
  23 #include "dict.h"   /* Hash tables */
  24 #include "adlist.h" /* Linked lists */
  25 #include "zmalloc.h" /* total memory usage aware version of malloc/free */
  26 #include "anet.h"   /* Networking the easy way */
  27 #include "zipmap.h" /* Compact string -> string data structure */
  28 #include "ziplist.h" /* Compact list data structure */
  29 #include "intset.h" /* Compact integer set structure */
  30 #include "version.h"
  31
  32 /* Error codes */
  33 #define REDIS_OK                0
  34 #define REDIS_ERR               -1
  35
  36 /* Static server configuration */
  37 #define REDIS_SERVERPORT        6379    /* TCP port */
  38 #define REDIS_MAXIDLETIME       (60*5)  /* default client timeout */
  39 #define REDIS_IOBUF_LEN         1024
  40 #define REDIS_LOADBUF_LEN       1024
  41 #define REDIS_STATIC_ARGS       8
  42 #define REDIS_DEFAULT_DBNUM     16
  43 #define REDIS_CONFIGLINE_MAX    1024
  44 #define REDIS_MAX_SYNC_TIME     60      /* Slave can't take more to sync */
  45 #define REDIS_EXPIRELOOKUPS_PER_CRON    10 /* lookup 10 expires per loop */
  46 #define REDIS_MAX_WRITE_PER_EVENT (1024*64)
  47 #define REDIS_REQUEST_MAX_SIZE (1024*1024*256) /* max bytes in inline command */
  48 #define REDIS_SHARED_INTEGERS 10000
  49 #define REDIS_REPLY_CHUNK_BYTES (5*1500) /* 5 TCP packets with default MTU */
  50
  51 /* If more then REDIS_WRITEV_THRESHOLD write packets are pending use writev */
  52 #define REDIS_WRITEV_THRESHOLD      3
  53 /* Max number of iovecs used for each writev call */
  54 #define REDIS_WRITEV_IOVEC_COUNT    256
  55
  56 /* Hash table parameters */
  57 #define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */
  58
  59 /* Command flags:
  60  *   REDIS_CMD_DENYOOM:
  61  *     Commands marked with this flag will return an error when 'maxmemory' is
  62  *     set and the server is using more than 'maxmemory' bytes of memory.
  63  *     In short: commands with this flag are denied on low memory conditions.
  64  *   REDIS_CMD_FORCE_REPLICATION:
  65  *     Force replication even if dirty is 0. */
  66 #define REDIS_CMD_DENYOOM 4
  67 #define REDIS_CMD_FORCE_REPLICATION 8
  68
  69 /* Object types */
  70 #define REDIS_STRING 0
  71 #define REDIS_LIST 1
  72 #define REDIS_SET 2
  73 #define REDIS_ZSET 3
  74 #define REDIS_HASH 4
  75 #define REDIS_VMPOINTER 8
  76
  77 /* Objects encoding. Some kind of objects like Strings and Hashes can be
  78  * internally represented in multiple ways. The 'encoding' field of the object
  79  * is set to one of this fields for this object. */
  80 #define REDIS_ENCODING_RAW 0     /* Raw representation */
  81 #define REDIS_ENCODING_INT 1     /* Encoded as integer */
  82 #define REDIS_ENCODING_HT 2      /* Encoded as hash table */
  83 #define REDIS_ENCODING_ZIPMAP 3  /* Encoded as zipmap */
  84 #define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
  85 #define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
  86 #define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
  87
  88 /* Object types only used for dumping to disk */
  89 #define REDIS_EXPIRETIME 253
  90 #define REDIS_SELECTDB 254
  91 #define REDIS_EOF 255
  92
  93 /* Defines related to the dump file format. To store 32 bits lengths for short
  94  * keys requires a lot of space, so we check the most significant 2 bits of
  95  * the first byte to interpreter the length:
  96  *
  97  * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
  98  * 01|000000 00000000 =>  01, the len is 14 byes, 6 bits + 8 bits of next byte
  99  * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
 100  * 11|000000 this means: specially encoded object will follow. The six bits
 101  *           number specify the kind of object that follows.
 102  *           See the REDIS_RDB_ENC_* defines.
 103  *
 104  * Lenghts up to 63 are stored using a single byte, most DB keys, and may
 105  * values, will fit inside. */
 106 #define REDIS_RDB_6BITLEN 0
 107 #define REDIS_RDB_14BITLEN 1
 108 #define REDIS_RDB_32BITLEN 2
 109 #define REDIS_RDB_ENCVAL 3
 110 #define REDIS_RDB_LENERR UINT_MAX
 111
 112 /* When a length of a string object stored on disk has the first two bits
 113  * set, the remaining two bits specify a special encoding for the object
 114  * accordingly to the following defines: */
 115 #define REDIS_RDB_ENC_INT8 0        /* 8 bit signed integer */
 116 #define REDIS_RDB_ENC_INT16 1       /* 16 bit signed integer */
 117 #define REDIS_RDB_ENC_INT32 2       /* 32 bit signed integer */
 118 #define REDIS_RDB_ENC_LZF 3         /* string compressed with FASTLZ */
 119
 120 /* Virtual memory object->where field. */
 121 #define REDIS_VM_MEMORY 0       /* The object is on memory */
 122 #define REDIS_VM_SWAPPED 1      /* The object is on disk */
 123 #define REDIS_VM_SWAPPING 2     /* Redis is swapping this object on disk */
 124 #define REDIS_VM_LOADING 3      /* Redis is loading this object from disk */
 125
 126 /* Virtual memory static configuration stuff.
 127  * Check vmFindContiguousPages() to know more about this magic numbers. */
 128 #define REDIS_VM_MAX_NEAR_PAGES 65536
 129 #define REDIS_VM_MAX_RANDOM_JUMP 4096
 130 #define REDIS_VM_MAX_THREADS 32
 131 #define REDIS_THREAD_STACK_SIZE (1024*1024*4)
 132 /* The following is the *percentage* of completed I/O jobs to process when the
 133  * handelr is called. While Virtual Memory I/O operations are performed by
 134  * threads, this operations must be processed by the main thread when completed
 135  * in order to take effect. */
 136 #define REDIS_MAX_COMPLETED_JOBS_PROCESSED 1
 137
 138 /* Client flags */
 139 #define REDIS_SLAVE 1       /* This client is a slave server */
 140 #define REDIS_MASTER 2      /* This client is a master server */
 141 #define REDIS_MONITOR 4     /* This client is a slave monitor, see MONITOR */
 142 #define REDIS_MULTI 8       /* This client is in a MULTI context */
 143 #define REDIS_BLOCKED 16    /* The client is waiting in a blocking operation */
 144 #define REDIS_IO_WAIT 32    /* The client is waiting for Virtual Memory I/O */
 145 #define REDIS_DIRTY_CAS 64  /* Watched keys modified. EXEC will fail. */
 146 #define REDIS_CLOSE_AFTER_REPLY 128 /* Close after writing entire reply. */
 147
 148 /* Client request types */
 149 #define REDIS_REQ_INLINE 1
 150 #define REDIS_REQ_MULTIBULK 2
 151
 152 /* Slave replication state - slave side */
 153 #define REDIS_REPL_NONE 0   /* No active replication */
 154 #define REDIS_REPL_CONNECT 1    /* Must connect to master */
 155 #define REDIS_REPL_TRANSFER 2    /* Receiving .rdb from master */
 156 #define REDIS_REPL_CONNECTED 3  /* Connected to master */
 157
 158 /* Slave replication state - from the point of view of master
 159  * Note that in SEND_BULK and ONLINE state the slave receives new updates
 160  * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
 161  * to start the next background saving in order to send updates to it. */
 162 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
 163 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
 164 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
 165 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
 166
 167 /* List related stuff */
 168 #define REDIS_HEAD 0
 169 #define REDIS_TAIL 1
 170
 171 /* Sort operations */
 172 #define REDIS_SORT_GET 0
 173 #define REDIS_SORT_ASC 1
 174 #define REDIS_SORT_DESC 2
 175 #define REDIS_SORTKEY_MAX 1024
 176
 177 /* Log levels */
 178 #define REDIS_DEBUG 0
 179 #define REDIS_VERBOSE 1
 180 #define REDIS_NOTICE 2
 181 #define REDIS_WARNING 3
 182
 183 /* Anti-warning macro... */
 184 #define REDIS_NOTUSED(V) ((void) V)
 185
 186 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
 187 #define ZSKIPLIST_P 0.25      /* Skiplist P = 1/4 */
 188
 189 /* Append only defines */
 190 #define APPENDFSYNC_NO 0
 191 #define APPENDFSYNC_ALWAYS 1
 192 #define APPENDFSYNC_EVERYSEC 2
 193
 194 /* Zip structure related defaults */
 195 #define REDIS_HASH_MAX_ZIPMAP_ENTRIES 64
 196 #define REDIS_HASH_MAX_ZIPMAP_VALUE 512
 197 #define REDIS_LIST_MAX_ZIPLIST_ENTRIES 1024
 198 #define REDIS_LIST_MAX_ZIPLIST_VALUE 32
 199 #define REDIS_SET_MAX_INTSET_ENTRIES 4096
 200
 201 /* Sets operations codes */
 202 #define REDIS_OP_UNION 0
 203 #define REDIS_OP_DIFF 1
 204 #define REDIS_OP_INTER 2
 205
 206 /* Redis maxmemory strategies */
 207 #define REDIS_MAXMEMORY_VOLATILE_LRU 0
 208 #define REDIS_MAXMEMORY_VOLATILE_TTL 1
 209 #define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
 210 #define REDIS_MAXMEMORY_ALLKEYS_LRU 3
 211 #define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
 212 #define REDIS_MAXMEMORY_NO_EVICTION 5
 213
 214 /* We can print the stacktrace, so our assert is defined this way: */
 215 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
 216 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
 217 void _redisAssert(char *estr, char *file, int line);
 218 void _redisPanic(char *msg, char *file, int line);
 219
 220 /*-----------------------------------------------------------------------------
 221  * Data types
 222  *----------------------------------------------------------------------------*/
 223
 224 /* A redis object, that is a type able to hold a string / list / set */
 225
 226 /* The actual Redis Object */
 227 #define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
 228 #define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
 229 typedef struct redisObject {
 230     unsigned type:4;
 231     unsigned storage:2;     /* REDIS_VM_MEMORY or REDIS_VM_SWAPPING */
 232     unsigned encoding:4;
 233     unsigned lru:22;        /* lru time (relative to server.lruclock) */
 234     int refcount;
 235     void *ptr;
 236     /* VM fields are only allocated if VM is active, otherwise the
 237      * object allocation function will just allocate
 238      * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
 239      * Redis without VM active will not have any overhead. */
 240 } robj;
 241
 242 /* The VM pointer structure - identifies an object in the swap file.
 243  *
 244  * This object is stored in place of the value
 245  * object in the main key->value hash table representing a database.
 246  * Note that the first fields (type, storage) are the same as the redisObject
 247  * structure so that vmPointer strucuters can be accessed even when casted
 248  * as redisObject structures.
 249  *
 250  * This is useful as we don't know if a value object is or not on disk, but we
 251  * are always able to read obj->storage to check this. For vmPointer
 252  * structures "type" is set to REDIS_VMPOINTER (even if without this field
 253  * is still possible to check the kind of object from the value of 'storage').*/
 254 typedef struct vmPointer {
 255     unsigned type:4;
 256     unsigned storage:2; /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
 257     unsigned notused:26;
 258     unsigned int vtype; /* type of the object stored in the swap file */
 259     off_t page;         /* the page at witch the object is stored on disk */
 260     off_t usedpages;    /* number of pages used on disk */
 261 } vmpointer;
 262
 263 /* Macro used to initalize a Redis object allocated on the stack.
 264  * Note that this macro is taken near the structure definition to make sure
 265  * we'll update it when the structure is changed, to avoid bugs like
 266  * bug #85 introduced exactly in this way. */
 267 #define initStaticStringObject(_var,_ptr) do { \
 268     _var.refcount = 1; \
 269     _var.type = REDIS_STRING; \
 270     _var.encoding = REDIS_ENCODING_RAW; \
 271     _var.ptr = _ptr; \
 272     _var.storage = REDIS_VM_MEMORY; \
 273 } while(0);
 274
 275 typedef struct redisDb {
 276     dict *dict;                 /* The keyspace for this DB */
 277     dict *expires;              /* Timeout of keys with a timeout set */
 278     dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP) */
 279     dict *io_keys;              /* Keys with clients waiting for VM I/O */
 280     dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
 281     int id;
 282 } redisDb;
 283
 284 /* Client MULTI/EXEC state */
 285 typedef struct multiCmd {
 286     robj **argv;
 287     int argc;
 288     struct redisCommand *cmd;
 289 } multiCmd;
 290
 291 typedef struct multiState {
 292     multiCmd *commands;     /* Array of MULTI commands */
 293     int count;              /* Total number of MULTI commands */
 294 } multiState;
 295
 296 typedef struct blockingState {
 297     robj **keys;            /* The key we are waiting to terminate a blocking
 298                              * operation such as BLPOP. Otherwise NULL. */
 299     int count;              /* Number of blocking keys */
 300     time_t timeout;         /* Blocking operation timeout. If UNIX current time
 301                              * is >= timeout then the operation timed out. */
 302     robj *target;           /* The key that should receive the element,
 303                              * for BRPOPLPUSH. */
 304 } blockingState;
 305
 306 /* With multiplexing we need to take per-clinet state.
 307  * Clients are taken in a liked list. */
 308 typedef struct redisClient {
 309     int fd;
 310     redisDb *db;
 311     int dictid;
 312     sds querybuf;
 313     int argc;
 314     robj **argv;
 315     int reqtype;
 316     int multibulklen;       /* number of multi bulk arguments left to read */
 317     long bulklen;           /* length of bulk argument in multi bulk request */
 318     list *reply;
 319     int sentlen;
 320     time_t lastinteraction; /* time of the last interaction, used for timeout */
 321     int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
 322     int slaveseldb;         /* slave selected db, if this client is a slave */
 323     int authenticated;      /* when requirepass is non-NULL */
 324     int replstate;          /* replication state if this is a slave */
 325     int repldbfd;           /* replication DB file descriptor */
 326     long repldboff;         /* replication DB file offset */
 327     off_t repldbsize;       /* replication DB file size */
 328     multiState mstate;      /* MULTI/EXEC state */
 329     blockingState bpop;   /* blocking state */
 330     list *io_keys;          /* Keys this client is waiting to be loaded from the
 331                              * swap file in order to continue. */
 332     list *watched_keys;     /* Keys WATCHED for MULTI/EXEC CAS */
 333     dict *pubsub_channels;  /* channels a client is interested in (SUBSCRIBE) */
 334     list *pubsub_patterns;  /* patterns a client is interested in (SUBSCRIBE) */
 335
 336     /* Response buffer */
 337     int bufpos;
 338     char buf[REDIS_REPLY_CHUNK_BYTES];
 339 } redisClient;
 340
 341 struct saveparam {
 342     time_t seconds;
 343     int changes;
 344 };
 345
 346 struct sharedObjectsStruct {
 347     robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
 348     *colon, *nullbulk, *nullmultibulk, *queued,
 349     *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
 350     *outofrangeerr, *loadingerr, *plus,
 351     *select0, *select1, *select2, *select3, *select4,
 352     *select5, *select6, *select7, *select8, *select9,
 353     *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
 354     *mbulk4, *psubscribebulk, *punsubscribebulk,
 355     *integers[REDIS_SHARED_INTEGERS];
 356 };
 357
 358 /* Global server state structure */
 359 struct redisServer {
 360     pthread_t mainthread;
 361     int port;
 362     char *bindaddr;
 363     char *unixsocket;
 364     int ipfd;
 365     int sofd;
 366     redisDb *db;
 367     long long dirty;            /* changes to DB from the last save */
 368     long long dirty_before_bgsave; /* used to restore dirty on failed BGSAVE */
 369     list *clients;
 370     dict *commands;             /* Command table hahs table */
 371     /* RDB / AOF loading information */
 372     int loading;
 373     off_t loading_total_bytes;
 374     off_t loading_loaded_bytes;
 375     time_t loading_start_time;
 376     /* Fast pointers to often looked up command */
 377     struct redisCommand *delCommand, *multiCommand;
 378     list *slaves, *monitors;
 379     char neterr[ANET_ERR_LEN];
 380     aeEventLoop *el;
 381     int cronloops;              /* number of times the cron function run */
 382     time_t lastsave;                /* Unix time of last save succeeede */
 383     /* Fields used only for stats */
 384     time_t stat_starttime;          /* server start time */
 385     long long stat_numcommands;     /* number of processed commands */
 386     long long stat_numconnections;  /* number of connections received */
 387     long long stat_expiredkeys;     /* number of expired keys */
 388     long long stat_keyspace_hits;   /* number of successful lookups of keys */
 389     long long stat_keyspace_misses; /* number of failed lookups of keys */
 390     /* Configuration */
 391     int verbosity;
 392     int glueoutputbuf;
 393     int maxidletime;
 394     int dbnum;
 395     int daemonize;
 396     int appendonly;
 397     int appendfsync;
 398     int no_appendfsync_on_rewrite;
 399     int shutdown_asap;
 400     time_t lastfsync;
 401     int appendfd;
 402     int appendseldb;
 403     char *pidfile;
 404     pid_t bgsavechildpid;
 405     pid_t bgrewritechildpid;
 406     sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
 407     sds aofbuf;       /* AOF buffer, written before entering the event loop */
 408     struct saveparam *saveparams;
 409     int saveparamslen;
 410     char *logfile;
 411     char *dbfilename;
 412     char *appendfilename;
 413     char *requirepass;
 414     int rdbcompression;
 415     int activerehashing;
 416     /* Replication related */
 417     int isslave;
 418     /* Slave specific fields */
 419     char *masterauth;
 420     char *masterhost;
 421     int masterport;
 422     redisClient *master;    /* client that is master for this slave */
 423     int replstate;          /* replication status if the instance is a slave */
 424     off_t repl_transfer_left;  /* bytes left reading .rdb  */
 425     int repl_transfer_s;    /* slave -> master SYNC socket */
 426     int repl_transfer_fd;   /* slave -> master SYNC temp file descriptor */
 427     char *repl_transfer_tmpfile; /* slave-> master SYNC temp file name */
 428     time_t repl_transfer_lastio; /* unix time of the latest read, for timeout */
 429     int repl_serve_stale_data; /* Serve stale data when link is down? */
 430     /* Limits */
 431     unsigned int maxclients;
 432     unsigned long long maxmemory;
 433     int maxmemory_policy;
 434     int maxmemory_samples;
 435     /* Blocked clients */
 436     unsigned int bpop_blocked_clients;
 437     unsigned int vm_blocked_clients;
 438     /* Sort parameters - qsort_r() is only available under BSD so we
 439      * have to take this state global, in order to pass it to sortCompare() */
 440     int sort_desc;
 441     int sort_alpha;
 442     int sort_bypattern;
 443     /* Virtual memory configuration */
 444     int vm_enabled;
 445     char *vm_swap_file;
 446     off_t vm_page_size;
 447     off_t vm_pages;
 448     unsigned long long vm_max_memory;
 449     /* Zip structure config */
 450     size_t hash_max_zipmap_entries;
 451     size_t hash_max_zipmap_value;
 452     size_t list_max_ziplist_entries;
 453     size_t list_max_ziplist_value;
 454     size_t set_max_intset_entries;
 455     /* Virtual memory state */
 456     FILE *vm_fp;
 457     int vm_fd;
 458     off_t vm_next_page; /* Next probably empty page */
 459     off_t vm_near_pages; /* Number of pages allocated sequentially */
 460     unsigned char *vm_bitmap; /* Bitmap of free/used pages */
 461     time_t unixtime;    /* Unix time sampled every second. */
 462     /* Virtual memory I/O threads stuff */
 463     /* An I/O thread process an element taken from the io_jobs queue and
 464      * put the result of the operation in the io_done list. While the
 465      * job is being processed, it's put on io_processing queue. */
 466     list *io_newjobs; /* List of VM I/O jobs yet to be processed */
 467     list *io_processing; /* List of VM I/O jobs being processed */
 468     list *io_processed; /* List of VM I/O jobs already processed */
 469     list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
 470     pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
 471     pthread_mutex_t io_swapfile_mutex; /* So we can lseek + write */
 472     pthread_attr_t io_threads_attr; /* attributes for threads creation */
 473     int io_active_threads; /* Number of running I/O threads */
 474     int vm_max_threads; /* Max number of I/O threads running at the same time */
 475     /* Our main thread is blocked on the event loop, locking for sockets ready
 476      * to be read or written, so when a threaded I/O operation is ready to be
 477      * processed by the main thread, the I/O thread will use a unix pipe to
 478      * awake the main thread. The followings are the two pipe FDs. */
 479     int io_ready_pipe_read;
 480     int io_ready_pipe_write;
 481     /* Virtual memory stats */
 482     unsigned long long vm_stats_used_pages;
 483     unsigned long long vm_stats_swapped_objects;
 484     unsigned long long vm_stats_swapouts;
 485     unsigned long long vm_stats_swapins;
 486     /* Pubsub */
 487     dict *pubsub_channels; /* Map channels to list of subscribed clients */
 488     list *pubsub_patterns; /* A list of pubsub_patterns */
 489     /* Misc */
 490     unsigned lruclock:22;        /* clock incrementing every minute, for LRU */
 491     unsigned lruclock_padding:10;
 492 };
 493
 494 typedef struct pubsubPattern {
 495     redisClient *client;
 496     robj *pattern;
 497 } pubsubPattern;
 498
 499 typedef void redisCommandProc(redisClient *c);
 500 typedef void redisVmPreloadProc(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
 501 struct redisCommand {
 502     char *name;
 503     redisCommandProc *proc;
 504     int arity;
 505     int flags;
 506     /* Use a function to determine which keys need to be loaded
 507      * in the background prior to executing this command. Takes precedence
 508      * over vm_firstkey and others, ignored when NULL */
 509     redisVmPreloadProc *vm_preload_proc;
 510     /* What keys should be loaded in background when calling this command? */
 511     int vm_firstkey; /* The first argument that's a key (0 = no keys) */
 512     int vm_lastkey;  /* THe last argument that's a key */
 513     int vm_keystep;  /* The step between first and last key */
 514 };
 515
 516 struct redisFunctionSym {
 517     char *name;
 518     unsigned long pointer;
 519 };
 520
 521 typedef struct _redisSortObject {
 522     robj *obj;
 523     union {
 524         double score;
 525         robj *cmpobj;
 526     } u;
 527 } redisSortObject;
 528
 529 typedef struct _redisSortOperation {
 530     int type;
 531     robj *pattern;
 532 } redisSortOperation;
 533
 534 /* ZSETs use a specialized version of Skiplists */
 535 typedef struct zskiplistNode {
 536     robj *obj;
 537     double score;
 538     struct zskiplistNode *backward;
 539     struct zskiplistLevel {
 540         struct zskiplistNode *forward;
 541         unsigned int span;
 542     } level[];
 543 } zskiplistNode;
 544
 545 typedef struct zskiplist {
 546     struct zskiplistNode *header, *tail;
 547     unsigned long length;
 548     int level;
 549 } zskiplist;
 550
 551 typedef struct zset {
 552     dict *dict;
 553     zskiplist *zsl;
 554 } zset;
 555
 556 /* VM threaded I/O request message */
 557 #define REDIS_IOJOB_LOAD 0          /* Load from disk to memory */
 558 #define REDIS_IOJOB_PREPARE_SWAP 1  /* Compute needed pages */
 559 #define REDIS_IOJOB_DO_SWAP 2       /* Swap from memory to disk */
 560 typedef struct iojob {
 561     int type;   /* Request type, REDIS_IOJOB_* */
 562     redisDb *db;/* Redis database */
 563     robj *key;  /* This I/O request is about swapping this key */
 564     robj *id;   /* Unique identifier of this job:
 565                    this is the object to swap for REDIS_IOREQ_*_SWAP, or the
 566                    vmpointer objct for REDIS_IOREQ_LOAD. */
 567     robj *val;  /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
 568                  * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
 569     off_t page; /* Swap page where to read/write the object */
 570     off_t pages; /* Swap pages needed to save object. PREPARE_SWAP return val */
 571     int canceled; /* True if this command was canceled by blocking side of VM */
 572     pthread_t thread; /* ID of the thread processing this entry */
 573 } iojob;
 574
 575 /* Structure to hold list iteration abstraction. */
 576 typedef struct {
 577     robj *subject;
 578     unsigned char encoding;
 579     unsigned char direction; /* Iteration direction */
 580     unsigned char *zi;
 581     listNode *ln;
 582 } listTypeIterator;
 583
 584 /* Structure for an entry while iterating over a list. */
 585 typedef struct {
 586     listTypeIterator *li;
 587     unsigned char *zi;  /* Entry in ziplist */
 588     listNode *ln;       /* Entry in linked list */
 589 } listTypeEntry;
 590
 591 /* Structure to hold set iteration abstraction. */
 592 typedef struct {
 593     robj *subject;
 594     int encoding;
 595     int ii; /* intset iterator */
 596     dictIterator *di;
 597 } setTypeIterator;
 598
 599 /* Structure to hold hash iteration abstration. Note that iteration over
 600  * hashes involves both fields and values. Because it is possible that
 601  * not both are required, store pointers in the iterator to avoid
 602  * unnecessary memory allocation for fields/values. */
 603 typedef struct {
 604     int encoding;
 605     unsigned char *zi;
 606     unsigned char *zk, *zv;
 607     unsigned int zklen, zvlen;
 608
 609     dictIterator *di;
 610     dictEntry *de;
 611 } hashTypeIterator;
 612
 613 #define REDIS_HASH_KEY 1
 614 #define REDIS_HASH_VALUE 2
 615
 616 /*-----------------------------------------------------------------------------
 617  * Extern declarations
 618  *----------------------------------------------------------------------------*/
 619
 620 extern struct redisServer server;
 621 extern struct sharedObjectsStruct shared;
 622 extern dictType setDictType;
 623 extern dictType zsetDictType;
 624 extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
 625 dictType hashDictType;
 626
 627 /*-----------------------------------------------------------------------------
 628  * Functions prototypes
 629  *----------------------------------------------------------------------------*/
 630
 631 /* networking.c -- Networking and Client related operations */
 632 redisClient *createClient(int fd);
 633 void closeTimedoutClients(void);
 634 void freeClient(redisClient *c);
 635 void resetClient(redisClient *c);
 636 void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
 637 void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask);
 638 void addReply(redisClient *c, robj *obj);
 639 void *addDeferredMultiBulkLength(redisClient *c);
 640 void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
 641 void addReplySds(redisClient *c, sds s);
 642 void processInputBuffer(redisClient *c);
 643 void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 644 void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 645 void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
 646 void addReplyBulk(redisClient *c, robj *obj);
 647 void addReplyBulkCString(redisClient *c, char *s);
 648 void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 649 void addReply(redisClient *c, robj *obj);
 650 void addReplySds(redisClient *c, sds s);
 651 void addReplyError(redisClient *c, char *err);
 652 void addReplyStatus(redisClient *c, char *status);
 653 void addReplyDouble(redisClient *c, double d);
 654 void addReplyLongLong(redisClient *c, long long ll);
 655 void addReplyMultiBulkLen(redisClient *c, long length);
 656 void *dupClientReplyValue(void *o);
 657
 658 #ifdef __GNUC__
 659 void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
 660     __attribute__((format(printf, 2, 3)));
 661 void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
 662     __attribute__((format(printf, 2, 3)));
 663 #else
 664 void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
 665 void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
 666 #endif
 667
 668 /* List data type */
 669 void listTypeTryConversion(robj *subject, robj *value);
 670 void listTypePush(robj *subject, robj *value, int where);
 671 robj *listTypePop(robj *subject, int where);
 672 unsigned long listTypeLength(robj *subject);
 673 listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction);
 674 void listTypeReleaseIterator(listTypeIterator *li);
 675 int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
 676 robj *listTypeGet(listTypeEntry *entry);
 677 void listTypeInsert(listTypeEntry *entry, robj *value, int where);
 678 int listTypeEqual(listTypeEntry *entry, robj *o);
 679 void listTypeDelete(listTypeEntry *entry);
 680 void listTypeConvert(robj *subject, int enc);
 681 void unblockClientWaitingData(redisClient *c);
 682 int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
 683 void popGenericCommand(redisClient *c, int where);
 684
 685 /* MULTI/EXEC/WATCH... */
 686 void unwatchAllKeys(redisClient *c);
 687 void initClientMultiState(redisClient *c);
 688 void freeClientMultiState(redisClient *c);
 689 void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
 690 void touchWatchedKey(redisDb *db, robj *key);
 691 void touchWatchedKeysOnFlush(int dbid);
 692
 693 /* Redis object implementation */
 694 void decrRefCount(void *o);
 695 void incrRefCount(robj *o);
 696 void freeStringObject(robj *o);
 697 void freeListObject(robj *o);
 698 void freeSetObject(robj *o);
 699 void freeZsetObject(robj *o);
 700 void freeHashObject(robj *o);
 701 robj *createObject(int type, void *ptr);
 702 robj *createStringObject(char *ptr, size_t len);
 703 robj *dupStringObject(robj *o);
 704 robj *tryObjectEncoding(robj *o);
 705 robj *getDecodedObject(robj *o);
 706 size_t stringObjectLen(robj *o);
 707 robj *createStringObjectFromLongLong(long long value);
 708 robj *createListObject(void);
 709 robj *createZiplistObject(void);
 710 robj *createSetObject(void);
 711 robj *createIntsetObject(void);
 712 robj *createHashObject(void);
 713 robj *createZsetObject(void);
 714 int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
 715 int checkType(redisClient *c, robj *o, int type);
 716 int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
 717 int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
 718 int getLongLongFromObject(robj *o, long long *target);
 719 char *strEncoding(int encoding);
 720 int compareStringObjects(robj *a, robj *b);
 721 int equalStringObjects(robj *a, robj *b);
 722 unsigned long estimateObjectIdleTime(robj *o);
 723
 724 /* Synchronous I/O with timeout */
 725 int syncWrite(int fd, char *ptr, ssize_t size, int timeout);
 726 int syncRead(int fd, char *ptr, ssize_t size, int timeout);
 727 int syncReadLine(int fd, char *ptr, ssize_t size, int timeout);
 728 int fwriteBulkString(FILE *fp, char *s, unsigned long len);
 729 int fwriteBulkDouble(FILE *fp, double d);
 730 int fwriteBulkLongLong(FILE *fp, long long l);
 731 int fwriteBulkObject(FILE *fp, robj *obj);
 732
 733 /* Replication */
 734 void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
 735 void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
 736 int syncWithMaster(void);
 737 void updateSlavesWaitingBgsave(int bgsaveerr);
 738 void replicationCron(void);
 739
 740 /* Generic persistence functions */
 741 void startLoading(FILE *fp);
 742 void loadingProgress(off_t pos);
 743 void stopLoading(void);
 744
 745 /* RDB persistence */
 746 int rdbLoad(char *filename);
 747 int rdbSaveBackground(char *filename);
 748 void rdbRemoveTempFile(pid_t childpid);
 749 int rdbSave(char *filename);
 750 int rdbSaveObject(FILE *fp, robj *o);
 751 off_t rdbSavedObjectLen(robj *o);
 752 off_t rdbSavedObjectPages(robj *o);
 753 robj *rdbLoadObject(int type, FILE *fp);
 754 void backgroundSaveDoneHandler(int statloc);
 755
 756 /* AOF persistence */
 757 void flushAppendOnlyFile(void);
 758 void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
 759 void aofRemoveTempFile(pid_t childpid);
 760 int rewriteAppendOnlyFileBackground(void);
 761 int loadAppendOnlyFile(char *filename);
 762 void stopAppendOnly(void);
 763 int startAppendOnly(void);
 764 void backgroundRewriteDoneHandler(int statloc);
 765
 766 /* Sorted sets data type */
 767 zskiplist *zslCreate(void);
 768 void zslFree(zskiplist *zsl);
 769 zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
 770
 771 /* Core functions */
 772 void freeMemoryIfNeeded(void);
 773 int processCommand(redisClient *c);
 774 void setupSigSegvAction(void);
 775 struct redisCommand *lookupCommand(sds name);
 776 struct redisCommand *lookupCommandByCString(char *s);
 777 void call(redisClient *c, struct redisCommand *cmd);
 778 int prepareForShutdown();
 779 void redisLog(int level, const char *fmt, ...);
 780 void usage();
 781 void updateDictResizePolicy(void);
 782 int htNeedsResize(dict *dict);
 783 void oom(const char *msg);
 784 void populateCommandTable(void);
 785
 786 /* Virtual Memory */
 787 void vmInit(void);
 788 void vmMarkPagesFree(off_t page, off_t count);
 789 robj *vmLoadObject(robj *o);
 790 robj *vmPreviewObject(robj *o);
 791 int vmSwapOneObjectBlocking(void);
 792 int vmSwapOneObjectThreaded(void);
 793 int vmCanSwapOut(void);
 794 void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
 795 void vmCancelThreadedIOJob(robj *o);
 796 void lockThreadedIO(void);
 797 void unlockThreadedIO(void);
 798 int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db);
 799 void freeIOJob(iojob *j);
 800 void queueIOJob(iojob *j);
 801 int vmWriteObjectOnSwap(robj *o, off_t page);
 802 robj *vmReadObjectFromSwap(off_t page, int type);
 803 void waitEmptyIOJobsQueue(void);
 804 void vmReopenSwapFile(void);
 805 int vmFreePage(off_t page);
 806 void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
 807 void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
 808 int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
 809 int dontWaitForSwappedKey(redisClient *c, robj *key);
 810 void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
 811 vmpointer *vmSwapObjectBlocking(robj *val);
 812
 813 /* Set data type */
 814 robj *setTypeCreate(robj *value);
 815 int setTypeAdd(robj *subject, robj *value);
 816 int setTypeRemove(robj *subject, robj *value);
 817 int setTypeIsMember(robj *subject, robj *value);
 818 setTypeIterator *setTypeInitIterator(robj *subject);
 819 void setTypeReleaseIterator(setTypeIterator *si);
 820 robj *setTypeNext(setTypeIterator *si);
 821 robj *setTypeRandomElement(robj *subject);
 822 unsigned long setTypeSize(robj *subject);
 823 void setTypeConvert(robj *subject, int enc);
 824
 825 /* Hash data type */
 826 void convertToRealHash(robj *o);
 827 void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
 828 void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
 829 robj *hashTypeGet(robj *o, robj *key);
 830 int hashTypeExists(robj *o, robj *key);
 831 int hashTypeSet(robj *o, robj *key, robj *value);
 832 int hashTypeDelete(robj *o, robj *key);
 833 unsigned long hashTypeLength(robj *o);
 834 hashTypeIterator *hashTypeInitIterator(robj *subject);
 835 void hashTypeReleaseIterator(hashTypeIterator *hi);
 836 int hashTypeNext(hashTypeIterator *hi);
 837 robj *hashTypeCurrent(hashTypeIterator *hi, int what);
 838 robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
 839
 840 /* Pub / Sub */
 841 int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
 842 int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
 843 void freePubsubPattern(void *p);
 844 int listMatchPubsubPattern(void *a, void *b);
 845
 846 /* Utility functions */
 847 int stringmatchlen(const char *pattern, int patternLen,
 848         const char *string, int stringLen, int nocase);
 849 int stringmatch(const char *pattern, const char *string, int nocase);
 850 long long memtoll(const char *p, int *err);
 851 int ll2string(char *s, size_t len, long long value);
 852 int isStringRepresentableAsLong(sds s, long *longval);
 853 int isStringRepresentableAsLongLong(sds s, long long *longval);
 854 int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
 855
 856 /* Configuration */
 857 void loadServerConfig(char *filename);
 858 void appendServerSaveParams(time_t seconds, int changes);
 859 void resetServerSaveParams();
 860
 861 /* db.c -- Keyspace access API */
 862 int removeExpire(redisDb *db, robj *key);
 863 void propagateExpire(redisDb *db, robj *key);
 864 int expireIfNeeded(redisDb *db, robj *key);
 865 time_t getExpire(redisDb *db, robj *key);
 866 void setExpire(redisDb *db, robj *key, time_t when);
 867 robj *lookupKey(redisDb *db, robj *key);
 868 robj *lookupKeyRead(redisDb *db, robj *key);
 869 robj *lookupKeyWrite(redisDb *db, robj *key);
 870 robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
 871 robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
 872 int dbAdd(redisDb *db, robj *key, robj *val);
 873 int dbReplace(redisDb *db, robj *key, robj *val);
 874 int dbExists(redisDb *db, robj *key);
 875 robj *dbRandomKey(redisDb *db);
 876 int dbDelete(redisDb *db, robj *key);
 877 long long emptyDb();
 878 int selectDb(redisClient *c, int id);
 879
 880 /* Git SHA1 */
 881 char *redisGitSHA1(void);
 882 char *redisGitDirty(void);
 883
 884 /* Commands prototypes */
 885 void authCommand(redisClient *c);
 886 void pingCommand(redisClient *c);
 887 void echoCommand(redisClient *c);
 888 void setCommand(redisClient *c);
 889 void setnxCommand(redisClient *c);
 890 void setexCommand(redisClient *c);
 891 void getCommand(redisClient *c);
 892 void delCommand(redisClient *c);
 893 void existsCommand(redisClient *c);
 894 void incrCommand(redisClient *c);
 895 void decrCommand(redisClient *c);
 896 void incrbyCommand(redisClient *c);
 897 void decrbyCommand(redisClient *c);
 898 void selectCommand(redisClient *c);
 899 void randomkeyCommand(redisClient *c);
 900 void keysCommand(redisClient *c);
 901 void dbsizeCommand(redisClient *c);
 902 void lastsaveCommand(redisClient *c);
 903 void saveCommand(redisClient *c);
 904 void bgsaveCommand(redisClient *c);
 905 void bgrewriteaofCommand(redisClient *c);
 906 void shutdownCommand(redisClient *c);
 907 void moveCommand(redisClient *c);
 908 void renameCommand(redisClient *c);
 909 void renamenxCommand(redisClient *c);
 910 void lpushCommand(redisClient *c);
 911 void rpushCommand(redisClient *c);
 912 void lpushxCommand(redisClient *c);
 913 void rpushxCommand(redisClient *c);
 914 void linsertCommand(redisClient *c);
 915 void lpopCommand(redisClient *c);
 916 void rpopCommand(redisClient *c);
 917 void llenCommand(redisClient *c);
 918 void lindexCommand(redisClient *c);
 919 void lrangeCommand(redisClient *c);
 920 void ltrimCommand(redisClient *c);
 921 void typeCommand(redisClient *c);
 922 void lsetCommand(redisClient *c);
 923 void saddCommand(redisClient *c);
 924 void sremCommand(redisClient *c);
 925 void smoveCommand(redisClient *c);
 926 void sismemberCommand(redisClient *c);
 927 void scardCommand(redisClient *c);
 928 void spopCommand(redisClient *c);
 929 void srandmemberCommand(redisClient *c);
 930 void sinterCommand(redisClient *c);
 931 void sinterstoreCommand(redisClient *c);
 932 void sunionCommand(redisClient *c);
 933 void sunionstoreCommand(redisClient *c);
 934 void sdiffCommand(redisClient *c);
 935 void sdiffstoreCommand(redisClient *c);
 936 void syncCommand(redisClient *c);
 937 void flushdbCommand(redisClient *c);
 938 void flushallCommand(redisClient *c);
 939 void sortCommand(redisClient *c);
 940 void lremCommand(redisClient *c);
 941 void rpoplpushCommand(redisClient *c);
 942 void infoCommand(redisClient *c);
 943 void mgetCommand(redisClient *c);
 944 void monitorCommand(redisClient *c);
 945 void expireCommand(redisClient *c);
 946 void expireatCommand(redisClient *c);
 947 void getsetCommand(redisClient *c);
 948 void ttlCommand(redisClient *c);
 949 void persistCommand(redisClient *c);
 950 void slaveofCommand(redisClient *c);
 951 void debugCommand(redisClient *c);
 952 void msetCommand(redisClient *c);
 953 void msetnxCommand(redisClient *c);
 954 void zaddCommand(redisClient *c);
 955 void zincrbyCommand(redisClient *c);
 956 void zrangeCommand(redisClient *c);
 957 void zrangebyscoreCommand(redisClient *c);
 958 void zrevrangebyscoreCommand(redisClient *c);
 959 void zcountCommand(redisClient *c);
 960 void zrevrangeCommand(redisClient *c);
 961 void zcardCommand(redisClient *c);
 962 void zremCommand(redisClient *c);
 963 void zscoreCommand(redisClient *c);
 964 void zremrangebyscoreCommand(redisClient *c);
 965 void multiCommand(redisClient *c);
 966 void execCommand(redisClient *c);
 967 void discardCommand(redisClient *c);
 968 void blpopCommand(redisClient *c);
 969 void brpopCommand(redisClient *c);
 970 void brpoplpushCommand(redisClient *c);
 971 void appendCommand(redisClient *c);
 972 void substrCommand(redisClient *c);
 973 void strlenCommand(redisClient *c);
 974 void zrankCommand(redisClient *c);
 975 void zrevrankCommand(redisClient *c);
 976 void hsetCommand(redisClient *c);
 977 void hsetnxCommand(redisClient *c);
 978 void hgetCommand(redisClient *c);
 979 void hmsetCommand(redisClient *c);
 980 void hmgetCommand(redisClient *c);
 981 void hdelCommand(redisClient *c);
 982 void hlenCommand(redisClient *c);
 983 void zremrangebyrankCommand(redisClient *c);
 984 void zunionstoreCommand(redisClient *c);
 985 void zinterstoreCommand(redisClient *c);
 986 void hkeysCommand(redisClient *c);
 987 void hvalsCommand(redisClient *c);
 988 void hgetallCommand(redisClient *c);
 989 void hexistsCommand(redisClient *c);
 990 void configCommand(redisClient *c);
 991 void hincrbyCommand(redisClient *c);
 992 void subscribeCommand(redisClient *c);
 993 void unsubscribeCommand(redisClient *c);
 994 void psubscribeCommand(redisClient *c);
 995 void punsubscribeCommand(redisClient *c);
 996 void publishCommand(redisClient *c);
 997 void watchCommand(redisClient *c);
 998 void unwatchCommand(redisClient *c);
 999
1000 #if defined(__GNUC__)
1001 void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1002 void free(void *ptr) __attribute__ ((deprecated));
1003 void *malloc(size_t size) __attribute__ ((deprecated));
1004 void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1005 #endif
1006
1007 #endif