server.h 92.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*
 * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Redis nor the names of its contributors may be used
 *     to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

30 31 32 33 34 35
#ifndef __REDIS_H
#define __REDIS_H

#include "fmacros.h"
#include "config.h"
#include "solarisfixes.h"
36
#include "rio.h"
37 38 39 40 41 42 43 44

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <limits.h>
#include <unistd.h>
#include <errno.h>
45
#include <inttypes.h>
A
antirez 已提交
46
#include <pthread.h>
J
Jonah H. Harris 已提交
47
#include <syslog.h>
A
antirez 已提交
48
#include <netinet/in.h>
49
#include <lua.h>
50
#include <signal.h>
51

52 53
typedef long long mstime_t; /* millisecond time type. */

54 55 56 57
#include "ae.h"      /* Event driven programming library */
#include "sds.h"     /* Dynamic safe strings */
#include "dict.h"    /* Hash tables */
#include "adlist.h"  /* Linked lists */
58
#include "zmalloc.h" /* total memory usage aware version of malloc/free */
59
#include "anet.h"    /* Networking the easy way */
60
#include "ziplist.h" /* Compact list data structure */
61 62 63
#include "intset.h"  /* Compact integer set structure */
#include "version.h" /* Version macro */
#include "util.h"    /* Misc functions useful in many places */
64
#include "latency.h" /* Latency monitor API */
A
antirez 已提交
65
#include "sparkline.h" /* ASCII graphs API */
66 67 68
#include "quicklist.h"  /* Lists are encoded as linked lists of
                           N-elements flat arrays */
#include "rax.h"     /* Radix tree */
69

70 71 72 73 74 75
/* Following includes allow test functions to be called from Redis main() */
#include "zipmap.h"
#include "sha1.h"
#include "endianconv.h"
#include "crc64.h"

76
/* Error codes */
77 78
#define C_OK                    0
#define C_ERR                   -1
79 80

/* Static server configuration */
81
#define CONFIG_DEFAULT_HZ        10      /* Time interrupt calls/sec. */
A
antirez 已提交
82 83 84 85 86
#define CONFIG_MIN_HZ            1
#define CONFIG_MAX_HZ            500
#define CONFIG_DEFAULT_SERVER_PORT        6379    /* TCP port */
#define CONFIG_DEFAULT_TCP_BACKLOG       511     /* TCP listen backlog */
#define CONFIG_DEFAULT_CLIENT_TIMEOUT       0       /* default client timeout: infinite */
87
#define CONFIG_DEFAULT_DBNUM     16
A
antirez 已提交
88 89 90 91 92 93 94 95 96 97
#define CONFIG_MAX_LINE    1024
#define CRON_DBS_PER_CALL 16
#define NET_MAX_WRITES_PER_EVENT (1024*64)
#define PROTO_SHARED_SELECT_CMDS 10
#define OBJ_SHARED_INTEGERS 10000
#define OBJ_SHARED_BULKHDR_LEN 32
#define LOG_MAX_LEN    1024 /* Default maximum length of syslog messages */
#define AOF_REWRITE_PERC  100
#define AOF_REWRITE_MIN_SIZE (64*1024*1024)
#define AOF_REWRITE_ITEMS_PER_CMD 64
A
antirez 已提交
98
#define AOF_READ_DIFF_INTERVAL_BYTES (1024*10)
A
antirez 已提交
99 100
#define CONFIG_DEFAULT_SLOWLOG_LOG_SLOWER_THAN 10000
#define CONFIG_DEFAULT_SLOWLOG_MAX_LEN 128
101
#define CONFIG_DEFAULT_MAX_CLIENTS 10000
A
antirez 已提交
102
#define CONFIG_AUTHPASS_MAX_LEN 512
103
#define CONFIG_DEFAULT_SLAVE_PRIORITY 100
A
antirez 已提交
104 105 106 107
#define CONFIG_DEFAULT_REPL_TIMEOUT 60
#define CONFIG_DEFAULT_REPL_PING_SLAVE_PERIOD 10
#define CONFIG_RUN_ID_SIZE 40
#define RDB_EOF_MARK_SIZE 40
108 109
#define CONFIG_DEFAULT_REPL_BACKLOG_SIZE (1024*1024)    /* 1mb */
#define CONFIG_DEFAULT_REPL_BACKLOG_TIME_LIMIT (60*60)  /* 1 hour */
A
antirez 已提交
110 111
#define CONFIG_REPL_BACKLOG_MIN_SIZE (1024*16)          /* 16k */
#define CONFIG_BGSAVE_RETRY_DELAY 5 /* Wait a few secs before trying again. */
112 113 114
#define CONFIG_DEFAULT_PID_FILE "/var/run/redis.pid"
#define CONFIG_DEFAULT_SYSLOG_IDENT "redis"
#define CONFIG_DEFAULT_CLUSTER_CONFIG_FILE "nodes.conf"
115 116 117
#define CONFIG_DEFAULT_CLUSTER_ANNOUNCE_IP NULL         /* Auto detect. */
#define CONFIG_DEFAULT_CLUSTER_ANNOUNCE_PORT 0          /* Use server.port */
#define CONFIG_DEFAULT_CLUSTER_ANNOUNCE_BUS_PORT 0      /* Use +10000 offset. */
118 119
#define CONFIG_DEFAULT_DAEMONIZE 0
#define CONFIG_DEFAULT_UNIX_SOCKET_PERM 0
120
#define CONFIG_DEFAULT_TCP_KEEPALIVE 300
121
#define CONFIG_DEFAULT_PROTECTED_MODE 1
122 123 124 125 126 127 128 129 130 131
#define CONFIG_DEFAULT_LOGFILE ""
#define CONFIG_DEFAULT_SYSLOG_ENABLED 0
#define CONFIG_DEFAULT_STOP_WRITES_ON_BGSAVE_ERROR 1
#define CONFIG_DEFAULT_RDB_COMPRESSION 1
#define CONFIG_DEFAULT_RDB_CHECKSUM 1
#define CONFIG_DEFAULT_RDB_FILENAME "dump.rdb"
#define CONFIG_DEFAULT_REPL_DISKLESS_SYNC 0
#define CONFIG_DEFAULT_REPL_DISKLESS_SYNC_DELAY 5
#define CONFIG_DEFAULT_SLAVE_SERVE_STALE_DATA 1
#define CONFIG_DEFAULT_SLAVE_READ_ONLY 1
132 133
#define CONFIG_DEFAULT_SLAVE_ANNOUNCE_IP NULL
#define CONFIG_DEFAULT_SLAVE_ANNOUNCE_PORT 0
134 135 136
#define CONFIG_DEFAULT_REPL_DISABLE_TCP_NODELAY 0
#define CONFIG_DEFAULT_MAXMEMORY 0
#define CONFIG_DEFAULT_MAXMEMORY_SAMPLES 5
137 138
#define CONFIG_DEFAULT_LFU_LOG_FACTOR 10
#define CONFIG_DEFAULT_LFU_DECAY_TIME 1
139 140 141
#define CONFIG_DEFAULT_AOF_FILENAME "appendonly.aof"
#define CONFIG_DEFAULT_AOF_NO_FSYNC_ON_REWRITE 0
#define CONFIG_DEFAULT_AOF_LOAD_TRUNCATED 1
142
#define CONFIG_DEFAULT_AOF_USE_RDB_PREAMBLE 1
143 144
#define CONFIG_DEFAULT_ACTIVE_REHASHING 1
#define CONFIG_DEFAULT_AOF_REWRITE_INCREMENTAL_FSYNC 1
145
#define CONFIG_DEFAULT_RDB_SAVE_INCREMENTAL_FSYNC 1
146 147
#define CONFIG_DEFAULT_MIN_SLAVES_TO_WRITE 0
#define CONFIG_DEFAULT_MIN_SLAVES_MAX_LAG 10
A
antirez 已提交
148 149 150 151
#define NET_IP_STR_LEN 46 /* INET6_ADDRSTRLEN is 46, but we need to be sure */
#define NET_PEER_ID_LEN (NET_IP_STR_LEN+32) /* Must be enough for ip:port */
#define CONFIG_BINDADDR_MAX 16
#define CONFIG_MIN_RESERVED_FDS 32
152
#define CONFIG_DEFAULT_LATENCY_MONITOR_THRESHOLD 0
153 154 155 156
#define CONFIG_DEFAULT_SLAVE_LAZY_FLUSH 0
#define CONFIG_DEFAULT_LAZYFREE_LAZY_EVICTION 0
#define CONFIG_DEFAULT_LAZYFREE_LAZY_EXPIRE 0
#define CONFIG_DEFAULT_LAZYFREE_LAZY_SERVER_DEL 0
157
#define CONFIG_DEFAULT_ALWAYS_SHOW_LOGO 0
158
#define CONFIG_DEFAULT_ACTIVE_DEFRAG 0
O
oranagra 已提交
159 160 161
#define CONFIG_DEFAULT_DEFRAG_THRESHOLD_LOWER 10 /* don't defrag when fragmentation is below 10% */
#define CONFIG_DEFAULT_DEFRAG_THRESHOLD_UPPER 100 /* maximum defrag force at 100% fragmentation */
#define CONFIG_DEFAULT_DEFRAG_IGNORE_BYTES (100<<20) /* don't defrag if frag overhead is below 100mb */
O
Oran Agra 已提交
162
#define CONFIG_DEFAULT_DEFRAG_CYCLE_MIN 5 /* 5% CPU min (at lower threshold) */
O
oranagra 已提交
163
#define CONFIG_DEFAULT_DEFRAG_CYCLE_MAX 75 /* 75% CPU max (at upper threshold) */
O
Oran Agra 已提交
164
#define CONFIG_DEFAULT_DEFRAG_MAX_SCAN_FIELDS 1000 /* keys with more than 1000 fields will be processed separately */
165
#define CONFIG_DEFAULT_PROTO_MAX_BULK_LEN (512ll*1024*1024) /* Bulk request max size */
166

A
antirez 已提交
167 168 169 170 171 172
#define ACTIVE_EXPIRE_CYCLE_LOOKUPS_PER_LOOP 20 /* Loopkups per loop. */
#define ACTIVE_EXPIRE_CYCLE_FAST_DURATION 1000 /* Microseconds */
#define ACTIVE_EXPIRE_CYCLE_SLOW_TIME_PERC 25 /* CPU max % for keys collection */
#define ACTIVE_EXPIRE_CYCLE_SLOW 0
#define ACTIVE_EXPIRE_CYCLE_FAST 1

173
/* Instantaneous metrics tracking. */
A
antirez 已提交
174 175 176 177 178
#define STATS_METRIC_SAMPLES 16     /* Number of samples per metric. */
#define STATS_METRIC_COMMAND 0      /* Number of commands executed. */
#define STATS_METRIC_NET_INPUT 1    /* Bytes read to network .*/
#define STATS_METRIC_NET_OUTPUT 2   /* Bytes written to network. */
#define STATS_METRIC_COUNT 3
179

180
/* Protocol and I/O related defines */
A
antirez 已提交
181 182 183 184 185
#define PROTO_MAX_QUERYBUF_LEN  (1024*1024*1024) /* 1GB max query buffer. */
#define PROTO_IOBUF_LEN         (1024*16)  /* Generic I/O buffer size */
#define PROTO_REPLY_CHUNK_BYTES (16*1024) /* 16k output buffer */
#define PROTO_INLINE_MAX_SIZE   (1024*64) /* Max size of inline reads */
#define PROTO_MBULK_BIG_ARG     (1024*32)
186
#define LONG_STR_SIZE      21          /* Bytes needed for long -> str + '\0' */
187
#define REDIS_AUTOSYNC_BYTES (1024*1024*32) /* fdatasync every 32MB */
A
antirez 已提交
188 189 190 191 192 193

/* When configuring the server eventloop, we setup it so that the total number
 * of file descriptors we can handle are server.maxclients + RESERVED_FDS +
 * a few more to stay safe. Since RESERVED_FDS defaults to 32, we add 96
 * in order to make sure of not over provisioning more than 128 fds. */
#define CONFIG_FDSET_INCR (CONFIG_MIN_RESERVED_FDS+96)
A
7c6da73  
antirez 已提交
194

195
/* Hash table parameters */
A
antirez 已提交
196
#define HASHTABLE_MIN_FILL        10      /* Minimal hash table fill 10% */
197

198 199
/* Command flags. Please check the command table defined in the redis.c file
 * for more information about the meaning of every flag. */
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
#define CMD_WRITE (1<<0)            /* "w" flag */
#define CMD_READONLY (1<<1)         /* "r" flag */
#define CMD_DENYOOM (1<<2)          /* "m" flag */
#define CMD_MODULE (1<<3)           /* Command exported by module. */
#define CMD_ADMIN (1<<4)            /* "a" flag */
#define CMD_PUBSUB (1<<5)           /* "p" flag */
#define CMD_NOSCRIPT (1<<6)         /* "s" flag */
#define CMD_RANDOM (1<<7)           /* "R" flag */
#define CMD_SORT_FOR_SCRIPT (1<<8)  /* "S" flag */
#define CMD_LOADING (1<<9)          /* "l" flag */
#define CMD_STALE (1<<10)           /* "t" flag */
#define CMD_SKIP_MONITOR (1<<11)    /* "M" flag */
#define CMD_ASKING (1<<12)          /* "k" flag */
#define CMD_FAST (1<<13)            /* "F" flag */
#define CMD_MODULE_GETKEYS (1<<14)  /* Use the modules getkeys interface. */
#define CMD_MODULE_NO_CLUSTER (1<<15) /* Deny on Redis Cluster. */
216

217
/* AOF states */
A
antirez 已提交
218 219 220
#define AOF_OFF 0             /* AOF is off */
#define AOF_ON 1              /* AOF is on */
#define AOF_WAIT_REWRITE 2    /* AOF waits rewrite to start appending */
221

222
/* Client flags */
A
antirez 已提交
223 224 225 226 227 228 229 230
#define CLIENT_SLAVE (1<<0)   /* This client is a slave server */
#define CLIENT_MASTER (1<<1)  /* This client is a master server */
#define CLIENT_MONITOR (1<<2) /* This client is a slave monitor, see MONITOR */
#define CLIENT_MULTI (1<<3)   /* This client is in a MULTI context */
#define CLIENT_BLOCKED (1<<4) /* The client is waiting in a blocking operation */
#define CLIENT_DIRTY_CAS (1<<5) /* Watched keys modified. EXEC will fail. */
#define CLIENT_CLOSE_AFTER_REPLY (1<<6) /* Close after writing entire reply. */
#define CLIENT_UNBLOCKED (1<<7) /* This client was unblocked and is stored in
A
antirez 已提交
231
                                  server.unblocked_clients */
