server.h 68.6 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 36 37 38 39 40 41 42 43
#ifndef __REDIS_H
#define __REDIS_H

#include "fmacros.h"
#include "config.h"
#include "solarisfixes.h"

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

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

53 54 55 56
#include "ae.h"      /* Event driven programming library */
#include "sds.h"     /* Dynamic safe strings */
#include "dict.h"    /* Hash tables */
#include "adlist.h"  /* Linked lists */
57
#include "zmalloc.h" /* total memory usage aware version of malloc/free */
58
#include "anet.h"    /* Networking the easy way */
59
#include "ziplist.h" /* Compact list data structure */
60 61 62
#include "intset.h"  /* Compact integer set structure */
#include "version.h" /* Version macro */
#include "util.h"    /* Misc functions useful in many places */
63
#include "latency.h" /* Latency monitor API */
A
antirez 已提交
64
#include "sparkline.h" /* ASII graphs API */
M
Matt Stancliff 已提交
65
#include "quicklist.h"
66

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

73 74 75 76 77
/* Error codes */
#define REDIS_OK                0
#define REDIS_ERR               -1

/* Static server configuration */
78
#define CONFIG_DEFAULT_HZ        10      /* Time interrupt calls/sec. */
79
#define REDIS_MIN_HZ            1
80
#define REDIS_MAX_HZ            500
81
#define REDIS_SERVERPORT        6379    /* TCP port */
82
#define REDIS_TCP_BACKLOG       511     /* TCP listen backlog */
83
#define REDIS_MAXIDLETIME       0       /* default client timeout: infinite */
84
#define CONFIG_DEFAULT_DBNUM     16
85
#define REDIS_CONFIGLINE_MAX    1024
86
#define REDIS_DBCRON_DBS_PER_CALL 16
87
#define REDIS_MAX_WRITE_PER_EVENT (1024*64)
88
#define REDIS_SHARED_SELECT_CMDS 10
89
#define REDIS_SHARED_INTEGERS 10000
90
#define REDIS_SHARED_BULKHDR_LEN 32
J
Jonah H. Harris 已提交
91
#define REDIS_MAX_LOGMSG_LEN    1024 /* Default maximum length of syslog messages */
92
#define REDIS_AOF_REWRITE_PERC  100
93
#define REDIS_AOF_REWRITE_MIN_SIZE (64*1024*1024)
94
#define REDIS_AOF_REWRITE_ITEMS_PER_CMD 64
95
#define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000
96
#define REDIS_SLOWLOG_MAX_LEN 128
97
#define CONFIG_DEFAULT_MAX_CLIENTS 10000
98
#define REDIS_AUTHPASS_MAX_LEN 512
99
#define CONFIG_DEFAULT_SLAVE_PRIORITY 100
A
7c6da73  
antirez 已提交
100 101
#define REDIS_REPL_TIMEOUT 60
#define REDIS_REPL_PING_SLAVE_PERIOD 10
102
#define REDIS_RUN_ID_SIZE 40
103
#define REDIS_EOF_MARK_SIZE 40
104 105
#define CONFIG_DEFAULT_REPL_BACKLOG_SIZE (1024*1024)    /* 1mb */
#define CONFIG_DEFAULT_REPL_BACKLOG_TIME_LIMIT (60*60)  /* 1 hour */
106
#define REDIS_REPL_BACKLOG_MIN_SIZE (1024*16)          /* 16k */
107
#define REDIS_BGSAVE_RETRY_DELAY 5 /* Wait a few secs before trying again. */
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
#define CONFIG_DEFAULT_PID_FILE "/var/run/redis.pid"
#define CONFIG_DEFAULT_SYSLOG_IDENT "redis"
#define CONFIG_DEFAULT_CLUSTER_CONFIG_FILE "nodes.conf"
#define CONFIG_DEFAULT_DAEMONIZE 0
#define CONFIG_DEFAULT_UNIX_SOCKET_PERM 0
#define CONFIG_DEFAULT_TCP_KEEPALIVE 0
#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
#define CONFIG_DEFAULT_REPL_DISABLE_TCP_NODELAY 0
#define CONFIG_DEFAULT_MAXMEMORY 0
#define CONFIG_DEFAULT_MAXMEMORY_SAMPLES 5
#define CONFIG_DEFAULT_AOF_FILENAME "appendonly.aof"
#define CONFIG_DEFAULT_AOF_NO_FSYNC_ON_REWRITE 0
#define CONFIG_DEFAULT_AOF_LOAD_TRUNCATED 1
#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
134
#define REDIS_IP_STR_LEN 46 /* INET6_ADDRSTRLEN is 46, but we need to be sure */
A
antirez 已提交
135
#define REDIS_PEER_ID_LEN (REDIS_IP_STR_LEN+32) /* Must be enough for ip:port */
A
antirez 已提交
136
#define REDIS_BINDADDR_MAX 16
137
#define REDIS_MIN_RESERVED_FDS 32
138
#define CONFIG_DEFAULT_LATENCY_MONITOR_THRESHOLD 0
139

A
antirez 已提交
140 141 142 143 144 145
#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

146 147 148 149 150 151 152
/* Instantaneous metrics tracking. */
#define REDIS_METRIC_SAMPLES 16     /* Number of samples per metric. */
#define REDIS_METRIC_COMMAND 0      /* Number of commands executed. */
#define REDIS_METRIC_NET_INPUT 1    /* Bytes read to network .*/
#define REDIS_METRIC_NET_OUTPUT 2   /* Bytes written to network. */
#define REDIS_METRIC_COUNT 3

153 154 155 156
/* Protocol and I/O related defines */
#define REDIS_MAX_QUERYBUF_LEN  (1024*1024*1024) /* 1GB max query buffer. */
#define REDIS_IOBUF_LEN         (1024*16)  /* Generic I/O buffer size */
#define REDIS_REPLY_CHUNK_BYTES (16*1024) /* 16k output buffer */
157
#define REDIS_INLINE_MAX_SIZE   (1024*64) /* Max size of inline reads */
158
#define REDIS_MBULK_BIG_ARG     (1024*32)
159
#define REDIS_LONGSTR_SIZE      21          /* Bytes needed for long -> str */
160
#define REDIS_AOF_AUTOSYNC_BYTES (1024*1024*32) /* fdatasync every 32MB */
A
antirez 已提交
161
/* When configuring the Redis eventloop, we setup it so that the total number
162
 * of file descriptors we can handle are server.maxclients + RESERVED_FDS + FDSET_INCR
A
antirez 已提交
163
 * that is our safety margin. */
164
#define REDIS_EVENTLOOP_FDSET_INCR (REDIS_MIN_RESERVED_FDS+96)
A
7c6da73  
antirez 已提交
165

166 167 168
/* Hash table parameters */
#define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */

169 170 171 172 173
/* Command flags. Please check the command table defined in the redis.c file
 * for more information about the meaning of every flag. */
#define REDIS_CMD_WRITE 1                   /* "w" flag */
#define REDIS_CMD_READONLY 2                /* "r" flag */
#define REDIS_CMD_DENYOOM 4                 /* "m" flag */
A
antirez 已提交
174
#define REDIS_CMD_NOT_USED_1 8              /* no longer used flag */
175 176
#define REDIS_CMD_ADMIN 16                  /* "a" flag */
#define REDIS_CMD_PUBSUB 32                 /* "p" flag */
177 178
#define REDIS_CMD_NOSCRIPT  64              /* "s" flag */
#define REDIS_CMD_RANDOM 128                /* "R" flag */
179
#define REDIS_CMD_SORT_FOR_SCRIPT 256       /* "S" flag */
180 181
#define REDIS_CMD_LOADING 512               /* "l" flag */
#define REDIS_CMD_STALE 1024                /* "t" flag */
182
#define REDIS_CMD_SKIP_MONITOR 2048         /* "M" flag */
183
#define REDIS_CMD_ASKING 4096               /* "k" flag */
184
#define REDIS_CMD_FAST 8192                 /* "F" flag */
185 186 187 188 189 190 191

