server.h 93.5 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
#define LIMIT_PENDING_QUERYBUF (4*1024*1024) /* 4mb */
A
antirez 已提交
190 191 192 193 194 195

/* 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 已提交
196

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

200 201
/* Command flags. Please check the command table defined in the redis.c file
 * for more information about the meaning of every flag. */
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
#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. */
218

219
/* AOF states */
A
antirez 已提交
220 221 222
#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 */
223

224
/* Client flags */
A
antirez 已提交
225 226 227 228 229 230 231 232
#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 已提交
233
                                  server.unblocked_clients */
A
antirez 已提交
234 235 236 237 238 239 240 241 242 243 244
#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. */
245 246 247 248
#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
249
                                        handler is yet not installed. */
250 251 252
#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. */
253
#define CLIENT_LUA_DEBUG (1<<25)  /* Run EVAL in debug mode. */
A
antirez 已提交
254
#define CLIENT_LUA_DEBUG_SYNC (1<<26)  /* EVAL debugging without fork() */
A
antirez 已提交
255
#define CLIENT_MODULE (1<<27) /* Non connected client used by some module. */
256

257
/* Client block type (btype field in client structure)
A
antirez 已提交
258 259 260 261
 * 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. */
262
#define BLOCKED_MODULE 3  /* Blocked by a loadable module. */
263
#define BLOCKED_STREAM 4  /* XREAD. */
264 265
#define BLOCKED_ZSET 5    /* BZPOP et al. */
#define BLOCKED_NUM 6     /* Number of blocked states. */
266

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

271 272
/* Client classes for client limits, currently used only for
 * the max-client-output-buffer limit implementation. */
A
antirez 已提交
273 274 275
#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 已提交
276 277 278 279
#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 已提交
280 281 282 283 284 285

/* 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 已提交
286
/* --- Handshake states, must be ordered --- */
A
antirez 已提交
287
#define REPL_STATE_RECEIVE_PONG 3 /* Wait for PING reply */
288 289 290 291
#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 */
292 293 294 295 296 297
#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 已提交
298
/* --- End of handshake states --- */
299 300
#define REPL_STATE_TRANSFER 14 /* Receiving .rdb from master */
#define REPL_STATE_CONNECTED 15 /* Connected to master */
A
antirez 已提交
301 302

/* State of slaves from the POV of the master. Used in client->replstate.
303
 * In SEND_BULK and ONLINE state the slave receives new updates
A
antirez 已提交
304
 * in its output queue. In the WAIT_BGSAVE states instead the server is waiting
305
 * to start the next background saving in order to send updates to it. */
A
antirez 已提交
306 307 308 309
#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. */
310

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

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

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

/* Sort operations */
A
antirez 已提交
326
#define SORT_OP_GET 0
327 328

/* Log levels */
A
antirez 已提交
329 330 331 332 333 334
#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
335

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

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

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

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

354
/* Zipped structures related defaults */
355 356 357 358 359
#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
360 361
#define OBJ_STREAM_NODE_MAX_BYTES 4096
#define OBJ_STREAM_NODE_MAX_ENTRIES 100
362

363
/* List defaults */
364 365
#define OBJ_LIST_MAX_ZIPLIST_SIZE -2
#define OBJ_LIST_COMPRESS_DEPTH 0
366

367
/* HyperLogLog defines */
368
#define CONFIG_DEFAULT_HLL_SPARSE_MAX_BYTES 3000
369

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

375 376 377 378 379
/* 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)
380
#define MAXMEMORY_FLAG_ALLKEYS (1<<2)
381 382
#define MAXMEMORY_FLAG_NO_SHARED_INTEGERS \
    (MAXMEMORY_FLAG_LRU|MAXMEMORY_FLAG_LFU)
383

384 385 386 387
#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)
388 389 390
#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)
391 392
#define MAXMEMORY_NO_EVICTION (7<<8)

A
antirez 已提交
393
#define CONFIG_DEFAULT_MAXMEMORY_POLICY MAXMEMORY_NO_EVICTION
394

A
antirez 已提交
395
/* Scripting */
A
antirez 已提交
396
#define LUA_SCRIPT_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
397

398 399 400 401
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

402
/* SHUTDOWN flags */
403 404 405 406
#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. */
407

408
/* Command call flags, see call() function */
A
antirez 已提交
409
#define CMD_CALL_NONE 0
A
antirez 已提交
410 411 412 413 414
#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 已提交
415
#define CMD_CALL_FULL (CMD_CALL_SLOWLOG | CMD_CALL_STATS | CMD_CALL_PROPAGATE)
416

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

A
antirez 已提交
422
/* RDB active child save type. */
A
antirez 已提交
423 424 425
#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 已提交
426

427 428
/* Keyspace changes notification classes. Every class is associated with a
 * character for configuration purposes. */
A
antirez 已提交
429 430 431 432 433 434 435 436 437 438
#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 */
439 440
#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 */
441

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

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

450
/* We can print the stacktrace, so our assert is defined this way: */
A
antirez 已提交
451 452
#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)))
453
#define serverPanic(...) _serverPanic(__FILE__,__LINE__,__VA_ARGS__),_exit(1)
454 455 456 457 458 459 460 461

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

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

/* The actual Redis Object */
462 463 464 465 466
#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. */
467

468 469 470 471 472 473 474 475 476 477 478
/* 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. */
479 480
#define OBJ_MODULE 5    /* Module object. */
#define OBJ_STREAM 6    /* Stream object. */
481 482 483 484 485 486 487 488 489 490