A
antirez 已提交
232 233 234 235 236 237 238 239 240 241 242
#define CLIENT_LUA (1<<8) /* This is a non connected client used by Lua */
#define CLIENT_ASKING (1<<9)     /* Client issued the ASKING command */
#define CLIENT_CLOSE_ASAP (1<<10)/* Close this client ASAP */
#define CLIENT_UNIX_SOCKET (1<<11) /* Client connected via Unix domain socket */
#define CLIENT_DIRTY_EXEC (1<<12)  /* EXEC will fail for errors while queueing */
#define CLIENT_MASTER_FORCE_REPLY (1<<13)  /* Queue replies even if is master */
#define CLIENT_FORCE_AOF (1<<14)   /* Force AOF propagation of current cmd. */
#define CLIENT_FORCE_REPL (1<<15)  /* Force replication of current cmd. */
#define CLIENT_PRE_PSYNC (1<<16)   /* Instance don't understand PSYNC. */
#define CLIENT_READONLY (1<<17)    /* Cluster client is in read-only state. */
#define CLIENT_PUBSUB (1<<18)      /* Client is in Pub/Sub mode. */
243 244 245 246
#define CLIENT_PREVENT_AOF_PROP (1<<19)  /* Don't propagate to AOF. */
#define CLIENT_PREVENT_REPL_PROP (1<<20)  /* Don't propagate to slaves. */
#define CLIENT_PREVENT_PROP (CLIENT_PREVENT_AOF_PROP|CLIENT_PREVENT_REPL_PROP)
#define CLIENT_PENDING_WRITE (1<<21) /* Client has output to send but a write
247
                                        handler is yet not installed. */
248 249 250
#define CLIENT_REPLY_OFF (1<<22)   /* Don't send replies to client. */
#define CLIENT_REPLY_SKIP_NEXT (1<<23)  /* Set CLIENT_REPLY_SKIP for next cmd */
#define CLIENT_REPLY_SKIP (1<<24)  /* Don't send just this reply. */
251
#define CLIENT_LUA_DEBUG (1<<25)  /* Run EVAL in debug mode. */
A
antirez 已提交
252
#define CLIENT_LUA_DEBUG_SYNC (1<<26)  /* EVAL debugging without fork() */
A
antirez 已提交
253
#define CLIENT_MODULE (1<<27) /* Non connected client used by some module. */
254

255
/* Client block type (btype field in client structure)
A
antirez 已提交
256 257 258 259
 * if CLIENT_BLOCKED flag is set. */
#define BLOCKED_NONE 0    /* Not blocked, no CLIENT_BLOCKED flag set. */
#define BLOCKED_LIST 1    /* BLPOP & co. */
#define BLOCKED_WAIT 2    /* WAIT for synchronous replication. */
260
#define BLOCKED_MODULE 3  /* Blocked by a loadable module. */
261
#define BLOCKED_STREAM 4  /* XREAD. */
262 263
#define BLOCKED_ZSET 5    /* BZPOP et al. */
#define BLOCKED_NUM 6     /* Number of blocked states. */
264

265
/* Client request types */
A
antirez 已提交
266 267
#define PROTO_REQ_INLINE 1
#define PROTO_REQ_MULTIBULK 2
268

269 270
/* Client classes for client limits, currently used only for
 * the max-client-output-buffer limit implementation. */
A
antirez 已提交
271 272 273
#define CLIENT_TYPE_NORMAL 0 /* Normal req-reply clients + MONITORs */
#define CLIENT_TYPE_SLAVE 1  /* Slaves. */
#define CLIENT_TYPE_PUBSUB 2 /* Clients subscribed to PubSub channels. */
A
antirez 已提交
274 275 276 277
#define CLIENT_TYPE_MASTER 3 /* Master. */
#define CLIENT_TYPE_OBUF_COUNT 3 /* Number of clients to expose to output
                                    buffer configuration. Just the first
                                    three: normal, slave, pubsub. */
A
antirez 已提交
278 279 280 281 282 283

/* Slave replication state. Used in server.repl_state for slaves to remember
 * what to do next. */
#define REPL_STATE_NONE 0 /* No active replication */
#define REPL_STATE_CONNECT 1 /* Must connect to master */
#define REPL_STATE_CONNECTING 2 /* Connecting to master */
A
antirez 已提交
284
/* --- Handshake states, must be ordered --- */
A
antirez 已提交
285
#define REPL_STATE_RECEIVE_PONG 3 /* Wait for PING reply */
286 287 288 289
#define REPL_STATE_SEND_AUTH 4 /* Send AUTH to master */
#define REPL_STATE_RECEIVE_AUTH 5 /* Wait for AUTH reply */
#define REPL_STATE_SEND_PORT 6 /* Send REPLCONF listening-port */
#define REPL_STATE_RECEIVE_PORT 7 /* Wait for REPLCONF reply */
290 291 292 293 294 295
#define REPL_STATE_SEND_IP 8 /* Send REPLCONF ip-address */
#define REPL_STATE_RECEIVE_IP 9 /* Wait for REPLCONF reply */
#define REPL_STATE_SEND_CAPA 10 /* Send REPLCONF capa */
#define REPL_STATE_RECEIVE_CAPA 11 /* Wait for REPLCONF reply */
#define REPL_STATE_SEND_PSYNC 12 /* Send PSYNC */
#define REPL_STATE_RECEIVE_PSYNC 13 /* Wait for PSYNC reply */
A
antirez 已提交
296
/* --- End of handshake states --- */
297 298
#define REPL_STATE_TRANSFER 14 /* Receiving .rdb from master */
#define REPL_STATE_CONNECTED 15 /* Connected to master */
A
antirez 已提交
299 300

/* State of slaves from the POV of the master. Used in client->replstate.
301
 * In SEND_BULK and ONLINE state the slave receives new updates
A
antirez 已提交
302
 * in its output queue. In the WAIT_BGSAVE states instead the server is waiting
303
 * to start the next background saving in order to send updates to it. */
A
antirez 已提交
304 305 306 307
#define SLAVE_STATE_WAIT_BGSAVE_START 6 /* We need to produce a new RDB file. */
#define SLAVE_STATE_WAIT_BGSAVE_END 7 /* Waiting RDB file creation to finish. */
#define SLAVE_STATE_SEND_BULK 8 /* Sending RDB file to slave. */
#define SLAVE_STATE_ONLINE 9 /* RDB file transmitted, sending just updates. */
308

309 310
/* Slave capabilities. */
#define SLAVE_CAPA_NONE 0
311 312
#define SLAVE_CAPA_EOF (1<<0)    /* Can parse the RDB EOF streaming format. */
#define SLAVE_CAPA_PSYNC2 (1<<1) /* Supports PSYNC2 protocol. */
313

314
/* Synchronous read timeout - slave side */
A
antirez 已提交
315
#define CONFIG_REPL_SYNCIO_TIMEOUT 5
316 317

/* List related stuff */
A
antirez 已提交
318 319
#define LIST_HEAD 0
#define LIST_TAIL 1
320 321
#define ZSET_MIN 0
#define ZSET_MAX 1
322 323

/* Sort operations */
A
antirez 已提交
324
#define SORT_OP_GET 0
325 326

/* Log levels */
A
antirez 已提交
327 328 329 330 331 332
#define LL_DEBUG 0
#define LL_VERBOSE 1
#define LL_NOTICE 2
#define LL_WARNING 3
#define LL_RAW (1<<10) /* Modifier to log without timestamp */
#define CONFIG_DEFAULT_VERBOSITY LL_NOTICE
333

334
/* Supervision options */
A
antirez 已提交
335 336 337 338
#define SUPERVISED_NONE 0
#define SUPERVISED_AUTODETECT 1
#define SUPERVISED_SYSTEMD 2
#define SUPERVISED_UPSTART 3
339

340
/* Anti-warning macro... */
A
antirez 已提交
341
#define UNUSED(V) ((void) V)
342

343
#define ZSKIPLIST_MAXLEVEL 64 /* Should be enough for 2^64 elements */
344 345 346
#define ZSKIPLIST_P 0.25      /* Skiplist P = 1/4 */

/* Append only defines */
347 348 349
#define AOF_FSYNC_NO 0
#define AOF_FSYNC_ALWAYS 1
#define AOF_FSYNC_EVERYSEC 2
350
#define CONFIG_DEFAULT_AOF_FSYNC AOF_FSYNC_EVERYSEC
351

352
/* Zipped structures related defaults */
353 354 355 356 357
#define OBJ_HASH_MAX_ZIPLIST_ENTRIES 512
#define OBJ_HASH_MAX_ZIPLIST_VALUE 64
#define OBJ_SET_MAX_INTSET_ENTRIES 512
#define OBJ_ZSET_MAX_ZIPLIST_ENTRIES 128
#define OBJ_ZSET_MAX_ZIPLIST_VALUE 64
358 359
#define OBJ_STREAM_NODE_MAX_BYTES 4096
#define OBJ_STREAM_NODE_MAX_ENTRIES 100
360

361
/* List defaults */
362 363
#define OBJ_LIST_MAX_ZIPLIST_SIZE -2
#define OBJ_LIST_COMPRESS_DEPTH 0
364

365
/* HyperLogLog defines */
366
#define CONFIG_DEFAULT_HLL_SPARSE_MAX_BYTES 3000
367

368
/* Sets operations codes */
A
antirez 已提交
369 370 371
#define SET_OP_UNION 0
#define SET_OP_DIFF 1
#define SET_OP_INTER 2
372

373 374 375 376 377
/* Redis maxmemory strategies. Instead of using just incremental number
 * for this defines, we use a set of flags so that testing for certain
 * properties common to multiple policies is faster. */
#define MAXMEMORY_FLAG_LRU (1<<0)
#define MAXMEMORY_FLAG_LFU (1<<1)
378
#define MAXMEMORY_FLAG_ALLKEYS (1<<2)
379 380
#define MAXMEMORY_FLAG_NO_SHARED_INTEGERS \
    (MAXMEMORY_FLAG_LRU|MAXMEMORY_FLAG_LFU)
381

382 383 384 385
#define MAXMEMORY_VOLATILE_LRU ((0<<8)|MAXMEMORY_FLAG_LRU)
#define MAXMEMORY_VOLATILE_LFU ((1<<8)|MAXMEMORY_FLAG_LFU)
#define MAXMEMORY_VOLATILE_TTL (2<<8)
#define MAXMEMORY_VOLATILE_RANDOM (3<<8)
386 387 388
#define MAXMEMORY_ALLKEYS_LRU ((4<<8)|MAXMEMORY_FLAG_LRU|MAXMEMORY_FLAG_ALLKEYS)
#define MAXMEMORY_ALLKEYS_LFU ((5<<8)|MAXMEMORY_FLAG_LFU|MAXMEMORY_FLAG_ALLKEYS)
#define MAXMEMORY_ALLKEYS_RANDOM ((6<<8)|MAXMEMORY_FLAG_ALLKEYS)
389 390
#define MAXMEMORY_NO_EVICTION (7<<8)

A
antirez 已提交
391
#define CONFIG_DEFAULT_MAXMEMORY_POLICY MAXMEMORY_NO_EVICTION
392

A
antirez 已提交
393
/* Scripting */
A
antirez 已提交
394
#define LUA_SCRIPT_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
395

396 397 398 399
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

400
/* SHUTDOWN flags */
401 402 403 404
#define SHUTDOWN_NOFLAGS 0      /* No flags. */
#define SHUTDOWN_SAVE 1         /* Force SAVE on SHUTDOWN even if no save
                                   points are configured. */
#define SHUTDOWN_NOSAVE 2       /* Don't SAVE on SHUTDOWN. */
405

406
/* Command call flags, see call() function */
A
antirez 已提交
407
#define CMD_CALL_NONE 0
A
antirez 已提交
408 409 410 411 412
#define CMD_CALL_SLOWLOG (1<<0)
#define CMD_CALL_STATS (1<<1)
#define CMD_CALL_PROPAGATE_AOF (1<<2)
#define CMD_CALL_PROPAGATE_REPL (1<<3)
#define CMD_CALL_PROPAGATE (CMD_CALL_PROPAGATE_AOF|CMD_CALL_PROPAGATE_REPL)
A
antirez 已提交
413
#define CMD_CALL_FULL (CMD_CALL_SLOWLOG | CMD_CALL_STATS | CMD_CALL_PROPAGATE)
414

A
antirez 已提交
415
/* Command propagation flags, see propagate() function */
A
antirez 已提交
416 417 418
#define PROPAGATE_NONE 0
#define PROPAGATE_AOF 1
#define PROPAGATE_REPL 2
A
antirez 已提交
419

A
antirez 已提交
420
/* RDB active child save type. */
A
antirez 已提交
421 422 423
#define RDB_CHILD_TYPE_NONE 0
#define RDB_CHILD_TYPE_DISK 1     /* RDB is written to disk. */
#define RDB_CHILD_TYPE_SOCKET 2   /* RDB is written to slave socket. */
A
antirez 已提交
424

425 426
/* Keyspace changes notification classes. Every class is associated with a
 * character for configuration purposes. */
A
antirez 已提交
427 428 429 430 431 432 433 434 435 436
#define NOTIFY_KEYSPACE (1<<0)    /* K */
#define NOTIFY_KEYEVENT (1<<1)    /* E */
#define NOTIFY_GENERIC (1<<2)     /* g */
#define NOTIFY_STRING (1<<3)      /* $ */
#define NOTIFY_LIST (1<<4)        /* l */
#define NOTIFY_SET (1<<5)         /* s */
#define NOTIFY_HASH (1<<6)        /* h */
#define NOTIFY_ZSET (1<<7)        /* z */
#define NOTIFY_EXPIRED (1<<8)     /* x */
#define NOTIFY_EVICTED (1<<9)     /* e */
437 438
#define NOTIFY_STREAM (1<<10)     /* t */
#define NOTIFY_ALL (NOTIFY_GENERIC | NOTIFY_STRING | NOTIFY_LIST | NOTIFY_SET | NOTIFY_HASH | NOTIFY_ZSET | NOTIFY_EXPIRED | NOTIFY_EVICTED | NOTIFY_STREAM) /* A flag */
439

