server.h 87.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
A
antirez 已提交
142
#define CONFIG_DEFAULT_AOF_USE_RDB_PREAMBLE 0
143 144 145 146
#define CONFIG_DEFAULT_ACTIVE_REHASHING 1
#define CONFIG_DEFAULT_AOF_REWRITE_INCREMENTAL_FSYNC 1
#define CONFIG_DEFAULT_MIN_SLAVES_TO_WRITE 0
#define CONFIG_DEFAULT_MIN_SLAVES_MAX_LAG 10
A
antirez 已提交
147 148 149 150
#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
151
#define CONFIG_DEFAULT_LATENCY_MONITOR_THRESHOLD 0
152 153 154 155
#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
156
#define CONFIG_DEFAULT_ALWAYS_SHOW_LOGO 0
157
#define CONFIG_DEFAULT_ACTIVE_DEFRAG 0
O
oranagra 已提交
158 159 160 161 162
#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 */
#define CONFIG_DEFAULT_DEFRAG_CYCLE_MIN 25 /* 25% CPU min (at lower threshold) */
#define CONFIG_DEFAULT_DEFRAG_CYCLE_MAX 75 /* 75% CPU max (at upper threshold) */
163

A
antirez 已提交
164 165 166 167 168 169
#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

170
/* Instantaneous metrics tracking. */
A
antirez 已提交
171 172 173 174 175
#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
176

177
/* Protocol and I/O related defines */
A
antirez 已提交
178 179 180 181 182
#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)
183
#define LONG_STR_SIZE      21          /* Bytes needed for long -> str + '\0' */
A
antirez 已提交
184 185 186 187 188 189 190
#define AOF_AUTOSYNC_BYTES (1024*1024*32) /* fdatasync every 32MB */

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

192
/* Hash table parameters */
A
antirez 已提交
193
#define HASHTABLE_MIN_FILL        10      /* Minimal hash table fill 10% */
194

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

214
/* AOF states */
A
antirez 已提交
215 216 217
#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 */
218

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

252
/* Client block type (btype field in client structure)
A
antirez 已提交
253 254 255 256
 * 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. */
257
#define BLOCKED_MODULE 3  /* Blocked by a loadable module. */
258

259
/* Client request types */
A
antirez 已提交
260 261
#define PROTO_REQ_INLINE 1
#define PROTO_REQ_MULTIBULK 2
262

263 264
/* Client classes for client limits, currently used only for
 * the max-client-output-buffer limit implementation. */
A
antirez 已提交
265 266 267
#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 已提交
268 269 270 271
#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 已提交
272 273 274 275 276 277

/* 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 已提交
278
/* --- Handshake states, must be ordered --- */
A
antirez 已提交
279
#define REPL_STATE_RECEIVE_PONG 3 /* Wait for PING reply */
280 281 282 283
#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 */
284 285 286 287 288 289
#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 已提交
290
/* --- End of handshake states --- */
291 292
#define REPL_STATE_TRANSFER 14 /* Receiving .rdb from master */
#define REPL_STATE_CONNECTED 15 /* Connected to master */
A
antirez 已提交
293 294

/* State of slaves from the POV of the master. Used in client->replstate.
295
 * In SEND_BULK and ONLINE state the slave receives new updates
A
antirez 已提交
296
 * in its output queue. In the WAIT_BGSAVE states instead the server is waiting
297
 * to start the next background saving in order to send updates to it. */
A
antirez 已提交
298 299 300 301
#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. */
302

303 304
/* Slave capabilities. */
#define SLAVE_CAPA_NONE 0
305 306
#define SLAVE_CAPA_EOF (1<<0)    /* Can parse the RDB EOF streaming format. */
#define SLAVE_CAPA_PSYNC2 (1<<1) /* Supports PSYNC2 protocol. */
307

308
/* Synchronous read timeout - slave side */
A
antirez 已提交
309
#define CONFIG_REPL_SYNCIO_TIMEOUT 5
310 311

/* List related stuff */
A
antirez 已提交
312 313
#define LIST_HEAD 0
#define LIST_TAIL 1
314 315

/* Sort operations */
A
antirez 已提交
316
#define SORT_OP_GET 0
317 318

/* Log levels */
A
antirez 已提交
319 320 321 322 323 324
#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
325

326
/* Supervision options */
A
antirez 已提交
327 328 329 330
#define SUPERVISED_NONE 0
#define SUPERVISED_AUTODETECT 1
#define SUPERVISED_SYSTEMD 2
#define SUPERVISED_UPSTART 3
331

332
/* Anti-warning macro... */
A
antirez 已提交
333
#define UNUSED(V) ((void) V)
334 335 336 337 338

#define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
#define ZSKIPLIST_P 0.25      /* Skiplist P = 1/4 */

/* Append only defines */
339 340 341
#define AOF_FSYNC_NO 0
#define AOF_FSYNC_ALWAYS 1
#define AOF_FSYNC_EVERYSEC 2
342
#define CONFIG_DEFAULT_AOF_FSYNC AOF_FSYNC_EVERYSEC
343 344

/* Zip structure related defaults */
345 346 347 348 349
#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
350

351
/* List defaults */
352 353
#define OBJ_LIST_MAX_ZIPLIST_SIZE -2
#define OBJ_LIST_COMPRESS_DEPTH 0
354

355
/* HyperLogLog defines */
356
#define CONFIG_DEFAULT_HLL_SPARSE_MAX_BYTES 3000
357