/* Object types */
#define REDIS_STRING 0
#define REDIS_LIST 1
#define REDIS_SET 2
#define REDIS_ZSET 3
#define REDIS_HASH 4
192

193 194 195 196 197 198 199 200 201
/* 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 REDIS_ENCODING_RAW 0     /* Raw representation */
#define REDIS_ENCODING_INT 1     /* Encoded as integer */
#define REDIS_ENCODING_HT 2      /* Encoded as hash table */
#define REDIS_ENCODING_ZIPMAP 3  /* Encoded as zipmap */
#define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
#define REDIS_ENCODING_ZIPLIST 5 /* Encoded as ziplist */
202
#define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
203
#define REDIS_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
204
#define REDIS_ENCODING_EMBSTR 8  /* Embedded sds string encoding */
M
Matt Stancliff 已提交
205
#define REDIS_ENCODING_QUICKLIST 9 /* Encoded as linked list of ziplists */
206 207 208 209 210 211 212

/* Defines related to the dump file format. To store 32 bits lengths for short
 * keys requires a lot of space, so we check the most significant 2 bits of
 * the first byte to interpreter the length:
 *
 * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
 * 01|000000 00000000 =>  01, the len is 14 byes, 6 bits + 8 bits of next byte
G
guiquanz 已提交
213
 * 10|000000 [32 bit integer] => if it's 10, a full 32 bit len will follow
214 215 216 217
 * 11|000000 this means: specially encoded object will follow. The six bits
 *           number specify the kind of object that follows.
 *           See the REDIS_RDB_ENC_* defines.
 *
G
guiquanz 已提交
218
 * Lengths up to 63 are stored using a single byte, most DB keys, and may
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
 * values, will fit inside. */
#define REDIS_RDB_6BITLEN 0
#define REDIS_RDB_14BITLEN 1
#define REDIS_RDB_32BITLEN 2
#define REDIS_RDB_ENCVAL 3
#define REDIS_RDB_LENERR UINT_MAX

/* When a length of a string object stored on disk has the first two bits
 * set, the remaining two bits specify a special encoding for the object
 * accordingly to the following defines: */
#define REDIS_RDB_ENC_INT8 0        /* 8 bit signed integer */
#define REDIS_RDB_ENC_INT16 1       /* 16 bit signed integer */
#define REDIS_RDB_ENC_INT32 2       /* 32 bit signed integer */
#define REDIS_RDB_ENC_LZF 3         /* string compressed with FASTLZ */

234 235 236 237 238
/* AOF states */
#define REDIS_AOF_OFF 0             /* AOF is off */
#define REDIS_AOF_ON 1              /* AOF is on */
#define REDIS_AOF_WAIT_REWRITE 2    /* AOF waits rewrite to start appending */

239
/* Client flags */
A
antirez 已提交
240 241 242 243 244 245 246 247 248 249 250 251 252 253
#define REDIS_SLAVE (1<<0)   /* This client is a slave server */
#define REDIS_MASTER (1<<1)  /* This client is a master server */
#define REDIS_MONITOR (1<<2) /* This client is a slave monitor, see MONITOR */
#define REDIS_MULTI (1<<3)   /* This client is in a MULTI context */
#define REDIS_BLOCKED (1<<4) /* The client is waiting in a blocking operation */
#define REDIS_DIRTY_CAS (1<<5) /* Watched keys modified. EXEC will fail. */
#define REDIS_CLOSE_AFTER_REPLY (1<<6) /* Close after writing entire reply. */
#define REDIS_UNBLOCKED (1<<7) /* This client was unblocked and is stored in
                                  server.unblocked_clients */
#define REDIS_LUA_CLIENT (1<<8) /* This is a non connected client used by Lua */
#define REDIS_ASKING (1<<9)     /* Client issued the ASKING command */
#define REDIS_CLOSE_ASAP (1<<10)/* Close this client ASAP */
#define REDIS_UNIX_SOCKET (1<<11) /* Client connected via Unix domain socket */
#define REDIS_DIRTY_EXEC (1<<12)  /* EXEC will fail for errors while queueing */
254
#define REDIS_MASTER_FORCE_REPLY (1<<13)  /* Queue replies even if is master */
A
antirez 已提交
255 256
#define REDIS_FORCE_AOF (1<<14)   /* Force AOF propagation of current cmd. */
#define REDIS_FORCE_REPL (1<<15)  /* Force replication of current cmd. */
257
#define REDIS_PRE_PSYNC (1<<16)   /* Instance don't understand PSYNC. */
258
#define REDIS_READONLY (1<<17)    /* Cluster client is in read-only state. */
259
#define REDIS_PUBSUB (1<<18)      /* Client is in Pub/Sub mode. */
260
#define REDIS_PREVENT_PROP (1<<19)  /* Don't propagate to AOF / Slaves. */
261

262 263 264 265 266 267
/* Client block type (btype field in client structure)
 * if REDIS_BLOCKED flag is set. */
#define REDIS_BLOCKED_NONE 0    /* Not blocked, no REDIS_BLOCKED flag set. */
#define REDIS_BLOCKED_LIST 1    /* BLPOP & co. */
#define REDIS_BLOCKED_WAIT 2    /* WAIT for synchronous replication. */

268 269 270
/* Client request types */
#define REDIS_REQ_INLINE 1
#define REDIS_REQ_MULTIBULK 2
271

272 273
/* Client classes for client limits, currently used only for
 * the max-client-output-buffer limit implementation. */
A
antirez 已提交
274 275 276 277
#define REDIS_CLIENT_TYPE_NORMAL 0 /* Normal req-reply clients + MONITORs */
#define REDIS_CLIENT_TYPE_SLAVE 1  /* Slaves. */
#define REDIS_CLIENT_TYPE_PUBSUB 2 /* Clients subscribed to PubSub channels. */
#define REDIS_CLIENT_TYPE_COUNT 3
278

279
/* Slave replication state - from the point of view of the slave. */
280 281
#define REDIS_REPL_NONE 0 /* No active replication */
#define REDIS_REPL_CONNECT 1 /* Must connect to master */
282
#define REDIS_REPL_CONNECTING 2 /* Connecting to master */
283 284 285
#define REDIS_REPL_RECEIVE_PONG 3 /* Wait for PING reply */
#define REDIS_REPL_TRANSFER 4 /* Receiving .rdb from master */
#define REDIS_REPL_CONNECTED 5 /* Connected to master */
286

287 288
/* Slave replication state - from the point of view of the master.
 * In SEND_BULK and ONLINE state the slave receives new updates
289 290
 * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
 * to start the next background saving in order to send updates to it. */
291 292 293 294 295 296 297
#define REDIS_REPL_WAIT_BGSAVE_START 6 /* We need to produce a new RDB file. */
#define REDIS_REPL_WAIT_BGSAVE_END 7 /* Waiting RDB file creation to finish. */
#define REDIS_REPL_SEND_BULK 8 /* Sending RDB file to slave. */
#define REDIS_REPL_ONLINE 9 /* RDB file transmitted, sending just updates. */