440
/* Get the first bind addr or NULL */
A
antirez 已提交
441
#define NET_FIRST_BIND_ADDR (server.bindaddr_count ? server.bindaddr[0] : NULL)
442

443 444
/* Using the following macro you can run code inside serverCron() with the
 * specified period, specified in milliseconds.
445 446
 * The actual resolution depends on server.hz. */
#define run_with_period(_ms_) if ((_ms_ <= 1000/server.hz) || !(server.cronloops%((_ms_)/(1000/server.hz))))
447

448
/* We can print the stacktrace, so our assert is defined this way: */
A
antirez 已提交
449 450
#define serverAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_serverAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
#define serverAssert(_e) ((_e)?(void)0 : (_serverAssert(#_e,__FILE__,__LINE__),_exit(1)))
451
#define serverPanic(...) _serverPanic(__FILE__,__LINE__,__VA_ARGS__),_exit(1)
452 453 454 455 456 457 458 459

/*-----------------------------------------------------------------------------
 * Data types
 *----------------------------------------------------------------------------*/

/* A redis object, that is a type able to hold a string / list / set */

/* The actual Redis Object */
460 461 462 463 464
#define OBJ_STRING 0    /* String object. */
#define OBJ_LIST 1      /* List object. */
#define OBJ_SET 2       /* Set object. */
#define OBJ_ZSET 3      /* Sorted set object. */
#define OBJ_HASH 4      /* Hash object. */
465

466 467 468 469 470 471 472 473 474 475 476
/* The "module" object type is a special one that signals that the object
 * is one directly managed by a Redis module. In this case the value points
 * to a moduleValue struct, which contains the object value (which is only
 * handled by the module itself) and the RedisModuleType struct which lists
 * function pointers in order to serialize, deserialize, AOF-rewrite and
 * free the object.
 *
 * Inside the RDB file, module types are encoded as OBJ_MODULE followed
 * by a 64 bit module type ID, which has a 54 bits module-specific signature
 * in order to dispatch the loading to the right module, plus a 10 bits
 * encoding version. */
477 478
#define OBJ_MODULE 5    /* Module object. */
#define OBJ_STREAM 6    /* Stream object. */
479 480 481 482 483 484 485 486 487 488

/* Extract encver / signature from a module type ID. */
#define REDISMODULE_TYPE_ENCVER_BITS 10
#define REDISMODULE_TYPE_ENCVER_MASK ((1<<REDISMODULE_TYPE_ENCVER_BITS)-1)
#define REDISMODULE_TYPE_ENCVER(id) (id & REDISMODULE_TYPE_ENCVER_MASK)
#define REDISMODULE_TYPE_SIGN(id) ((id & ~((uint64_t)REDISMODULE_TYPE_ENCVER_MASK)) >>REDISMODULE_TYPE_ENCVER_BITS)

struct RedisModule;
struct RedisModuleIO;
struct RedisModuleDigest;
489
struct RedisModuleCtx;
490 491 492 493 494 495 496 497 498 499
struct redisObject;

/* Each module type implementation should export a set of methods in order
 * to serialize and deserialize the value in the RDB file, rewrite the AOF
 * log, create the digest for "DEBUG DIGEST", and free the value when a key
 * is deleted. */
typedef void *(*moduleTypeLoadFunc)(struct RedisModuleIO *io, int encver);
typedef void (*moduleTypeSaveFunc)(struct RedisModuleIO *io, void *value);
typedef void (*moduleTypeRewriteFunc)(struct RedisModuleIO *io, struct redisObject *key, void *value);
typedef void (*moduleTypeDigestFunc)(struct RedisModuleDigest *digest, void *value);
500
typedef size_t (*moduleTypeMemUsageFunc)(const void *value);
501 502 503 504 505 506 507 508 509 510
typedef void (*moduleTypeFreeFunc)(void *value);

/* The module type, which is referenced in each value of a given type, defines
 * the methods and links to the module exporting the type. */
typedef struct RedisModuleType {
    uint64_t id; /* Higher 54 bits of type ID + 10 lower bits of encoding ver. */
    struct RedisModule *module;
    moduleTypeLoadFunc rdb_load;
    moduleTypeSaveFunc rdb_save;
    moduleTypeRewriteFunc aof_rewrite;
511
    moduleTypeMemUsageFunc mem_usage;
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
    moduleTypeDigestFunc digest;
    moduleTypeFreeFunc free;
    char name[10]; /* 9 bytes name + null term. Charset: A-Z a-z 0-9 _- */
} moduleType;

/* In Redis objects 'robj' structures of type OBJ_MODULE, the value pointer
 * is set to the following structure, referencing the moduleType structure
 * in order to work with the value, and at the same time providing a raw
 * pointer to the value, as created by the module commands operating with
 * the module type.
 *
 * So for example in order to free such a value, it is possible to use
 * the following code:
 *
 *  if (robj->type == OBJ_MODULE) {
 *      moduleValue *mt = robj->ptr;
 *      mt->type->free(mt->value);
 *      zfree(mt); // We need to release this in-the-middle struct as well.
 *  }
 */
typedef struct moduleValue {
    moduleType *type;
    void *value;
} moduleValue;

/* This is a wrapper for the 'rio' streams used inside rdb.c in Redis, so that
 * the user does not have to take the total count of the written bytes nor
 * to care about error conditions. */
typedef struct RedisModuleIO {
    size_t bytes;       /* Bytes read / written so far. */
    rio *rio;           /* Rio stream. */
    moduleType *type;   /* Module type doing the operation. */
    int error;          /* True if error condition happened. */
545 546
    int ver;            /* Module serialization version: 1 (old),
                         * 2 (current version with opcodes annotation). */
A
antirez 已提交
547
    struct RedisModuleCtx *ctx; /* Optional context, see RM_GetContextFromIO()*/
548 549
} RedisModuleIO;

550 551
/* Macro to initialize an IO context. Note that the 'ver' field is populated
 * inside rdb.c according to the version of the value to load. */
552 553 554 555 556
#define moduleInitIOContext(iovar,mtype,rioptr) do { \
    iovar.rio = rioptr; \
    iovar.type = mtype; \
    iovar.bytes = 0; \
    iovar.error = 0; \
557
    iovar.ver = 0; \
558
    iovar.ctx = NULL; \
559 560
} while(0);

A
antirez 已提交
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
/* This is a structure used to export DEBUG DIGEST capabilities to Redis
 * modules. We want to capture both the ordered and unordered elements of
 * a data structure, so that a digest can be created in a way that correctly
 * reflects the values. See the DEBUG DIGEST command implementation for more
 * background. */
typedef struct RedisModuleDigest {
    unsigned char o[20];    /* Ordered elements. */
    unsigned char x[20];    /* Xored elements. */
} RedisModuleDigest;

/* Just start with a digest composed of all zero bytes. */
#define moduleInitDigestContext(mdvar) do { \
    memset(mdvar.o,0,sizeof(mdvar.o)); \
    memset(mdvar.x,0,sizeof(mdvar.x)); \
} while(0);

577 578 579 580 581 582 583
/* Objects encoding. Some kind of objects like Strings and Hashes can be
 * internally represented in multiple ways. The 'encoding' field of the object
 * is set to one of this fields for this object. */
#define OBJ_ENCODING_RAW 0     /* Raw representation */
#define OBJ_ENCODING_INT 1     /* Encoded as integer */
#define OBJ_ENCODING_HT 2      /* Encoded as hash table */
#define OBJ_ENCODING_ZIPMAP 3  /* Encoded as zipmap */
584
#define OBJ_ENCODING_LINKEDLIST 4 /* No longer used: old list encoding. */
585 586 587 588 589
#define OBJ_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
#define OBJ_ENCODING_INTSET 6  /* Encoded as intset */
#define OBJ_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
#define OBJ_ENCODING_EMBSTR 8  /* Embedded sds string encoding */
#define OBJ_ENCODING_QUICKLIST 9 /* Encoded as linked list of ziplists */
590
#define OBJ_ENCODING_STREAM 10 /* Encoded as a radix tree of listpacks */
591

A
antirez 已提交
592 593 594
#define LRU_BITS 24
#define LRU_CLOCK_MAX ((1<<LRU_BITS)-1) /* Max value of obj->lru */
#define LRU_CLOCK_RESOLUTION 1000 /* LRU clock resolution in ms */
595 596

#define OBJ_SHARED_REFCOUNT INT_MAX
597 598 599
typedef struct redisObject {
    unsigned type:4;
    unsigned encoding:4;
600
    unsigned lru:LRU_BITS; /* LRU time (relative to global lru_clock) or
601
                            * LFU data (least significant 8 bits frequency
602
                            * and most significant 16 bits access time). */
603 604 605 606
    int refcount;
    void *ptr;
} robj;

G
guiquanz 已提交
607
/* Macro used to initialize a Redis object allocated on the stack.
608 609 610 611 612
 * Note that this macro is taken near the structure definition to make sure
 * we'll update it when the structure is changed, to avoid bugs like
 * bug #85 introduced exactly in this way. */
#define initStaticStringObject(_var,_ptr) do { \
    _var.refcount = 1; \
613 614
    _var.type = OBJ_STRING; \
    _var.encoding = OBJ_ENCODING_RAW; \
615
    _var.ptr = _ptr; \
O
Oran Agra 已提交
616
} while(0)
617

618
struct evictionPoolEntry; /* Defined in evict.c */
A
antirez 已提交
619 620 621 622

/* Redis database representation. There are multiple databases identified
 * by integers from 0 (the default database) up to the max configured
 * database. The database number is the 'id' field in the structure. */
623 624 625
typedef struct redisDb {
    dict *dict;                 /* The keyspace for this DB */
    dict *expires;              /* Timeout of keys with a timeout set */
626
    dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP)*/
627
    dict *ready_keys;           /* Blocked keys that received a PUSH */
628
    dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
A
antirez 已提交
629
    int id;                     /* Database ID */
630
    long long avg_ttl;          /* Average TTL, just for stats */
O
Oran Agra 已提交
631
    list *defrag_later;         /* List of key names to attempt to defrag one by one, gradually. */
632 633 634 635 636 637 638 639 640 641 642 643
} redisDb;

/* Client MULTI/EXEC state */
typedef struct multiCmd {
    robj **argv;
    int argc;
    struct redisCommand *cmd;
} multiCmd;

typedef struct multiState {
    multiCmd *commands;     /* Array of MULTI commands */
    int count;              /* Total number of MULTI commands */
644 645
    int minreplicas;        /* MINREPLICAS for synchronous replication */
    time_t minreplicas_timeout; /* MINREPLICAS timeout as unixtime. */
646 647
} multiState;

648 649
/* This structure holds the blocking operation state for a client.
 * The fields used depend on client->btype. */
650
typedef struct blockingState {
651 652 653 654
    /* Generic fields. */
    mstime_t timeout;       /* Blocking operation timeout. If UNIX current time
                             * is > timeout then the operation timed out. */

655
    /* BLOCKED_LIST, BLOCKED_ZSET and BLOCKED_STREAM */
656
    dict *keys;             /* The keys we are waiting to terminate a blocking
657
                             * operation such as BLPOP or XREAD. Or NULL. */
658 659
    robj *target;           /* The key that should receive the element,
                             * for BRPOPLPUSH. */
660

661 662
    /* BLOCK_STREAM */
    size_t xread_count;     /* XREAD COUNT option. */
663 664
    robj *xread_group;      /* XREADGROUP group name. */
    robj *xread_consumer;   /* XREADGROUP consumer name. */
665 666
    mstime_t xread_retry_time, xread_retry_ttl;

A
antirez 已提交
667
    /* BLOCKED_WAIT */
668 669
    int numreplicas;        /* Number of replicas we are waiting for ACK. */
    long long reploffset;   /* Replication offset to reach. */
670 671 672 673 674

    /* BLOCKED_MODULE */
    void *module_blocked_handle; /* RedisModuleBlockedClient structure.
                                    which is opaque for the Redis core, only
                                    handled in module.c. */
675 676
} blockingState;

677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
/* The following structure represents a node in the server.ready_keys list,
 * where we accumulate all the keys that had clients blocked with a blocking
 * operation such as B[LR]POP, but received new data in the context of the
 * last executed command.
 *
 * After the execution of every command or script, we run this list to check
 * if as a result we should serve data to clients blocked, unblocking them.
 * Note that server.ready_keys will not have duplicates as there dictionary
 * also called ready_keys in every structure representing a Redis database,
 * where we make sure to remember if a given key was already added in the
 * server.ready_keys list. */
typedef struct readyList {
    redisDb *db;
    robj *key;
} readyList;

G
guiquanz 已提交
693
/* With multiplexing we need to take per-client state.
X
xuxiang 已提交
694
 * Clients are taken in a linked list. */