358
/* Sets operations codes */
A
antirez 已提交
359 360 361
#define SET_OP_UNION 0
#define SET_OP_DIFF 1
#define SET_OP_INTER 2
362

363 364 365 366 367
/* 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)
368
#define MAXMEMORY_FLAG_ALLKEYS (1<<2)
369 370
#define MAXMEMORY_FLAG_NO_SHARED_INTEGERS \
    (MAXMEMORY_FLAG_LRU|MAXMEMORY_FLAG_LFU)
371

372 373 374 375
#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)
376 377 378
#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)
379 380
#define MAXMEMORY_NO_EVICTION (7<<8)

A
antirez 已提交
381
#define CONFIG_DEFAULT_MAXMEMORY_POLICY MAXMEMORY_NO_EVICTION
382

A
antirez 已提交
383
/* Scripting */
A
antirez 已提交
384
#define LUA_SCRIPT_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
385

386 387 388 389
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

390
/* SHUTDOWN flags */
391 392 393 394
#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. */
395

396
/* Command call flags, see call() function */
A
antirez 已提交
397
#define CMD_CALL_NONE 0
A
antirez 已提交
398 399 400 401 402
#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 已提交
403
#define CMD_CALL_FULL (CMD_CALL_SLOWLOG | CMD_CALL_STATS | CMD_CALL_PROPAGATE)
404

A
antirez 已提交
405
/* Command propagation flags, see propagate() function */
A
antirez 已提交
406 407 408
#define PROPAGATE_NONE 0
#define PROPAGATE_AOF 1
#define PROPAGATE_REPL 2
A
antirez 已提交
409

A
antirez 已提交
410
/* RDB active child save type. */
A
antirez 已提交
411 412 413
#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 已提交
414

415 416
/* Keyspace changes notification classes. Every class is associated with a
 * character for configuration purposes. */
A
antirez 已提交
417 418 419 420 421 422 423 424 425 426 427
#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 */
#define NOTIFY_ALL (NOTIFY_GENERIC | NOTIFY_STRING | NOTIFY_LIST | NOTIFY_SET | NOTIFY_HASH | NOTIFY_ZSET | NOTIFY_EXPIRED | NOTIFY_EVICTED)      /* A */
428

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

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

437
/* We can print the stacktrace, so our assert is defined this way: */
A
antirez 已提交
438 439
#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)))
440
#define serverPanic(...) _serverPanic(__FILE__,__LINE__,__VA_ARGS__),_exit(1)
441 442 443 444 445 446 447 448

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

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

/* The actual Redis Object */
449 450 451 452 453 454
#define OBJ_STRING 0
#define OBJ_LIST 1
#define OBJ_SET 2
#define OBJ_ZSET 3
#define OBJ_HASH 4

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
/* The "module" object type is a special one that signals that the object
 * is one directly managed by a Redis module. In this case the value points
 * to a moduleValue struct, which contains the object value (which is only
 * handled by the module itself) and the RedisModuleType struct which lists
 * function pointers in order to serialize, deserialize, AOF-rewrite and
 * free the object.
 *
 * Inside the RDB file, module types are encoded as OBJ_MODULE followed
 * by a 64 bit module type ID, which has a 54 bits module-specific signature
 * in order to dispatch the loading to the right module, plus a 10 bits
 * encoding version. */
#define OBJ_MODULE 5

/* 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;
477
struct RedisModuleCtx;
478 479 480 481 482 483 484 485 486 487
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);
488
typedef size_t (*moduleTypeMemUsageFunc)(const void *value);
489 490 491 492 493 494 495 496 497 498
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;
499
    moduleTypeMemUsageFunc mem_usage;
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
    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. */
A
antirez 已提交
533
    struct RedisModuleCtx *ctx; /* Optional context, see RM_GetContextFromIO()*/
534 535 536 537 538 539 540
} RedisModuleIO;

#define moduleInitIOContext(iovar,mtype,rioptr) do { \
    iovar.rio = rioptr; \
    iovar.type = mtype; \
    iovar.bytes = 0; \
    iovar.error = 0; \
541
    iovar.ctx = NULL; \
542 543
} while(0);

544 545 546 547 548 549 550
/* 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 */
551
#define OBJ_ENCODING_LINKEDLIST 4 /* No longer used: old list encoding. */
552 553 554 555 556 557
#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 */

A
antirez 已提交
558 559 560
#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 */
561 562

#define OBJ_SHARED_REFCOUNT INT_MAX
563 564 565
typedef struct redisObject {
    unsigned type:4;
    unsigned encoding:4;
566 567 568
    unsigned lru:LRU_BITS; /* LRU time (relative to server.lruclock) or
                            * LFU data (least significant 8 bits frequency
                            * and most significant 16 bits decreas time). */
569 570 571 572
    int refcount;
    void *ptr;
} robj;

573 574 575
/* Macro used to obtain the current LRU clock.
 * If the current resolution is lower than the frequency we refresh the
 * LRU clock (as it should be in production servers) we return the
576
 * precomputed value, otherwise we need to resort to a system call. */
A
antirez 已提交
577
#define LRU_CLOCK() ((1000/server.hz <= LRU_CLOCK_RESOLUTION) ? server.lruclock : getLRUClock())
578

G
guiquanz 已提交
579
/* Macro used to initialize a Redis object allocated on the stack.
580 581 582 583 584
 * 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; \
585 586
    _var.type = OBJ_STRING; \
    _var.encoding = OBJ_ENCODING_RAW; \
587
    _var.ptr = _ptr; \
O
Oran Agra 已提交
588
} while(0)
589

590
struct evictionPoolEntry; /* Defined in evict.c */
A
antirez 已提交
591 592 593 594

