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