/* Synchronous read timeout - slave side */
#define REDIS_REPL_SYNCIO_TIMEOUT 5
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313

/* List related stuff */
#define REDIS_HEAD 0
#define REDIS_TAIL 1

/* Sort operations */
#define REDIS_SORT_GET 0
#define REDIS_SORT_ASC 1
#define REDIS_SORT_DESC 2
#define REDIS_SORTKEY_MAX 1024

/* Log levels */
#define REDIS_DEBUG 0
#define REDIS_VERBOSE 1
#define REDIS_NOTICE 2
#define REDIS_WARNING 3
A
antirez 已提交
314
#define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
315
#define CONFIG_DEFAULT_VERBOSITY REDIS_NOTICE
316

317 318 319 320 321 322
/* Supervision options */
#define REDIS_SUPERVISED_NONE 0
#define REDIS_SUPERVISED_AUTODETECT 1
#define REDIS_SUPERVISED_SYSTEMD 2
#define REDIS_SUPERVISED_UPSTART 3

323 324 325 326 327 328 329
/* Anti-warning macro... */
#define REDIS_NOTUSED(V) ((void) V)

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

/* Append only defines */
330 331 332
#define AOF_FSYNC_NO 0
#define AOF_FSYNC_ALWAYS 1
#define AOF_FSYNC_EVERYSEC 2
333
#define CONFIG_DEFAULT_AOF_FSYNC AOF_FSYNC_EVERYSEC
334 335

/* Zip structure related defaults */
336 337
#define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
#define REDIS_HASH_MAX_ZIPLIST_VALUE 64
338
#define REDIS_SET_MAX_INTSET_ENTRIES 512
339 340
#define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
#define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
341

342 343 344 345
/* List defaults */
#define REDIS_LIST_MAX_ZIPLIST_SIZE -2
#define REDIS_LIST_COMPRESS_DEPTH 0

346
/* HyperLogLog defines */
347
#define CONFIG_DEFAULT_HLL_SPARSE_MAX_BYTES 3000
348

349 350 351 352 353
/* Sets operations codes */
#define REDIS_OP_UNION 0
#define REDIS_OP_DIFF 1
#define REDIS_OP_INTER 2

354 355 356 357 358 359
/* Redis maxmemory strategies */
#define REDIS_MAXMEMORY_VOLATILE_LRU 0
#define REDIS_MAXMEMORY_VOLATILE_TTL 1
#define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
#define REDIS_MAXMEMORY_ALLKEYS_LRU 3
#define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
360
#define REDIS_MAXMEMORY_NO_EVICTION 5
361
#define CONFIG_DEFAULT_MAXMEMORY_POLICY REDIS_MAXMEMORY_NO_EVICTION
362

A
antirez 已提交
363
/* Scripting */
364
#define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
365

366 367 368 369
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

370 371 372 373 374
/* SHUTDOWN flags */
#define REDIS_SHUTDOWN_SAVE 1       /* Force SAVE on SHUTDOWN even if no save
                                       points are configured. */
#define REDIS_SHUTDOWN_NOSAVE 2     /* Don't SAVE on SHUTDOWN. */

375 376 377 378 379 380 381
/* Command call flags, see call() function */
#define REDIS_CALL_NONE 0
#define REDIS_CALL_SLOWLOG 1
#define REDIS_CALL_STATS 2
#define REDIS_CALL_PROPAGATE 4
#define REDIS_CALL_FULL (REDIS_CALL_SLOWLOG | REDIS_CALL_STATS | REDIS_CALL_PROPAGATE)

A
antirez 已提交
382 383 384 385 386
/* Command propagation flags, see propagate() function */
#define REDIS_PROPAGATE_NONE 0
#define REDIS_PROPAGATE_AOF 1
#define REDIS_PROPAGATE_REPL 2

A
antirez 已提交
387 388 389 390 391
/* RDB active child save type. */
#define REDIS_RDB_CHILD_TYPE_NONE 0
#define REDIS_RDB_CHILD_TYPE_DISK 1     /* RDB is written to disk. */
#define REDIS_RDB_CHILD_TYPE_SOCKET 2   /* RDB is written to slave socket. */

392 393 394 395 396 397 398 399 400 401 402 403 404 405
/* Keyspace changes notification classes. Every class is associated with a
 * character for configuration purposes. */
#define REDIS_NOTIFY_KEYSPACE (1<<0)    /* K */
#define REDIS_NOTIFY_KEYEVENT (1<<1)    /* E */
#define REDIS_NOTIFY_GENERIC (1<<2)     /* g */
#define REDIS_NOTIFY_STRING (1<<3)      /* $ */
#define REDIS_NOTIFY_LIST (1<<4)        /* l */
#define REDIS_NOTIFY_SET (1<<5)         /* s */
#define REDIS_NOTIFY_HASH (1<<6)        /* h */
#define REDIS_NOTIFY_ZSET (1<<7)        /* z */
#define REDIS_NOTIFY_EXPIRED (1<<8)     /* x */
#define REDIS_NOTIFY_EVICTED (1<<9)     /* e */
#define REDIS_NOTIFY_ALL (REDIS_NOTIFY_GENERIC | REDIS_NOTIFY_STRING | REDIS_NOTIFY_LIST | REDIS_NOTIFY_SET | REDIS_NOTIFY_HASH | REDIS_NOTIFY_ZSET | REDIS_NOTIFY_EXPIRED | REDIS_NOTIFY_EVICTED)      /* A */

406 407 408
/* Get the first bind addr or NULL */
#define REDIS_BIND_ADDR (server.bindaddr_count ? server.bindaddr[0] : NULL)

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

414
/* We can print the stacktrace, so our assert is defined this way: */
415
#define redisAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_redisAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
416 417 418 419 420 421 422 423 424 425
#define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
#define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)

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

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

/* The actual Redis Object */
426
#define REDIS_LRU_BITS 24
427
#define REDIS_LRU_CLOCK_MAX ((1<<REDIS_LRU_BITS)-1) /* Max value of obj->lru */
428
#define REDIS_LRU_CLOCK_RESOLUTION 1000 /* LRU clock resolution in ms */
429 430 431
typedef struct redisObject {
    unsigned type:4;
    unsigned encoding:4;
432
    unsigned lru:REDIS_LRU_BITS; /* lru time (relative to server.lruclock) */
433 434 435 436
    int refcount;
    void *ptr;
} robj;

437 438 439 440 441 442
/* 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
 * precomputed value, otherwise we need to resort to a function call. */
#define LRU_CLOCK() ((1000/server.hz <= REDIS_LRU_CLOCK_RESOLUTION) ? server.lruclock : getLRUClock())

G
guiquanz 已提交
443
/* Macro used to initialize a Redis object allocated on the stack.
444 445 446 447 448 449 450 451 452 453
 * 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; \
    _var.type = REDIS_STRING; \
    _var.encoding = REDIS_ENCODING_RAW; \
    _var.ptr = _ptr; \
} while(0);

A
antirez 已提交
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
/* To improve the quality of the LRU approximation we take a set of keys
 * that are good candidate for eviction across freeMemoryIfNeeded() calls.
 *
 * Entries inside the eviciton pool are taken ordered by idle time, putting
 * greater idle times to the right (ascending order).
 *
 * Empty entries have the key pointer set to NULL. */
#define REDIS_EVICTION_POOL_SIZE 16
struct evictionPoolEntry {
    unsigned long long idle;    /* Object idle time. */
    sds key;                    /* Key name. */
};