/* 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. */
595 596 597
typedef struct redisDb {
    dict *dict;                 /* The keyspace for this DB */
    dict *expires;              /* Timeout of keys with a timeout set */
598
    dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP)*/
599
    dict *ready_keys;           /* Blocked keys that received a PUSH */
600
    dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
A
antirez 已提交
601
    int id;                     /* Database ID */
602
    long long avg_ttl;          /* Average TTL, just for stats */
603 604 605 606 607 608 609 610 611 612 613 614
} 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 */
615 616
    int minreplicas;        /* MINREPLICAS for synchronous replication */
    time_t minreplicas_timeout; /* MINREPLICAS timeout as unixtime. */
617 618
} multiState;

619 620
/* This structure holds the blocking operation state for a client.
 * The fields used depend on client->btype. */
621
typedef struct blockingState {
622 623 624 625
    /* Generic fields. */
    mstime_t timeout;       /* Blocking operation timeout. If UNIX current time
                             * is > timeout then the operation timed out. */

A
antirez 已提交
626
    /* BLOCKED_LIST */
627
    dict *keys;             /* The keys we are waiting to terminate a blocking
628 629 630
                             * operation such as BLPOP. Otherwise NULL. */
    robj *target;           /* The key that should receive the element,
                             * for BRPOPLPUSH. */
631

A
antirez 已提交
632
    /* BLOCKED_WAIT */
633 634
    int numreplicas;        /* Number of replicas we are waiting for ACK. */
    long long reploffset;   /* Replication offset to reach. */
635 636 637 638 639

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

642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
/* 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 已提交
658
/* With multiplexing we need to take per-client state.
X
xuxiang 已提交
659
 * Clients are taken in a linked list. */
660
typedef struct client {
661
    uint64_t id;            /* Client incremental unique ID. */
A
antirez 已提交
662 663 664 665
    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. */
666 667 668
    sds pending_querybuf;   /* If this is a master, this buffer represents the
                               yet not applied replication stream that we
                               are receiving from the master. */
A
antirez 已提交
669 670 671 672 673 674 675 676 677
    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. */
678
    size_t sentlen;         /* Amount of bytes already sent in the current
679
                               buffer or object being sent. */
A
antirez 已提交
680 681
    time_t ctime;           /* Client creation time. */
    time_t lastinteraction; /* Time of the last interaction, used for timeout */
682
    time_t obuf_soft_limit_reached_time;
A
antirez 已提交
683 684 685
    int flags;              /* Client flags: CLIENT_* macros. */
    int authenticated;      /* When requirepass is non-NULL. */
    int replstate;          /* Replication state if this is a slave. */
A
antirez 已提交
686
    int repl_put_online_on_ack; /* Install slave write handler on ACK. */
A
antirez 已提交
687 688 689 690
    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. */
691 692
    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 已提交
693 694
    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 已提交
695 696 697
    long long psync_initial_offset; /* FULLRESYNC reply offset other slaves
                                       copying this slave output buffer
                                       should use. */
698 699
    char replid[CONFIG_RUN_ID_SIZE+1]; /* Master replication ID (if master). */
    int slave_listening_port; /* As configured with: SLAVECONF listening-port */
700
    char slave_ip[NET_IP_STR_LEN]; /* Optionally given by REPLCONF ip-address */
701
    int slave_capa;         /* Slave capabilities: SLAVE_CAPA_* bitwise OR. */
702
    multiState mstate;      /* MULTI/EXEC state */
A
antirez 已提交
703
    int btype;              /* Type of blocking op if CLIENT_BLOCKED. */
704 705
    blockingState bpop;     /* blocking state */
    long long woff;         /* Last write global replication offset. */
706 707 708
    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) */
709
    sds peerid;             /* Cached peer ID. */
710 711

    /* Response buffer */
712
    int bufpos;
A
antirez 已提交
713
    char buf[PROTO_REPLY_CHUNK_BYTES];
714
} client;
715 716 717 718 719 720

struct saveparam {
    time_t seconds;
    int changes;
};

721
struct moduleLoadQueueEntry {
722 723
    sds path;
    int argc;
724
    robj **argv;
725 726
};

727 728 729 730
struct sharedObjectsStruct {
    robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
    *colon, *nullbulk, *nullmultibulk, *queued,
    *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
731
    *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
732
    *masterdownerr, *roslaveerr, *execaborterr, *noautherr, *noreplicaserr,
733
    *busykeyerr, *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
734 735
    *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *unlink,
    *rpop, *lpop, *lpush, *emptyscan,
A
antirez 已提交
736 737 738 739
    *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" */
740
    sds minstring, maxstring;
741 742
};

743 744
/* ZSETs use a specialized version of Skiplists */
typedef struct zskiplistNode {
745
    sds ele;
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
    double score;
    struct zskiplistNode *backward;
    struct zskiplistLevel {
        struct zskiplistNode *forward;
        unsigned int span;
    } level[];
} zskiplistNode;

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

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