/* 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;
491
struct RedisModuleCtx;
492 493 494 495 496 497 498 499 500 501
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);
502
typedef size_t (*moduleTypeMemUsageFunc)(const void *value);
503 504 505 506 507 508 509 510 511 512
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;
513
    moduleTypeMemUsageFunc mem_usage;
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 545 546
    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. */
547 548
    int ver;            /* Module serialization version: 1 (old),
                         * 2 (current version with opcodes annotation). */
A
antirez 已提交
549
    struct RedisModuleCtx *ctx; /* Optional context, see RM_GetContextFromIO()*/
550 551
} RedisModuleIO;

552 553
/* 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. */
554 555 556 557 558
#define moduleInitIOContext(iovar,mtype,rioptr) do { \
    iovar.rio = rioptr; \
    iovar.type = mtype; \
    iovar.bytes = 0; \
    iovar.error = 0; \
559
    iovar.ver = 0; \
560
    iovar.ctx = NULL; \
561 562
} while(0);

A
antirez 已提交
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
/* 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);

579 580 581 582 583 584 585
/* 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 */
586
#define OBJ_ENCODING_LINKEDLIST 4 /* No longer used: old list encoding. */
587 588 589 590 591
#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 */
592
#define OBJ_ENCODING_STREAM 10 /* Encoded as a radix tree of listpacks */
593

A
antirez 已提交
594 595 596
#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 */
597 598

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

G
guiquanz 已提交
609
/* Macro used to initialize a Redis object allocated on the stack.
610 611 612 613 614
 * 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; \
615 616
    _var.type = OBJ_STRING; \
    _var.encoding = OBJ_ENCODING_RAW; \
617
    _var.ptr = _ptr; \
O
Oran Agra 已提交
618
} while(0)
619

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

622 623 624 625 626
typedef struct clientReplyBlock {
    size_t size, used;
    char buf[];
} clientReplyBlock;

A
antirez 已提交
627 628 629
/* 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. */
630 631 632
typedef struct redisDb {
    dict *dict;                 /* The keyspace for this DB */
    dict *expires;              /* Timeout of keys with a timeout set */
633
    dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP)*/
634
    dict *ready_keys;           /* Blocked keys that received a PUSH */
635
    dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
A
antirez 已提交
636
    int id;                     /* Database ID */
637
    long long avg_ttl;          /* Average TTL, just for stats */
O
Oran Agra 已提交
638
    list *defrag_later;         /* List of key names to attempt to defrag one by one, gradually. */
639 640 641 642 643 644 645 646 647 648 649 650
} 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 */
651 652
    int minreplicas;        /* MINREPLICAS for synchronous replication */
    time_t minreplicas_timeout; /* MINREPLICAS timeout as unixtime. */
653 654
} multiState;

655 656
/* This structure holds the blocking operation state for a client.
 * The fields used depend on client->btype. */
657
typedef struct blockingState {
658 659 660 661
    /* Generic fields. */
    mstime_t timeout;       /* Blocking operation timeout. If UNIX current time
                             * is > timeout then the operation timed out. */

662
    /* BLOCKED_LIST, BLOCKED_ZSET and BLOCKED_STREAM */
663
    dict *keys;             /* The keys we are waiting to terminate a blocking
664
                             * operation such as BLPOP or XREAD. Or NULL. */
665 666
    robj *target;           /* The key that should receive the element,
                             * for BRPOPLPUSH. */
667

668 669
    /* BLOCK_STREAM */
    size_t xread_count;     /* XREAD COUNT option. */
670 671
    robj *xread_group;      /* XREADGROUP group name. */
    robj *xread_consumer;   /* XREADGROUP consumer name. */
672
    mstime_t xread_retry_time, xread_retry_ttl;
673
    int xread_group_noack;
674

A
antirez 已提交
675
    /* BLOCKED_WAIT */
676 677
    int numreplicas;        /* Number of replicas we are waiting for ACK. */
    long long reploffset;   /* Replication offset to reach. */
678 679 680 681 682

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

685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
/* 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 已提交
701
/* With multiplexing we need to take per-client state.
X
xuxiang 已提交
702
 * Clients are taken in a linked list. */
703
typedef struct client {
704
    uint64_t id;            /* Client incremental unique ID. */
A
antirez 已提交
705 706 707 708
    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. */
709 710 711 712
    sds pending_querybuf;   /* If this client is flagged as master, this buffer
                               represents the yet not applied portion of the
                               replication stream that we are receiving from
                               the master. */
A
antirez 已提交
713 714 715 716 717 718 719 720 721
    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. */
722
    size_t sentlen;         /* Amount of bytes already sent in the current
723
                               buffer or object being sent. */
A
antirez 已提交
724 725
    time_t ctime;           /* Client creation time. */
    time_t lastinteraction; /* Time of the last interaction, used for timeout */
726
    time_t obuf_soft_limit_reached_time;
A
antirez 已提交
727 728 729
    int flags;              /* Client flags: CLIENT_* macros. */
    int authenticated;      /* When requirepass is non-NULL. */
    int replstate;          /* Replication state if this is a slave. */
A
antirez 已提交
730
    int repl_put_online_on_ack; /* Install slave write handler on ACK. */
A
antirez 已提交
731 732 733 734
    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. */
735 736
    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 已提交
737 738
    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 已提交
739 740 741
    long long psync_initial_offset; /* FULLRESYNC reply offset other slaves
                                       copying this slave output buffer
                                       should use. */
742 743
    char replid[CONFIG_RUN_ID_SIZE+1]; /* Master replication ID (if master). */
    int slave_listening_port; /* As configured with: SLAVECONF listening-port */
744
    char slave_ip[NET_IP_STR_LEN]; /* Optionally given by REPLCONF ip-address */
745
    int slave_capa;         /* Slave capabilities: SLAVE_CAPA_* bitwise OR. */
746
    multiState mstate;      /* MULTI/EXEC state */
A
antirez 已提交
747
    int btype;              /* Type of blocking op if CLIENT_BLOCKED. */
748 749
    blockingState bpop;     /* blocking state */
    long long woff;         /* Last write global replication offset. */
750 751 752
    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) */
753
    sds peerid;             /* Cached peer ID. */
754
    listNode *client_list_node; /* list node in client list */
755 756

    /* Response buffer */
757
    int bufpos;
A
antirez 已提交
758
    char buf[PROTO_REPLY_CHUNK_BYTES];
759
} client;
760 761 762 763 764 765

