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