765
typedef struct clientBufferLimitsConfig {
766 767
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
768 769 770
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

A
antirez 已提交
771
extern clientBufferLimitsConfig clientBufferLimitsDefaults[CLIENT_TYPE_OBUF_COUNT];
772

773 774
/* The redisOp structure defines a Redis Operation, that is an instance of
 * a command with an argument vector, database ID, propagation target
A
antirez 已提交
775
 * (PROPAGATE_*), and command pointer.
776 777 778 779
 *
 * Currently only used to additionally propagate more commands to AOF/Replication
 * after the propagation of the executed command. */
typedef struct redisOp {
780 781 782
    robj **argv;
    int argc, dbid, target;
    struct redisCommand *cmd;
783 784 785 786 787 788 789 790 791 792 793 794 795
} 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;
796

797 798 799
/* This structure is returned by the getMemoryOverheadData() function in
 * order to return memory overhead information. */
struct redisMemOverhead {
800
    size_t peak_allocated;
801 802 803 804 805 806 807 808
    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 已提交
809 810
    size_t total_keys;
    size_t bytes_per_key;
811
    float dataset_perc;
812
    float peak_perc;
A
antirez 已提交
813
    float fragmentation;
814 815 816 817 818 819 820 821
    size_t num_dbs;
    struct {
        size_t dbid;
        size_t overhead_ht_main;
        size_t overhead_ht_expires;
    } *db;
};

822 823 824 825 826 827 828 829 830
/* 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 {
831
    /* Used saving and loading. */
832
    int repl_stream_db;  /* DB to select in server.master client. */
833 834 835 836 837

    /* 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. */
838 839
} rdbSaveInfo;

840
#define RDB_SAVE_INFO_INIT {-1,0,"000000000000000000000000000000",-1}
841

A
antirez 已提交
842 843 844 845
/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

846 847
struct clusterState;

A
antirez 已提交
848 849
/* 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 已提交
850 851 852 853
#ifdef _AIX
#undef hz
#endif

854 855 856 857
#define CHILD_INFO_MAGIC 0xC17DDA7A12345678LL
#define CHILD_INFO_TYPE_RDB 0
#define CHILD_INFO_TYPE_AOF 1

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

typedef struct pubsubPattern {
1183
    client *client;
1184 1185 1186
    robj *pattern;
} pubsubPattern;

1187
typedef void redisCommandProc(client *c);
1188
typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1189 1190 1191 1192
struct redisCommand {
    char *name;
    redisCommandProc *proc;
    int arity;
G
guiquanz 已提交
1193
    char *sflags; /* Flags as string representation, one char per flag. */
1194
    int flags;    /* The actual flags, obtained from the 'sflags' field. */
1195
    /* Use a function to determine keys arguments in a command line.
A
antirez 已提交
1196
     * Used for Redis Cluster redirect. */
1197
    redisGetKeysProc *getkeys_proc;
1198
    /* What keys should be loaded in background when calling this command? */
1199
    int firstkey; /* The first argument that's a key (0 = no keys) */
G
guiquanz 已提交
1200
    int lastkey;  /* The last argument that's a key */
1201
    int keystep;  /* The step between first and last key */
1202
    long long microseconds, calls;
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
};

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 已提交
1228
    quicklistIter *iter;
1229 1230 1231 1232 1233
} listTypeIterator;

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

1237 1238 1239 1240 1241 1242
/* Structure to hold set iteration abstraction. */
typedef struct {
    robj *subject;
    int encoding;
    int ii; /* intset iterator */
    dictIterator *di;
1243
} setTypeIterator;
1244

G
guiquanz 已提交
1245
/* Structure to hold hash iteration abstraction. Note that iteration over
1246 1247 1248 1249
 * 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 {
1250
    robj *subject;
1251
    int encoding;
1252 1253

    unsigned char *fptr, *vptr;
1254 1255 1256 1257 1258

    dictIterator *di;
    dictEntry *de;
} hashTypeIterator;

1259 1260
#define OBJ_HASH_KEY 1
#define OBJ_HASH_VALUE 2
1261 1262 1263 1264 1265 1266 1267

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

extern struct redisServer server;
extern struct sharedObjectsStruct shared;
1268
extern dictType objectKeyPointerValueDictType;
1269 1270
extern dictType setDictType;
extern dictType zsetDictType;
A
antirez 已提交
1271
extern dictType clusterNodesDictType;
1272
extern dictType clusterNodesBlackListDictType;
1273
extern dictType dbDictType;
A
antirez 已提交
1274
extern dictType shaScriptObjectDictType;
1275
extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
1276
extern dictType hashDictType;
1277
extern dictType replScriptCacheDictType;
1278
extern dictType keyptrDictType;
A
antirez 已提交
1279
extern dictType modulesDictType;
1280 1281 1282 1283 1284

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

A
antirez 已提交
1285 1286
/* Modules */
void moduleInitModulesSystem(void);
1287
int moduleLoad(const char *path, void **argv, int argc);
A
antirez 已提交
1288
void moduleLoadFromQueue(void);
1289
int *moduleGetCommandKeysViaAPI(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1290 1291
moduleType *moduleTypeLookupModuleByID(uint64_t id);
void moduleTypeNameByID(char *name, uint64_t moduleid);
1292
void moduleFreeContext(struct RedisModuleCtx *ctx);
1293 1294 1295
void unblockClientFromModule(client *c);
void moduleHandleBlockedClients(void);
void moduleBlockedClientTimedOut(client *c);
1296
void moduleBlockedClientPipeReadable(aeEventLoop *el, int fd, void *privdata, int mask);
1297
void moduleCooperativeMultiTaskingCycle(void);
A
antirez 已提交
1298

1299 1300
/* Utils */
long long ustime(void);
1301
long long mstime(void);
1302
void getRandomHexChars(char *p, unsigned int len);
1303
uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
1304
void exitFromChild(int retcode);
1305
size_t redisPopcount(void *s, long count);
1306
void redisSetProcTitle(char *title);
1307

1308
/* networking.c -- Networking and Client related operations */
1309
client *createClient(int fd);
1310
void closeTimedoutClients(void);
1311 1312 1313
void freeClient(client *c);
void freeClientAsync(client *c);
void resetClient(client *c);
1314
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
1315 1316 1317
void *addDeferredMultiBulkLength(client *c);
void setDeferredMultiBulkLength(client *c, void *node, long length);
void processInputBuffer(client *c);
1318
void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
1319 1320
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
1321
void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
1322
void addReplyString(client *c, const char *s, size_t len);
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
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 已提交
1333
void addReplyHumanLongDouble(client *c, long double d);
1334 1335 1336
void addReplyLongLong(client *c, long long ll);
void addReplyMultiBulkLen(client *c, long length);
void copyClientOutputBuffer(client *dst, client *src);
O
oranagra 已提交
1337 1338
size_t sdsZmallocSize(sds s);
size_t getStringObjectSdsUsedMemory(robj *o);
1339
void *dupClientReplyValue(void *o);
1340 1341
void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer);
1342 1343
char *getClientPeerId(client *client);
sds catClientInfoString(sds s, client *client);
1344
sds getAllClientsInfoString(void);
1345 1346 1347 1348
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);
1349
void freeClientsInAsyncFreeQueue(void);
1350 1351
void asyncCloseClientOnOutputBufferLimitReached(client *c);
int getClientType(client *c);
A
antirez 已提交
1352 1353
int getClientTypeByName(char *name);
char *getClientTypeName(int class);
A
antirez 已提交
1354
void flushSlavesOutputBuffers(void);
1355
void disconnectSlaves(void);
1356
int listenToPort(int port, int *fds, int *count);
1357 1358
void pauseClients(mstime_t duration);
int clientsArePaused(void);
1359
int processEventsWhileBlocked(void);
1360
int handleClientsWithPendingWrites(void);
1361
int clientHasPendingReplies(client *c);
1362
void unlinkClient(client *c);
A
antirez 已提交
1363
int writeToClient(int fd, client *c, int handler_installed);
1364