struct saveparam {
    time_t seconds;
    int changes;
};

766
struct moduleLoadQueueEntry {
767 768
    sds path;
    int argc;
769
    robj **argv;
770 771
};

772 773 774 775
struct sharedObjectsStruct {
    robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
    *colon, *nullbulk, *nullmultibulk, *queued,
    *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
776
    *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
777
    *masterdownerr, *roslaveerr, *execaborterr, *noautherr, *noreplicaserr,
778
    *busykeyerr, *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
779
    *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *unlink,
780
    *rpop, *lpop, *lpush, *zpopmin, *zpopmax, *emptyscan,
A
antirez 已提交
781 782 783 784
    *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" */
785
    sds minstring, maxstring;
786 787
};

788 789
/* ZSETs use a specialized version of Skiplists */
typedef struct zskiplistNode {
790
    sds ele;
791 792 793 794
    double score;
    struct zskiplistNode *backward;
    struct zskiplistLevel {
        struct zskiplistNode *forward;
795
        unsigned long span;
796 797 798 799 800 801 802 803 804 805 806 807 808 809
    } level[];
} zskiplistNode;

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

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

810
typedef struct clientBufferLimitsConfig {
811 812
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
813 814 815
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

A
antirez 已提交
816
extern clientBufferLimitsConfig clientBufferLimitsDefaults[CLIENT_TYPE_OBUF_COUNT];
817

818 819
/* The redisOp structure defines a Redis Operation, that is an instance of
 * a command with an argument vector, database ID, propagation target
A
antirez 已提交
820
 * (PROPAGATE_*), and command pointer.
821 822 823 824
 *
 * Currently only used to additionally propagate more commands to AOF/Replication
 * after the propagation of the executed command. */
typedef struct redisOp {
825 826 827
    robj **argv;
    int argc, dbid, target;
    struct redisCommand *cmd;
828 829 830 831 832 833 834 835 836 837 838 839 840
} 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;
841

842 843 844
/* This structure is returned by the getMemoryOverheadData() function in
 * order to return memory overhead information. */
struct redisMemOverhead {
845
    size_t peak_allocated;
846 847 848 849 850 851 852 853
    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 已提交
854 855
    size_t total_keys;
    size_t bytes_per_key;
856
    float dataset_perc;
857
    float peak_perc;
858 859 860 861 862 863 864 865
    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;
866 867 868 869 870 871 872 873
    size_t num_dbs;
    struct {
        size_t dbid;
        size_t overhead_ht_main;
        size_t overhead_ht_expires;
    } *db;
};

874 875 876 877 878 879 880 881 882
/* 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 {
883
    /* Used saving and loading. */
884
    int repl_stream_db;  /* DB to select in server.master client. */
885 886 887 888 889

    /* 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. */
890 891
} rdbSaveInfo;

892
#define RDB_SAVE_INFO_INIT {-1,0,"000000000000000000000000000000",-1}
893

894
struct malloc_stats {
895 896 897 898 899
    size_t zmalloc_used;
    size_t process_rss;
    size_t allocator_allocated;
    size_t allocator_active;
    size_t allocator_resident;
900
};
901

A
antirez 已提交
902 903 904 905
/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

906 907
struct clusterState;

A
antirez 已提交
908 909
/* 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 已提交
910 911 912 913
#ifdef _AIX
#undef hz
#endif

914 915 916 917
#define CHILD_INFO_MAGIC 0xC17DDA7A12345678LL
#define CHILD_INFO_TYPE_RDB 0
#define CHILD_INFO_TYPE_AOF 1

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

    /* 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;
1262 1263 1264
};

typedef struct pubsubPattern {
1265
    client *client;
1266 1267 1268
    robj *pattern;
} pubsubPattern;

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

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 已提交
1310
    quicklistIter *iter;
1311 1312 1313 1314 1315
} listTypeIterator;

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

1319 1320 1321 1322 1323 1324
/* Structure to hold set iteration abstraction. */
typedef struct {
    robj *subject;
    int encoding;
    int ii; /* intset iterator */
    dictIterator *di;
1325
} setTypeIterator;
1326

G
guiquanz 已提交
1327
/* Structure to hold hash iteration abstraction. Note that iteration over
1328 1329 1330 1331
 * 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 {
1332
    robj *subject;
1333
    int encoding;
1334 1335

    unsigned char *fptr, *vptr;
1336 1337 1338 1339 1340

    dictIterator *di;
    dictEntry *de;
} hashTypeIterator;

1341 1342
#include "stream.h"  /* Stream data type header file. */