/* 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. */
470 471 472 473
typedef struct redisDb {
    dict *dict;                 /* The keyspace for this DB */
    dict *expires;              /* Timeout of keys with a timeout set */
    dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP) */
474
    dict *ready_keys;           /* Blocked keys that received a PUSH */
475
    dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
A
antirez 已提交
476 477
    struct evictionPoolEntry *eviction_pool;    /* Eviction pool of keys */
    int id;                     /* Database ID */
478
    long long avg_ttl;          /* Average TTL, just for stats */
479 480 481 482 483 484 485 486 487 488 489 490
} 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 */
491 492
    int minreplicas;        /* MINREPLICAS for synchronous replication */
    time_t minreplicas_timeout; /* MINREPLICAS timeout as unixtime. */
493 494
} multiState;

495 496
/* This structure holds the blocking operation state for a client.
 * The fields used depend on client->btype. */
497
typedef struct blockingState {
498 499 500 501 502
    /* Generic fields. */
    mstime_t timeout;       /* Blocking operation timeout. If UNIX current time
                             * is > timeout then the operation timed out. */

    /* REDIS_BLOCK_LIST */
503
    dict *keys;             /* The keys we are waiting to terminate a blocking
504 505 506
                             * operation such as BLPOP. Otherwise NULL. */
    robj *target;           /* The key that should receive the element,
                             * for BRPOPLPUSH. */
507 508 509 510

    /* REDIS_BLOCK_WAIT */
    int numreplicas;        /* Number of replicas we are waiting for ACK. */
    long long reploffset;   /* Replication offset to reach. */
511 512
} blockingState;

513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
/* 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 已提交
529
/* With multiplexing we need to take per-client state.
X
xuxiang 已提交
530
 * Clients are taken in a linked list. */
531
typedef struct client {
532
    uint64_t id;            /* Client incremental unique ID. */
533 534 535
    int fd;
    redisDb *db;
    int dictid;
536
    robj *name;             /* As set by CLIENT SETNAME */
537
    sds querybuf;
538
    size_t querybuf_peak;   /* Recent (100ms or more) peak of querybuf size */
539 540
    int argc;
    robj **argv;
541
    struct redisCommand *cmd, *lastcmd;
542 543 544
    int reqtype;
    int multibulklen;       /* number of multi bulk arguments left to read */
    long bulklen;           /* length of bulk argument in multi bulk request */
545
    list *reply;
546
    unsigned long long reply_bytes; /* Tot bytes of objects in reply list */
547
    size_t sentlen;         /* Amount of bytes already sent in the current
548
                               buffer or object being sent. */
549
    time_t ctime;           /* Client creation time */
550
    time_t lastinteraction; /* time of the last interaction, used for timeout */
551
    time_t obuf_soft_limit_reached_time;
552 553 554
    int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
    int authenticated;      /* when requirepass is non-NULL */
    int replstate;          /* replication state if this is a slave */
A
antirez 已提交
555
    int repl_put_online_on_ack; /* Install slave write handler on ACK. */
556
    int repldbfd;           /* replication DB file descriptor */
557 558
    off_t repldboff;       /* replication DB file offset */
    off_t repldbsize;      /* replication DB file size */
559
    sds replpreamble;       /* replication DB preamble. */
560
    long long reploff;      /* replication offset if this is our master */
A
antirez 已提交
561 562
    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 */
563
    char replrunid[REDIS_RUN_ID_SIZE+1]; /* master run id if this is a master */
A
antirez 已提交
564
    int slave_listening_port; /* As configured with: SLAVECONF listening-port */
565
    multiState mstate;      /* MULTI/EXEC state */
566
    int btype;              /* Type of blocking op if REDIS_BLOCKED. */
567 568
    blockingState bpop;     /* blocking state */
    long long woff;         /* Last write global replication offset. */
569 570 571
    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) */
572
    sds peerid;             /* Cached peer ID. */
573 574

    /* Response buffer */
575
    int bufpos;
576
    char buf[REDIS_REPLY_CHUNK_BYTES];
577
} client;
578 579 580 581 582 583 584 585 586 587

struct saveparam {
    time_t seconds;
    int changes;
};

struct sharedObjectsStruct {
    robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
    *colon, *nullbulk, *nullmultibulk, *queued,
    *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
588
    *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
589
    *masterdownerr, *roslaveerr, *execaborterr, *noautherr, *noreplicaserr,
590
    *busykeyerr, *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
591
    *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
592
    *lpush, *emptyscan, *minstring, *maxstring,
593
    *select[REDIS_SHARED_SELECT_CMDS],
594 595 596
    *integers[REDIS_SHARED_INTEGERS],
    *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
    *bulkhdr[REDIS_SHARED_BULKHDR_LEN];  /* "$<value>\r\n" */
597 598
};