1365
#ifdef __GNUC__
1366
void addReplyErrorFormat(client *c, const char *fmt, ...)
1367
    __attribute__((format(printf, 2, 3)));
1368
void addReplyStatusFormat(client *c, const char *fmt, ...)
1369 1370
    __attribute__((format(printf, 2, 3)));
#else
1371 1372
void addReplyErrorFormat(client *c, const char *fmt, ...);
void addReplyStatusFormat(client *c, const char *fmt, ...);
1373 1374
#endif

1375 1376 1377 1378
/* List data type */
void listTypeTryConversion(robj *subject, robj *value);
void listTypePush(robj *subject, robj *value, int where);
robj *listTypePop(robj *subject, int where);
1379
unsigned long listTypeLength(const robj *subject);
1380
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
1381 1382 1383 1384 1385
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 已提交
1386
void listTypeDelete(listTypeIterator *iter, listTypeEntry *entry);
1387
void listTypeConvert(robj *subject, int enc);
1388
void unblockClientWaitingData(client *c);
1389
void handleClientsBlockedOnLists(void);
1390
void popGenericCommand(client *c, int where);
1391
void signalListAsReady(redisDb *db, robj *key);
1392 1393

/* MULTI/EXEC/WATCH... */
1394 1395 1396 1397
void unwatchAllKeys(client *c);
void initClientMultiState(client *c);
void freeClientMultiState(client *c);
void queueMultiCommand(client *c);
1398 1399
void touchWatchedKey(redisDb *db, robj *key);
void touchWatchedKeysOnFlush(int dbid);
1400 1401
void discardTransaction(client *c);
void flagTransaction(client *c);
1402
void execCommandPropagateMulti(client *c);
1403 1404

/* Redis object implementation */
1405 1406
void decrRefCount(robj *o);
void decrRefCountVoid(void *o);
1407
void incrRefCount(robj *o);
1408
robj *makeObjectShared(robj *o);
1409
robj *resetRefCount(robj *obj);
1410 1411 1412 1413 1414 1415
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);
1416 1417 1418
robj *createStringObject(const char *ptr, size_t len);
robj *createRawStringObject(const char *ptr, size_t len);
robj *createEmbeddedStringObject(const char *ptr, size_t len);
1419
robj *dupStringObject(const robj *o);
1420
int isSdsRepresentableAsLongLong(sds s, long long *llval);
1421
int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
1422 1423 1424 1425
robj *tryObjectEncoding(robj *o);
robj *getDecodedObject(robj *o);
size_t stringObjectLen(robj *o);
robj *createStringObjectFromLongLong(long long value);
1426
robj *createStringObjectFromLongDouble(long double value, int humanfriendly);
M
Matt Stancliff 已提交
1427
robj *createQuicklistObject(void);
1428 1429
robj *createZiplistObject(void);
robj *createSetObject(void);
1430
robj *createIntsetObject(void);
1431 1432
robj *createHashObject(void);
robj *createZsetObject(void);
1433
robj *createZsetZiplistObject(void);
1434
robj *createModuleObject(moduleType *mt, void *value);
1435 1436 1437 1438
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);
1439
int getDoubleFromObject(const robj *o, double *target);
1440
int getLongLongFromObject(robj *o, long long *target);
A
antirez 已提交
1441
int getLongDoubleFromObject(robj *o, long double *target);
1442
int getLongDoubleFromObjectOrReply(client *c, robj *o, long double *target, const char *msg);
1443 1444
char *strEncoding(int encoding);
int compareStringObjects(robj *a, robj *b);
1445
int collateStringObjects(robj *a, robj *b);
1446
int equalStringObjects(robj *a, robj *b);
1447
unsigned long long estimateObjectIdleTime(robj *o);
1448
#define sdsEncodedObject(objptr) (objptr->encoding == OBJ_ENCODING_RAW || objptr->encoding == OBJ_ENCODING_EMBSTR)
1449