1343 1344
#define OBJ_HASH_KEY 1
#define OBJ_HASH_VALUE 2
1345 1346 1347 1348 1349 1350 1351

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

extern struct redisServer server;
extern struct sharedObjectsStruct shared;
1352
extern dictType objectKeyPointerValueDictType;
1353
extern dictType objectKeyHeapPointerValueDictType;
1354 1355
extern dictType setDictType;
extern dictType zsetDictType;
A
antirez 已提交
1356
extern dictType clusterNodesDictType;
1357
extern dictType clusterNodesBlackListDictType;
1358
extern dictType dbDictType;
A
antirez 已提交
1359
extern dictType shaScriptObjectDictType;
1360
extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
1361
extern dictType hashDictType;
1362
extern dictType replScriptCacheDictType;
1363
extern dictType keyptrDictType;
A
antirez 已提交
1364
extern dictType modulesDictType;
1365 1366 1367 1368 1369

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

A
antirez 已提交
1370 1371
/* Modules */
void moduleInitModulesSystem(void);
1372
int moduleLoad(const char *path, void **argv, int argc);
A
antirez 已提交
1373
void moduleLoadFromQueue(void);
1374
int *moduleGetCommandKeysViaAPI(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1375 1376
moduleType *moduleTypeLookupModuleByID(uint64_t id);
void moduleTypeNameByID(char *name, uint64_t moduleid);
1377
void moduleFreeContext(struct RedisModuleCtx *ctx);
1378 1379 1380
void unblockClientFromModule(client *c);
void moduleHandleBlockedClients(void);
void moduleBlockedClientTimedOut(client *c);
1381
void moduleBlockedClientPipeReadable(aeEventLoop *el, int fd, void *privdata, int mask);
1382 1383 1384
size_t moduleCount(void);
void moduleAcquireGIL(void);
void moduleReleaseGIL(void);
1385 1386
void moduleNotifyKeyspaceEvent(int type, const char *event, robj *key, int dbid);

A
antirez 已提交
1387

1388 1389
/* Utils */
long long ustime(void);
1390
long long mstime(void);
1391 1392
void getRandomHexChars(char *p, size_t len);
void getRandomBytes(unsigned char *p, size_t len);
1393
uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
1394
void exitFromChild(int retcode);
1395
size_t redisPopcount(void *s, long count);
1396
void redisSetProcTitle(char *title);
1397

1398
/* networking.c -- Networking and Client related operations */
1399
client *createClient(int fd);
1400
void closeTimedoutClients(void);
1401 1402 1403
void freeClient(client *c);
void freeClientAsync(client *c);
void resetClient(client *c);
1404
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
1405 1406 1407
void *addDeferredMultiBulkLength(client *c);
void setDeferredMultiBulkLength(client *c, void *node, long length);
void processInputBuffer(client *c);
1408
void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
1409 1410
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
1411
void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
1412
void addReplyString(client *c, const char *s, size_t len);
1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
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 已提交
1423
void addReplyHumanLongDouble(client *c, long double d);
1424 1425
void addReplyLongLong(client *c, long long ll);
void addReplyMultiBulkLen(client *c, long length);
I
Itamar Haber 已提交
1426
void addReplyHelp(client *c, const char **help);
1427
void addReplySubcommandSyntaxError(client *c);
1428
void copyClientOutputBuffer(client *dst, client *src);
O
oranagra 已提交
1429 1430
size_t sdsZmallocSize(sds s);
size_t getStringObjectSdsUsedMemory(robj *o);
1431
void freeClientReplyValue(void *o);
1432
void *dupClientReplyValue(void *o);
1433 1434
void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer);
1435 1436
char *getClientPeerId(client *client);
sds catClientInfoString(sds s, client *client);
1437
sds getAllClientsInfoString(int type);
1438 1439 1440 1441
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);
1442
void freeClientsInAsyncFreeQueue(void);
1443 1444
void asyncCloseClientOnOutputBufferLimitReached(client *c);
int getClientType(client *c);
A
antirez 已提交
1445 1446
int getClientTypeByName(char *name);
char *getClientTypeName(int class);
A
antirez 已提交
1447
void flushSlavesOutputBuffers(void);
1448
void disconnectSlaves(void);
1449
int listenToPort(int port, int *fds, int *count);
1450 1451
void pauseClients(mstime_t duration);
int clientsArePaused(void);
1452
int processEventsWhileBlocked(void);
1453
int handleClientsWithPendingWrites(void);
1454
int clientHasPendingReplies(client *c);
1455
void unlinkClient(client *c);
A
antirez 已提交
1456
int writeToClient(int fd, client *c, int handler_installed);
1457
void linkClient(client *c);
1458

1459
#ifdef __GNUC__
1460
void addReplyErrorFormat(client *c, const char *fmt, ...)
1461
    __attribute__((format(printf, 2, 3)));
1462
void addReplyStatusFormat(client *c, const char *fmt, ...)
1463 1464
    __attribute__((format(printf, 2, 3)));
#else
1465 1466
void addReplyErrorFormat(client *c, const char *fmt, ...);
void addReplyStatusFormat(client *c, const char *fmt, ...);
1467 1468
#endif