599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
/* ZSETs use a specialized version of Skiplists */
typedef struct zskiplistNode {
    robj *obj;
    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;

621
typedef struct clientBufferLimitsConfig {
622 623
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
624 625 626
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

A
antirez 已提交
627
extern clientBufferLimitsConfig clientBufferLimitsDefaults[REDIS_CLIENT_TYPE_COUNT];
628

629 630 631 632 633 634 635
/* The redisOp structure defines a Redis Operation, that is an instance of
 * a command with an argument vector, database ID, propagation target
 * (REDIS_PROPAGATE_*), and command pointer.
 *
 * Currently only used to additionally propagate more commands to AOF/Replication
 * after the propagation of the executed command. */
typedef struct redisOp {
636 637 638
    robj **argv;
    int argc, dbid, target;
    struct redisCommand *cmd;
639 640 641 642 643 644 645 646 647 648 649 650 651
} 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;
652

A
antirez 已提交
653 654 655 656
/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

657 658
struct clusterState;

A
antirez 已提交
659 660
/* 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 已提交
661 662 663 664
#ifdef _AIX
#undef hz
#endif

665
struct redisServer {
666
    /* General */
A
antirez 已提交
667
    pid_t pid;                  /* Main process pid. */
668
    char *configfile;           /* Absolute config file path, or NULL */
669
    int hz;                     /* serverCron() calls frequency in hertz */
670
    redisDb *db;
671 672
    dict *commands;             /* Command table */
    dict *orig_commands;        /* Command table before command renaming. */
673
    aeEventLoop *el;
674
    unsigned lruclock:REDIS_LRU_BITS; /* Clock for LRU eviction */
675 676 677 678
    int shutdown_asap;          /* SHUTDOWN needed ASAP */
    int activerehashing;        /* Incremental rehash in serverCron() */
    char *requirepass;          /* Pass for AUTH command, or NULL */
    char *pidfile;              /* PID file path */
679
    int arch_bits;              /* 32 or 64 depending on sizeof(long) */
680
    int cronloops;              /* Number of times the cron function run */
A
antirez 已提交
681
    char runid[REDIS_RUN_ID_SIZE+1];  /* ID always different at every exec. */
682
    int sentinel_mode;          /* True if this instance is a Sentinel. */
683
    /* Networking */
684
    int port;                   /* TCP listening port */
685
    int tcp_backlog;            /* TCP listen() backlog */
A
antirez 已提交
686 687
    char *bindaddr[REDIS_BINDADDR_MAX]; /* Addresses we should bind to */
    int bindaddr_count;         /* Number of addresses in server.bindaddr[] */
688 689
    char *unixsocket;           /* UNIX socket path */
    mode_t unixsocketperm;      /* UNIX socket permission */
690 691
    int ipfd[REDIS_BINDADDR_MAX]; /* TCP socket file descriptors */
    int ipfd_count;             /* Used slots in ipfd[] */
692
    int sofd;                   /* Unix socket file descriptor */
693 694
    int cfd[REDIS_BINDADDR_MAX];/* Cluster bus listening socket */
    int cfd_count;              /* Used slots in cfd[] */
695
    list *clients;              /* List of active clients */
696
    list *clients_to_close;     /* Clients to close asynchronously */
697
    list *slaves, *monitors;    /* List of slaves and MONITORs */
698
    client *current_client; /* Current client, only used on crash report */
699 700
    int clients_paused;         /* True if clients are currently paused */
    mstime_t clients_pause_end_time; /* Time when we undo clients_paused */
A
antirez 已提交
701 702
    char neterr[ANET_ERR_LEN];   /* Error buffer for anet.c */
    dict *migrate_cached_sockets;/* MIGRATE cached sockets */
703
    uint64_t next_client_id;    /* Next client unique ID. Incremental. */
704
    /* RDB / AOF loading information */
705
    int loading;                /* We are loading data from disk if true */
706 707 708
    off_t loading_total_bytes;
    off_t loading_loaded_bytes;
    time_t loading_start_time;
709
    off_t loading_process_events_interval_bytes;
710
    /* Fast pointers to often looked up command */
711
    struct redisCommand *delCommand, *multiCommand, *lpushCommand, *lpopCommand,
712
                        *rpopCommand, *sremCommand;
713
    /* Fields used only for stats */
714 715 716 717 718 719 720 721
    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 */
    size_t stat_peak_memory;        /* Max used memory record */
G
guiquanz 已提交
722
    long long stat_fork_time;       /* Time needed to perform latest fork() */
723
    double stat_fork_rate;          /* Fork rate in GB/sec. */
724
    long long stat_rejected_conn;   /* Clients rejected because of maxclients */
725 726 727
    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. */
728 729 730 731
    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 已提交
732
    size_t resident_set_size;       /* RSS sampled in serverCron(). */
733 734 735 736 737 738 739 740 741 742
    long long stat_net_input_bytes; /* Bytes read from network. */
    long long stat_net_output_bytes; /* Bytes written to network. */
    /* 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 */
        long long samples[REDIS_METRIC_SAMPLES];
        int idx;
    } inst_metric[REDIS_METRIC_COUNT];
743
    /* Configuration */
744 745
    int verbosity;                  /* Loglevel in redis.conf */
    int maxidletime;                /* Client timeout in seconds */
746
    int tcpkeepalive;               /* Set SO_KEEPALIVE if non-zero. */
A
antirez 已提交
747
    int active_expire_enabled;      /* Can be disabled for testing purposes. */
748 749
    size_t client_max_querybuf_len; /* Limit for client query buffer length */
    int dbnum;                      /* Total number of configured DBs */
750 751
    int supervised;                 /* 1 if supervised, 0 otherwise. */
    int supervised_mode;            /* See REDIS_SUPERVISED_* */
752
    int daemonize;                  /* True if running as a daemon */
A
antirez 已提交
753
    clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_TYPE_COUNT];
754 755
    /* AOF persistence */
    int aof_state;                  /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
756 757 758 759 760 761 762 763
    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 已提交
764
    pid_t aof_child_pid;            /* PID if rewriting process */
765
    list *aof_rewrite_buf_blocks;   /* Hold changes during an AOF rewrite. */
A
antirez 已提交
766 767 768
    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 */
769
    time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
A
antirez 已提交
770
    time_t aof_last_fsync;            /* UNIX time of last fsync() */
771 772
    time_t aof_rewrite_time_last;   /* Time used by last AOF rewrite run. */
    time_t aof_rewrite_time_start;  /* Current AOF rewrite start time. */
773
    int aof_lastbgrewrite_status;   /* REDIS_OK or REDIS_ERR */
774
    unsigned long aof_delayed_fsync;  /* delayed AOF fsync() counter */
775
    int aof_rewrite_incremental_fsync;/* fsync incrementally while rewriting? */
776 777
    int aof_last_write_status;      /* REDIS_OK or REDIS_ERR */
    int aof_last_write_errno;       /* Valid if aof_last_write_status is ERR */
A
antirez 已提交
778
    int aof_load_truncated;         /* Don't stop on unexpected AOF EOF. */
779 780 781 782 783 784 785 786 787 788
    /* 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. */
789 790 791
    /* 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 已提交
792
    pid_t rdb_child_pid;            /* PID of RDB saving child */
793 794
    struct saveparam *saveparams;   /* Save points array for RDB */
    int saveparamslen;              /* Number of saving points */
A
antirez 已提交
795 796
    char *rdb_filename;             /* Name of RDB file */
    int rdb_compression;            /* Use compression in RDB? */
797
    int rdb_checksum;               /* Use RDB checksum? */
G
guiquanz 已提交
798
    time_t lastsave;                /* Unix time of last successful save */
799
    time_t lastbgsave_try;          /* Unix time of last attempted bgsave */
800 801
    time_t rdb_save_time_last;      /* Time used by last RDB save run. */
    time_t rdb_save_time_start;     /* Current RDB save start time. */
A
antirez 已提交
802
    int rdb_child_type;             /* Type of save by active child. */
803
    int lastbgsave_status;          /* REDIS_OK or REDIS_ERR */
804
    int stop_writes_on_bgsave_err;  /* Don't allow writes if can't BGSAVE */
805 806
    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. */
807
    /* Propagation of commands in AOF / replication */
808
    redisOpArray also_propagate;    /* Additional command to propagate. */
809
    /* Logging */
810 811 812 813
    char *logfile;                  /* Path of log file */
    int syslog_enabled;             /* Is syslog enabled? */
    char *syslog_ident;             /* Syslog ident */
    int syslog_facility;            /* Syslog facility */
814 815 816 817 818 819 820 821 822 823 824 825 826 827
    /* Replication (master) */
    int slaveseldb;                 /* Last SELECTed DB in replication output */
    long long master_repl_offset;   /* Global replication offset */
    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 */
    long long repl_backlog_idx;     /* Backlog circular buffer current offset */
    long long repl_backlog_off;     /* Replication offset of first byte in the
                                       backlog buffer. */
    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. */
828 829 830
    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. */
831
    int repl_diskless_sync;         /* Send RDB to slaves sockets directly. */
A
antirez 已提交
832
    int repl_diskless_sync_delay;   /* Delay to start a diskless repl BGSAVE. */
833
    /* Replication (slave) */
834 835 836 837
    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 */
838 839
    client *master;     /* Client that is master for this slave */
    client *cached_master; /* Cached master to be reused for PSYNC. */
840
    int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
A
antirez 已提交
841
    int repl_state;          /* Replication status if the instance is a slave */
842 843 844
    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. */
845 846 847 848
    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 */
849
    int repl_serve_stale_data; /* Serve stale data when link is down? */
850
    int repl_slave_ro;          /* Slave is read only? */
851
    time_t repl_down_since; /* Unix time at which link with master went down */
852
    int repl_disable_tcp_nodelay;   /* Disable TCP_NODELAY after SYNC? */
853
    int slave_priority;             /* Reported in INFO and used by Sentinel. */
854 855
    char repl_master_runid[REDIS_RUN_ID_SIZE+1];  /* Master run id for PSYNC. */
    long long repl_master_initial_offset;         /* Master PSYNC offset. */
856 857 858
    /* Replication script cache. */
    dict *repl_scriptcache_dict;        /* SHA1 all slaves are aware of. */
    list *repl_scriptcache_fifo;        /* First in, first out LRU eviction. */