695
typedef struct client {
696
    uint64_t id;            /* Client incremental unique ID. */
A
antirez 已提交
697 698 699 700
    int fd;                 /* Client socket. */
    redisDb *db;            /* Pointer to currently SELECTed DB. */
    robj *name;             /* As set by CLIENT SETNAME. */
    sds querybuf;           /* Buffer we use to accumulate client queries. */
701 702 703
    sds pending_querybuf;   /* If this is a master, this buffer represents the
                               yet not applied replication stream that we
                               are receiving from the master. */
A
antirez 已提交
704 705 706 707 708 709 710 711 712
    size_t querybuf_peak;   /* Recent (100ms or more) peak of querybuf size. */
    int argc;               /* Num of arguments of current command. */
    robj **argv;            /* Arguments of current command. */
    struct redisCommand *cmd, *lastcmd;  /* Last command executed. */
    int reqtype;            /* Request protocol type: PROTO_REQ_* */
    int multibulklen;       /* Number of multi bulk arguments left to read. */
    long bulklen;           /* Length of bulk argument in multi bulk request. */
    list *reply;            /* List of reply objects to send to the client. */
    unsigned long long reply_bytes; /* Tot bytes of objects in reply list. */
713
    size_t sentlen;         /* Amount of bytes already sent in the current
714
                               buffer or object being sent. */
A
antirez 已提交
715 716
    time_t ctime;           /* Client creation time. */
    time_t lastinteraction; /* Time of the last interaction, used for timeout */
717
    time_t obuf_soft_limit_reached_time;
A
antirez 已提交
718 719 720
    int flags;              /* Client flags: CLIENT_* macros. */
    int authenticated;      /* When requirepass is non-NULL. */
    int replstate;          /* Replication state if this is a slave. */
A
antirez 已提交
721
    int repl_put_online_on_ack; /* Install slave write handler on ACK. */
A
antirez 已提交
722 723 724 725
    int repldbfd;           /* Replication DB file descriptor. */
    off_t repldboff;        /* Replication DB file offset. */
    off_t repldbsize;       /* Replication DB file size. */
    sds replpreamble;       /* Replication DB preamble. */
726 727
    long long read_reploff; /* Read replication offset if this is a master. */
    long long reploff;      /* Applied replication offset if this is a master. */
A
antirez 已提交
728 729
    long long repl_ack_off; /* Replication ack offset, if this is a slave. */
    long long repl_ack_time;/* Replication ack time, if this is a slave. */
A
antirez 已提交
730 731 732
    long long psync_initial_offset; /* FULLRESYNC reply offset other slaves
                                       copying this slave output buffer
                                       should use. */
733 734
    char replid[CONFIG_RUN_ID_SIZE+1]; /* Master replication ID (if master). */
    int slave_listening_port; /* As configured with: SLAVECONF listening-port */
735
    char slave_ip[NET_IP_STR_LEN]; /* Optionally given by REPLCONF ip-address */
736
    int slave_capa;         /* Slave capabilities: SLAVE_CAPA_* bitwise OR. */
737
    multiState mstate;      /* MULTI/EXEC state */
A
antirez 已提交
738
    int btype;              /* Type of blocking op if CLIENT_BLOCKED. */
739 740
    blockingState bpop;     /* blocking state */
    long long woff;         /* Last write global replication offset. */
741 742 743
    list *watched_keys;     /* Keys WATCHED for MULTI/EXEC CAS */
    dict *pubsub_channels;  /* channels a client is interested in (SUBSCRIBE) */
    list *pubsub_patterns;  /* patterns a client is interested in (SUBSCRIBE) */
744
    sds peerid;             /* Cached peer ID. */
745
    listNode *client_list_node; /* list node in client list */
746 747

    /* Response buffer */
748
    int bufpos;
A
antirez 已提交
749
    char buf[PROTO_REPLY_CHUNK_BYTES];
750
} client;
751 752 753 754 755 756

struct saveparam {
    time_t seconds;
    int changes;
};

757
struct moduleLoadQueueEntry {
758 759
    sds path;
    int argc;
760
    robj **argv;
761 762
};