1450
/* Synchronous I/O with timeout */
1451 1452 1453
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);
1454

1455 1456
/* Replication */
void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
1457
void replicationFeedSlavesFromMasterStream(list *slaves, char *buf, size_t buflen);
1458
void replicationFeedMonitors(client *c, list *monitors, int dictid, robj **argv, int argc);
1459
void updateSlavesWaitingBgsave(int bgsaveerr, int type);
1460
void replicationCron(void);
1461
void replicationHandleMasterDisconnection(void);
1462
void replicationCacheMaster(client *c);
1463
void resizeReplicationBacklog(long long newsize);
1464 1465
void replicationSetMaster(char *ip, int port);
void replicationUnsetMaster(void);
1466
void refreshGoodSlavesCount(void);
1467 1468 1469 1470
void replicationScriptCacheInit(void);
void replicationScriptCacheFlush(void);
void replicationScriptCacheAdd(sds sha1);
int replicationScriptCacheExists(sds sha1);
1471
void processClientsWaitingReplicas(void);
1472
void unblockClientWaitingReplicas(client *c);
1473
int replicationCountAcksByOffset(long long offset);
A
antirez 已提交
1474
void replicationSendNewlineToMaster(void);
1475
long long replicationGetSlaveOffset(void);
1476
char *replicationGetSlaveName(client *c);
A
antirez 已提交
1477
long long getPsyncInitialOffset(void);
1478
int replicationSetupSlaveForFullResync(client *slave, long long offset);
1479 1480 1481
void changeReplicationId(void);
void clearReplicationId2(void);
void chopReplicationBacklog(void);
1482
void replicationCacheMasterUsingMyself(void);
1483

1484 1485 1486 1487 1488
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

1489
/* RDB persistence */
1490
#include "rdb.h"
1491
int rdbSaveRio(rio *rdb, int *error, int flags, rdbSaveInfo *rsi);
1492 1493

/* AOF persistence */
1494
void flushAppendOnlyFile(int force);
1495 1496 1497 1498 1499 1500
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);
1501
void backgroundRewriteDoneHandler(int exitcode, int bysignal);
1502 1503
void aofRewriteBufferReset(void);
unsigned long aofRewriteBufferSize(void);
A
antirez 已提交
1504
ssize_t aofReadDiffFromParent(void);
1505

1506 1507 1508 1509 1510 1511
/* Child info */
void openChildInfoPipe(void);
void closeChildInfoPipe(void);
void sendChildInfo(int process_type);
void receiveChildInfo(void);

1512
/* Sorted sets data type */
1513

A
antirez 已提交
1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
/* Input flags. */
#define ZADD_NONE 0
#define ZADD_INCR (1<<0)    /* Increment the score instead of setting it. */
#define ZADD_NX (1<<1)      /* Don't touch elements not already existing. */
#define ZADD_XX (1<<2)      /* Only touch elements already exisitng. */

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

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

1529
/* Struct to hold a inclusive/exclusive range spec by score comparison. */
1530 1531 1532 1533 1534
typedef struct {
    double min, max;
    int minex, maxex; /* are min or max exclusive? */
} zrangespec;

1535 1536
/* Struct to hold an inclusive/exclusive range spec by lexicographic comparison. */
typedef struct {
1537
    sds min, max;     /* May be set to shared.(minstring|maxstring) */
1538 1539 1540
    int minex, maxex; /* are min or max exclusive? */
} zlexrangespec;

1541 1542
zskiplist *zslCreate(void);
void zslFree(zskiplist *zsl);
1543 1544 1545
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);
1546 1547
zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec *range);
zskiplistNode *zslLastInRange(zskiplist *zsl, zrangespec *range);
1548 1549 1550
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 已提交
1551
unsigned char *zzlFirstInRange(unsigned char *zl, zrangespec *range);
A
antirez 已提交
1552
unsigned char *zzlLastInRange(unsigned char *zl, zrangespec *range);
1553
unsigned int zsetLength(const robj *zobj);
1554
void zsetConvert(robj *zobj, int encoding);
1555
void zsetConvertToZiplistIfNeeded(robj *zobj, size_t maxelelen);
1556 1557
int zsetScore(robj *zobj, sds member, double *score);
unsigned long zslGetRank(zskiplist *zsl, double score, sds o);
A
antirez 已提交
1558
int zsetAdd(robj *zobj, double score, sds ele, int *flags, double *newscore);
A
antirez 已提交
1559
long zsetRank(robj *zobj, sds ele, int reverse);
A
antirez 已提交
1560
int zsetDel(robj *zobj, sds ele);
A
antirez 已提交
1561
sds ziplistGetObject(unsigned char *sptr);
A
antirez 已提交
1562 1563
int zslValueGteMin(double value, zrangespec *spec);
int zslValueLteMax(double value, zrangespec *spec);
A
antirez 已提交
1564
void zslFreeLexRange(zlexrangespec *spec);
A
antirez 已提交
1565 1566 1567 1568 1569
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 已提交
1570 1571 1572 1573
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);
1574 1575