859
    unsigned int repl_scriptcache_size; /* Max number of elements. */
860 861 862
    /* Synchronous replication. */
    list *clients_waiting_acks;         /* Clients waiting in WAIT command. */
    int get_ack_from_slaves;            /* If true we send REPLCONF GETACK. */
863
    /* Limits */
864
    unsigned int maxclients;            /* Max number of simultaneous clients */
865
    unsigned long long maxmemory;   /* Max number of memory bytes to use */
G
guiquanz 已提交
866
    int maxmemory_policy;           /* Policy for key eviction */
867
    int maxmemory_samples;          /* Pricision of random sampling */
868
    /* Blocked clients */
869
    unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */
870
    list *unblocked_clients; /* list of clients to unblock before next loop */
871
    list *ready_keys;        /* List of readyList structures for BLPOP & co */
872 873 874 875 876
    /* 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;
877
    int sort_store;
878
    /* Zip structure config, see redis.conf for more information  */
879 880
    size_t hash_max_ziplist_entries;
    size_t hash_max_ziplist_value;
881
    size_t set_max_intset_entries;
882 883
    size_t zset_max_ziplist_entries;
    size_t zset_max_ziplist_value;
884
    size_t hll_sparse_max_bytes;
885 886 887 888
    /* List parameters */
    int list_max_ziplist_size;
    int list_compress_depth;
    /* time cache */
889 890
    time_t unixtime;        /* Unix time sampled every cron cycle. */
    long long mstime;       /* Like 'unixtime' but with milliseconds resolution. */
891
    /* Pubsub */
892 893
    dict *pubsub_channels;  /* Map channels to list of subscribed clients */
    list *pubsub_patterns;  /* A list of pubsub_patterns */
894 895
    int notify_keyspace_events; /* Events to propagate via Pub/Sub. This is an
                                   xor of REDIS_NOTIFY... flags. */
896
    /* Cluster */
897
    int cluster_enabled;      /* Is cluster enabled? */
898
    mstime_t cluster_node_timeout; /* Cluster node timeout. */
899
    char *cluster_configfile; /* Cluster auto-generated config file name. */
900
    struct clusterState *cluster;  /* State of the cluster */
901
    int cluster_migration_barrier; /* Cluster replicas migration barrier. */
902
    int cluster_slave_validity_factor; /* Slave max data age for failover. */
903 904
    int cluster_require_full_coverage; /* If true, put the cluster down if
                                          there is at least an uncovered slot. */
905
    /* Scripting */
906
    lua_State *lua; /* The Lua interpreter. We use just one for all clients */
907 908
    client *lua_client;   /* The "fake client" to query Redis from Lua */
    client *lua_caller;   /* The client running EVAL right now, or NULL */
909
    dict *lua_scripts;         /* A dictionary of SHA1 -> Lua scripts */
910 911
    mstime_t lua_time_limit;  /* Script timeout in milliseconds */
    mstime_t lua_time_start;  /* Start time of script, milliseconds time */
912 913
    int lua_write_dirty;  /* True if a write command was called during the
                             execution of the current script. */
914
    int lua_random_dirty; /* True if a random command was called during the
915
                             execution of the current script. */
916 917
    int lua_timedout;     /* True if we reached the time limit for script
                             execution. */
918
    int lua_kill;         /* Kill the script if true. */
919 920 921
    /* Latency monitor */
    long long latency_monitor_threshold;
    dict *latency_events;
G
guiquanz 已提交
922
    /* Assert & bug reporting */
A
antirez 已提交
923 924 925
    char *assert_failed;
    char *assert_file;
    int assert_line;
926
    int bug_report_start; /* True if bug report header was already logged. */
A
antirez 已提交
927
    int watchdog_period;  /* Software watchdog period in ms. 0 = off */
928 929
    /* System hardware info */
    size_t system_memory_size;  /* Total memory in system as reported by OS */
930 931 932
};

typedef struct pubsubPattern {
933
    client *client;
934 935 936
    robj *pattern;
} pubsubPattern;

937
typedef void redisCommandProc(client *c);
938
typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
939 940 941 942
struct redisCommand {
    char *name;
    redisCommandProc *proc;
    int arity;
G
guiquanz 已提交
943
    char *sflags; /* Flags as string representation, one char per flag. */
944
    int flags;    /* The actual flags, obtained from the 'sflags' field. */
945
    /* Use a function to determine keys arguments in a command line.
A
antirez 已提交
946
     * Used for Redis Cluster redirect. */
947
    redisGetKeysProc *getkeys_proc;
948
    /* What keys should be loaded in background when calling this command? */
949
    int firstkey; /* The first argument that's a key (0 = no keys) */
G
guiquanz 已提交
950
    int lastkey;  /* The last argument that's a key */
951
    int keystep;  /* The step between first and last key */
952
    long long microseconds, calls;
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
};

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 已提交
978
    quicklistIter *iter;
979 980 981 982 983
} listTypeIterator;

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

987 988 989 990 991 992
/* Structure to hold set iteration abstraction. */
typedef struct {
    robj *subject;
    int encoding;
    int ii; /* intset iterator */
    dictIterator *di;
993
} setTypeIterator;
994

G
guiquanz 已提交
995
/* Structure to hold hash iteration abstraction. Note that iteration over
996 997 998 999
 * 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 {
1000
    robj *subject;
1001
    int encoding;
1002 1003

    unsigned char *fptr, *vptr;
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019

    dictIterator *di;
    dictEntry *de;
} hashTypeIterator;

#define REDIS_HASH_KEY 1
#define REDIS_HASH_VALUE 2

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

extern struct redisServer server;
extern struct sharedObjectsStruct shared;
extern dictType setDictType;
extern dictType zsetDictType;
A
antirez 已提交
1020
extern dictType clusterNodesDictType;
1021
extern dictType clusterNodesBlackListDictType;
1022
extern dictType dbDictType;
A
antirez 已提交
1023
extern dictType shaScriptObjectDictType;
1024
extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
1025
extern dictType hashDictType;
1026
extern dictType replScriptCacheDictType;
1027 1028 1029 1030 1031

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

1032 1033
/* Utils */
long long ustime(void);
1034
long long mstime(void);
1035
void getRandomHexChars(char *p, unsigned int len);
1036
uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
1037
void exitFromChild(int retcode);
1038
size_t redisPopcount(void *s, long count);
1039
void redisSetProcTitle(char *title);
1040

1041
/* networking.c -- Networking and Client related operations */
1042
client *createClient(int fd);
1043
void closeTimedoutClients(void);
1044 1045 1046
void freeClient(client *c);
void freeClientAsync(client *c);
void resetClient(client *c);
1047
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
1048 1049 1050
void *addDeferredMultiBulkLength(client *c);
void setDeferredMultiBulkLength(client *c, void *node, long length);
void processInputBuffer(client *c);
1051
void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
1052 1053
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
1054
void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
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);
void addReplyLongLong(client *c, long long ll);
void addReplyMultiBulkLen(client *c, long length);
void copyClientOutputBuffer(client *dst, client *src);
1068
void *dupClientReplyValue(void *o);
1069 1070
void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer);
1071
void formatPeerId(char *peerid, size_t peerid_len, char *ip, int port);
1072 1073
char *getClientPeerId(client *client);
sds catClientInfoString(sds s, client *client);
1074
sds getAllClientsInfoString(void);
1075 1076 1077 1078
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);
1079
void freeClientsInAsyncFreeQueue(void);
1080 1081
void asyncCloseClientOnOutputBufferLimitReached(client *c);
int getClientType(client *c);
A
antirez 已提交
1082 1083
int getClientTypeByName(char *name);
char *getClientTypeName(int class);
A
antirez 已提交
1084
void flushSlavesOutputBuffers(void);
1085
void disconnectSlaves(void);
1086
int listenToPort(int port, int *fds, int *count);
1087 1088
void pauseClients(mstime_t duration);
int clientsArePaused(void);
1089
int processEventsWhileBlocked(void);
1090