763 764 765 766
struct sharedObjectsStruct {
    robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
    *colon, *nullbulk, *nullmultibulk, *queued,
    *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
767
    *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
768
    *masterdownerr, *roslaveerr, *execaborterr, *noautherr, *noreplicaserr,
769
    *busykeyerr, *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
770
    *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *unlink,
771
    *rpop, *lpop, *lpush, *zpopmin, *zpopmax, *emptyscan,
A
antirez 已提交
772 773 774 775
    *select[PROTO_SHARED_SELECT_CMDS],
    *integers[OBJ_SHARED_INTEGERS],
    *mbulkhdr[OBJ_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
    *bulkhdr[OBJ_SHARED_BULKHDR_LEN];  /* "$<value>\r\n" */
776
    sds minstring, maxstring;
777 778
};

779 780
/* ZSETs use a specialized version of Skiplists */
typedef struct zskiplistNode {
781
    sds ele;
782 783 784 785
    double score;
    struct zskiplistNode *backward;
    struct zskiplistLevel {
        struct zskiplistNode *forward;
786
        unsigned long span;
787 788 789 790 791 792 793 794 795 796 797 798 799 800
    } level[];
} zskiplistNode;

typedef struct zskiplist {
    struct zskiplistNode *header, *tail;
    unsigned long length;
    int level;
} zskiplist;

typedef struct zset {
    dict *dict;
    zskiplist *zsl;
} zset;

801
typedef struct clientBufferLimitsConfig {
802 803
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
804 805 806
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

A
antirez 已提交
807
extern clientBufferLimitsConfig clientBufferLimitsDefaults[CLIENT_TYPE_OBUF_COUNT];
808

809 810
/* The redisOp structure defines a Redis Operation, that is an instance of
 * a command with an argument vector, database ID, propagation target
A
antirez 已提交
811
 * (PROPAGATE_*), and command pointer.
812 813 814 815
 *
 * Currently only used to additionally propagate more commands to AOF/Replication
 * after the propagation of the executed command. */
typedef struct redisOp {
816 817 818
    robj **argv;
    int argc, dbid, target;
    struct redisCommand *cmd;
819 820 821 822 823 824 825 826 827 828 829 830 831
} redisOp;

/* Defines an array of Redis operations. There is an API to add to this
 * structure in a easy way.
 *
 * redisOpArrayInit();
 * redisOpArrayAppend();
 * redisOpArrayFree();
 */
typedef struct redisOpArray {
    redisOp *ops;
    int numops;
} redisOpArray;
832

833 834 835
/* This structure is returned by the getMemoryOverheadData() function in
 * order to return memory overhead information. */
struct redisMemOverhead {
836
    size_t peak_allocated;
837 838 839 840 841 842 843 844
    size_t total_allocated;
    size_t startup_allocated;
    size_t repl_backlog;
    size_t clients_slaves;
    size_t clients_normal;
    size_t aof_buffer;
    size_t overhead_total;
    size_t dataset;
A
antirez 已提交
845 846
    size_t total_keys;
    size_t bytes_per_key;
847
    float dataset_perc;
848
    float peak_perc;
849 850 851 852 853 854 855 856
    float total_frag;
    size_t total_frag_bytes;
    float allocator_frag;
    size_t allocator_frag_bytes;
    float allocator_rss;
    size_t allocator_rss_bytes;
    float rss_extra;
    size_t rss_extra_bytes;
857 858 859 860 861 862 863 864
    size_t num_dbs;
    struct {
        size_t dbid;
        size_t overhead_ht_main;
        size_t overhead_ht_expires;
    } *db;
};

865 866 867 868 869 870 871 872 873
/* This structure can be optionally passed to RDB save/load functions in
 * order to implement additional functionalities, by storing and loading
 * metadata to the RDB file.
 *
 * Currently the only use is to select a DB at load time, useful in
 * replication in order to make sure that chained slaves (slaves of slaves)
 * select the correct DB and are able to accept the stream coming from the
 * top-level master. */
typedef struct rdbSaveInfo {
874
    /* Used saving and loading. */
875
    int repl_stream_db;  /* DB to select in server.master client. */
876 877 878 879 880

    /* Used only loading. */
    int repl_id_is_set;  /* True if repl_id field is set. */
    char repl_id[CONFIG_RUN_ID_SIZE+1];     /* Replication ID. */
    long long repl_offset;                  /* Replication offset. */
881 882
} rdbSaveInfo;

883
#define RDB_SAVE_INFO_INIT {-1,0,"000000000000000000000000000000",-1}
884

885
struct malloc_stats {
886 887 888 889 890
    size_t zmalloc_used;
    size_t process_rss;
    size_t allocator_allocated;
    size_t allocator_active;
    size_t allocator_resident;
891
};
892

A
antirez 已提交
893 894 895 896
/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

897 898
struct clusterState;

A
antirez 已提交
899 900
/* AIX defines hz to __hz, we don't use this define and in order to allow
 * Redis build on AIX we need to undef it. */
S
siahl 已提交
901 902 903 904
#ifdef _AIX
#undef hz
#endif

905 906 907 908
#define CHILD_INFO_MAGIC 0xC17DDA7A12345678LL
#define CHILD_INFO_TYPE_RDB 0
#define CHILD_INFO_TYPE_AOF 1

909
struct redisServer {
910
    /* General */
A
antirez 已提交
911
    pid_t pid;                  /* Main process pid. */
912
    char *configfile;           /* Absolute config file path, or NULL */
A
antirez 已提交
913 914
    char *executable;           /* Absolute executable file path. */
    char **exec_argv;           /* Executable argv vector (copy). */
915
    int hz;                     /* serverCron() calls frequency in hertz */
916
    redisDb *db;
917 918
    dict *commands;             /* Command table */
    dict *orig_commands;        /* Command table before command renaming. */
919
    aeEventLoop *el;
920
    unsigned int lruclock;      /* Clock for LRU eviction */
921 922
    int shutdown_asap;          /* SHUTDOWN needed ASAP */
    int activerehashing;        /* Incremental rehash in serverCron() */
O
oranagra 已提交
923
    int active_defrag_running;  /* Active defragmentation running (holds current scan aggressiveness) */
924 925
    char *requirepass;          /* Pass for AUTH command, or NULL */
    char *pidfile;              /* PID file path */
926
    int arch_bits;              /* 32 or 64 depending on sizeof(long) */
927
    int cronloops;              /* Number of times the cron function run */
A
antirez 已提交
928
    char runid[CONFIG_RUN_ID_SIZE+1];  /* ID always different at every exec. */
929
    int sentinel_mode;          /* True if this instance is a Sentinel. */
930
    size_t initial_memory_usage; /* Bytes used after initialization. */
931
    int always_show_logo;       /* Show logo even for non-stdout logging. */
A
antirez 已提交
932 933 934
    /* Modules */
    dict *moduleapi;            /* Exported APIs dictionary for modules. */
    list *loadmodule_queue;     /* List of modules to load at startup. */
935 936 937
    int module_blocked_pipe[2]; /* Pipe used to awake the event loop if a
                                   client blocked on a module command needs
                                   to be processed. */
938
    /* Networking */
939
    int port;                   /* TCP listening port */
940
    int tcp_backlog;            /* TCP listen() backlog */
A
antirez 已提交
941
    char *bindaddr[CONFIG_BINDADDR_MAX]; /* Addresses we should bind to */
A
antirez 已提交
942
    int bindaddr_count;         /* Number of addresses in server.bindaddr[] */
943 944
    char *unixsocket;           /* UNIX socket path */
    mode_t unixsocketperm;      /* UNIX socket permission */
A
antirez 已提交
945
    int ipfd[CONFIG_BINDADDR_MAX]; /* TCP socket file descriptors */
946
    int ipfd_count;             /* Used slots in ipfd[] */
947
    int sofd;                   /* Unix socket file descriptor */
A
antirez 已提交
948
    int cfd[CONFIG_BINDADDR_MAX];/* Cluster bus listening socket */
949
    int cfd_count;              /* Used slots in cfd[] */
950
    list *clients;              /* List of active clients */
951
    list *clients_to_close;     /* Clients to close asynchronously */
952
    list *clients_pending_write; /* There is to write or install handler. */
953
    list *slaves, *monitors;    /* List of slaves and MONITORs */
954
    client *current_client; /* Current client, only used on crash report */
955 956
    int clients_paused;         /* True if clients are currently paused */
    mstime_t clients_pause_end_time; /* Time when we undo clients_paused */
A
antirez 已提交
957 958
    char neterr[ANET_ERR_LEN];   /* Error buffer for anet.c */
    dict *migrate_cached_sockets;/* MIGRATE cached sockets */
959
    uint64_t next_client_id;    /* Next client unique ID. Incremental. */
960
    int protected_mode;         /* Don't accept external connections. */
961
    /* RDB / AOF loading information */
962
    int loading;                /* We are loading data from disk if true */
963 964 965
    off_t loading_total_bytes;
    off_t loading_loaded_bytes;
    time_t loading_start_time;
966
    off_t loading_process_events_interval_bytes;
967
    /* Fast pointers to often looked up command */
968 969 970 971
    struct redisCommand *delCommand, *multiCommand, *lpushCommand,
                        *lpopCommand, *rpopCommand, *zpopminCommand,
                        *zpopmaxCommand, *sremCommand, *execCommand,
                        *expireCommand, *pexpireCommand, *xclaimCommand;
972
    /* Fields used only for stats */
973 974 975 976
    time_t stat_starttime;          /* Server start time */
    long long stat_numcommands;     /* Number of processed commands */
    long long stat_numconnections;  /* Number of connections received */
    long long stat_expiredkeys;     /* Number of expired keys */
977 978
    double stat_expired_stale_perc; /* Percentage of keys probably expired */
    long long stat_expired_time_cap_reached_count; /* Early expire cylce stops.*/
979 980 981
    long long stat_evictedkeys;     /* Number of evicted keys (maxmemory) */
    long long stat_keyspace_hits;   /* Number of successful lookups of keys */
    long long stat_keyspace_misses; /* Number of failed lookups of keys */
O
oranagra 已提交
982 983 984 985
    long long stat_active_defrag_hits;      /* number of allocations moved */
    long long stat_active_defrag_misses;    /* number of allocations scanned but not moved */
    long long stat_active_defrag_key_hits;  /* number of keys with moved allocations */
    long long stat_active_defrag_key_misses;/* number of keys scanned and not moved */
O
Oran Agra 已提交
986
    long long stat_active_defrag_scanned;   /* number of dictEntries scanned */
987
    size_t stat_peak_memory;        /* Max used memory record */
G
guiquanz 已提交
988
    long long stat_fork_time;       /* Time needed to perform latest fork() */
989
    double stat_fork_rate;          /* Fork rate in GB/sec. */
990
    long long stat_rejected_conn;   /* Clients rejected because of maxclients */
991 992 993
    long long stat_sync_full;       /* Number of full resyncs with slaves. */
    long long stat_sync_partial_ok; /* Number of accepted PSYNC requests. */
    long long stat_sync_partial_err;/* Number of unaccepted PSYNC requests. */
994 995 996 997
    list *slowlog;                  /* SLOWLOG list of commands */
    long long slowlog_entry_id;     /* SLOWLOG current entry ID */
    long long slowlog_log_slower_than; /* SLOWLOG time limit (to get logged) */
    unsigned long slowlog_max_len;     /* SLOWLOG max number of items logged */
998
    struct malloc_stats cron_malloc_stats; /* sampled in serverCron(). */
999 1000
    long long stat_net_input_bytes; /* Bytes read from network. */
    long long stat_net_output_bytes; /* Bytes written to network. */
1001 1002
    size_t stat_rdb_cow_bytes;      /* Copy on write bytes during RDB saving. */
    size_t stat_aof_cow_bytes;      /* Copy on write bytes during AOF rewrite. */
1003 1004 1005 1006 1007
    /* The following two are used to track instantaneous metrics, like
     * number of operations per second, network traffic. */
    struct {
        long long last_sample_time; /* Timestamp of last sample in ms */
        long long last_sample_count;/* Count in last sample */
A
antirez 已提交
1008
        long long samples[STATS_METRIC_SAMPLES];
1009
        int idx;
A
antirez 已提交
1010
    } inst_metric[STATS_METRIC_COUNT];
1011
    /* Configuration */
1012 1013
    int verbosity;                  /* Loglevel in redis.conf */
    int maxidletime;                /* Client timeout in seconds */
1014
    int tcpkeepalive;               /* Set SO_KEEPALIVE if non-zero. */
A
antirez 已提交
1015
    int active_expire_enabled;      /* Can be disabled for testing purposes. */
O
oranagra 已提交
1016 1017 1018 1019 1020 1021
    int active_defrag_enabled;
    size_t active_defrag_ignore_bytes; /* minimum amount of fragmentation waste to start active defrag */
    int active_defrag_threshold_lower; /* minimum percentage of fragmentation to start active defrag */
    int active_defrag_threshold_upper; /* maximum percentage of fragmentation at which we use maximum effort */
    int active_defrag_cycle_min;       /* minimal effort for defrag in CPU percentage */
    int active_defrag_cycle_max;       /* maximal effort for defrag in CPU percentage */
O
Oran Agra 已提交
1022
    unsigned long active_defrag_max_scan_fields; /* maximum number of fields of set/hash/zset/list to process from within the main dict scan */
1023 1024
    size_t client_max_querybuf_len; /* Limit for client query buffer length */
    int dbnum;                      /* Total number of configured DBs */
1025
    int supervised;                 /* 1 if supervised, 0 otherwise. */
A
antirez 已提交
1026
    int supervised_mode;            /* See SUPERVISED_* */
1027
    int daemonize;                  /* True if running as a daemon */
A
antirez 已提交
1028
    clientBufferLimitsConfig client_obuf_limits[CLIENT_TYPE_OBUF_COUNT];
1029
    /* AOF persistence */
A
antirez 已提交
1030
    int aof_state;                  /* AOF_(ON|OFF|WAIT_REWRITE) */
1031 1032 1033 1034 1035 1036 1037 1038
    int aof_fsync;                  /* Kind of fsync() policy */
    char *aof_filename;             /* Name of the AOF file */
    int aof_no_fsync_on_rewrite;    /* Don't fsync if a rewrite is in prog. */
    int aof_rewrite_perc;           /* Rewrite AOF if % growth is > M and... */
    off_t aof_rewrite_min_size;     /* the AOF file is at least N bytes. */
    off_t aof_rewrite_base_size;    /* AOF size on latest startup or rewrite. */
    off_t aof_current_size;         /* AOF current size. */
    int aof_rewrite_scheduled;      /* Rewrite once BGSAVE terminates. */
A
antirez 已提交
1039
    pid_t aof_child_pid;            /* PID if rewriting process */
1040
    list *aof_rewrite_buf_blocks;   /* Hold changes during an AOF rewrite. */
A
antirez 已提交
1041 1042 1043
    sds aof_buf;      /* AOF buffer, written before entering the event loop */
    int aof_fd;       /* File descriptor of currently selected AOF file */
    int aof_selected_db; /* Currently selected DB in AOF */
1044
    time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
A
antirez 已提交
1045
    time_t aof_last_fsync;            /* UNIX time of last fsync() */
1046 1047
    time_t aof_rewrite_time_last;   /* Time used by last AOF rewrite run. */
    time_t aof_rewrite_time_start;  /* Current AOF rewrite start time. */
1048
    int aof_lastbgrewrite_status;   /* C_OK or C_ERR */
1049
    unsigned long aof_delayed_fsync;  /* delayed AOF fsync() counter */
1050 1051
    int aof_rewrite_incremental_fsync;/* fsync incrementally while aof rewriting? */
    int rdb_save_incremental_fsync;   /* fsync incrementally while rdb saving? */
1052
    int aof_last_write_status;      /* C_OK or C_ERR */
1053
    int aof_last_write_errno;       /* Valid if aof_last_write_status is ERR */
A
antirez 已提交
1054
    int aof_load_truncated;         /* Don't stop on unexpected AOF EOF. */
A
antirez 已提交
1055
    int aof_use_rdb_preamble;       /* Use RDB preamble on AOF rewrites. */
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
    /* AOF pipes used to communicate between parent and child during rewrite. */
    int aof_pipe_write_data_to_child;
    int aof_pipe_read_data_from_parent;
    int aof_pipe_write_ack_to_parent;
    int aof_pipe_read_ack_from_child;
    int aof_pipe_write_ack_to_child;
    int aof_pipe_read_ack_from_parent;
    int aof_stop_sending_diff;     /* If true stop sending accumulated diffs
                                      to child process. */
    sds aof_child_diff;             /* AOF diff accumulator child side. */
1066 1067 1068
    /* RDB persistence */
    long long dirty;                /* Changes to DB from the last save */
    long long dirty_before_bgsave;  /* Used to restore dirty on failed BGSAVE */
A
antirez 已提交
1069
    pid_t rdb_child_pid;            /* PID of RDB saving child */
1070 1071
    struct saveparam *saveparams;   /* Save points array for RDB */
    int saveparamslen;              /* Number of saving points */
A
antirez 已提交
1072 1073
    char *rdb_filename;             /* Name of RDB file */
    int rdb_compression;            /* Use compression in RDB? */
1074
    int rdb_checksum;               /* Use RDB checksum? */
G
guiquanz 已提交
1075
    time_t lastsave;                /* Unix time of last successful save */
1076
    time_t lastbgsave_try;          /* Unix time of last attempted bgsave */
1077 1078
    time_t rdb_save_time_last;      /* Time used by last RDB save run. */
    time_t rdb_save_time_start;     /* Current RDB save start time. */
1079
    int rdb_bgsave_scheduled;       /* BGSAVE when possible if true. */
A
antirez 已提交
1080
    int rdb_child_type;             /* Type of save by active child. */
1081
    int lastbgsave_status;          /* C_OK or C_ERR */
1082
    int stop_writes_on_bgsave_err;  /* Don't allow writes if can't BGSAVE */
1083 1084
    int rdb_pipe_write_result_to_parent; /* RDB pipes used to return the state */
    int rdb_pipe_read_result_from_child; /* of each slave in diskless SYNC. */
1085 1086 1087 1088 1089 1090 1091
    /* Pipe and data structures for child -> parent info sharing. */
    int child_info_pipe[2];         /* Pipe used to write the child_info_data. */
    struct {
        int process_type;           /* AOF or RDB child? */
        size_t cow_size;            /* Copy on write size. */
        unsigned long long magic;   /* Magic value to make sure data is valid. */
    } child_info_data;
1092
    /* Propagation of commands in AOF / replication */
1093
    redisOpArray also_propagate;    /* Additional command to propagate. */
1094
    /* Logging */
1095 1096 1097 1098
    char *logfile;                  /* Path of log file */
    int syslog_enabled;             /* Is syslog enabled? */
    char *syslog_ident;             /* Syslog ident */
    int syslog_facility;            /* Syslog facility */
1099
    /* Replication (master) */
1100 1101 1102 1103
    char replid[CONFIG_RUN_ID_SIZE+1];  /* My current replication ID. */
    char replid2[CONFIG_RUN_ID_SIZE+1]; /* replid inherited from master*/
    long long master_repl_offset;   /* My current replication offset */
    long long second_replid_offset; /* Accept offsets up to this for replid2. */
1104 1105 1106 1107 1108
    int slaveseldb;                 /* Last SELECTed DB in replication output */
    int repl_ping_slave_period;     /* Master pings the slave every N seconds */
    char *repl_backlog;             /* Replication backlog for partial syncs */
    long long repl_backlog_size;    /* Backlog circular buffer size */
    long long repl_backlog_histlen; /* Backlog actual data length */
1109 1110 1111 1112
    long long repl_backlog_idx;     /* Backlog circular buffer current offset,
                                       that is the next byte will'll write to.*/
    long long repl_backlog_off;     /* Replication "master offset" of first
                                       byte in the replication backlog buffer.*/
1113 1114 1115 1116
    time_t repl_backlog_time_limit; /* Time without slaves after the backlog
                                       gets released. */
    time_t repl_no_slaves_since;    /* We have no slaves since that time.
                                       Only valid if server.slaves len is 0. */
1117 1118 1119
    int repl_min_slaves_to_write;   /* Min number of slaves to write. */
    int repl_min_slaves_max_lag;    /* Max lag of <count> slaves to write. */
    int repl_good_slaves_count;     /* Number of slaves with lag <= max_lag. */
1120
    int repl_diskless_sync;         /* Send RDB to slaves sockets directly. */
A
antirez 已提交
1121
    int repl_diskless_sync_delay;   /* Delay to start a diskless repl BGSAVE. */
1122
    /* Replication (slave) */
1123 1124 1125 1126
    char *masterauth;               /* AUTH with this password with master */
    char *masterhost;               /* Hostname of master */
    int masterport;                 /* Port of master */
    int repl_timeout;               /* Timeout after N seconds of master idle */
1127 1128
    client *master;     /* Client that is master for this slave */
    client *cached_master; /* Cached master to be reused for PSYNC. */
1129
    int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
A
antirez 已提交
1130
    int repl_state;          /* Replication status if the instance is a slave */
1131 1132 1133
    off_t repl_transfer_size; /* Size of RDB to read from master during sync. */
    off_t repl_transfer_read; /* Amount of RDB read from master during sync. */
    off_t repl_transfer_last_fsync_off; /* Offset when we fsync-ed last time. */
1134 1135 1136 1137
    int repl_transfer_s;     /* Slave -> Master SYNC socket */
    int repl_transfer_fd;    /* Slave -> Master SYNC temp file descriptor */
    char *repl_transfer_tmpfile; /* Slave-> master SYNC temp file name */
    time_t repl_transfer_lastio; /* Unix time of the latest read, for timeout */
1138
    int repl_serve_stale_data; /* Serve stale data when link is down? */
1139
    int repl_slave_ro;          /* Slave is read only? */
1140
    time_t repl_down_since; /* Unix time at which link with master went down */
1141
    int repl_disable_tcp_nodelay;   /* Disable TCP_NODELAY after SYNC? */
1142
    int slave_priority;             /* Reported in INFO and used by Sentinel. */
1143 1144
    int slave_announce_port;        /* Give the master this listening port. */
    char *slave_announce_ip;        /* Give the master this ip address. */
1145 1146 1147 1148 1149
    /* The following two fields is where we store master PSYNC replid/offset
     * while the PSYNC is in progress. At the end we'll copy the fields into
     * the server->master client structure. */
    char master_replid[CONFIG_RUN_ID_SIZE+1];  /* Master PSYNC runid. */
    long long master_initial_offset;           /* Master PSYNC offset. */
1150
    int repl_slave_lazy_flush;          /* Lazy FLUSHALL before loading DB? */
1151 1152 1153
    /* Replication script cache. */
    dict *repl_scriptcache_dict;        /* SHA1 all slaves are aware of. */
    list *repl_scriptcache_fifo;        /* First in, first out LRU eviction. */
1154
    unsigned int repl_scriptcache_size; /* Max number of elements. */
1155 1156 1157
    /* Synchronous replication. */
    list *clients_waiting_acks;         /* Clients waiting in WAIT command. */
    int get_ack_from_slaves;            /* If true we send REPLCONF GETACK. */
1158
    /* Limits */
1159
    unsigned int maxclients;            /* Max number of simultaneous clients */
1160
    unsigned long long maxmemory;   /* Max number of memory bytes to use */
G
guiquanz 已提交
1161
    int maxmemory_policy;           /* Policy for key eviction */
1162
    int maxmemory_samples;          /* Pricision of random sampling */
Z
zhaozhao.zz 已提交
1163 1164
    int lfu_log_factor;             /* LFU logarithmic counter factor. */
    int lfu_decay_time;             /* LFU counter decay factor. */
1165
    long long proto_max_bulk_len;   /* Protocol bulk length maximum size. */
1166
    /* Blocked clients */
A
antirez 已提交
1167 1168
    unsigned int blocked_clients;   /* # of clients executing a blocking cmd.*/
    unsigned int blocked_clients_by_type[BLOCKED_NUM];
1169
    list *unblocked_clients; /* list of clients to unblock before next loop */
1170
    list *ready_keys;        /* List of readyList structures for BLPOP & co */
1171 1172 1173 1174 1175
    /* Sort parameters - qsort_r() is only available under BSD so we
     * have to take this state global, in order to pass it to sortCompare() */
    int sort_desc;
    int sort_alpha;
    int sort_bypattern;
1176
    int sort_store;
1177
    /* Zip structure config, see redis.conf for more information  */
1178 1179
    size_t hash_max_ziplist_entries;
    size_t hash_max_ziplist_value;
1180
    size_t set_max_intset_entries;
1181 1182
    size_t zset_max_ziplist_entries;
    size_t zset_max_ziplist_value;
1183
    size_t hll_sparse_max_bytes;
1184 1185
    size_t stream_node_max_bytes;
    int64_t stream_node_max_entries;
1186 1187 1188 1189
    /* List parameters */
    int list_max_ziplist_size;
    int list_compress_depth;
    /* time cache */
1190 1191
    time_t unixtime;    /* Unix time sampled every cron cycle. */
    long long mstime;   /* Like 'unixtime' but with milliseconds resolution. */
1192
    /* Pubsub */
1193 1194
    dict *pubsub_channels;  /* Map channels to list of subscribed clients */
    list *pubsub_patterns;  /* A list of pubsub_patterns */
1195
    int notify_keyspace_events; /* Events to propagate via Pub/Sub. This is an
A
antirez 已提交
1196
                                   xor of NOTIFY_... flags. */
1197
    /* Cluster */
1198
    int cluster_enabled;      /* Is cluster enabled? */
1199
    mstime_t cluster_node_timeout; /* Cluster node timeout. */
1200
    char *cluster_configfile; /* Cluster auto-generated config file name. */
1201
    struct clusterState *cluster;  /* State of the cluster */
1202
    int cluster_migration_barrier; /* Cluster replicas migration barrier. */
1203
    int cluster_slave_validity_factor; /* Slave max data age for failover. */
1204
    int cluster_require_full_coverage; /* If true, put the cluster down if
A
antirez 已提交
1205
                                          there is at least an uncovered slot.*/
1206 1207
    int cluster_slave_no_failover;  /* Prevent slave from starting a failover
                                       if the master is in failure state. */
1208 1209 1210
    char *cluster_announce_ip;  /* IP address to announce on cluster bus. */
    int cluster_announce_port;     /* base port to announce on cluster bus. */
    int cluster_announce_bus_port; /* bus port to announce on cluster bus. */
1211
    /* Scripting */
1212
    lua_State *lua; /* The Lua interpreter. We use just one for all clients */
1213 1214
    client *lua_client;   /* The "fake client" to query Redis from Lua */
    client *lua_caller;   /* The client running EVAL right now, or NULL */
1215
    dict *lua_scripts;         /* A dictionary of SHA1 -> Lua scripts */
1216 1217
    mstime_t lua_time_limit;  /* Script timeout in milliseconds */
    mstime_t lua_time_start;  /* Start time of script, milliseconds time */
1218 1219
    int lua_write_dirty;  /* True if a write command was called during the
                             execution of the current script. */
1220
    int lua_random_dirty; /* True if a random command was called during the
1221
                             execution of the current script. */
1222 1223
    int lua_replicate_commands; /* True if we are doing single commands repl. */
    int lua_multi_emitted;/* True if we already proagated MULTI. */
A
antirez 已提交
1224
    int lua_repl;         /* Script replication flags for redis.set_repl(). */
1225 1226
    int lua_timedout;     /* True if we reached the time limit for script
                             execution. */
1227
    int lua_kill;         /* Kill the script if true. */
1228
    int lua_always_replicate_commands; /* Default replication type. */
1229 1230 1231 1232
    /* Lazy free */
    int lazyfree_lazy_eviction;
    int lazyfree_lazy_expire;
    int lazyfree_lazy_server_del;
1233 1234 1235
    /* Latency monitor */
    long long latency_monitor_threshold;
    dict *latency_events;
G
guiquanz 已提交
1236
    /* Assert & bug reporting */
1237 1238
    const char *assert_failed;
    const char *assert_file;
A
antirez 已提交
1239
    int assert_line;
1240
    int bug_report_start; /* True if bug report header was already logged. */
A
antirez 已提交
1241
    int watchdog_period;  /* Software watchdog period in ms. 0 = off */
1242 1243
    /* System hardware info */
    size_t system_memory_size;  /* Total memory in system as reported by OS */
1244 1245 1246 1247 1248 1249

    /* Mutexes used to protect atomic variables when atomic builtins are
     * not available. */
    pthread_mutex_t lruclock_mutex;
    pthread_mutex_t next_client_id_mutex;
    pthread_mutex_t unixtime_mutex;
1250 1251 1252
};

typedef struct pubsubPattern {
1253
    client *client;
1254 1255 1256
    robj *pattern;
} pubsubPattern;

1257
typedef void redisCommandProc(client *c);
1258
typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1259 1260 1261 1262
struct redisCommand {
    char *name;
    redisCommandProc *proc;
    int arity;
G
guiquanz 已提交
1263
    char *sflags; /* Flags as string representation, one char per flag. */
1264
    int flags;    /* The actual flags, obtained from the 'sflags' field. */
1265
    /* Use a function to determine keys arguments in a command line.
A
antirez 已提交
1266
     * Used for Redis Cluster redirect. */
1267
    redisGetKeysProc *getkeys_proc;
1268
    /* What keys should be loaded in background when calling this command? */
1269
    int firstkey; /* The first argument that's a key (0 = no keys) */
G
guiquanz 已提交
1270
    int lastkey;  /* The last argument that's a key */
1271
    int keystep;  /* The step between first and last key */
1272
    long long microseconds, calls;
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
};

struct redisFunctionSym {
    char *name;
    unsigned long pointer;
};

typedef struct _redisSortObject {
    robj *obj;
    union {
        double score;
        robj *cmpobj;
    } u;
} redisSortObject;

typedef struct _redisSortOperation {
    int type;
    robj *pattern;
} redisSortOperation;

/* Structure to hold list iteration abstraction. */
typedef struct {
    robj *subject;
    unsigned char encoding;
    unsigned char direction; /* Iteration direction */
M
Matt Stancliff 已提交
1298
    quicklistIter *iter;
1299 1300 1301 1302 1303
} listTypeIterator;

/* Structure for an entry while iterating over a list. */
typedef struct {
    listTypeIterator *li;
M
Matt Stancliff 已提交
1304
    quicklistEntry entry; /* Entry in quicklist */
1305 1306
} listTypeEntry;

1307 1308 1309 1310 1311 1312
/* Structure to hold set iteration abstraction. */
typedef struct {
    robj *subject;
    int encoding;
    int ii; /* intset iterator */
    dictIterator *di;
1313
} setTypeIterator;
1314

G
guiquanz 已提交
1315
/* Structure to hold hash iteration abstraction. Note that iteration over
1316 1317 1318 1319
 * hashes involves both fields and values. Because it is possible that
 * not both are required, store pointers in the iterator to avoid
 * unnecessary memory allocation for fields/values. */
typedef struct {
1320
    robj *subject;
1321
    int encoding;
1322 1323

    unsigned char *fptr, *vptr;
1324 1325 1326 1327 1328

    dictIterator *di;
    dictEntry *de;
} hashTypeIterator;

1329 1330
#include "stream.h"  /* Stream data type header file. */

1331 1332
#define OBJ_HASH_KEY 1
#define OBJ_HASH_VALUE 2
1333 1334 1335 1336 1337 1338 1339

/*-----------------------------------------------------------------------------
 * Extern declarations
 *----------------------------------------------------------------------------*/

extern struct redisServer server;
extern struct sharedObjectsStruct shared;
1340
extern dictType objectKeyPointerValueDictType;
1341
extern dictType objectKeyHeapPointerValueDictType;
1342 1343
extern dictType setDictType;
extern dictType zsetDictType;
A
antirez 已提交
1344
extern dictType clusterNodesDictType;
1345
extern dictType clusterNodesBlackListDictType;
1346
extern dictType dbDictType;
A
antirez 已提交
1347
extern dictType shaScriptObjectDictType;
1348
extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
1349
extern dictType hashDictType;
1350
extern dictType replScriptCacheDictType;
1351
extern dictType keyptrDictType;
A
antirez 已提交
1352
extern dictType modulesDictType;
1353 1354 1355 1356 1357

/*-----------------------------------------------------------------------------
 * Functions prototypes
 *----------------------------------------------------------------------------*/

A
antirez 已提交
1358 1359
/* Modules */
void moduleInitModulesSystem(void);
1360
int moduleLoad(const char *path, void **argv, int argc);
A
antirez 已提交
1361
void moduleLoadFromQueue(void);
1362
int *moduleGetCommandKeysViaAPI(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1363 1364
moduleType *moduleTypeLookupModuleByID(uint64_t id);
void moduleTypeNameByID(char *name, uint64_t moduleid);
1365
void moduleFreeContext(struct RedisModuleCtx *ctx);
1366 1367 1368
void unblockClientFromModule(client *c);
void moduleHandleBlockedClients(void);
void moduleBlockedClientTimedOut(client *c);
1369
void moduleBlockedClientPipeReadable(aeEventLoop *el, int fd, void *privdata, int mask);
1370 1371 1372
size_t moduleCount(void);
void moduleAcquireGIL(void);
void moduleReleaseGIL(void);
1373 1374
void moduleNotifyKeyspaceEvent(int type, const char *event, robj *key, int dbid);

A
antirez 已提交
1375

1376 1377
/* Utils */
long long ustime(void);
1378
long long mstime(void);
1379 1380
void getRandomHexChars(char *p, size_t len);
void getRandomBytes(unsigned char *p, size_t len);
1381
uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
1382
void exitFromChild(int retcode);
1383
size_t redisPopcount(void *s, long count);
1384
void redisSetProcTitle(char *title);
1385

1386
/* networking.c -- Networking and Client related operations */
1387
client *createClient(int fd);
1388
void closeTimedoutClients(void);
1389 1390 1391
void freeClient(client *c);
void freeClientAsync(client *c);
void resetClient(client *c);
1392
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
1393 1394 1395
void *addDeferredMultiBulkLength(client *c);
void setDeferredMultiBulkLength(client *c, void *node, long length);
void processInputBuffer(client *c);
1396
void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
1397 1398
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
1399
void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
1400
void addReplyString(client *c, const char *s, size_t len);
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
void addReplyBulk(client *c, robj *obj);
void addReplyBulkCString(client *c, const char *s);
void addReplyBulkCBuffer(client *c, const void *p, size_t len);
void addReplyBulkLongLong(client *c, long long ll);
void addReply(client *c, robj *obj);
void addReplySds(client *c, sds s);
void addReplyBulkSds(client *c, sds s);
void addReplyError(client *c, const char *err);
void addReplyStatus(client *c, const char *status);
void addReplyDouble(client *c, double d);
A
antirez 已提交
1411
void addReplyHumanLongDouble(client *c, long double d);
1412 1413
void addReplyLongLong(client *c, long long ll);
void addReplyMultiBulkLen(client *c, long length);
I
Itamar Haber 已提交
1414
void addReplyHelp(client *c, const char **help);
1415
void copyClientOutputBuffer(client *dst, client *src);
O
oranagra 已提交
1416 1417
size_t sdsZmallocSize(sds s);
size_t getStringObjectSdsUsedMemory(robj *o);
1418
void *dupClientReplyValue(void *o);
1419 1420
void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer);
1421 1422
char *getClientPeerId(client *client);
sds catClientInfoString(sds s, client *client);
1423
sds getAllClientsInfoString(void);
1424 1425 1426 1427
void rewriteClientCommandVector(client *c, int argc, ...);
void rewriteClientCommandArgument(client *c, int i, robj *newval);
void replaceClientCommandVector(client *c, int argc, robj **argv);
unsigned long getClientOutputBufferMemoryUsage(client *c);
1428
void freeClientsInAsyncFreeQueue(void);
1429 1430
void asyncCloseClientOnOutputBufferLimitReached(client *c);
int getClientType(client *c);
A
antirez 已提交
1431 1432
int getClientTypeByName(char *name);
char *getClientTypeName(int class);
A
antirez 已提交
1433
void flushSlavesOutputBuffers(void);
1434
void disconnectSlaves(void);
1435
int listenToPort(int port, int *fds, int *count);
1436 1437
void pauseClients(mstime_t duration);
int clientsArePaused(void);
1438
int processEventsWhileBlocked(void);
1439
int handleClientsWithPendingWrites(void);
1440
int clientHasPendingReplies(client *c);
1441
void unlinkClient(client *c);
A
antirez 已提交
1442
int writeToClient(int fd, client *c, int handler_installed);
1443
void linkClient(client *c);
1444

1445
#ifdef __GNUC__
1446
void addReplyErrorFormat(client *c, const char *fmt, ...)
1447
    __attribute__((format(printf, 2, 3)));
1448
void addReplyStatusFormat(client *c, const char *fmt, ...)
1449 1450
    __attribute__((format(printf, 2, 3)));
#else
1451 1452
void addReplyErrorFormat(client *c, const char *fmt, ...);
void addReplyStatusFormat(client *c, const char *fmt, ...);
1453 1454
#endif

1455 1456 1457 1458
/* List data type */
void listTypeTryConversion(robj *subject, robj *value);
void listTypePush(robj *subject, robj *value, int where);
robj *listTypePop(robj *subject, int where);
1459
unsigned long listTypeLength(const robj *subject);
1460
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
1461 1462 1463 1464 1465
void listTypeReleaseIterator(listTypeIterator *li);
int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
robj *listTypeGet(listTypeEntry *entry);
void listTypeInsert(listTypeEntry *entry, robj *value, int where);
int listTypeEqual(listTypeEntry *entry, robj *o);
M
Matt Stancliff 已提交
1466
void listTypeDelete(listTypeIterator *iter, listTypeEntry *entry);
1467
void listTypeConvert(robj *subject, int enc);
1468 1469
void unblockClientWaitingData(client *c);
void popGenericCommand(client *c, int where);
1470 1471

/* MULTI/EXEC/WATCH... */
1472 1473 1474 1475
void unwatchAllKeys(client *c);
void initClientMultiState(client *c);
void freeClientMultiState(client *c);
void queueMultiCommand(client *c);
1476 1477
void touchWatchedKey(redisDb *db, robj *key);
void touchWatchedKeysOnFlush(int dbid);
1478 1479
void discardTransaction(client *c);
void flagTransaction(client *c);
1480
void execCommandPropagateMulti(client *c);
1481 1482

/* Redis object implementation */
1483 1484
void decrRefCount(robj *o);
void decrRefCountVoid(void *o);
1485
void incrRefCount(robj *o);
1486
robj *makeObjectShared(robj *o);
1487
robj *resetRefCount(robj *obj);
1488 1489 1490 1491 1492 1493
void freeStringObject(robj *o);
void freeListObject(robj *o);
void freeSetObject(robj *o);
void freeZsetObject(robj *o);
void freeHashObject(robj *o);
robj *createObject(int type, void *ptr);
1494 1495 1496
robj *createStringObject(const char *ptr, size_t len);
robj *createRawStringObject(const char *ptr, size_t len);
robj *createEmbeddedStringObject(const char *ptr, size_t len);
1497
robj *dupStringObject(const robj *o);
1498
int isSdsRepresentableAsLongLong(sds s, long long *llval);
1499
int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
1500 1501 1502 1503
robj *tryObjectEncoding(robj *o);
robj *getDecodedObject(robj *o);
size_t stringObjectLen(robj *o);
robj *createStringObjectFromLongLong(long long value);
1504
robj *createStringObjectFromLongLongForValue(long long value);
1505
robj *createStringObjectFromLongDouble(long double value, int humanfriendly);
M
Matt Stancliff 已提交
1506
robj *createQuicklistObject(void);
1507 1508
robj *createZiplistObject(void);
robj *createSetObject(void);
1509
robj *createIntsetObject(void);
1510 1511
robj *createHashObject(void);
robj *createZsetObject(void);
1512
robj *createZsetZiplistObject(void);
1513
robj *createStreamObject(void);
1514
robj *createModuleObject(moduleType *mt, void *value);
1515 1516 1517 1518
int getLongFromObjectOrReply(client *c, robj *o, long *target, const char *msg);
int checkType(client *c, robj *o, int type);
int getLongLongFromObjectOrReply(client *c, robj *o, long long *target, const char *msg);
int getDoubleFromObjectOrReply(client *c, robj *o, double *target, const char *msg);
1519
int getDoubleFromObject(const robj *o, double *target);
1520
int getLongLongFromObject(robj *o, long long *target);
A
antirez 已提交
1521
int getLongDoubleFromObject(robj *o, long double *target);
1522
int getLongDoubleFromObjectOrReply(client *c, robj *o, long double *target, const char *msg);
1523 1524
char *strEncoding(int encoding);
int compareStringObjects(robj *a, robj *b);
1525
int collateStringObjects(robj *a, robj *b);
1526
int equalStringObjects(robj *a, robj *b);
1527
unsigned long long estimateObjectIdleTime(robj *o);
1528
#define sdsEncodedObject(objptr) (objptr->encoding == OBJ_ENCODING_RAW || objptr->encoding == OBJ_ENCODING_EMBSTR)
1529

1530
/* Synchronous I/O with timeout */
1531 1532 1533
ssize_t syncWrite(int fd, char *ptr, ssize_t size, long long timeout);
ssize_t syncRead(int fd, char *ptr, ssize_t size, long long timeout);
ssize_t syncReadLine(int fd, char *ptr, ssize_t size, long long timeout);
1534

1535 1536
/* Replication */
void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
1537
void replicationFeedSlavesFromMasterStream(list *slaves, char *buf, size_t buflen);
1538
void replicationFeedMonitors(client *c, list *monitors, int dictid, robj **argv, int argc);
1539
void updateSlavesWaitingBgsave(int bgsaveerr, int type);
1540
void replicationCron(void);
1541
void replicationHandleMasterDisconnection(void);
1542
void replicationCacheMaster(client *c);
1543
void resizeReplicationBacklog(long long newsize);
1544 1545
void replicationSetMaster(char *ip, int port);
void replicationUnsetMaster(void);
1546
void refreshGoodSlavesCount(void);
1547 1548 1549 1550
void replicationScriptCacheInit(void);
void replicationScriptCacheFlush(void);
void replicationScriptCacheAdd(sds sha1);
int replicationScriptCacheExists(sds sha1);
1551
void processClientsWaitingReplicas(void);
1552
void unblockClientWaitingReplicas(client *c);
1553
int replicationCountAcksByOffset(long long offset);
A
antirez 已提交
1554
void replicationSendNewlineToMaster(void);
1555
long long replicationGetSlaveOffset(void);
1556
char *replicationGetSlaveName(client *c);
A
antirez 已提交
1557
long long getPsyncInitialOffset(void);
1558
int replicationSetupSlaveForFullResync(client *slave, long long offset);
1559 1560 1561
void changeReplicationId(void);
void clearReplicationId2(void);
void chopReplicationBacklog(void);
1562
void replicationCacheMasterUsingMyself(void);
1563
void feedReplicationBacklog(void *ptr, size_t len);
1564

1565 1566 1567 1568 1569
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

1570
/* RDB persistence */
1571
#include "rdb.h"
1572
int rdbSaveRio(rio *rdb, int *error, int flags, rdbSaveInfo *rsi);
1573 1574

/* AOF persistence */
1575
void flushAppendOnlyFile(int force);
1576 1577 1578 1579 1580 1581
void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
void aofRemoveTempFile(pid_t childpid);
int rewriteAppendOnlyFileBackground(void);
int loadAppendOnlyFile(char *filename);
void stopAppendOnly(void);
int startAppendOnly(void);
1582
void backgroundRewriteDoneHandler(int exitcode, int bysignal);
1583 1584
void aofRewriteBufferReset(void);
unsigned long aofRewriteBufferSize(void);
A
antirez 已提交
1585
ssize_t aofReadDiffFromParent(void);
1586

1587 1588 1589 1590 1591 1592
/* Child info */
void openChildInfoPipe(void);
void closeChildInfoPipe(void);
void sendChildInfo(int process_type);
void receiveChildInfo(void);

1593
/* Sorted sets data type */
1594

A
antirez 已提交
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609
/* Input flags. */
#define ZADD_NONE 0
#define ZADD_INCR (1<<0)    /* Increment the score instead of setting it. */
#define ZADD_NX (1<<1)      /* Don't touch elements not already existing. */
#define ZADD_XX (1<<2)      /* Only touch elements already exisitng. */

/* Output flags. */
#define ZADD_NOP (1<<3)     /* Operation not performed because of conditionals.*/
#define ZADD_NAN (1<<4)     /* Only touch elements already exisitng. */
#define ZADD_ADDED (1<<5)   /* The element was new and was added. */
#define ZADD_UPDATED (1<<6) /* The element already existed, score updated. */

/* Flags only used by the ZADD command but not by zsetAdd() API: */
#define ZADD_CH (1<<16)      /* Return num of elements added or updated. */

1610
/* Struct to hold a inclusive/exclusive range spec by score comparison. */
1611 1612 1613 1614 1615
typedef struct {
    double min, max;
    int minex, maxex; /* are min or max exclusive? */
} zrangespec;

1616 1617
/* Struct to hold an inclusive/exclusive range spec by lexicographic comparison. */
typedef struct {
1618
    sds min, max;     /* May be set to shared.(minstring|maxstring) */
1619 1620 1621
    int minex, maxex; /* are min or max exclusive? */
} zlexrangespec;

1622 1623
zskiplist *zslCreate(void);
void zslFree(zskiplist *zsl);
1624 1625 1626
zskiplistNode *zslInsert(zskiplist *zsl, double score, sds ele);
unsigned char *zzlInsert(unsigned char *zl, sds ele, double score);
int zslDelete(zskiplist *zsl, double score, sds ele, zskiplistNode **node);
1627 1628
zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec *range);
zskiplistNode *zslLastInRange(zskiplist *zsl, zrangespec *range);
1629 1630 1631
double zzlGetScore(unsigned char *sptr);
void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
A
antirez 已提交
1632
unsigned char *zzlFirstInRange(unsigned char *zl, zrangespec *range);
A
antirez 已提交
1633
unsigned char *zzlLastInRange(unsigned char *zl, zrangespec *range);
Z
zhaozhao.zz 已提交
1634
unsigned long zsetLength(const robj *zobj);
1635
void zsetConvert(robj *zobj, int encoding);
1636
void zsetConvertToZiplistIfNeeded(robj *zobj, size_t maxelelen);
1637 1638
int zsetScore(robj *zobj, sds member, double *score);
unsigned long zslGetRank(zskiplist *zsl, double score, sds o);
A
antirez 已提交
1639
int zsetAdd(robj *zobj, double score, sds ele, int *flags, double *newscore);
A
antirez 已提交
1640
long zsetRank(robj *zobj, sds ele, int reverse);
A
antirez 已提交
1641
int zsetDel(robj *zobj, sds ele);
1642
void genericZpopCommand(client *c, robj **keyv, int keyc, int where, int emitkey, robj *countarg);
A
antirez 已提交
1643
sds ziplistGetObject(unsigned char *sptr);
A
antirez 已提交
1644 1645
int zslValueGteMin(double value, zrangespec *spec);
int zslValueLteMax(double value, zrangespec *spec);
A
antirez 已提交
1646
void zslFreeLexRange(zlexrangespec *spec);
A
antirez 已提交
1647 1648 1649 1650 1651
int zslParseLexRange(robj *min, robj *max, zlexrangespec *spec);
unsigned char *zzlFirstInLexRange(unsigned char *zl, zlexrangespec *range);
unsigned char *zzlLastInLexRange(unsigned char *zl, zlexrangespec *range);
zskiplistNode *zslFirstInLexRange(zskiplist *zsl, zlexrangespec *range);
zskiplistNode *zslLastInLexRange(zskiplist *zsl, zlexrangespec *range);
A
antirez 已提交
1652 1653 1654 1655
int zzlLexValueGteMin(unsigned char *p, zlexrangespec *spec);
int zzlLexValueLteMax(unsigned char *p, zlexrangespec *spec);
int zslLexValueGteMin(sds value, zlexrangespec *spec);
int zslLexValueLteMax(sds value, zlexrangespec *spec);
1656 1657

/* Core functions */
1658
int getMaxmemoryState(size_t *total, size_t *logical, size_t *tofree, float *level);
1659
int freeMemoryIfNeeded(void);
1660
int processCommand(client *c);
1661
void setupSignalHandlers(void);
1662 1663
struct redisCommand *lookupCommand(sds name);
struct redisCommand *lookupCommandByCString(char *s);
1664
struct redisCommand *lookupCommandOrOriginal(sds name);
1665
void call(client *c, int flags);
A
antirez 已提交
1666
void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1667
void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
1668 1669
void forceCommandPropagation(client *c, int flags);
void preventCommandPropagation(client *c);
1670 1671
void preventCommandAOF(client *c);
void preventCommandReplication(client *c);
1672
int prepareForShutdown();
1673
#ifdef __GNUC__
A
antirez 已提交
1674
void serverLog(int level, const char *fmt, ...)
1675 1676
    __attribute__((format(printf, 2, 3)));
#else
A
antirez 已提交
1677
void serverLog(int level, const char *fmt, ...);
1678
#endif
A
antirez 已提交
1679 1680
void serverLogRaw(int level, const char *msg);
void serverLogFromHandler(int level, const char *msg);
1681
void usage(void);
1682 1683
void updateDictResizePolicy(void);
int htNeedsResize(dict *dict);
1684
void populateCommandTable(void);
1685
void resetCommandTableStats(void);
A
antirez 已提交
1686
void adjustOpenFilesLimit(void);
1687
void closeListeningSockets(int unlink_unix_socket);
1688 1689
void updateCachedTime(void);
void resetServerStats(void);
O
oranagra 已提交
1690
void activeDefragCycle(void);
1691
unsigned int getLRUClock(void);
1692
unsigned int LRU_CLOCK(void);
T
therealbill 已提交
1693
const char *evictPolicyToString(void);
1694 1695
struct redisMemOverhead *getMemoryOverheadData(void);
void freeMemoryOverheadData(struct redisMemOverhead *mh);
1696

A
antirez 已提交
1697 1698 1699 1700 1701
#define RESTART_SERVER_NONE 0
#define RESTART_SERVER_GRACEFULLY (1<<0)     /* Do proper shutdown. */
#define RESTART_SERVER_CONFIG_REWRITE (1<<1) /* CONFIG REWRITE before restart.*/
int restartServer(int flags, mstime_t delay);

1702
/* Set data type */
1703 1704 1705 1706
robj *setTypeCreate(sds value);
int setTypeAdd(robj *subject, sds value);
int setTypeRemove(robj *subject, sds value);
int setTypeIsMember(robj *subject, sds value);
1707 1708
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
1709 1710 1711
int setTypeNext(setTypeIterator *si, sds *sdsele, int64_t *llele);
sds setTypeNextObject(setTypeIterator *si);
int setTypeRandomElement(robj *setobj, sds *sdsele, int64_t *llele);
1712
unsigned long setTypeRandomElements(robj *set, unsigned long count, robj *aux_set);
1713
unsigned long setTypeSize(const robj *subject);
1714 1715
void setTypeConvert(robj *subject, int enc);

1716
/* Hash data type */
A
antirez 已提交
1717 1718 1719 1720
#define HASH_SET_TAKE_FIELD (1<<0)
#define HASH_SET_TAKE_VALUE (1<<1)
#define HASH_SET_COPY 0

1721
void hashTypeConvert(robj *o, int enc);
1722 1723
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1724 1725
int hashTypeExists(robj *o, sds key);
int hashTypeDelete(robj *o, sds key);
1726
unsigned long hashTypeLength(const robj *o);
1727 1728 1729
hashTypeIterator *hashTypeInitIterator(robj *subject);
void hashTypeReleaseIterator(hashTypeIterator *hi);
int hashTypeNext(hashTypeIterator *hi);
1730 1731 1732 1733
void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what,
                                unsigned char **vstr,
                                unsigned int *vlen,
                                long long *vll);