/* Core functions */
1576
int freeMemoryIfNeeded(void);
1577
int processCommand(client *c);
1578
void setupSignalHandlers(void);
1579 1580
struct redisCommand *lookupCommand(sds name);
struct redisCommand *lookupCommandByCString(char *s);
1581
struct redisCommand *lookupCommandOrOriginal(sds name);
1582
void call(client *c, int flags);
A
antirez 已提交
1583
void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1584
void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
1585 1586
void forceCommandPropagation(client *c, int flags);
void preventCommandPropagation(client *c);
1587 1588
void preventCommandAOF(client *c);
void preventCommandReplication(client *c);
1589
int prepareForShutdown();
1590
#ifdef __GNUC__
A
antirez 已提交
1591
void serverLog(int level, const char *fmt, ...)
1592 1593
    __attribute__((format(printf, 2, 3)));
#else
A
antirez 已提交
1594
void serverLog(int level, const char *fmt, ...);
1595
#endif
A
antirez 已提交
1596 1597
void serverLogRaw(int level, const char *msg);
void serverLogFromHandler(int level, const char *msg);
1598
void usage(void);
1599 1600
void updateDictResizePolicy(void);
int htNeedsResize(dict *dict);
1601
void populateCommandTable(void);
1602
void resetCommandTableStats(void);
A
antirez 已提交
1603
void adjustOpenFilesLimit(void);
1604
void closeListeningSockets(int unlink_unix_socket);
1605 1606
void updateCachedTime(void);
void resetServerStats(void);
O
oranagra 已提交
1607
void activeDefragCycle(void);
1608
unsigned int getLRUClock(void);
T
therealbill 已提交
1609
const char *evictPolicyToString(void);
1610 1611
struct redisMemOverhead *getMemoryOverheadData(void);
void freeMemoryOverheadData(struct redisMemOverhead *mh);
1612

A
antirez 已提交
1613 1614 1615 1616 1617
#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);

1618
/* Set data type */
1619 1620 1621 1622
robj *setTypeCreate(sds value);
int setTypeAdd(robj *subject, sds value);
int setTypeRemove(robj *subject, sds value);
int setTypeIsMember(robj *subject, sds value);
1623 1624
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
1625 1626 1627
int setTypeNext(setTypeIterator *si, sds *sdsele, int64_t *llele);
sds setTypeNextObject(setTypeIterator *si);
int setTypeRandomElement(robj *setobj, sds *sdsele, int64_t *llele);
1628
unsigned long setTypeRandomElements(robj *set, unsigned long count, robj *aux_set);
1629
unsigned long setTypeSize(const robj *subject);
1630 1631
void setTypeConvert(robj *subject, int enc);

1632
/* Hash data type */
A
antirez 已提交
1633 1634 1635 1636
#define HASH_SET_TAKE_FIELD (1<<0)
#define HASH_SET_TAKE_VALUE (1<<1)
#define HASH_SET_COPY 0

1637
void hashTypeConvert(robj *o, int enc);
1638 1639
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1640 1641
int hashTypeExists(robj *o, sds key);
int hashTypeDelete(robj *o, sds key);
1642
unsigned long hashTypeLength(const robj *o);
1643 1644 1645
hashTypeIterator *hashTypeInitIterator(robj *subject);
void hashTypeReleaseIterator(hashTypeIterator *hi);
int hashTypeNext(hashTypeIterator *hi);
1646 1647 1648 1649
void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what,
                                unsigned char **vstr,
                                unsigned int *vlen,
                                long long *vll);
1650 1651 1652
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);
1653
robj *hashTypeLookupWriteOrCreate(client *c, robj *key);
1654
robj *hashTypeGetValueObject(robj *o, sds field);
A
antirez 已提交
1655
int hashTypeSet(robj *o, sds field, sds value, int flags);
1656 1657

/* Pub / Sub */
1658 1659
int pubsubUnsubscribeAllChannels(client *c, int notify);
int pubsubUnsubscribeAllPatterns(client *c, int notify);
1660 1661
void freePubsubPattern(void *p);
int listMatchPubsubPattern(void *a, void *b);
1662
int pubsubPublishMessage(robj *channel, robj *message);
1663 1664 1665 1666 1667

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

/* Configuration */
1670
void loadServerConfig(char *filename, char *options);
1671
void appendServerSaveParams(time_t seconds, int changes);
1672
void resetServerSaveParams(void);
1673
struct rewriteConfigState; /* Forward declaration to export API. */
1674
void rewriteConfigRewriteLine(struct rewriteConfigState *state, const char *option, sds line, int force);
1675
int rewriteConfig(char *path);
1676 1677 1678

/* db.c -- Keyspace access API */
int removeExpire(redisDb *db, robj *key);
1679
void propagateExpire(redisDb *db, robj *key, int lazy);
1680
int expireIfNeeded(redisDb *db, robj *key);
1681
long long getExpire(redisDb *db, robj *key);
1682
void setExpire(client *c, redisDb *db, robj *key, long long when);
1683
robj *lookupKey(redisDb *db, robj *key, int flags);
1684 1685
robj *lookupKeyRead(redisDb *db, robj *key);
robj *lookupKeyWrite(redisDb *db, robj *key);
1686 1687
robj *lookupKeyReadOrReply(client *c, robj *key, robj *reply);
robj *lookupKeyWriteOrReply(client *c, robj *key, robj *reply);
1688
robj *lookupKeyReadWithFlags(redisDb *db, robj *key, int flags);
1689 1690
robj *objectCommandLookup(client *c, robj *key);
robj *objectCommandLookupOrReply(client *c, robj *key, robj *reply);
1691 1692
#define LOOKUP_NONE 0
#define LOOKUP_NOTOUCH (1<<0)
1693 1694 1695
void dbAdd(redisDb *db, robj *key, robj *val);
void dbOverwrite(redisDb *db, robj *key, robj *val);
void setKey(redisDb *db, robj *key, robj *val);
1696 1697
int dbExists(redisDb *db, robj *key);
robj *dbRandomKey(redisDb *db);
1698
int dbSyncDelete(redisDb *db, robj *key);
1699
int dbDelete(redisDb *db, robj *key);
1700
robj *dbUnshareStringValue(redisDb *db, robj *key, robj *o);
1701 1702 1703 1704 1705

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