1469 1470 1471 1472
/* List data type */
void listTypeTryConversion(robj *subject, robj *value);
void listTypePush(robj *subject, robj *value, int where);
robj *listTypePop(robj *subject, int where);
1473
unsigned long listTypeLength(const robj *subject);
1474
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
1475 1476 1477 1478 1479
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 已提交
1480
void listTypeDelete(listTypeIterator *iter, listTypeEntry *entry);
1481
void listTypeConvert(robj *subject, int enc);
1482 1483
void unblockClientWaitingData(client *c);
void popGenericCommand(client *c, int where);
1484 1485

/* MULTI/EXEC/WATCH... */
1486 1487 1488 1489
void unwatchAllKeys(client *c);
void initClientMultiState(client *c);
void freeClientMultiState(client *c);
void queueMultiCommand(client *c);
1490 1491
void touchWatchedKey(redisDb *db, robj *key);
void touchWatchedKeysOnFlush(int dbid);
1492 1493
void discardTransaction(client *c);
void flagTransaction(client *c);
1494
void execCommandPropagateMulti(client *c);
1495 1496

/* Redis object implementation */
1497 1498
void decrRefCount(robj *o);
void decrRefCountVoid(void *o);
1499
void incrRefCount(robj *o);
1500
robj *makeObjectShared(robj *o);
1501
robj *resetRefCount(robj *obj);
1502 1503 1504 1505 1506 1507
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);
1508 1509 1510
robj *createStringObject(const char *ptr, size_t len);
robj *createRawStringObject(const char *ptr, size_t len);
robj *createEmbeddedStringObject(const char *ptr, size_t len);
1511
robj *dupStringObject(const robj *o);
1512
int isSdsRepresentableAsLongLong(sds s, long long *llval);
1513
int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
1514 1515 1516 1517
robj *tryObjectEncoding(robj *o);
robj *getDecodedObject(robj *o);
size_t stringObjectLen(robj *o);
robj *createStringObjectFromLongLong(long long value);
1518
robj *createStringObjectFromLongLongForValue(long long value);
1519
robj *createStringObjectFromLongDouble(long double value, int humanfriendly);
M
Matt Stancliff 已提交
1520
robj *createQuicklistObject(void);
1521 1522
robj *createZiplistObject(void);
robj *createSetObject(void);
1523
robj *createIntsetObject(void);
1524 1525
robj *createHashObject(void);
robj *createZsetObject(void);
1526
robj *createZsetZiplistObject(void);
1527
robj *createStreamObject(void);
1528
robj *createModuleObject(moduleType *mt, void *value);
1529 1530 1531 1532
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);
1533
int getDoubleFromObject(const robj *o, double *target);
1534
int getLongLongFromObject(robj *o, long long *target);
A
antirez 已提交
1535
int getLongDoubleFromObject(robj *o, long double *target);
1536
int getLongDoubleFromObjectOrReply(client *c, robj *o, long double *target, const char *msg);
1537 1538
char *strEncoding(int encoding);
int compareStringObjects(robj *a, robj *b);
1539
int collateStringObjects(robj *a, robj *b);
1540
int equalStringObjects(robj *a, robj *b);
1541
unsigned long long estimateObjectIdleTime(robj *o);
1542
#define sdsEncodedObject(objptr) (objptr->encoding == OBJ_ENCODING_RAW || objptr->encoding == OBJ_ENCODING_EMBSTR)
1543

1544
/* Synchronous I/O with timeout */
1545 1546 1547
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);
1548

1549 1550
/* Replication */
void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
1551
void replicationFeedSlavesFromMasterStream(list *slaves, char *buf, size_t buflen);
1552
void replicationFeedMonitors(client *c, list *monitors, int dictid, robj **argv, int argc);
1553
void updateSlavesWaitingBgsave(int bgsaveerr, int type);
1554
void replicationCron(void);
1555
void replicationHandleMasterDisconnection(void);
1556
void replicationCacheMaster(client *c);
1557
void resizeReplicationBacklog(long long newsize);
1558 1559
void replicationSetMaster(char *ip, int port);
void replicationUnsetMaster(void);
1560
void refreshGoodSlavesCount(void);
1561 1562 1563 1564
void replicationScriptCacheInit(void);
void replicationScriptCacheFlush(void);
void replicationScriptCacheAdd(sds sha1);
int replicationScriptCacheExists(sds sha1);
1565
void processClientsWaitingReplicas(void);
1566
void unblockClientWaitingReplicas(client *c);
1567
int replicationCountAcksByOffset(long long offset);
A
antirez 已提交
1568
void replicationSendNewlineToMaster(void);
1569
long long replicationGetSlaveOffset(void);
1570
char *replicationGetSlaveName(client *c);
A
antirez 已提交
1571
long long getPsyncInitialOffset(void);
1572
int replicationSetupSlaveForFullResync(client *slave, long long offset);
1573 1574 1575
void changeReplicationId(void);
void clearReplicationId2(void);
void chopReplicationBacklog(void);
1576
void replicationCacheMasterUsingMyself(void);
1577
void feedReplicationBacklog(void *ptr, size_t len);
1578

1579 1580 1581 1582 1583
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

1584
/* RDB persistence */
1585
#include "rdb.h"
1586
int rdbSaveRio(rio *rdb, int *error, int flags, rdbSaveInfo *rsi);
1587 1588

/* AOF persistence */
1589
void flushAppendOnlyFile(int force);
1590 1591 1592 1593 1594 1595
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);
1596
void backgroundRewriteDoneHandler(int exitcode, int bysignal);
1597 1598
void aofRewriteBufferReset(void);
unsigned long aofRewriteBufferSize(void);
A
antirez 已提交
1599
ssize_t aofReadDiffFromParent(void);
1600