1734 1735 1736
sds hashTypeCurrentFromHashTable(hashTypeIterator *hi, int what);
void hashTypeCurrentObject(hashTypeIterator *hi, int what, unsigned char **vstr, unsigned int *vlen, long long *vll);
sds hashTypeCurrentObjectNewSds(hashTypeIterator *hi, int what);
1737
robj *hashTypeLookupWriteOrCreate(client *c, robj *key);
1738
robj *hashTypeGetValueObject(robj *o, sds field);
A
antirez 已提交
1739
int hashTypeSet(robj *o, sds field, sds value, int flags);
1740 1741

/* Pub / Sub */
1742 1743
int pubsubUnsubscribeAllChannels(client *c, int notify);
int pubsubUnsubscribeAllPatterns(client *c, int notify);
1744 1745
void freePubsubPattern(void *p);
int listMatchPubsubPattern(void *a, void *b);
1746
int pubsubPublishMessage(robj *channel, robj *message);
1747 1748 1749 1750 1751

/* Keyspace events notification */
void notifyKeyspaceEvent(int type, char *event, robj *key, int dbid);
int keyspaceEventsStringToFlags(char *classes);
sds keyspaceEventsFlagsToString(int flags);
1752 1753

/* Configuration */
1754
void loadServerConfig(char *filename, char *options);
1755
void appendServerSaveParams(time_t seconds, int changes);
1756
void resetServerSaveParams(void);
1757
struct rewriteConfigState; /* Forward declaration to export API. */
1758
void rewriteConfigRewriteLine(struct rewriteConfigState *state, const char *option, sds line, int force);
1759
int rewriteConfig(char *path);
1760 1761 1762