1706
int selectDb(client *c, int id);
1707 1708
void signalModifiedKey(redisDb *db, robj *key);
void signalFlushedDb(int dbid);
1709 1710
unsigned int getKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
unsigned int countKeysInSlot(unsigned int hashslot);
1711
unsigned int delKeysInSlot(unsigned int hashslot);
1712
int verifyClusterConfigWithData(void);
1713 1714
void scanGenericCommand(client *c, robj *o, unsigned long cursor);
int parseScanCursorOrReply(client *c, robj *o, unsigned long *cursor);
1715 1716 1717 1718
void slotToKeyAdd(robj *key);
void slotToKeyDel(robj *key);
void slotToKeyFlush(void);
int dbAsyncDelete(redisDb *db, robj *key);
1719 1720
void emptyDbAsync(redisDb *db);
void slotToKeyFlushAsync(void);
1721
size_t lazyfreeGetPendingObjectsCount(void);
1722

1723
/* API to get key arguments from commands */
1724
int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1725
void getKeysFreeResult(int *result);
1726
int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys);
1727
int *evalGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1728
int *sortGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1729
int *migrateGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1730

A
antirez 已提交
1731 1732 1733 1734 1735
/* Cluster */
void clusterInit(void);
unsigned short crc16(const char *buf, int len);
unsigned int keyHashSlot(char *key, int keylen);
void clusterCron(void);
1736
void clusterPropagatePublish(robj *channel, robj *message);
A
antirez 已提交
1737
void migrateCloseTimedoutSockets(void);
1738
void clusterBeforeSleep(void);
A
antirez 已提交
1739

1740 1741 1742 1743 1744
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);
A
antirez 已提交
1745
void sentinelIsRunning(void);
1746

1747 1748
/* redis-check-rdb */
int redis_check_rdb(char *rdbfilename);
1749
int redis_check_rdb_main(int argc, char **argv);
1750

1751
/* Scripting */
1752
void scriptingInit(int setup);
1753 1754
int ldbRemoveChild(pid_t pid);
void ldbKillForkedSessions(void);
1755
int ldbPendingChildren(void);
1756

1757 1758
/* Blocked clients */
void processUnblockedClients(void);
1759 1760 1761 1762
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);
1763
void disconnectAllBlockedClients(void);
1764

1765 1766
/* expire.c -- Handling of expired keys */
void activeExpireCycle(int type);
1767 1768 1769
void expireSlaveKeys(void);
void rememberSlaveKeyWithExpire(redisDb *db, robj *key);
void flushSlaveKeysWithExpireList(void);
1770
size_t getSlaveKeyWithExpireCount(void);
1771

1772
/* evict.c -- maxmemory handling and LRU eviction. */
1773
void evictionPoolAlloc(void);
1774 1775 1776
#define LFU_INIT_VAL 5
unsigned long LFUGetTimeInMinutes(void);
uint8_t LFULogIncr(uint8_t value);
1777

1778
/* Keys hashing / comparison functions for dict.c hash tables. */
1779
uint64_t dictSdsHash(const void *key);
1780 1781 1782
int dictSdsKeyCompare(void *privdata, const void *key1, const void *key2);
void dictSdsDestructor(void *privdata, void *val);

1783 1784 1785
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);
1786
uint64_t redisBuildId(void);
1787 1788

/* Commands prototypes */
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798
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);
1799
void unlinkCommand(client *c);
1800 1801 1802
void existsCommand(client *c);
void setbitCommand(client *c);
void getbitCommand(client *c);
1803
void bitfieldCommand(client *c);
1804 1805 1806 1807 1808 1809 1810 1811
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 已提交
1812
void swapdbCommand(client *c);
1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866
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);
1867
void touchCommand(client *c);
1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935
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);
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);
1936
void memoryCommand(client *c);
1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960
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);
void georadiusByMemberCommand(client *c);
void georadiusCommand(client *c);
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 已提交
1961
void moduleCommand(client *c);
1962
void securityWarningCommand(client *c);
1963

1964 1965 1966 1967 1968 1969 1970
#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

1971
/* Debugging stuff */
1972 1973
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);
1974
void _serverPanic(const char *file, int line, const char *msg, ...);
A
antirez 已提交
1975
void bugReportStart(void);
1976
void serverLogObjectDebugInfo(const robj *o);
1977 1978
void sigsegvHandler(int sig, siginfo_t *info, void *secret);
sds genRedisInfoString(char *section);
A
antirez 已提交
1979 1980 1981
void enableWatchdog(int period);
void disableWatchdog(void);
void watchdogScheduleSignal(int period);
A
antirez 已提交
1982
void serverLogHexDump(int level, char *descr, void *value, size_t len);
A
antirez 已提交
1983
int memtest_preserving_test(unsigned long *m, size_t bytes, int passes);
1984 1985 1986 1987 1988 1989

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

1990
#endif