1091
#ifdef __GNUC__
1092
void addReplyErrorFormat(client *c, const char *fmt, ...)
1093
    __attribute__((format(printf, 2, 3)));
1094
void addReplyStatusFormat(client *c, const char *fmt, ...)
1095 1096
    __attribute__((format(printf, 2, 3)));
#else
1097 1098
void addReplyErrorFormat(client *c, const char *fmt, ...);
void addReplyStatusFormat(client *c, const char *fmt, ...);
1099 1100
#endif

1101 1102 1103 1104 1105
/* List data type */
void listTypeTryConversion(robj *subject, robj *value);
void listTypePush(robj *subject, robj *value, int where);
robj *listTypePop(robj *subject, int where);
unsigned long listTypeLength(robj *subject);
1106
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
1107 1108 1109 1110 1111
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 已提交
1112
void listTypeDelete(listTypeIterator *iter, listTypeEntry *entry);
1113
void listTypeConvert(robj *subject, int enc);
1114
void unblockClientWaitingData(client *c);
1115
void handleClientsBlockedOnLists(void);
1116
void popGenericCommand(client *c, int where);
1117
void signalListAsReady(redisDb *db, robj *key);
1118 1119

/* MULTI/EXEC/WATCH... */
1120 1121 1122 1123
void unwatchAllKeys(client *c);
void initClientMultiState(client *c);
void freeClientMultiState(client *c);
void queueMultiCommand(client *c);
1124 1125
void touchWatchedKey(redisDb *db, robj *key);
void touchWatchedKeysOnFlush(int dbid);
1126 1127
void discardTransaction(client *c);
void flagTransaction(client *c);
1128 1129

/* Redis object implementation */
1130 1131
void decrRefCount(robj *o);
void decrRefCountVoid(void *o);
1132
void incrRefCount(robj *o);
1133
robj *resetRefCount(robj *obj);
1134 1135 1136 1137 1138 1139
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);
1140 1141 1142
robj *createStringObject(const char *ptr, size_t len);
robj *createRawStringObject(const char *ptr, size_t len);
robj *createEmbeddedStringObject(const char *ptr, size_t len);
1143
robj *dupStringObject(robj *o);
1144
int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
1145 1146 1147 1148
robj *tryObjectEncoding(robj *o);
robj *getDecodedObject(robj *o);
size_t stringObjectLen(robj *o);
robj *createStringObjectFromLongLong(long long value);
1149
robj *createStringObjectFromLongDouble(long double value, int humanfriendly);
M
Matt Stancliff 已提交
1150
robj *createQuicklistObject(void);
1151 1152
robj *createZiplistObject(void);
robj *createSetObject(void);
1153
robj *createIntsetObject(void);
1154 1155
robj *createHashObject(void);
robj *createZsetObject(void);
1156
robj *createZsetZiplistObject(void);
1157 1158 1159 1160
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);
1161
int getLongLongFromObject(robj *o, long long *target);
A
antirez 已提交
1162
int getLongDoubleFromObject(robj *o, long double *target);
1163
int getLongDoubleFromObjectOrReply(client *c, robj *o, long double *target, const char *msg);
1164 1165
char *strEncoding(int encoding);
int compareStringObjects(robj *a, robj *b);
1166
int collateStringObjects(robj *a, robj *b);
1167
int equalStringObjects(robj *a, robj *b);
1168
unsigned long long estimateObjectIdleTime(robj *o);
1169
#define sdsEncodedObject(objptr) (objptr->encoding == REDIS_ENCODING_RAW || objptr->encoding == REDIS_ENCODING_EMBSTR)
1170

1171
/* Synchronous I/O with timeout */
1172 1173 1174
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);
1175

1176 1177
/* Replication */
void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
1178
void replicationFeedMonitors(client *c, list *monitors, int dictid, robj **argv, int argc);
1179
void updateSlavesWaitingBgsave(int bgsaveerr, int type);
1180
void replicationCron(void);
1181
void replicationHandleMasterDisconnection(void);
1182
void replicationCacheMaster(client *c);
1183
void resizeReplicationBacklog(long long newsize);
1184 1185
void replicationSetMaster(char *ip, int port);
void replicationUnsetMaster(void);
1186
void refreshGoodSlavesCount(void);
1187 1188 1189 1190
void replicationScriptCacheInit(void);
void replicationScriptCacheFlush(void);
void replicationScriptCacheAdd(sds sha1);
int replicationScriptCacheExists(sds sha1);
1191
void processClientsWaitingReplicas(void);
1192
void unblockClientWaitingReplicas(client *c);
1193
int replicationCountAcksByOffset(long long offset);
A
antirez 已提交
1194
void replicationSendNewlineToMaster(void);
1195
long long replicationGetSlaveOffset(void);
1196
char *replicationGetSlaveName(client *c);
1197

1198 1199 1200 1201 1202
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

1203
/* RDB persistence */
1204
#include "rdb.h"
1205 1206

/* AOF persistence */
1207
void flushAppendOnlyFile(int force);
1208 1209 1210 1211 1212 1213
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);
1214
void backgroundRewriteDoneHandler(int exitcode, int bysignal);
1215 1216
void aofRewriteBufferReset(void);
unsigned long aofRewriteBufferSize(void);
1217 1218

/* Sorted sets data type */
1219

1220
/* Struct to hold a inclusive/exclusive range spec by score comparison. */
1221 1222 1223 1224 1225
typedef struct {
    double min, max;
    int minex, maxex; /* are min or max exclusive? */
} zrangespec;

1226 1227 1228 1229 1230 1231
/* Struct to hold an inclusive/exclusive range spec by lexicographic comparison. */
typedef struct {
    robj *min, *max;  /* May be set to shared.(minstring|maxstring) */
    int minex, maxex; /* are min or max exclusive? */
} zlexrangespec;

1232 1233
zskiplist *zslCreate(void);
void zslFree(zskiplist *zsl);
1234
zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
1235
unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
1236
int zslDelete(zskiplist *zsl, double score, robj *obj);
1237 1238
zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec *range);
zskiplistNode *zslLastInRange(zskiplist *zsl, zrangespec *range);
1239 1240 1241
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);
1242 1243
unsigned int zsetLength(robj *zobj);
void zsetConvert(robj *zobj, int encoding);
A
antirez 已提交
1244
int zsetScore(robj *zobj, robj *member, double *score);
1245
unsigned long zslGetRank(zskiplist *zsl, double score, robj *o);
1246 1247

/* Core functions */
1248
int freeMemoryIfNeeded(void);
1249
int processCommand(client *c);
1250
void setupSignalHandlers(void);
1251 1252
struct redisCommand *lookupCommand(sds name);
struct redisCommand *lookupCommandByCString(char *s);
1253
struct redisCommand *lookupCommandOrOriginal(sds name);
1254
void call(client *c, int flags);
A
antirez 已提交
1255
void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1256
void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
1257 1258
void forceCommandPropagation(client *c, int flags);
void preventCommandPropagation(client *c);
1259
int prepareForShutdown();
1260
#ifdef __GNUC__
A
antirez 已提交
1261
void serverLog(int level, const char *fmt, ...)
1262 1263
    __attribute__((format(printf, 2, 3)));