/* db.c -- Keyspace access API */
int removeExpire(redisDb *db, robj *key);
1763
void propagateExpire(redisDb *db, robj *key, int lazy);
1764
int expireIfNeeded(redisDb *db, robj *key);
1765
long long getExpire(redisDb *db, robj *key);
1766
void setExpire(client *c, redisDb *db, robj *key, long long when);
1767
robj *lookupKey(redisDb *db, robj *key, int flags);
1768 1769
robj *lookupKeyRead(redisDb *db, robj *key);
robj *lookupKeyWrite(redisDb *db, robj *key);
1770 1771
robj *lookupKeyReadOrReply(client *c, robj *key, robj *reply);
robj *lookupKeyWriteOrReply(client *c, robj *key, robj *reply);
1772
robj *lookupKeyReadWithFlags(redisDb *db, robj *key, int flags);
1773 1774
robj *objectCommandLookup(client *c, robj *key);
robj *objectCommandLookupOrReply(client *c, robj *key, robj *reply);
1775 1776
void objectSetLRUOrLFU(robj *val, long long lfu_freq, long long lru_idle,
                       long long lru_clock);
1777 1778
#define LOOKUP_NONE 0
#define LOOKUP_NOTOUCH (1<<0)
1779 1780 1781
void dbAdd(redisDb *db, robj *key, robj *val);
void dbOverwrite(redisDb *db, robj *key, robj *val);
void setKey(redisDb *db, robj *key, robj *val);
1782 1783
int dbExists(redisDb *db, robj *key);
robj *dbRandomKey(redisDb *db);
1784
int dbSyncDelete(redisDb *db, robj *key);
1785
int dbDelete(redisDb *db, robj *key);
1786
robj *dbUnshareStringValue(redisDb *db, robj *key, robj *o);
1787 1788 1789 1790 1791