1601 1602 1603 1604 1605 1606
/* Child info */
void openChildInfoPipe(void);
void closeChildInfoPipe(void);
void sendChildInfo(int process_type);
void receiveChildInfo(void);

1607
/* Sorted sets data type */
1608

A
antirez 已提交
1609 1610 1611 1612
/* 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. */
J
Jack Drogon 已提交
1613
#define ZADD_XX (1<<2)      /* Only touch elements already existing. */
A
antirez 已提交
1614 1615 1616

/* Output flags. */
#define ZADD_NOP (1<<3)     /* Operation not performed because of conditionals.*/
J
Jack Drogon 已提交
1617
#define ZADD_NAN (1<<4)     /* Only touch elements already existing. */
A
antirez 已提交
1618 1619 1620 1621 1622 1623
#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. */

1624
/* Struct to hold a inclusive/exclusive range spec by score comparison. */
1625 1626 1627 1628 1629
typedef struct {
    double min, max;
    int minex, maxex; /* are min or max exclusive? */
} zrangespec;

1630 1631
/* Struct to hold an inclusive/exclusive range spec by lexicographic comparison. */
typedef struct {
1632
    sds min, max;     /* May be set to shared.(minstring|maxstring) */
1633 1634 1635
    int minex, maxex; /* are min or max exclusive? */
} zlexrangespec;

1636 1637
zskiplist *zslCreate(void);
void zslFree(zskiplist *zsl);
1638 1639 1640
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);
1641 1642
zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec *range);
zskiplistNode *zslLastInRange(zskiplist *zsl, zrangespec *range);
1643 1644 1645
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 已提交
1646
unsigned char *zzlFirstInRange(unsigned char *zl, zrangespec *range);
A
antirez 已提交
1647
unsigned char *zzlLastInRange(unsigned char *zl, zrangespec *range);
Z
zhaozhao.zz 已提交
1648
unsigned long zsetLength(const robj *zobj);
1649
void zsetConvert(robj *zobj, int encoding);
1650
void zsetConvertToZiplistIfNeeded(robj *zobj, size_t maxelelen);
1651 1652
int zsetScore(robj *zobj, sds member, double *score);
unsigned long zslGetRank(zskiplist *zsl, double score, sds o);
A
antirez 已提交
1653
int zsetAdd(robj *zobj, double score, sds ele, int *flags, double *newscore);
A
antirez 已提交
1654
long zsetRank(robj *zobj, sds ele, int reverse);
A
antirez 已提交
1655
int zsetDel(robj *zobj, sds ele);
1656
void genericZpopCommand(client *c, robj **keyv, int keyc, int where, int emitkey, robj *countarg);
A
antirez 已提交
1657
sds ziplistGetObject(unsigned char *sptr);
A
antirez 已提交
1658 1659
int zslValueGteMin(double value, zrangespec *spec);
int zslValueLteMax(double value, zrangespec *spec);
A
antirez 已提交
1660
void zslFreeLexRange(zlexrangespec *spec);
A
antirez 已提交
1661 1662 1663 1664 1665
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 已提交
1666 1667 1668 1669
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);
1670 1671

/* Core functions */
1672
int getMaxmemoryState(size_t *total, size_t *logical, size_t *tofree, float *level);
1673
size_t freeMemoryGetNotCountedMemory();
1674
int freeMemoryIfNeeded(void);
1675
int processCommand(client *c);
1676
void setupSignalHandlers(void);
1677 1678
struct redisCommand *lookupCommand(sds name);
struct redisCommand *lookupCommandByCString(char *s);
1679
struct redisCommand *lookupCommandOrOriginal(sds name);
1680
void call(client *c, int flags);
A
antirez 已提交
1681
void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1682
void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
1683 1684
void forceCommandPropagation(client *c, int flags);
void preventCommandPropagation(client *c);
1685 1686
void preventCommandAOF(client *c);
void preventCommandReplication(client *c);
1687
int prepareForShutdown();
1688
#ifdef __GNUC__
A
antirez 已提交
1689
void serverLog(int level, const char *fmt, ...)
1690 1691
    __attribute__((format(printf, 2, 3)));
#else
A
antirez 已提交
1692
void serverLog(int level, const char *fmt, ...);
1693
#endif
A
antirez 已提交
1694 1695
void serverLogRaw(int level, const char *msg);
void serverLogFromHandler(int level, const char *msg);
1696
void usage(void);
1697 1698
void updateDictResizePolicy(void);
int htNeedsResize(dict *dict);
1699
void populateCommandTable(void);
1700
void resetCommandTableStats(void);
A
antirez 已提交
1701
void adjustOpenFilesLimit(void);
1702
void closeListeningSockets(int unlink_unix_socket);
1703 1704
void updateCachedTime(void);
void resetServerStats(void);
O
oranagra 已提交
1705
void activeDefragCycle(void);
1706
unsigned int getLRUClock(void);
1707
unsigned int LRU_CLOCK(void);
T
therealbill 已提交
1708
const char *evictPolicyToString(void);
1709 1710
struct redisMemOverhead *getMemoryOverheadData(void);
void freeMemoryOverheadData(struct redisMemOverhead *mh);
1711

A
antirez 已提交
1712 1713 1714 1715 1716
#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);

