server.h 68.3 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
/* Error codes */
74 75
#define C_OK                    0
#define C_ERR                   -1
76 77

/* Static server configuration */
78
#define CONFIG_DEFAULT_HZ        10      /* Time interrupt calls/sec. */
A
antirez 已提交
79 80 81 82 83
#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 */
84
#define CONFIG_DEFAULT_DBNUM     16
A
antirez 已提交
85 86 87 88 89 90 91 92 93 94 95 96
#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
#define CONFIG_DEFAULT_SLOWLOG_LOG_SLOWER_THAN 10000
#define CONFIG_DEFAULT_SLOWLOG_MAX_LEN 128
97
#define CONFIG_DEFAULT_MAX_CLIENTS 10000
A
antirez 已提交
98
#define CONFIG_AUTHPASS_MAX_LEN 512
99
#define CONFIG_DEFAULT_SLAVE_PRIORITY 100
A
antirez 已提交
100 101 102 103
#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
104 105
#define CONFIG_DEFAULT_REPL_BACKLOG_SIZE (1024*1024)    /* 1mb */
#define CONFIG_DEFAULT_REPL_BACKLOG_TIME_LIMIT (60*60)  /* 1 hour */
A
antirez 已提交
106 107
#define CONFIG_REPL_BACKLOG_MIN_SIZE (1024*16)          /* 16k */
#define CONFIG_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
A
antirez 已提交
134 135 136 137
#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
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
/* Instantaneous metrics tracking. */
A
antirez 已提交
147 148 149 150 151
#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
152

153
/* Protocol and I/O related defines */
A
antirez 已提交
154 155 156 157 158 159 160 161 162 163 164 165 166
#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)
#define LONG_STR_SIZE      21          /* Bytes needed for long -> str */
#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 已提交
167

168
/* Hash table parameters */
A
antirez 已提交
169
#define HASHTABLE_MIN_FILL        10      /* Minimal hash table fill 10% */
170

171 172
/* Command flags. Please check the command table defined in the redis.c file
 * for more information about the meaning of every flag. */
A
antirez 已提交
173 174 175 176 177 178 179 180 181 182 183 184 185 186
#define CMD_WRITE 1                   /* "w" flag */
#define CMD_READONLY 2                /* "r" flag */
#define CMD_DENYOOM 4                 /* "m" flag */
#define CMD_NOT_USED_1 8              /* no longer used flag */
#define CMD_ADMIN 16                  /* "a" flag */
#define CMD_PUBSUB 32                 /* "p" flag */
#define CMD_NOSCRIPT  64              /* "s" flag */
#define CMD_RANDOM 128                /* "R" flag */
#define CMD_SORT_FOR_SCRIPT 256       /* "S" flag */
#define CMD_LOADING 512               /* "l" flag */
#define CMD_STALE 1024                /* "t" flag */
#define CMD_SKIP_MONITOR 2048         /* "M" flag */
#define CMD_ASKING 4096               /* "k" flag */
#define CMD_FAST 8192                 /* "F" flag */
187 188

/* Object types */
189 190 191 192 193
#define OBJ_STRING 0
#define OBJ_LIST 1
#define OBJ_SET 2
#define OBJ_ZSET 3
#define OBJ_HASH 4
194

195 196 197
/* 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. */
198 199 200 201 202 203 204 205 206 207
#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 */
#define OBJ_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
#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 */
208 209 210 211 212 213 214

/* 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 已提交
215
 * 10|000000 [32 bit integer] => if it's 10, a full 32 bit len will follow
216 217
 * 11|000000 this means: specially encoded object will follow. The six bits
 *           number specify the kind of object that follows.
A
antirez 已提交
218
 *           See the RDB_ENC_* defines.
219
 *
G
guiquanz 已提交
220
 * Lengths up to 63 are stored using a single byte, most DB keys, and may
221
 * values, will fit inside. */
A
antirez 已提交
222 223 224 225 226
#define RDB_6BITLEN 0
#define RDB_14BITLEN 1
#define RDB_32BITLEN 2
#define RDB_ENCVAL 3
#define RDB_LENERR UINT_MAX
227 228 229 230