#define EMPTYDB_NO_FLAGS 0      /* No flags. */
#define EMPTYDB_ASYNC (1<<0)    /* Reclaim memory in another thread. */
long long emptyDb(int dbnum, int flags, void(callback)(void*));

1792
int selectDb(client *c, int id);
1793 1794
void signalModifiedKey(redisDb *db, robj *key);
void signalFlushedDb(int dbid);
1795 1796
unsigned int getKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
unsigned int countKeysInSlot(unsigned int hashslot);
1797
unsigned int delKeysInSlot(unsigned int hashslot);
1798
int verifyClusterConfigWithData(void);
1799 1800
void scanGenericCommand(client *c, robj *o, unsigned long cursor);
int parseScanCursorOrReply(client *c, robj *o, unsigned long *cursor);
1801 1802 1803 1804
void slotToKeyAdd(robj *key);
void slotToKeyDel(robj *key);
void slotToKeyFlush(void);
int dbAsyncDelete(redisDb *db, robj *key);
1805 1806
void emptyDbAsync(redisDb *db);
void slotToKeyFlushAsync(void);
1807
size_t lazyfreeGetPendingObjectsCount(void);
1808

1809
/* API to get key arguments from commands */
1810
int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1811
void getKeysFreeResult(int *result);
1812
int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys);
1813
int *evalGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1814
int *sortGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1815
int *migrateGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1816
int *georadiusGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
A
antirez 已提交
1817
int *xreadGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1818

A
antirez 已提交
1819 1820 1821 1822 1823
/* Cluster */
void clusterInit(void);
unsigned short crc16(const char *buf, int len);
unsigned int keyHashSlot(char *key, int keylen);
void clusterCron(void);
1824
void clusterPropagatePublish(robj *channel, robj *message);
A
antirez 已提交
1825
void migrateCloseTimedoutSockets(void);
1826
void clusterBeforeSleep(void);
1827
int clusterSendModuleMessageToTarget(const char *target, uint64_t module_id, uint8_t type, unsigned char *payload, uint32_t len);
A
antirez 已提交
1828

1829 1830 1831 1832 1833
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);
A
antirez 已提交
1834
void sentinelIsRunning(void);
1835

1836 1837 1838 1839
/* redis-check-rdb & aof */
int redis_check_rdb(char *rdbfilename, FILE *fp);
int redis_check_rdb_main(int argc, char **argv, FILE *fp);
int redis_check_aof_main(int argc, char **argv);
1840

1841
/* Scripting */
1842
void scriptingInit(int setup);
1843 1844
int ldbRemoveChild(pid_t pid);
void ldbKillForkedSessions(void);
1845
int ldbPendingChildren(void);
1846
sds luaCreateFunction(client *c, lua_State *lua, robj *body);
1847

1848 1849
/* Blocked clients */
void processUnblockedClients(void);
1850 1851 1852 1853
void blockClient(client *c, int btype);
void unblockClient(client *c);
void replyToBlockedClientTimedOut(client *c);
int getTimeoutFromObjectOrReply(client *c, robj *object, mstime_t *timeout, int unit);
1854
void disconnectAllBlockedClients(void);
1855 1856
void handleClientsBlockedOnKeys(void);
void signalKeyAsReady(redisDb *db, robj *key);
1857
void blockForKeys(client *c, int btype, robj **keys, int numkeys, mstime_t timeout, robj *target, streamID *ids);
1858

1859 1860
/* expire.c -- Handling of expired keys */
void activeExpireCycle(int type);
1861 1862 1863
void expireSlaveKeys(void);
void rememberSlaveKeyWithExpire(redisDb *db, robj *key);
void flushSlaveKeysWithExpireList(void);
1864
size_t getSlaveKeyWithExpireCount(void);
1865

1866
/* evict.c -- maxmemory handling and LRU eviction. */
1867
void evictionPoolAlloc(void);
1868 1869 1870
#define LFU_INIT_VAL 5
unsigned long LFUGetTimeInMinutes(void);
uint8_t LFULogIncr(uint8_t value);
1871
unsigned long LFUDecrAndReturn(robj *o);
1872

1873
/* Keys hashing / comparison functions for dict.c hash tables. */
1874
uint64_t dictSdsHash(const void *key);
1875 1876 1877
int dictSdsKeyCompare(void *privdata, const void *key1, const void *key2);
void dictSdsDestructor(void *privdata, void *val);

1878 1879 1880
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);
1881
uint64_t redisBuildId(void);
1882 1883

/* Commands prototypes */
1884 1885 1886 1887 1888 1889 1890 1891 1892 1893
void authCommand(client *c);
void pingCommand(client *c);
void echoCommand(client *c);
void commandCommand(client *c);
void setCommand(client *c);
void setnxCommand(client *c);
void setexCommand(client *c);
void psetexCommand(client *c);
void getCommand(client *c);
void delCommand(client *c);
1894
void unlinkCommand(client *c);
1895 1896 1897
void existsCommand(client *c);
void setbitCommand(client *c);
void getbitCommand(client *c);
1898
void bitfieldCommand(client *c);
1899 1900 1901 1902 1903 1904 1905 1906
void setrangeCommand(client *c);
void getrangeCommand(client *c);
void incrCommand(client *c);
void decrCommand(client *c);
void incrbyCommand(client *c);
void decrbyCommand(client *c);
void incrbyfloatCommand(client *c);
void selectCommand(client *c);
A
antirez 已提交
1907
void swapdbCommand(client *c);
1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961
void randomkeyCommand(client *c);
void keysCommand(client *c);
void scanCommand(client *c);
void dbsizeCommand(client *c);
void lastsaveCommand(client *c);
void saveCommand(client *c);
void bgsaveCommand(client *c);
void bgrewriteaofCommand(client *c);
void shutdownCommand(client *c);
void moveCommand(client *c);
void renameCommand(client *c);
void renamenxCommand(client *c);
void lpushCommand(client *c);
void rpushCommand(client *c);
void lpushxCommand(client *c);
void rpushxCommand(client *c);
void linsertCommand(client *c);
void lpopCommand(client *c);
void rpopCommand(client *c);
void llenCommand(client *c);
void lindexCommand(client *c);
void lrangeCommand(client *c);
void ltrimCommand(client *c);
void typeCommand(client *c);
void lsetCommand(client *c);
void saddCommand(client *c);
void sremCommand(client *c);
void smoveCommand(client *c);
void sismemberCommand(client *c);
void scardCommand(client *c);
void spopCommand(client *c);
void srandmemberCommand(client *c);
void sinterCommand(client *c);
void sinterstoreCommand(client *c);
void sunionCommand(client *c);
void sunionstoreCommand(client *c);
void sdiffCommand(client *c);
void sdiffstoreCommand(client *c);
void sscanCommand(client *c);
void syncCommand(client *c);
void flushdbCommand(client *c);
void flushallCommand(client *c);
void sortCommand(client *c);
void lremCommand(client *c);
void rpoplpushCommand(client *c);
void infoCommand(client *c);
void mgetCommand(client *c);
void monitorCommand(client *c);
void expireCommand(client *c);
void expireatCommand(client *c);
void pexpireCommand(client *c);
void pexpireatCommand(client *c);
void getsetCommand(client *c);
void ttlCommand(client *c);
1962
void touchCommand(client *c);
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984
void pttlCommand(client *c);
void persistCommand(client *c);
void slaveofCommand(client *c);
void roleCommand(client *c);
void debugCommand(client *c);
void msetCommand(client *c);
void msetnxCommand(client *c);
void zaddCommand(client *c);
void zincrbyCommand(client *c);
void zrangeCommand(client *c);
void zrangebyscoreCommand(client *c);
void zrevrangebyscoreCommand(client *c);
void zrangebylexCommand(client *c);
void zrevrangebylexCommand(client *c);
void zcountCommand(client *c);
void zlexcountCommand(client *c);
void zrevrangeCommand(client *c);
void zcardCommand(client *c);
void zremCommand(client *c);
void zscoreCommand(client *c);
void zremrangebyscoreCommand(client *c);
void zremrangebylexCommand(client *c);
1985 1986 1987 1988
void zpopminCommand(client *c);
void zpopmaxCommand(client *c);
void bzpopminCommand(client *c);
void bzpopmaxCommand(client *c);
1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034
void multiCommand(client *c);
void execCommand(client *c);
void discardCommand(client *c);
void blpopCommand(client *c);
void brpopCommand(client *c);
void brpoplpushCommand(client *c);
void appendCommand(client *c);
void strlenCommand(client *c);
void zrankCommand(client *c);
void zrevrankCommand(client *c);
void hsetCommand(client *c);
void hsetnxCommand(client *c);
void hgetCommand(client *c);
void hmsetCommand(client *c);
void hmgetCommand(client *c);
void hdelCommand(client *c);
void hlenCommand(client *c);
void hstrlenCommand(client *c);
void zremrangebyrankCommand(client *c);
void zunionstoreCommand(client *c);
void zinterstoreCommand(client *c);
void zscanCommand(client *c);
void hkeysCommand(client *c);
void hvalsCommand(client *c);
void hgetallCommand(client *c);
void hexistsCommand(client *c);
void hscanCommand(client *c);
void configCommand(client *c);
void hincrbyCommand(client *c);
void hincrbyfloatCommand(client *c);
void subscribeCommand(client *c);
void unsubscribeCommand(client *c);
void psubscribeCommand(client *c);
void punsubscribeCommand(client *c);
void publishCommand(client *c);
void pubsubCommand(client *c);
void watchCommand(client *c);
void unwatchCommand(client *c);
void clusterCommand(client *c);
void restoreCommand(client *c);
void migrateCommand(client *c);
void askingCommand(client *c);
void readonlyCommand(client *c);
void readwriteCommand(client *c);
void dumpCommand(client *c);
void objectCommand(client *c);
2035
void memoryCommand(client *c);
2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047
void clientCommand(client *c);
void evalCommand(client *c);
void evalShaCommand(client *c);
void scriptCommand(client *c);
void timeCommand(client *c);
void bitopCommand(client *c);
void bitcountCommand(client *c);
void bitposCommand(client *c);
void replconfCommand(client *c);
void waitCommand(client *c);
void geoencodeCommand(client *c);
void geodecodeCommand(client *c);
2048 2049
void georadiusbymemberCommand(client *c);
void georadiusbymemberroCommand(client *c);
2050
void georadiusCommand(client *c);
2051
void georadiusroCommand(client *c);
2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
void geoaddCommand(client *c);
void geohashCommand(client *c);
void geoposCommand(client *c);
void geodistCommand(client *c);
void pfselftestCommand(client *c);
void pfaddCommand(client *c);
void pfcountCommand(client *c);
void pfmergeCommand(client *c);
void pfdebugCommand(client *c);
void latencyCommand(client *c);
A
antirez 已提交
2062
void moduleCommand(client *c);
2063
void securityWarningCommand(client *c);
2064 2065
void xaddCommand(client *c);
void xrangeCommand(client *c);
2066
void xrevrangeCommand(client *c);
A
antirez 已提交
2067
void xlenCommand(client *c);
A
antirez 已提交
2068
void xreadCommand(client *c);
2069
void xgroupCommand(client *c);
A
antirez 已提交
2070
void xackCommand(client *c);
2071
void xpendingCommand(client *c);
2072
void xclaimCommand(client *c);
A
antirez 已提交
2073
void xinfoCommand(client *c);
A
antirez 已提交
2074
void xdelCommand(client *c);
A
antirez 已提交
2075
void xtrimCommand(client *c);
2076

2077 2078 2079 2080 2081 2082 2083
#if defined(__GNUC__)
void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
void free(void *ptr) __attribute__ ((deprecated));
void *malloc(size_t size) __attribute__ ((deprecated));
void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
#endif

2084
/* Debugging stuff */
2085 2086
void _serverAssertWithInfo(const client *c, const robj *o, const char *estr, const char *file, int line);
void _serverAssert(const char *estr, const char *file, int line);
2087
void _serverPanic(const char *file, int line, const char *msg, ...);
A
antirez 已提交
2088
void bugReportStart(void);
2089
void serverLogObjectDebugInfo(const robj *o);
2090 2091
void sigsegvHandler(int sig, siginfo_t *info, void *secret);
sds genRedisInfoString(char *section);
A
antirez 已提交
2092 2093 2094
void enableWatchdog(int period);
void disableWatchdog(void);
void watchdogScheduleSignal(int period);
A
antirez 已提交
2095
void serverLogHexDump(int level, char *descr, void *value, size_t len);
A
antirez 已提交
2096
int memtest_preserving_test(unsigned long *m, size_t bytes, int passes);
A
antirez 已提交
2097 2098
void mixDigest(unsigned char *digest, void *ptr, size_t len);
void xorDigest(unsigned char *digest, void *ptr, size_t len);
2099 2100 2101 2102 2103 2104

#define redisDebug(fmt, ...) \
    printf("DEBUG %s:%d > " fmt "\n", __FILE__, __LINE__, __VA_ARGS__)
#define redisDebugMark() \
    printf("-- MARK %s:%d --\n", __FILE__, __LINE__)

2105
#endif