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
 213 /* We can print the stacktrace, so our assert is defined this way: */
 214 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
 215 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
 216 void _redisAssert(char *estr, char *file, int line);
 217 void _redisPanic(char *msg, char *file, int line);
 218
 219 /*-----------------------------------------------------------------------------
 220  * Data types
 221  *----------------------------------------------------------------------------*/
 222
 223 /* A redis object, that is a type able to hold a string / list / set */
 224
 225 /* The actual Redis Object */
 226 #define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
 227 #define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
 228 typedef struct redisObject {
 229     unsigned type:4;
 230     unsigned storage:2;     /* REDIS_VM_MEMORY or REDIS_VM_SWAPPING */
 231     unsigned encoding:4;
 232     unsigned lru:22;        /* lru time (relative to server.lruclock) */
 233     int refcount;
 234     void *ptr;
 235     /* VM fields are only allocated if VM is active, otherwise the
 236      * object allocation function will just allocate
 237      * sizeof(redisObjct) minus sizeof(redisObjectVM), so using
 238      * Redis without VM active will not have any overhead. */
 239 } robj;
 240
 241 /* The VM pointer structure - identifies an object in the swap file.
 242  *
 243  * This object is stored in place of the value
 244  * object in the main key->value hash table representing a database.
 245  * Note that the first fields (type, storage) are the same as the redisObject
 246  * structure so that vmPointer strucuters can be accessed even when casted
 247  * as redisObject structures.
 248  *
 249  * This is useful as we don't know if a value object is or not on disk, but we
 250  * are always able to read obj->storage to check this. For vmPointer
 251  * structures "type" is set to REDIS_VMPOINTER (even if without this field
 252  * is still possible to check the kind of object from the value of 'storage').*/
 253 typedef struct vmPointer {
 254     unsigned type:4;
 255     unsigned storage:2; /* REDIS_VM_SWAPPED or REDIS_VM_LOADING */
 256     unsigned notused:26;
 257     unsigned int vtype; /* type of the object stored in the swap file */
 258     off_t page;         /* the page at witch the object is stored on disk */
 259     off_t usedpages;    /* number of pages used on disk */
 260 } vmpointer;
 261
 262 /* Macro used to initalize a Redis object allocated on the stack.
 263  * Note that this macro is taken near the structure definition to make sure
 264  * we'll update it when the structure is changed, to avoid bugs like
 265  * bug #85 introduced exactly in this way. */
 266 #define initStaticStringObject(_var,_ptr) do { \
 267     _var.refcount = 1; \
 268     _var.type = REDIS_STRING; \
 269     _var.encoding = REDIS_ENCODING_RAW; \
 270     _var.ptr = _ptr; \
 271     _var.storage = REDIS_VM_MEMORY; \
 272 } while(0);
 273
 274 typedef struct redisDb {
 275     dict *dict;                 /* The keyspace for this DB */
 276     dict *expires;              /* Timeout of keys with a timeout set */
 277     dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP) */
 278     dict *io_keys;              /* Keys with clients waiting for VM I/O */
 279     dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
 280     int id;
 281 } redisDb;
 282
 283 /* Client MULTI/EXEC state */
 284 typedef struct multiCmd {
 285     robj **argv;
 286     int argc;
 287     struct redisCommand *cmd;
 288 } multiCmd;
 289
 290 typedef struct multiState {
 291     multiCmd *commands;     /* Array of MULTI commands */
 292     int count;              /* Total number of MULTI commands */
 293 } multiState;
 294
 295 /* With multiplexing we need to take per-clinet state.
 296  * Clients are taken in a liked list. */
 297 typedef struct redisClient {
 298     int fd;
 299     redisDb *db;
 300     int dictid;
 301     sds querybuf;
 302     int argc;
 303     robj **argv;
 304     int reqtype;
 305     int multibulklen;       /* number of multi bulk arguments left to read */
 306     long bulklen;           /* length of bulk argument in multi bulk request */
 307     list *reply;
 308     int sentlen;
 309     time_t lastinteraction; /* time of the last interaction, used for timeout */
 310     int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
 311     int slaveseldb;         /* slave selected db, if this client is a slave */
 312     int authenticated;      /* when requirepass is non-NULL */
 313     int replstate;          /* replication state if this is a slave */
 314     int repldbfd;           /* replication DB file descriptor */
 315     long repldboff;         /* replication DB file offset */
 316     off_t repldbsize;       /* replication DB file size */
 317     multiState mstate;      /* MULTI/EXEC state */
 318     robj **blocking_keys;   /* The key we are waiting to terminate a blocking
 319                              * operation such as BLPOP. Otherwise NULL. */
 320     int blocking_keys_num;  /* Number of blocking keys */
 321     time_t blockingto;      /* Blocking operation timeout. If UNIX current time
 322                              * is >= blockingto then the operation timed out. */
 323     list *io_keys;          /* Keys this client is waiting to be loaded from the
 324                              * swap file in order to continue. */
 325     list *watched_keys;     /* Keys WATCHED for MULTI/EXEC CAS */
 326     dict *pubsub_channels;  /* channels a client is interested in (SUBSCRIBE) */
 327     list *pubsub_patterns;  /* patterns a client is interested in (SUBSCRIBE) */
 328
 329     /* Response buffer */
 330     int bufpos;
 331     char buf[REDIS_REPLY_CHUNK_BYTES];
 332 } redisClient;
 333
 334 struct saveparam {
 335     time_t seconds;
 336     int changes;
 337 };
 338
 339 struct sharedObjectsStruct {
 340     robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
 341     *colon, *nullbulk, *nullmultibulk, *queued,
 342     *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
 343     *outofrangeerr, *plus,
 344     *select0, *select1, *select2, *select3, *select4,
 345     *select5, *select6, *select7, *select8, *select9,
 346     *messagebulk, *pmessagebulk, *subscribebulk, *unsubscribebulk, *mbulk3,
 347     *mbulk4, *psubscribebulk, *punsubscribebulk,
 348     *integers[REDIS_SHARED_INTEGERS];
 349 };
 350
 351 /* Global server state structure */
 352 struct redisServer {
 353     pthread_t mainthread;
 354     int port;
 355     char *bindaddr;
 356     char *unixsocket;
 357     int ipfd;
 358     int sofd;
 359     redisDb *db;
 360     long long dirty;            /* changes to DB from the last save */
 361     long long dirty_before_bgsave; /* used to restore dirty on failed BGSAVE */
 362     list *clients;
 363     dict *commands;             /* Command table hahs table */
 364     /* Fast pointers to often looked up command */
 365     struct redisCommand *delCommand, *multiCommand;
 366     list *slaves, *monitors;
 367     char neterr[ANET_ERR_LEN];
 368     aeEventLoop *el;
 369     int cronloops;              /* number of times the cron function run */
 370     time_t lastsave;                /* Unix time of last save succeeede */
 371     /* Fields used only for stats */
 372     time_t stat_starttime;          /* server start time */
 373     long long stat_numcommands;     /* number of processed commands */
 374     long long stat_numconnections;  /* number of connections received */
 375     long long stat_expiredkeys;     /* number of expired keys */
 376     long long stat_keyspace_hits;   /* number of successful lookups of keys */
 377     long long stat_keyspace_misses; /* number of failed lookups of keys */
 378     /* Configuration */
 379     int verbosity;
 380     int glueoutputbuf;
 381     int maxidletime;
 382     int dbnum;
 383     int daemonize;
 384     int appendonly;
 385     int appendfsync;
 386     int no_appendfsync_on_rewrite;
 387     int shutdown_asap;
 388     time_t lastfsync;
 389     int appendfd;
 390     int appendseldb;
 391     char *pidfile;
 392     pid_t bgsavechildpid;
 393     pid_t bgrewritechildpid;
 394     sds bgrewritebuf; /* buffer taken by parent during oppend only rewrite */
 395     sds aofbuf;       /* AOF buffer, written before entering the event loop */
 396     struct saveparam *saveparams;
 397     int saveparamslen;
 398     char *logfile;
 399     char *dbfilename;
 400     char *appendfilename;
 401     char *requirepass;
 402     int rdbcompression;
 403     int activerehashing;
 404     /* Replication related */
 405     int isslave;
 406     /* Slave specific fields */
 407     char *masterauth;
 408     char *masterhost;
 409     int masterport;
 410     redisClient *master;    /* client that is master for this slave */
 411     int replstate;          /* replication status if the instance is a slave */
 412     off_t repl_transfer_left;  /* bytes left reading .rdb  */
 413     int repl_transfer_s;    /* slave -> master SYNC socket */
 414     int repl_transfer_fd;   /* slave -> master SYNC temp file descriptor */
 415     char *repl_transfer_tmpfile; /* slave-> master SYNC temp file name */
 416     time_t repl_transfer_lastio; /* unix time of the latest read, for timeout */
 417     int repl_serve_stale_data; /* Serve stale data when link is down? */
 418     /* Limits */
 419     unsigned int maxclients;
 420     unsigned long long maxmemory;
 421     int maxmemory_policy;
 422     int maxmemory_samples;
 423     /* Blocked clients */
 424     unsigned int blpop_blocked_clients;
 425     unsigned int vm_blocked_clients;
 426     /* Sort parameters - qsort_r() is only available under BSD so we
 427      * have to take this state global, in order to pass it to sortCompare() */
 428     int sort_desc;
 429     int sort_alpha;
 430     int sort_bypattern;
 431     /* Virtual memory configuration */
 432     int vm_enabled;
 433     char *vm_swap_file;
 434     off_t vm_page_size;
 435     off_t vm_pages;
 436     unsigned long long vm_max_memory;
 437     /* Zip structure config */
 438     size_t hash_max_zipmap_entries;
 439     size_t hash_max_zipmap_value;
 440     size_t list_max_ziplist_entries;
 441     size_t list_max_ziplist_value;
 442     size_t set_max_intset_entries;
 443     /* Virtual memory state */
 444     FILE *vm_fp;
 445     int vm_fd;
 446     off_t vm_next_page; /* Next probably empty page */
 447     off_t vm_near_pages; /* Number of pages allocated sequentially */
 448     unsigned char *vm_bitmap; /* Bitmap of free/used pages */
 449     time_t unixtime;    /* Unix time sampled every second. */
 450     /* Virtual memory I/O threads stuff */
 451     /* An I/O thread process an element taken from the io_jobs queue and
 452      * put the result of the operation in the io_done list. While the
 453      * job is being processed, it's put on io_processing queue. */
 454     list *io_newjobs; /* List of VM I/O jobs yet to be processed */
 455     list *io_processing; /* List of VM I/O jobs being processed */
 456     list *io_processed; /* List of VM I/O jobs already processed */
 457     list *io_ready_clients; /* Clients ready to be unblocked. All keys loaded */
 458     pthread_mutex_t io_mutex; /* lock to access io_jobs/io_done/io_thread_job */
 459     pthread_mutex_t io_swapfile_mutex; /* So we can lseek + write */
 460     pthread_attr_t io_threads_attr; /* attributes for threads creation */
 461     int io_active_threads; /* Number of running I/O threads */
 462     int vm_max_threads; /* Max number of I/O threads running at the same time */
 463     /* Our main thread is blocked on the event loop, locking for sockets ready
 464      * to be read or written, so when a threaded I/O operation is ready to be
 465      * processed by the main thread, the I/O thread will use a unix pipe to
 466      * awake the main thread. The followings are the two pipe FDs. */
 467     int io_ready_pipe_read;
 468     int io_ready_pipe_write;
 469     /* Virtual memory stats */
 470     unsigned long long vm_stats_used_pages;
 471     unsigned long long vm_stats_swapped_objects;
 472     unsigned long long vm_stats_swapouts;
 473     unsigned long long vm_stats_swapins;
 474     /* Pubsub */
 475     dict *pubsub_channels; /* Map channels to list of subscribed clients */
 476     list *pubsub_patterns; /* A list of pubsub_patterns */
 477     /* Misc */
 478     FILE *devnull;
 479     unsigned lruclock:22;        /* clock incrementing every minute, for LRU */
 480     unsigned lruclock_padding:10;
 481 };
 482
 483 typedef struct pubsubPattern {
 484     redisClient *client;
 485     robj *pattern;
 486 } pubsubPattern;
 487
 488 typedef void redisCommandProc(redisClient *c);
 489 typedef void redisVmPreloadProc(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
 490 struct redisCommand {
 491     char *name;
 492     redisCommandProc *proc;
 493     int arity;
 494     int flags;
 495     /* Use a function to determine which keys need to be loaded
 496      * in the background prior to executing this command. Takes precedence
 497      * over vm_firstkey and others, ignored when NULL */
 498     redisVmPreloadProc *vm_preload_proc;
 499     /* What keys should be loaded in background when calling this command? */
 500     int vm_firstkey; /* The first argument that's a key (0 = no keys) */
 501     int vm_lastkey;  /* THe last argument that's a key */
 502     int vm_keystep;  /* The step between first and last key */
 503 };
 504
 505 struct redisFunctionSym {
 506     char *name;
 507     unsigned long pointer;
 508 };
 509
 510 typedef struct _redisSortObject {
 511     robj *obj;
 512     union {
 513         double score;
 514         robj *cmpobj;
 515     } u;
 516 } redisSortObject;
 517
 518 typedef struct _redisSortOperation {
 519     int type;
 520     robj *pattern;
 521 } redisSortOperation;
 522
 523 /* ZSETs use a specialized version of Skiplists */
 524 typedef struct zskiplistNode {
 525     robj *obj;
 526     double score;
 527     struct zskiplistNode *backward;
 528     struct zskiplistLevel {
 529         struct zskiplistNode *forward;
 530         unsigned int span;
 531     } level[];
 532 } zskiplistNode;
 533
 534 typedef struct zskiplist {
 535     struct zskiplistNode *header, *tail;
 536     unsigned long length;
 537     int level;
 538 } zskiplist;
 539
 540 typedef struct zset {
 541     dict *dict;
 542     zskiplist *zsl;
 543 } zset;
 544
 545 /* VM threaded I/O request message */
 546 #define REDIS_IOJOB_LOAD 0          /* Load from disk to memory */
 547 #define REDIS_IOJOB_PREPARE_SWAP 1  /* Compute needed pages */
 548 #define REDIS_IOJOB_DO_SWAP 2       /* Swap from memory to disk */
 549 typedef struct iojob {
 550     int type;   /* Request type, REDIS_IOJOB_* */
 551     redisDb *db;/* Redis database */
 552     robj *key;  /* This I/O request is about swapping this key */
 553     robj *id;   /* Unique identifier of this job:
 554                    this is the object to swap for REDIS_IOREQ_*_SWAP, or the
 555                    vmpointer objct for REDIS_IOREQ_LOAD. */
 556     robj *val;  /* the value to swap for REDIS_IOREQ_*_SWAP, otherwise this
 557                  * field is populated by the I/O thread for REDIS_IOREQ_LOAD. */
 558     off_t page; /* Swap page where to read/write the object */
 559     off_t pages; /* Swap pages needed to save object. PREPARE_SWAP return val */
 560     int canceled; /* True if this command was canceled by blocking side of VM */
 561     pthread_t thread; /* ID of the thread processing this entry */
 562 } iojob;
 563
 564 /* Structure to hold list iteration abstraction. */
 565 typedef struct {
 566     robj *subject;
 567     unsigned char encoding;
 568     unsigned char direction; /* Iteration direction */
 569     unsigned char *zi;
 570     listNode *ln;
 571 } listTypeIterator;
 572
 573 /* Structure for an entry while iterating over a list. */
 574 typedef struct {
 575     listTypeIterator *li;
 576     unsigned char *zi;  /* Entry in ziplist */
 577     listNode *ln;       /* Entry in linked list */
 578 } listTypeEntry;
 579
 580 /* Structure to hold set iteration abstraction. */
 581 typedef struct {
 582     robj *subject;
 583     int encoding;
 584     int ii; /* intset iterator */
 585     dictIterator *di;
 586 } setTypeIterator;
 587
 588 /* Structure to hold hash iteration abstration. Note that iteration over
 589  * hashes involves both fields and values. Because it is possible that
 590  * not both are required, store pointers in the iterator to avoid
 591  * unnecessary memory allocation for fields/values. */
 592 typedef struct {
 593     int encoding;
 594     unsigned char *zi;
 595     unsigned char *zk, *zv;
 596     unsigned int zklen, zvlen;
 597
 598     dictIterator *di;
 599     dictEntry *de;
 600 } hashTypeIterator;
 601
 602 #define REDIS_HASH_KEY 1
 603 #define REDIS_HASH_VALUE 2
 604
 605 /*-----------------------------------------------------------------------------
 606  * Extern declarations
 607  *----------------------------------------------------------------------------*/
 608
 609 extern struct redisServer server;
 610 extern struct sharedObjectsStruct shared;
 611 extern dictType setDictType;
 612 extern dictType zsetDictType;
 613 extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
 614 dictType hashDictType;
 615
 616 /*-----------------------------------------------------------------------------
 617  * Functions prototypes
 618  *----------------------------------------------------------------------------*/
 619
 620 /* networking.c -- Networking and Client related operations */
 621 redisClient *createClient(int fd);
 622 void closeTimedoutClients(void);
 623 void freeClient(redisClient *c);
 624 void resetClient(redisClient *c);
 625 void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
 626 void sendReplyToClientWritev(aeEventLoop *el, int fd, void *privdata, int mask);
 627 void addReply(redisClient *c, robj *obj);
 628 void *addDeferredMultiBulkLength(redisClient *c);
 629 void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
 630 void addReplySds(redisClient *c, sds s);
 631 void processInputBuffer(redisClient *c);
 632 void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 633 void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 634 void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
 635 void addReplyBulk(redisClient *c, robj *obj);
 636 void addReplyBulkCString(redisClient *c, char *s);
 637 void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 638 void addReply(redisClient *c, robj *obj);
 639 void addReplySds(redisClient *c, sds s);
 640 void addReplyError(redisClient *c, char *err);
 641 void addReplyStatus(redisClient *c, char *status);
 642 void addReplyDouble(redisClient *c, double d);
 643 void addReplyLongLong(redisClient *c, long long ll);
 644 void addReplyMultiBulkLen(redisClient *c, long length);
 645 void *dupClientReplyValue(void *o);
 646
 647 #ifdef __GNUC__
 648 void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
 649     __attribute__((format(printf, 2, 3)));
 650 void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
 651     __attribute__((format(printf, 2, 3)));
 652 #else
 653 void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
 654 void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
 655 #endif
 656
 657 /* List data type */
 658 void listTypeTryConversion(robj *subject, robj *value);
 659 void listTypePush(robj *subject, robj *value, int where);
 660 robj *listTypePop(robj *subject, int where);
 661 unsigned long listTypeLength(robj *subject);
 662 listTypeIterator *listTypeInitIterator(robj *subject, int index, unsigned char direction);
 663 void listTypeReleaseIterator(listTypeIterator *li);
 664 int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
 665 robj *listTypeGet(listTypeEntry *entry);
 666 void listTypeInsert(listTypeEntry *entry, robj *value, int where);
 667 int listTypeEqual(listTypeEntry *entry, robj *o);
 668 void listTypeDelete(listTypeEntry *entry);
 669 void listTypeConvert(robj *subject, int enc);
 670 void unblockClientWaitingData(redisClient *c);
 671 int handleClientsWaitingListPush(redisClient *c, robj *key, robj *ele);
 672 void popGenericCommand(redisClient *c, int where);
 673
 674 /* MULTI/EXEC/WATCH... */
 675 void unwatchAllKeys(redisClient *c);
 676 void initClientMultiState(redisClient *c);
 677 void freeClientMultiState(redisClient *c);
 678 void queueMultiCommand(redisClient *c, struct redisCommand *cmd);
 679 void touchWatchedKey(redisDb *db, robj *key);
 680 void touchWatchedKeysOnFlush(int dbid);
 681
 682 /* Redis object implementation */
 683 void decrRefCount(void *o);
 684 void incrRefCount(robj *o);
 685 void freeStringObject(robj *o);
 686 void freeListObject(robj *o);
 687 void freeSetObject(robj *o);
 688 void freeZsetObject(robj *o);
 689 void freeHashObject(robj *o);
 690 robj *createObject(int type, void *ptr);
 691 robj *createStringObject(char *ptr, size_t len);
 692 robj *dupStringObject(robj *o);
 693 robj *tryObjectEncoding(robj *o);
 694 robj *getDecodedObject(robj *o);
 695 size_t stringObjectLen(robj *o);
 696 robj *createStringObjectFromLongLong(long long value);
 697 robj *createListObject(void);
 698 robj *createZiplistObject(void);
 699 robj *createSetObject(void);
 700 robj *createIntsetObject(void);
 701 robj *createHashObject(void);
 702 robj *createZsetObject(void);
 703 int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
 704 int checkType(redisClient *c, robj *o, int type);
 705 int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
 706 int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
 707 int getLongLongFromObject(robj *o, long long *target);
 708 char *strEncoding(int encoding);
 709 int compareStringObjects(robj *a, robj *b);
 710 int equalStringObjects(robj *a, robj *b);
 711 unsigned long estimateObjectIdleTime(robj *o);
 712
 713 /* Synchronous I/O with timeout */
 714 int syncWrite(int fd, char *ptr, ssize_t size, int timeout);
 715 int syncRead(int fd, char *ptr, ssize_t size, int timeout);
 716 int syncReadLine(int fd, char *ptr, ssize_t size, int timeout);
 717 int fwriteBulkString(FILE *fp, char *s, unsigned long len);
 718 int fwriteBulkDouble(FILE *fp, double d);
 719 int fwriteBulkLongLong(FILE *fp, long long l);
 720 int fwriteBulkObject(FILE *fp, robj *obj);
 721
 722 /* Replication */
 723 void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
 724 void replicationFeedMonitors(list *monitors, int dictid, robj **argv, int argc);
 725 int syncWithMaster(void);
 726 void updateSlavesWaitingBgsave(int bgsaveerr);
 727 void replicationCron(void);
 728
 729 /* RDB persistence */
 730 int rdbLoad(char *filename);
 731 int rdbSaveBackground(char *filename);
 732 void rdbRemoveTempFile(pid_t childpid);
 733 int rdbSave(char *filename);
 734 int rdbSaveObject(FILE *fp, robj *o);
 735 off_t rdbSavedObjectPages(robj *o, FILE *fp);
 736 off_t rdbSavedObjectLen(robj *o, FILE *fp);
 737 robj *rdbLoadObject(int type, FILE *fp);
 738 void backgroundSaveDoneHandler(int statloc);
 739
 740 /* AOF persistence */
 741 void flushAppendOnlyFile(void);
 742 void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
 743 void aofRemoveTempFile(pid_t childpid);
 744 int rewriteAppendOnlyFileBackground(void);
 745 int loadAppendOnlyFile(char *filename);
 746 void stopAppendOnly(void);
 747 int startAppendOnly(void);
 748 void backgroundRewriteDoneHandler(int statloc);
 749
 750 /* Sorted sets data type */
 751 zskiplist *zslCreate(void);
 752 void zslFree(zskiplist *zsl);
 753 zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
 754
 755 /* Core functions */
 756 void freeMemoryIfNeeded(void);
 757 int processCommand(redisClient *c);
 758 void setupSigSegvAction(void);
 759 struct redisCommand *lookupCommand(sds name);
 760 struct redisCommand *lookupCommandByCString(char *s);
 761 void call(redisClient *c, struct redisCommand *cmd);
 762 int prepareForShutdown();
 763 void redisLog(int level, const char *fmt, ...);
 764 void usage();
 765 void updateDictResizePolicy(void);
 766 int htNeedsResize(dict *dict);
 767 void oom(const char *msg);
 768 void populateCommandTable(void);
 769
 770 /* Virtual Memory */
 771 void vmInit(void);
 772 void vmMarkPagesFree(off_t page, off_t count);
 773 robj *vmLoadObject(robj *o);
 774 robj *vmPreviewObject(robj *o);
 775 int vmSwapOneObjectBlocking(void);
 776 int vmSwapOneObjectThreaded(void);
 777 int vmCanSwapOut(void);
 778 void vmThreadedIOCompletedJob(aeEventLoop *el, int fd, void *privdata, int mask);
 779 void vmCancelThreadedIOJob(robj *o);
 780 void lockThreadedIO(void);
 781 void unlockThreadedIO(void);
 782 int vmSwapObjectThreaded(robj *key, robj *val, redisDb *db);
 783 void freeIOJob(iojob *j);
 784 void queueIOJob(iojob *j);
 785 int vmWriteObjectOnSwap(robj *o, off_t page);
 786 robj *vmReadObjectFromSwap(off_t page, int type);
 787 void waitEmptyIOJobsQueue(void);
 788 void vmReopenSwapFile(void);
 789 int vmFreePage(off_t page);
 790 void zunionInterBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
 791 void execBlockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd, int argc, robj **argv);
 792 int blockClientOnSwappedKeys(redisClient *c, struct redisCommand *cmd);
 793 int dontWaitForSwappedKey(redisClient *c, robj *key);
 794 void handleClientsBlockedOnSwappedKey(redisDb *db, robj *key);
 795 vmpointer *vmSwapObjectBlocking(robj *val);
 796
 797 /* Set data type */
 798 robj *setTypeCreate(robj *value);
 799 int setTypeAdd(robj *subject, robj *value);
 800 int setTypeRemove(robj *subject, robj *value);
 801 int setTypeIsMember(robj *subject, robj *value);
 802 setTypeIterator *setTypeInitIterator(robj *subject);
 803 void setTypeReleaseIterator(setTypeIterator *si);
 804 robj *setTypeNext(setTypeIterator *si);
 805 robj *setTypeRandomElement(robj *subject);
 806 unsigned long setTypeSize(robj *subject);
 807 void setTypeConvert(robj *subject, int enc);
 808
 809 /* Hash data type */
 810 void convertToRealHash(robj *o);
 811 void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
 812 void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
 813 robj *hashTypeGet(robj *o, robj *key);
 814 int hashTypeExists(robj *o, robj *key);
 815 int hashTypeSet(robj *o, robj *key, robj *value);
 816 int hashTypeDelete(robj *o, robj *key);
 817 unsigned long hashTypeLength(robj *o);
 818 hashTypeIterator *hashTypeInitIterator(robj *subject);
 819 void hashTypeReleaseIterator(hashTypeIterator *hi);
 820 int hashTypeNext(hashTypeIterator *hi);
 821 robj *hashTypeCurrent(hashTypeIterator *hi, int what);
 822 robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
 823
 824 /* Pub / Sub */
 825 int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
 826 int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
 827 void freePubsubPattern(void *p);
 828 int listMatchPubsubPattern(void *a, void *b);
 829
 830 /* Utility functions */
 831 int stringmatchlen(const char *pattern, int patternLen,
 832         const char *string, int stringLen, int nocase);
 833 int stringmatch(const char *pattern, const char *string, int nocase);
 834 long long memtoll(const char *p, int *err);
 835 int ll2string(char *s, size_t len, long long value);
 836 int isStringRepresentableAsLong(sds s, long *longval);
 837 int isStringRepresentableAsLongLong(sds s, long long *longval);
 838 int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
 839
 840 /* Configuration */
 841 void loadServerConfig(char *filename);
 842 void appendServerSaveParams(time_t seconds, int changes);
 843 void resetServerSaveParams();
 844
 845 /* db.c -- Keyspace access API */
 846 int removeExpire(redisDb *db, robj *key);
 847 void propagateExpire(redisDb *db, robj *key);
 848 int expireIfNeeded(redisDb *db, robj *key);
 849 time_t getExpire(redisDb *db, robj *key);
 850 void setExpire(redisDb *db, robj *key, time_t when);
 851 robj *lookupKey(redisDb *db, robj *key);
 852 robj *lookupKeyRead(redisDb *db, robj *key);
 853 robj *lookupKeyWrite(redisDb *db, robj *key);
 854 robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
 855 robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
 856 int dbAdd(redisDb *db, robj *key, robj *val);
 857 int dbReplace(redisDb *db, robj *key, robj *val);
 858 int dbExists(redisDb *db, robj *key);
 859 robj *dbRandomKey(redisDb *db);
 860 int dbDelete(redisDb *db, robj *key);
 861 long long emptyDb();
 862 int selectDb(redisClient *c, int id);
 863
 864 /* Git SHA1 */
 865 char *redisGitSHA1(void);
 866 char *redisGitDirty(void);
 867
 868 /* Commands prototypes */
 869 void authCommand(redisClient *c);
 870 void pingCommand(redisClient *c);
 871 void echoCommand(redisClient *c);
 872 void setCommand(redisClient *c);
 873 void setnxCommand(redisClient *c);
 874 void setexCommand(redisClient *c);
 875 void getCommand(redisClient *c);
 876 void delCommand(redisClient *c);
 877 void existsCommand(redisClient *c);
 878 void incrCommand(redisClient *c);
 879 void decrCommand(redisClient *c);
 880 void incrbyCommand(redisClient *c);
 881 void decrbyCommand(redisClient *c);
 882 void selectCommand(redisClient *c);
 883 void randomkeyCommand(redisClient *c);
 884 void keysCommand(redisClient *c);
 885 void dbsizeCommand(redisClient *c);
 886 void lastsaveCommand(redisClient *c);
 887 void saveCommand(redisClient *c);
 888 void bgsaveCommand(redisClient *c);
 889 void bgrewriteaofCommand(redisClient *c);
 890 void shutdownCommand(redisClient *c);
 891 void moveCommand(redisClient *c);
 892 void renameCommand(redisClient *c);
 893 void renamenxCommand(redisClient *c);
 894 void lpushCommand(redisClient *c);
 895 void rpushCommand(redisClient *c);
 896 void lpushxCommand(redisClient *c);
 897 void rpushxCommand(redisClient *c);
 898 void linsertCommand(redisClient *c);
 899 void lpopCommand(redisClient *c);
 900 void rpopCommand(redisClient *c);
 901 void llenCommand(redisClient *c);
 902 void lindexCommand(redisClient *c);
 903 void lrangeCommand(redisClient *c);
 904 void ltrimCommand(redisClient *c);
 905 void typeCommand(redisClient *c);
 906 void lsetCommand(redisClient *c);
 907 void saddCommand(redisClient *c);
 908 void sremCommand(redisClient *c);
 909 void smoveCommand(redisClient *c);
 910 void sismemberCommand(redisClient *c);
 911 void scardCommand(redisClient *c);
 912 void spopCommand(redisClient *c);
 913 void srandmemberCommand(redisClient *c);
 914 void sinterCommand(redisClient *c);
 915 void sinterstoreCommand(redisClient *c);
 916 void sunionCommand(redisClient *c);
 917 void sunionstoreCommand(redisClient *c);
 918 void sdiffCommand(redisClient *c);
 919 void sdiffstoreCommand(redisClient *c);
 920 void syncCommand(redisClient *c);
 921 void flushdbCommand(redisClient *c);
 922 void flushallCommand(redisClient *c);
 923 void sortCommand(redisClient *c);
 924 void lremCommand(redisClient *c);
 925 void rpoplpushcommand(redisClient *c);
 926 void infoCommand(redisClient *c);
 927 void mgetCommand(redisClient *c);
 928 void monitorCommand(redisClient *c);
 929 void expireCommand(redisClient *c);
 930 void expireatCommand(redisClient *c);
 931 void getsetCommand(redisClient *c);
 932 void ttlCommand(redisClient *c);
 933 void persistCommand(redisClient *c);
 934 void slaveofCommand(redisClient *c);
 935 void debugCommand(redisClient *c);
 936 void msetCommand(redisClient *c);
 937 void msetnxCommand(redisClient *c);
 938 void zaddCommand(redisClient *c);
 939 void zincrbyCommand(redisClient *c);
 940 void zrangeCommand(redisClient *c);
 941 void zrangebyscoreCommand(redisClient *c);
 942 void zrevrangebyscoreCommand(redisClient *c);
 943 void zcountCommand(redisClient *c);
 944 void zrevrangeCommand(redisClient *c);
 945 void zcardCommand(redisClient *c);
 946 void zremCommand(redisClient *c);
 947 void zscoreCommand(redisClient *c);
 948 void zremrangebyscoreCommand(redisClient *c);
 949 void multiCommand(redisClient *c);
 950 void execCommand(redisClient *c);
 951 void discardCommand(redisClient *c);
 952 void blpopCommand(redisClient *c);
 953 void brpopCommand(redisClient *c);
 954 void appendCommand(redisClient *c);
 955 void substrCommand(redisClient *c);
 956 void strlenCommand(redisClient *c);
 957 void zrankCommand(redisClient *c);
 958 void zrevrankCommand(redisClient *c);
 959 void hsetCommand(redisClient *c);
 960 void hsetnxCommand(redisClient *c);
 961 void hgetCommand(redisClient *c);
 962 void hmsetCommand(redisClient *c);
 963 void hmgetCommand(redisClient *c);
 964 void hdelCommand(redisClient *c);
 965 void hlenCommand(redisClient *c);
 966 void zremrangebyrankCommand(redisClient *c);
 967 void zunionstoreCommand(redisClient *c);
 968 void zinterstoreCommand(redisClient *c);
 969 void hkeysCommand(redisClient *c);
 970 void hvalsCommand(redisClient *c);
 971 void hgetallCommand(redisClient *c);
 972 void hexistsCommand(redisClient *c);
 973 void configCommand(redisClient *c);
 974 void hincrbyCommand(redisClient *c);
 975 void subscribeCommand(redisClient *c);
 976 void unsubscribeCommand(redisClient *c);
 977 void psubscribeCommand(redisClient *c);
 978 void punsubscribeCommand(redisClient *c);
 979 void publishCommand(redisClient *c);
 980 void watchCommand(redisClient *c);
 981 void unwatchCommand(redisClient *c);
 982
 983 #if defined(__GNUC__)
 984 void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
 985 void free(void *ptr) __attribute__ ((deprecated));
 986 void *malloc(size_t size) __attribute__ ((deprecated));
 987 void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
 988 #endif
 989
 990 #endif