1717
/* Set data type */
1718 1719 1720 1721
robj *setTypeCreate(sds value);
int setTypeAdd(robj *subject, sds value);
int setTypeRemove(robj *subject, sds value);
int setTypeIsMember(robj *subject, sds value);
1722 1723
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
1724 1725 1726
int setTypeNext(setTypeIterator *si, sds *sdsele, int64_t *llele);
sds setTypeNextObject(setTypeIterator *si);
int setTypeRandomElement(robj *setobj, sds *sdsele, int64_t *llele);
1727
unsigned long setTypeRandomElements(robj *set, unsigned long count, robj *aux_set);
1728
unsigned long setTypeSize(const robj *subject);
1729 1730
void setTypeConvert(robj *subject, int enc);

1731
/* Hash data type */
A
antirez 已提交
1732 1733 1734 1735
#define HASH_SET_TAKE_FIELD (1<<0)
#define HASH_SET_TAKE_VALUE (1<<1)
#define HASH_SET_COPY 0

1736
void hashTypeConvert(robj *o, int enc);
1737 1738
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1739 1740
int hashTypeExists(robj *o, sds key);
int hashTypeDelete(robj *o, sds key);
1741
unsigned long hashTypeLength(const robj *o);
1742 1743 1744
hashTypeIterator *hashTypeInitIterator(robj *subject);
void hashTypeReleaseIterator(hashTypeIterator *hi);
int hashTypeNext(hashTypeIterator *hi);
1745 1746 1747 1748
void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what,
                                unsigned char **vstr,
                                unsigned int *vlen,
                                long long *vll);
1749 1750 1751
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);
1752
robj *hashTypeLookupWriteOrCreate(client *c, robj *key);
1753
robj *hashTypeGetValueObject(robj *o, sds field);
A
antirez 已提交
1754
int hashTypeSet(robj *o, sds field, sds value, int flags);
1755 1756

/* Pub / Sub */
1757 1758
int pubsubUnsubscribeAllChannels(client *c, int notify);
int pubsubUnsubscribeAllPatterns(client *c, int notify);
1759 1760
void freePubsubPattern(void *p);
int listMatchPubsubPattern(void *a, void *b);
1761
int pubsubPublishMessage(robj *channel, robj *message);
1762 1763 1764 1765 1766

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

/* Configuration */
1769
void loadServerConfig(char *filename, char *options);
1770
void appendServerSaveParams(time_t seconds, int changes);
1771
void resetServerSaveParams(void);
1772
struct rewriteConfigState; /* Forward declaration to export API. */
1773
void rewriteConfigRewriteLine(struct rewriteConfigState *state, const char *option, sds line, int force);
1774
int rewriteConfig(char *path);
1775 1776 1777

/* db.c -- Keyspace access API */
int removeExpire(redisDb *db, robj *key);
1778
void propagateExpire(redisDb *db, robj *key, int lazy);
1779
int expireIfNeeded(redisDb *db, robj *key);
1780
long long getExpire(redisDb *db, robj *key);
1781
void setExpire(client *c, redisDb *db, robj *key, long long when);
1782
robj *lookupKey(redisDb *db, robj *key, int flags);
1783 1784
robj *lookupKeyRead(redisDb *db, robj *key);
robj *lookupKeyWrite(redisDb *db, robj *key);
1785 1786
robj *lookupKeyReadOrReply(client *c, robj *key, robj *reply);
robj *lookupKeyWriteOrReply(client *c, robj *key, robj *reply);
1787
robj *lookupKeyReadWithFlags(redisDb *db, robj *key, int flags);
1788 1789
robj *objectCommandLookup(client *c, robj *key);
robj *objectCommandLookupOrReply(client *c, robj *key, robj *reply);
1790 1791
void objectSetLRUOrLFU(robj *val, long long lfu_freq, long long lru_idle,
                       long long lru_clock);
1792 1793
#define LOOKUP_NONE 0
#define LOOKUP_NOTOUCH (1<<0)
1794 1795 1796
void dbAdd(redisDb *db, robj *key, robj *val);
void dbOverwrite(redisDb *db, robj *key, robj *val);
void setKey(redisDb *db, robj *key, robj *val);
1797 1798
int dbExists(redisDb *db, robj *key);
robj *dbRandomKey(redisDb *db);
1799
int dbSyncDelete(redisDb *db, robj *key);
1800
int dbDelete(redisDb *db, robj *key);
1801
robj *dbUnshareStringValue(redisDb *db, robj *key, robj *o);
1802 1803 1804 1805 1806

#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*));

1807
int selectDb(client *c, int id);
1808 1809
void signalModifiedKey(redisDb *db, robj *key);
void signalFlushedDb(int dbid);
1810 1811
unsigned int getKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
unsigned int countKeysInSlot(unsigned int hashslot);
1812
unsigned int delKeysInSlot(unsigned int hashslot);
1813
int verifyClusterConfigWithData(void);
1814 1815
void scanGenericCommand(client *c, robj *o, unsigned long cursor);
int parseScanCursorOrReply(client *c, robj *o, unsigned long *cursor);
1816 1817 1818 1819
void slotToKeyAdd(robj *key);
void slotToKeyDel(robj *key);
void slotToKeyFlush(void);
int dbAsyncDelete(redisDb *db, robj *key);
1820 1821
void emptyDbAsync(redisDb *db);
void slotToKeyFlushAsync(void);
1822
size_t lazyfreeGetPendingObjectsCount(void);
1823

1824
/* API to get key arguments from commands */
1825
int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1826
void getKeysFreeResult(int *result);
1827
int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys);
1828
int *evalGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1829
int *sortGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1830
int *migrateGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1831
int *georadiusGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
A
antirez 已提交
1832
int *xreadGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1833