/* 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: */
A
antirez 已提交
231 232 233 234
#define RDB_ENC_INT8 0        /* 8 bit signed integer */
#define RDB_ENC_INT16 1       /* 16 bit signed integer */
#define RDB_ENC_INT32 2       /* 32 bit signed integer */
#define RDB_ENC_LZF 3         /* string compressed with FASTLZ */
235

236
/* AOF states */
A
antirez 已提交
237 238 239
#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 */
240

241
/* Client flags */
A
antirez 已提交
242 243 244 245 246 247 248 249
#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 已提交
250
                                  server.unblocked_clients */
A
antirez 已提交
251 252 253 254 255 256 257 258 259 260 261 262
#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. */
#define CLIENT_PREVENT_PROP (1<<19)  /* Don't propagate to AOF / Slaves. */
263

264
/* Client block type (btype field in client structure)
A
antirez 已提交
265 266 267 268
 * 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. */
269

270
/* Client request types */
A
antirez 已提交
271 272
#define PROTO_REQ_INLINE 1
#define PROTO_REQ_MULTIBULK 2
273

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

/* 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 */
#define REPL_STATE_RECEIVE_PONG 3 /* Wait for PING reply */
#define REPL_STATE_TRANSFER 4 /* Receiving .rdb from master */
#define REPL_STATE_CONNECTED 5 /* Connected to master */

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

/* Synchronous read timeout - slave side */
A
antirez 已提交
303
#define CONFIG_REPL_SYNCIO_TIMEOUT 5
304 305

/* List related stuff */
A
antirez 已提交
306 307
#define LIST_HEAD 0
#define LIST_TAIL 1
308 309

/* Sort operations */
A
antirez 已提交
310
#define SORT_OP_GET 0
311 312

/* Log levels */
A
antirez 已提交
313 314 315 316 317 318
#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
319

320
/* Supervision options */
A
antirez 已提交
321 322 323 324
#define SUPERVISED_NONE 0
#define SUPERVISED_AUTODETECT 1
#define SUPERVISED_SYSTEMD 2
#define SUPERVISED_UPSTART 3
325

326
/* Anti-warning macro... */
A
antirez 已提交
327
#define UNUSED(V) ((void) V)
328 329 330 331 332

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

/* Append only defines */
333 334 335
#define AOF_FSYNC_NO 0
#define AOF_FSYNC_ALWAYS 1
#define AOF_FSYNC_EVERYSEC 2
336
#define CONFIG_DEFAULT_AOF_FSYNC AOF_FSYNC_EVERYSEC
337 338

/* Zip structure related defaults */
339 340 341 342 343
#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
344

345
/* List defaults */
346 347
#define OBJ_LIST_MAX_ZIPLIST_SIZE -2
#define OBJ_LIST_COMPRESS_DEPTH 0
348

349
/* HyperLogLog defines */
350
#define CONFIG_DEFAULT_HLL_SPARSE_MAX_BYTES 3000
351

352
/* Sets operations codes */
A
antirez 已提交
353 354 355
#define SET_OP_UNION 0
#define SET_OP_DIFF 1
#define SET_OP_INTER 2
356

357
/* Redis maxmemory strategies */
A
antirez 已提交
358 359 360 361 362 363 364
#define MAXMEMORY_VOLATILE_LRU 0
#define MAXMEMORY_VOLATILE_TTL 1
#define MAXMEMORY_VOLATILE_RANDOM 2
#define MAXMEMORY_ALLKEYS_LRU 3
#define MAXMEMORY_ALLKEYS_RANDOM 4
#define MAXMEMORY_NO_EVICTION 5
#define CONFIG_DEFAULT_MAXMEMORY_POLICY MAXMEMORY_NO_EVICTION
365

A
antirez 已提交
366
/* Scripting */
A
antirez 已提交
367
#define LUA_SCRIPT_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
368

369 370 371 372
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

373
/* SHUTDOWN flags */
374 375 376 377
#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. */
378

379
/* Command call flags, see call() function */
A
antirez 已提交
380 381 382 383 384
#define CMD_CALL_NONE 0
#define CMD_CALL_SLOWLOG 1
#define CMD_CALL_STATS 2
#define CMD_CALL_PROPAGATE 4
#define CMD_CALL_FULL (CMD_CALL_SLOWLOG | CMD_CALL_STATS | CMD_CALL_PROPAGATE)
385

