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