A
antirez 已提交
1834 1835 1836 1837 1838
/* Cluster */
void clusterInit(void);
unsigned short crc16(const char *buf, int len);
unsigned int keyHashSlot(char *key, int keylen);
void clusterCron(void);
1839
void clusterPropagatePublish(robj *channel, robj *message);
A
antirez 已提交
1840
void migrateCloseTimedoutSockets(void);
1841
void clusterBeforeSleep(void);
1842
int clusterSendModuleMessageToTarget(const char *target, uint64_t module_id, uint8_t type, unsigned char *payload, uint32_t len);
A
antirez 已提交
1843

1844 1845 1846 1847 1848
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);
A
antirez 已提交
1849
void sentinelIsRunning(void);
1850

1851 1852 1853 1854
/* 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);
1855

1856
/* Scripting */
1857
void scriptingInit(int setup);
1858 1859
int ldbRemoveChild(pid_t pid);
void ldbKillForkedSessions(void);
1860
int ldbPendingChildren(void);
1861
sds luaCreateFunction(client *c, lua_State *lua, robj *body);
1862

1863 1864
/* Blocked clients */
void processUnblockedClients(void);
1865 1866 1867 1868
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);
1869
void disconnectAllBlockedClients(void);
1870 1871
void handleClientsBlockedOnKeys(void);
void signalKeyAsReady(redisDb *db, robj *key);
1872
void blockForKeys(client *c, int btype, robj **keys, int numkeys, mstime_t timeout, robj *target, streamID *ids);
1873

1874 1875
/* expire.c -- Handling of expired keys */
void activeExpireCycle(int type);
1876 1877 1878
void expireSlaveKeys(void);
void rememberSlaveKeyWithExpire(redisDb *db, robj *key);
void flushSlaveKeysWithExpireList(void);
1879
size_t getSlaveKeyWithExpireCount(void);
1880

1881
/* evict.c -- maxmemory handling and LRU eviction. */
1882
void evictionPoolAlloc(void);
1883 1884 1885
#define LFU_INIT_VAL 5
unsigned long LFUGetTimeInMinutes(void);
uint8_t LFULogIncr(uint8_t value);
1886
unsigned long LFUDecrAndReturn(robj *o);
1887

1888
/* Keys hashing / comparison functions for dict.c hash tables. */
1889
uint64_t dictSdsHash(const void *key);
1890 1891 1892
int dictSdsKeyCompare(void *privdata, const void *key1, const void *key2);
void dictSdsDestructor(void *privdata, void *val);

1893 1894 1895
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);
1896
uint64_t redisBuildId(void);
1897 1898

/* Commands prototypes */
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
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);
1909
void unlinkCommand(client *c);
1910 1911 1912
void existsCommand(client *c);
void setbitCommand(client *c);
void getbitCommand(client *c);
1913
void bitfieldCommand(client *c);
1914 1915 1916 1917 1918 1919 1920 1921
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 已提交
1922
void swapdbCommand(client *c);
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 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976
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);
1977
void touchCommand(client *c);
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999
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);
2000 2001 2002 2003
void zpopminCommand(client *c);
void zpopmaxCommand(client *c);
void bzpopminCommand(client *c);
void bzpopmaxCommand(client *c);
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 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049
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);
2050
void memoryCommand(client *c);
2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062
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);
2063 2064
void georadiusbymemberCommand(client *c);
void georadiusbymemberroCommand(client *c);
2065
void georadiusCommand(client *c);
2066
void georadiusroCommand(client *c);
2067 2068 2069 2070 2071 2072 2073 2074 2075 2076
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 已提交
2077
void moduleCommand(client *c);
2078
void securityWarningCommand(client *c);
2079 2080
void xaddCommand(client *c);
void xrangeCommand(client *c);
2081
void xrevrangeCommand(client *c);
A
antirez 已提交
2082
void xlenCommand(client *c);
A
antirez 已提交
2083
void xreadCommand(client *c);
2084
void xgroupCommand(client *c);
A
antirez 已提交
2085
void xackCommand(client *c);
2086
void xpendingCommand(client *c);
2087
void xclaimCommand(client *c);
A
antirez 已提交
2088
void xinfoCommand(client *c);
A
antirez 已提交
2089
void xdelCommand(client *c);
A
antirez 已提交
2090
void xtrimCommand(client *c);
2091

2092 2093 2094 2095 2096 2097 2098
#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

2099
/* Debugging stuff */
2100 2101
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);
2102
void _serverPanic(const char *file, int line, const char *msg, ...);
A
antirez 已提交
2103
void bugReportStart(void);
2104
void serverLogObjectDebugInfo(const robj *o);
2105 2106
void sigsegvHandler(int sig, siginfo_t *info, void *secret);
sds genRedisInfoString(char *section);
A
antirez 已提交
2107 2108 2109
void enableWatchdog(int period);
void disableWatchdog(void);
void watchdogScheduleSignal(int period);
A
antirez 已提交
2110
void serverLogHexDump(int level, char *descr, void *value, size_t len);
A
antirez 已提交
2111
int memtest_preserving_test(unsigned long *m, size_t bytes, int passes);
A
antirez 已提交
2112 2113
void mixDigest(unsigned char *digest, void *ptr, size_t len);
void xorDigest(unsigned char *digest, void *ptr, size_t len);
2114 2115 2116 2117 2118 2119

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

2120
#endif