A
antirez 已提交
386
/* Command propagation flags, see propagate() function */
A
antirez 已提交
387 388 389
#define PROPAGATE_NONE 0
#define PROPAGATE_AOF 1
#define PROPAGATE_REPL 2
A
antirez 已提交
390

A
antirez 已提交
391
/* RDB active child save type. */
A
antirez 已提交
392 393 394
#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 已提交
395

396 397
/* Keyspace changes notification classes. Every class is associated with a
 * character for configuration purposes. */
A
antirez 已提交
398 399 400 401 402 403 404 405 406 407 408
#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 */
409

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

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

418
/* We can print the stacktrace, so our assert is defined this way: */
A
antirez 已提交
419 420
#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)))
A
antirez 已提交
421
#define serverPanic(_e) _serverPanic(#_e,__FILE__,__LINE__),_exit(1)
422 423 424 425 426 427 428 429

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

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

/* The actual Redis Object */
A
antirez 已提交
430 431 432
#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 */
433 434 435
typedef struct redisObject {
    unsigned type:4;
    unsigned encoding:4;
A
antirez 已提交
436
    unsigned lru:LRU_BITS; /* lru time (relative to server.lruclock) */
437 438 439 440
    int refcount;
    void *ptr;
} robj;

441 442 443 444
/* 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. */
A
antirez 已提交
445
#define LRU_CLOCK() ((1000/server.hz <= LRU_CLOCK_RESOLUTION) ? server.lruclock : getLRUClock())
446

G
guiquanz 已提交
447
/* Macro used to initialize a Redis object allocated on the stack.
448 449 450 451 452
 * 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; \
453 454
    _var.type = OBJ_STRING; \
    _var.encoding = OBJ_ENCODING_RAW; \
455 456 457
    _var.ptr = _ptr; \
} while(0);

A
antirez 已提交
458 459 460 461 462 463 464
/* 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. */
A
antirez 已提交
465
#define MAXMEMORY_EVICTION_POOL_SIZE 16
A
antirez 已提交
466 467 468 469 470 471 472 473
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. */
474 475 476 477
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) */
478
    dict *ready_keys;           /* Blocked keys that received a PUSH */
479
    dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
A
antirez 已提交
480 481
    struct evictionPoolEntry *eviction_pool;    /* Eviction pool of keys */
    int id;                     /* Database ID */
482
    long long avg_ttl;          /* Average TTL, just for stats */
483 484 485 486 487 488 489 490 491 492 493 494
} 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 */
495 496
    int minreplicas;        /* MINREPLICAS for synchronous replication */
    time_t minreplicas_timeout; /* MINREPLICAS timeout as unixtime. */
497 498
} multiState;

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

A
antirez 已提交
506
    /* BLOCKED_LIST */
507
    dict *keys;             /* The keys we are waiting to terminate a blocking
508 509 510
                             * operation such as BLPOP. Otherwise NULL. */
    robj *target;           /* The key that should receive the element,
                             * for BRPOPLPUSH. */
511

A
antirez 已提交
512
    /* BLOCKED_WAIT */
513 514
    int numreplicas;        /* Number of replicas we are waiting for ACK. */
    long long reploffset;   /* Replication offset to reach. */
515 516
} blockingState;

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

    /* Response buffer */
579
    int bufpos;
A
antirez 已提交
580
    char buf[PROTO_REPLY_CHUNK_BYTES];
581
} client;
582 583 584 585 586 587 588 589 590 591

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,
592
    *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
593
    *masterdownerr, *roslaveerr, *execaborterr, *noautherr, *noreplicaserr,
594
    *busykeyerr, *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
595
    *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
596
    *lpush, *emptyscan, *minstring, *maxstring,
A
antirez 已提交
597 598 599 600
    *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" */
601 602
};

603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
/* 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;

625
typedef struct clientBufferLimitsConfig {
626 627
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
628 629 630
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

A
antirez 已提交
631
extern clientBufferLimitsConfig clientBufferLimitsDefaults[CLIENT_TYPE_OBUF_COUNT];
632

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

A
antirez 已提交
657 658 659 660
/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

661 662
struct clusterState;

A
antirez 已提交
663 664
/* 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 已提交
665 666 667 668
#ifdef _AIX
#undef hz
#endif

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

typedef struct pubsubPattern {
937
    client *client;
938 939 940
    robj *pattern;
} pubsubPattern;

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

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 已提交
982
    quicklistIter *iter;
983 984 985 986 987
} listTypeIterator;

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

991 992 993 994 995 996
/* Structure to hold set iteration abstraction. */
typedef struct {
    robj *subject;
    int encoding;
    int ii; /* intset iterator */
    dictIterator *di;
997
} setTypeIterator;
998

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

    unsigned char *fptr, *vptr;