#else
A
antirez 已提交
1264
void serverLog(int level, const char *fmt, ...);
1265
#endif
A
antirez 已提交
1266 1267
void serverLogRaw(int level, const char *msg);
void serverLogFromHandler(int level, const char *msg);
1268
void usage(void);
1269 1270 1271
void updateDictResizePolicy(void);
int htNeedsResize(dict *dict);
void oom(const char *msg);
1272
void populateCommandTable(void);
1273
void resetCommandTableStats(void);
A
antirez 已提交
1274
void adjustOpenFilesLimit(void);
1275
void closeListeningSockets(int unlink_unix_socket);
1276 1277
void updateCachedTime(void);
void resetServerStats(void);
1278
unsigned int getLRUClock(void);
1279
const char *maxmemoryToString(void);
1280

1281 1282 1283 1284 1285
/* Set data type */
robj *setTypeCreate(robj *value);
int setTypeAdd(robj *subject, robj *value);
int setTypeRemove(robj *subject, robj *value);
int setTypeIsMember(robj *subject, robj *value);
1286 1287
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
1288 1289
int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
robj *setTypeNextObject(setTypeIterator *si);
A
antirez 已提交
1290
int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1291
unsigned long setTypeRandomElements(robj *set, unsigned long count, robj *aux_set);
1292 1293 1294
unsigned long setTypeSize(robj *subject);
void setTypeConvert(robj *subject, int enc);

1295
/* Hash data type */
1296
void hashTypeConvert(robj *o, int enc);
1297 1298
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1299
robj *hashTypeGetObject(robj *o, robj *key);
1300 1301 1302 1303 1304 1305 1306
int hashTypeExists(robj *o, robj *key);
int hashTypeSet(robj *o, robj *key, robj *value);
int hashTypeDelete(robj *o, robj *key);
unsigned long hashTypeLength(robj *o);
hashTypeIterator *hashTypeInitIterator(robj *subject);
void hashTypeReleaseIterator(hashTypeIterator *hi);
int hashTypeNext(hashTypeIterator *hi);
1307 1308 1309 1310 1311
void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what,
                                unsigned char **vstr,
                                unsigned int *vlen,
                                long long *vll);
void hashTypeCurrentFromHashTable(hashTypeIterator *hi, int what, robj **dst);
A
antirez 已提交
1312
robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1313
robj *hashTypeLookupWriteOrCreate(client *c, robj *key);
1314 1315

/* Pub / Sub */
1316 1317
int pubsubUnsubscribeAllChannels(client *c, int notify);
int pubsubUnsubscribeAllPatterns(client *c, int notify);
1318 1319
void freePubsubPattern(void *p);
int listMatchPubsubPattern(void *a, void *b);
1320
int pubsubPublishMessage(robj *channel, robj *message);
1321 1322 1323 1324 1325

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

/* Configuration */
1328
void loadServerConfig(char *filename, char *options);
1329
void appendServerSaveParams(time_t seconds, int changes);
1330
void resetServerSaveParams(void);
1331
struct rewriteConfigState; /* Forward declaration to export API. */
1332
void rewriteConfigRewriteLine(struct rewriteConfigState *state, const char *option, sds line, int force);
1333
int rewriteConfig(char *path);
1334 1335 1336

/* db.c -- Keyspace access API */
int removeExpire(redisDb *db, robj *key);
1337
void propagateExpire(redisDb *db, robj *key);
1338
int expireIfNeeded(redisDb *db, robj *key);
1339 1340
long long getExpire(redisDb *db, robj *key);
void setExpire(redisDb *db, robj *key, long long when);
1341 1342 1343
robj *lookupKey(redisDb *db, robj *key);
robj *lookupKeyRead(redisDb *db, robj *key);
robj *lookupKeyWrite(redisDb *db, robj *key);
1344 1345
robj *lookupKeyReadOrReply(client *c, robj *key, robj *reply);
robj *lookupKeyWriteOrReply(client *c, robj *key, robj *reply);
1346 1347 1348
void dbAdd(redisDb *db, robj *key, robj *val);
void dbOverwrite(redisDb *db, robj *key, robj *val);
void setKey(redisDb *db, robj *key, robj *val);
1349 1350 1351
int dbExists(redisDb *db, robj *key);
robj *dbRandomKey(redisDb *db);
int dbDelete(redisDb *db, robj *key);
1352
robj *dbUnshareStringValue(redisDb *db, robj *key, robj *o);
1353
long long emptyDb(void(callback)(void*));
1354
int selectDb(client *c, int id);
1355 1356
void signalModifiedKey(redisDb *db, robj *key);
void signalFlushedDb(int dbid);
1357 1358
unsigned int getKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
unsigned int countKeysInSlot(unsigned int hashslot);
1359
unsigned int delKeysInSlot(unsigned int hashslot);
1360
int verifyClusterConfigWithData(void);
1361 1362
void scanGenericCommand(client *c, robj *o, unsigned long cursor);
int parseScanCursorOrReply(client *c, robj *o, unsigned long *cursor);
1363

1364
/* API to get key arguments from commands */
1365
int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1366
void getKeysFreeResult(int *result);
1367
int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys);
1368
int *evalGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1369
int *sortGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1370

A
antirez 已提交
1371 1372 1373 1374 1375
/* Cluster */
void clusterInit(void);
unsigned short crc16(const char *buf, int len);
unsigned int keyHashSlot(char *key, int keylen);
void clusterCron(void);
1376
void clusterPropagatePublish(robj *channel, robj *message);
A
antirez 已提交
1377
void migrateCloseTimedoutSockets(void);
1378
void clusterBeforeSleep(void);
A
antirez 已提交
1379

1380 1381 1382 1383 1384
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);
A
antirez 已提交
1385
void sentinelIsRunning(void);
1386

1387 1388
/* redis-check-rdb */
int redis_check_rdb(char *rdbfilename);
1389
int redis_check_rdb_main(char **argv, int argc);
1390

1391 1392 1393
/* Scripting */
void scriptingInit(void);

1394 1395
/* Blocked clients */
void processUnblockedClients(void);
1396 1397 1398 1399
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);
1400
void disconnectAllBlockedClients(void);
1401

1402 1403 1404
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);
1405
uint64_t redisBuildId(void);
1406 1407

/* Commands prototypes */
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
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);
void existsCommand(client *c);
void setbitCommand(client *c);
void getbitCommand(client *c);
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);
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);
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);
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);
1575

1576 1577 1578 1579 1580 1581 1582
#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

1583
/* Debugging stuff */
1584
void _redisAssertWithInfo(client *c, robj *o, char *estr, char *file, int line);
1585 1586
void _redisAssert(char *estr, char *file, int line);
void _redisPanic(char *msg, char *file, int line);
A
antirez 已提交
1587
void bugReportStart(void);
A
antirez 已提交
1588
void serverLogObjectDebugInfo(robj *o);
1589 1590
void sigsegvHandler(int sig, siginfo_t *info, void *secret);
sds genRedisInfoString(char *section);
A
antirez 已提交
1591 1592 1593
void enableWatchdog(int period);
void disableWatchdog(void);
void watchdogScheduleSignal(int period);
A
antirez 已提交
1594
void serverLogHexDump(int level, char *descr, void *value, size_t len);
1595 1596 1597 1598 1599 1600

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

1601
#endif