1008 1009 1010 1011 1012

    dictIterator *di;
    dictEntry *de;
} hashTypeIterator;

1013 1014
#define OBJ_HASH_KEY 1
#define OBJ_HASH_VALUE 2
1015 1016 1017 1018 1019 1020 1021 1022 1023

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

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

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

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

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

1095
#ifdef __GNUC__
1096
void addReplyErrorFormat(client *c, const char *fmt, ...)
1097
    __attribute__((format(printf, 2, 3)));
1098
void addReplyStatusFormat(client *c, const char *fmt, ...)
1099 1100
    __attribute__((format(printf, 2, 3)));
#else
1101 1102
void addReplyErrorFormat(client *c, const char *fmt, ...);
void addReplyStatusFormat(client *c, const char *fmt, ...);
1103 1104
#endif

1105 1106 1107 1108 1109
/* 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);
1110
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
1111 1112 1113 1114 1115
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 已提交
1116
void listTypeDelete(listTypeIterator *iter, listTypeEntry *entry);
1117
void listTypeConvert(robj *subject, int enc);
1118
void unblockClientWaitingData(client *c);
1119
void handleClientsBlockedOnLists(void);
1120
void popGenericCommand(client *c, int where);
1121
void signalListAsReady(redisDb *db, robj *key);
1122 1123

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

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

1175
/* Synchronous I/O with timeout */
1176 1177 1178
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);
1179

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

1202 1203 1204 1205 1206
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

1207
/* RDB persistence */
1208
#include "rdb.h"
1209 1210

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

/* Sorted sets data type */
1223

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

1230 1231 1232 1233 1234 1235
/* 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;

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

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

1285 1286 1287 1288 1289
/* 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);
1290 1291
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
1292 1293
int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
robj *setTypeNextObject(setTypeIterator *si);
A
antirez 已提交
1294
int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1295
unsigned long setTypeRandomElements(robj *set, unsigned long count, robj *aux_set);
1296 1297 1298
unsigned long setTypeSize(robj *subject);
void setTypeConvert(robj *subject, int enc);

1299
/* Hash data type */
1300
void hashTypeConvert(robj *o, int enc);
1301 1302
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1303
robj *hashTypeGetObject(robj *o, robj *key);
1304 1305 1306 1307 1308 1309 1310
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);
1311 1312 1313 1314 1315
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 已提交
1316
robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1317
robj *hashTypeLookupWriteOrCreate(client *c, robj *key);
1318 1319

/* Pub / Sub */
1320 1321
int pubsubUnsubscribeAllChannels(client *c, int notify);
int pubsubUnsubscribeAllPatterns(client *c, int notify);
1322 1323
void freePubsubPattern(void *p);
int listMatchPubsubPattern(void *a, void *b);
1324
int pubsubPublishMessage(robj *channel, robj *message);
1325 1326 1327 1328 1329

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

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

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

1368
/* API to get key arguments from commands */
1369
int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1370
void getKeysFreeResult(int *result);
1371
int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys);
1372
int *evalGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1373
int *sortGetKeys(struct redisCommand *cmd, robj **argv, int argc, int *numkeys);
1374

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

1384 1385 1386 1387 1388
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);
A
antirez 已提交
1389
void sentinelIsRunning(void);
1390

1391 1392
/* redis-check-rdb */
int redis_check_rdb(char *rdbfilename);
1393
int redis_check_rdb_main(char **argv, int argc);
1394

1395 1396 1397
/* Scripting */
void scriptingInit(void);

1398 1399
/* Blocked clients */
void processUnblockedClients(void);
1400 1401 1402 1403
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);
1404
void disconnectAllBlockedClients(void);
1405

1406 1407 1408
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);
1409
uint64_t redisBuildId(void);
1410 1411

/* Commands prototypes */
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 1575 1576 1577 1578
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);
1579

1580 1581 1582 1583 1584 1585 1586
#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

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

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

1605
#endif