redis.h 66.1 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 44 45 46
#ifndef __REDIS_H
#define __REDIS_H

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

#if defined(__sun)
#include "solarisfixes.h"
#endif

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

54 55 56 57
#include "ae.h"      /* Event driven programming library */
#include "sds.h"     /* Dynamic safe strings */
#include "dict.h"    /* Hash tables */
#include "adlist.h"  /* Linked lists */
58
#include "zmalloc.h" /* total memory usage aware version of malloc/free */
59
#include "anet.h"    /* Networking the easy way */
60
#include "ziplist.h" /* Compact list data structure */
61 62 63
#include "intset.h"  /* Compact integer set structure */
#include "version.h" /* Version macro */
#include "util.h"    /* Misc functions useful in many places */
64 65 66 67 68 69

/* Error codes */
#define REDIS_OK                0
#define REDIS_ERR               -1

/* Static server configuration */
70 71 72
#define REDIS_DEFAULT_HZ        10      /* Time interrupt calls/sec. */
#define REDIS_MIN_HZ            1
#define REDIS_MAX_HZ            500 
73
#define REDIS_SERVERPORT        6379    /* TCP port */
74
#define REDIS_MAXIDLETIME       0       /* default client timeout: infinite */
75 76 77
#define REDIS_DEFAULT_DBNUM     16
#define REDIS_CONFIGLINE_MAX    1024
#define REDIS_EXPIRELOOKUPS_PER_CRON    10 /* lookup 10 expires per loop */
78
#define REDIS_EXPIRELOOKUPS_TIME_PERC   25 /* CPU max % for keys collection */
79
#define REDIS_DBCRON_DBS_PER_CALL 16
80
#define REDIS_MAX_WRITE_PER_EVENT (1024*64)
81
#define REDIS_SHARED_SELECT_CMDS 10
82
#define REDIS_SHARED_INTEGERS 10000
83
#define REDIS_SHARED_BULKHDR_LEN 32
J
Jonah H. Harris 已提交
84
#define REDIS_MAX_LOGMSG_LEN    1024 /* Default maximum length of syslog messages */
85 86 87
#define REDIS_AOF_REWRITE_PERC  100
#define REDIS_AOF_REWRITE_MIN_SIZE (1024*1024)
#define REDIS_AOF_REWRITE_ITEMS_PER_CMD 64
88
#define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000
89
#define REDIS_SLOWLOG_MAX_LEN 128
90
#define REDIS_MAX_CLIENTS 10000
91
#define REDIS_AUTHPASS_MAX_LEN 512
92
#define REDIS_DEFAULT_SLAVE_PRIORITY 100
A
7c6da73  
antirez 已提交
93 94
#define REDIS_REPL_TIMEOUT 60
#define REDIS_REPL_PING_SLAVE_PERIOD 10
95
#define REDIS_RUN_ID_SIZE 40
96
#define REDIS_OPS_SEC_SAMPLES 16
97 98 99
#define REDIS_DEFAULT_REPL_BACKLOG_SIZE (1024*1024)    /* 1mb */
#define REDIS_DEFAULT_REPL_BACKLOG_TIME_LIMIT (60*60)  /* 1 hour */
#define REDIS_REPL_BACKLOG_MIN_SIZE (1024*16)          /* 16k */
100
#define REDIS_BGSAVE_RETRY_DELAY 5 /* Wait a few secs before trying again. */
101 102 103
#define REDIS_DEFAULT_PID_FILE "/var/run/redis.pid"
#define REDIS_DEFAULT_SYSLOG_IDENT "redis"
#define REDIS_DEFAULT_CLUSTER_CONFIG_FILE "nodes.conf"
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
#define REDIS_DEFAULT_DAEMONIZE 0
#define REDIS_DEFAULT_UNIX_SOCKET_PERM 0
#define REDIS_DEFAULT_TCP_KEEPALIVE 0
#define REDIS_DEFAULT_LOGFILE ""
#define REDIS_DEFAULT_SYSLOG_ENABLED 0
#define REDIS_DEFAULT_STOP_WRITES_ON_BGSAVE_ERROR 1
#define REDIS_DEFAULT_RDB_COMPRESSION 1
#define REDIS_DEFAULT_RDB_CHECKSUM 1
#define REDIS_DEFAULT_RDB_FILENAME "dump.rdb"
#define REDIS_DEFAULT_SLAVE_SERVE_STALE_DATA 1
#define REDIS_DEFAULT_SLAVE_READ_ONLY 1
#define REDIS_DEFAULT_REPL_DISABLE_TCP_NODELAY 0
#define REDIS_DEFAULT_MAXMEMORY 0
#define REDIS_DEFAULT_MAXMEMORY_SAMPLES 3
#define REDIS_DEFAULT_AOF_NO_FSYNC_ON_REWRITE 0
#define REDIS_DEFAULT_ACTIVE_REHASHING 1
#define REDIS_DEFAULT_AOF_REWRITE_INCREMENTAL_FSYNC 1
121 122
#define REDIS_DEFAULT_MIN_SLAVES_TO_WRITE 0
#define REDIS_DEFAULT_MIN_SLAVES_MAX_LAG 10
123
#define REDIS_IP_STR_LEN INET6_ADDRSTRLEN
A
antirez 已提交
124
#define REDIS_PEER_ID_LEN (REDIS_IP_STR_LEN+32) /* Must be enough for ip:port */
A
antirez 已提交
125
#define REDIS_BINDADDR_MAX 16
126

127 128 129 130
/* 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 */
131
#define REDIS_INLINE_MAX_SIZE   (1024*64) /* Max size of inline reads */
132
#define REDIS_MBULK_BIG_ARG     (1024*32)
133
#define REDIS_LONGSTR_SIZE      21          /* Bytes needed for long -> str */
134
#define REDIS_AOF_AUTOSYNC_BYTES (1024*1024*32) /* fdatasync every 32MB */
A
antirez 已提交
135 136 137 138
/* When configuring the Redis eventloop, we setup it so that the total number
 * of file descriptors we can handle are server.maxclients + FDSET_INCR
 * that is our safety margin. */
#define REDIS_EVENTLOOP_FDSET_INCR 128
A
7c6da73  
antirez 已提交
139

140 141 142
/* Hash table parameters */
#define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */

143 144 145 146 147
/* 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 已提交
148
#define REDIS_CMD_NOT_USED_1 8              /* no longer used flag */
149 150
#define REDIS_CMD_ADMIN 16                  /* "a" flag */
#define REDIS_CMD_PUBSUB 32                 /* "p" flag */
151 152
#define REDIS_CMD_NOSCRIPT  64              /* "s" flag */
#define REDIS_CMD_RANDOM 128                /* "R" flag */
153
#define REDIS_CMD_SORT_FOR_SCRIPT 256       /* "S" flag */
154 155
#define REDIS_CMD_LOADING 512               /* "l" flag */
#define REDIS_CMD_STALE 1024                /* "t" flag */
156
#define REDIS_CMD_SKIP_MONITOR 2048         /* "M" flag */
157
#define REDIS_CMD_ASKING 4096               /* "k" flag */
158 159 160 161 162 163 164

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

166 167 168 169 170 171 172 173 174
/* 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 */
175
#define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
176
#define REDIS_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
177 178 179 180 181 182 183

/* 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 已提交
184
 * 10|000000 [32 bit integer] => if it's 10, a full 32 bit len will follow
185 186 187 188
 * 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 已提交
189
 * Lengths up to 63 are stored using a single byte, most DB keys, and may
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
 * 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 */

205 206 207 208 209
/* 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 */

210
/* Client flags */
A
antirez 已提交
211 212 213 214 215 216 217 218 219 220 221 222 223 224
#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 */
225
#define REDIS_MASTER_FORCE_REPLY (1<<13)  /* Queue replies even if is master */
A
antirez 已提交
226 227
#define REDIS_FORCE_AOF (1<<14)   /* Force AOF propagation of current cmd. */
#define REDIS_FORCE_REPL (1<<15)  /* Force replication of current cmd. */
228
#define REDIS_PRE_PSYNC_SLAVE (1<<16) /* Slave don't understand PSYNC. */
229 230 231 232

/* Client request types */
#define REDIS_REQ_INLINE 1
#define REDIS_REQ_MULTIBULK 2
233

234 235 236 237 238
/* Client classes for client limits, currently used only for
 * the max-client-output-buffer limit implementation. */
#define REDIS_CLIENT_LIMIT_CLASS_NORMAL 0
#define REDIS_CLIENT_LIMIT_CLASS_SLAVE 1
#define REDIS_CLIENT_LIMIT_CLASS_PUBSUB 2
239
#define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
240

241
/* Slave replication state - from the point of view of the slave. */
242 243
#define REDIS_REPL_NONE 0 /* No active replication */
#define REDIS_REPL_CONNECT 1 /* Must connect to master */
244
#define REDIS_REPL_CONNECTING 2 /* Connecting to master */
245 246 247
#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 */
248

249 250
/* Slave replication state - from the point of view of the master.
 * In SEND_BULK and ONLINE state the slave receives new updates
251 252
 * 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. */
253 254 255 256 257 258 259
#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
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275

/* 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 已提交
276
#define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
277
#define REDIS_DEFAULT_VERBOSITY REDIS_NOTICE
278 279 280 281 282 283 284 285

/* 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 */
286 287 288
#define AOF_FSYNC_NO 0
#define AOF_FSYNC_ALWAYS 1
#define AOF_FSYNC_EVERYSEC 2
289
#define REDIS_DEFAULT_AOF_FSYNC AOF_FSYNC_EVERYSEC
290 291

/* Zip structure related defaults */
292 293
#define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
#define REDIS_HASH_MAX_ZIPLIST_VALUE 64
294 295 296
#define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
#define REDIS_LIST_MAX_ZIPLIST_VALUE 64
#define REDIS_SET_MAX_INTSET_ENTRIES 512
297 298
#define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
#define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
299 300 301 302 303 304

/* Sets operations codes */
#define REDIS_OP_UNION 0
#define REDIS_OP_DIFF 1
#define REDIS_OP_INTER 2

305 306 307 308 309 310
/* 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
311
#define REDIS_MAXMEMORY_NO_EVICTION 5
312
#define REDIS_DEFAULT_MAXMEMORY_POLICY REDIS_MAXMEMORY_VOLATILE_LRU
313

A
antirez 已提交
314
/* Scripting */
315
#define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
316

317 318 319 320
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

321 322 323 324 325
/* 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. */

326 327 328 329 330 331 332
/* 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 已提交
333 334 335 336 337
/* Command propagation flags, see propagate() function */
#define REDIS_PROPAGATE_NONE 0
#define REDIS_PROPAGATE_AOF 1
#define REDIS_PROPAGATE_REPL 2

338 339 340 341 342 343 344 345 346 347 348 349 350 351
/* 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 */

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

357
/* We can print the stacktrace, so our assert is defined this way: */
358
#define redisAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_redisAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
359 360 361 362 363 364 365 366 367 368
#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 */
369
#define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
370
#define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
371 372
typedef struct redisObject {
    unsigned type:4;
373
    unsigned notused:2;     /* Not used */
374 375 376 377 378 379
    unsigned encoding:4;
    unsigned lru:22;        /* lru time (relative to server.lruclock) */
    int refcount;
    void *ptr;
} robj;

G
guiquanz 已提交
380
/* Macro used to initialize a Redis object allocated on the stack.
381 382 383 384 385 386 387 388 389 390 391 392 393 394
 * 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);

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) */
395
    dict *ready_keys;           /* Blocked keys that received a PUSH */
396 397 398 399 400 401 402 403 404 405 406 407 408 409
    dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
    int id;
} 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 */
410 411
    int minreplicas;        /* MINREPLICAS for synchronous replication */
    time_t minreplicas_timeout; /* MINREPLICAS timeout as unixtime. */
412 413
} multiState;

414
typedef struct blockingState {
415
    dict *keys;             /* The keys we are waiting to terminate a blocking
416 417
                             * operation such as BLPOP. Otherwise NULL. */
    time_t timeout;         /* Blocking operation timeout. If UNIX current time
418
                             * is > timeout then the operation timed out. */
419 420 421 422
    robj *target;           /* The key that should receive the element,
                             * for BRPOPLPUSH. */
} blockingState;

423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
/* 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 已提交
439
/* With multiplexing we need to take per-client state.
440 441 442 443 444
 * Clients are taken in a liked list. */
typedef struct redisClient {
    int fd;
    redisDb *db;
    int dictid;
445
    robj *name;             /* As set by CLIENT SETNAME */
446
    sds querybuf;
447
    size_t querybuf_peak;   /* Recent (100ms or more) peak of querybuf size */
448 449
    int argc;
    robj **argv;
450
    struct redisCommand *cmd, *lastcmd;
451 452 453
    int reqtype;
    int multibulklen;       /* number of multi bulk arguments left to read */
    long bulklen;           /* length of bulk argument in multi bulk request */
454
    list *reply;
455
    unsigned long reply_bytes; /* Tot bytes of objects in reply list */
456 457
    int sentlen;            /* Amount of bytes already sent in the current
                               buffer or object being sent. */
458
    time_t ctime;           /* Client creation time */
459
    time_t lastinteraction; /* time of the last interaction, used for timeout */
460
    time_t obuf_soft_limit_reached_time;
461 462 463 464 465 466
    int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
    int authenticated;      /* when requirepass is non-NULL */
    int replstate;          /* replication state if this is a slave */
    int repldbfd;           /* replication DB file descriptor */
    long repldboff;         /* replication DB file offset */
    off_t repldbsize;       /* replication DB file size */
467
    long long reploff;      /* replication offset if this is our master */
A
antirez 已提交
468 469
    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 */
470
    char replrunid[REDIS_RUN_ID_SIZE+1]; /* master run id if this is a master */
A
antirez 已提交
471
    int slave_listening_port; /* As configured with: SLAVECONF listening-port */
472
    multiState mstate;      /* MULTI/EXEC state */
473
    blockingState bpop;   /* blocking state */
474 475 476 477 478
    list *io_keys;          /* Keys this client is waiting to be loaded from the
                             * swap file in order to continue. */
    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) */
479 480 481

    /* Response buffer */
    int bufpos;
482
    char buf[REDIS_REPLY_CHUNK_BYTES];
483 484 485 486 487 488 489 490 491 492 493
} redisClient;

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,
494
    *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
495
    *masterdownerr, *roslaveerr, *execaborterr, *noautherr, *noreplicaserr,
496
    *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
497
    *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
498
    *lpush,
499
    *select[REDIS_SHARED_SELECT_CMDS],
500 501 502
    *integers[REDIS_SHARED_INTEGERS],
    *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
    *bulkhdr[REDIS_SHARED_BULKHDR_LEN];  /* "$<value>\r\n" */
503 504
};

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
/* 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;

527
typedef struct clientBufferLimitsConfig {
528 529
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
530 531 532
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

533 534
extern clientBufferLimitsConfig clientBufferLimitsDefaults[REDIS_CLIENT_LIMIT_NUM_CLASSES];

535 536 537 538 539 540 541
/* 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 {
542 543 544
    robj **argv;
    int argc, dbid, target;
    struct redisCommand *cmd;
545 546 547 548 549 550 551 552 553 554 555 556 557
} 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;
558

A
antirez 已提交
559 560 561 562
/*-----------------------------------------------------------------------------
 * Redis cluster data structures
 *----------------------------------------------------------------------------*/

563
#define REDIS_CLUSTER_SLOTS 16384
A
antirez 已提交
564 565 566 567
#define REDIS_CLUSTER_OK 0          /* Everything looks ok */
#define REDIS_CLUSTER_FAIL 1        /* The cluster can't work */
#define REDIS_CLUSTER_NAMELEN 40    /* sha1 hex length */
#define REDIS_CLUSTER_PORT_INCR 10000 /* Cluster port = baseport + PORT_INCR */
568
#define REDIS_CLUSTER_IPLEN INET6_ADDRSTRLEN /* IPv6 address string length */
A
antirez 已提交
569

570 571 572 573 574 575 576 577
/* The following defines are amunt of time, sometimes expressed as
 * multiplicators of the node timeout value (when ending with MULT). */
#define REDIS_CLUSTER_DEFAULT_NODE_TIMEOUT 15
#define REDIS_CLUSTER_FAIL_REPORT_VALIDITY_MULT 2 /* Fail report validity. */
#define REDIS_CLUSTER_FAIL_UNDO_TIME_MULT 2 /* Undo fail if master is back. */
#define REDIS_CLUSTER_FAIL_UNDO_TIME_ADD 10 /* Some additional time. */
#define REDIS_CLUSTER_SLAVE_VALIDITY_MULT 10 /* Slave data validity. */
#define REDIS_CLUSTER_FAILOVER_AUTH_RETRY_MULT 1 /* Auth request retry time. */
578
#define REDIS_CLUSTER_FAILOVER_DELAY 5 /* Seconds */
579

A
antirez 已提交
580 581 582 583
struct clusterNode;

/* clusterLink encapsulates everything needed to talk with a remote node. */
typedef struct clusterLink {
584
    time_t ctime;               /* Link creation time */
A
antirez 已提交
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
    int fd;                     /* TCP socket file descriptor */
    sds sndbuf;                 /* Packet send buffer */
    sds rcvbuf;                 /* Packet reception buffer */
    struct clusterNode *node;   /* Node related to this link if any, or NULL */
} clusterLink;

/* Node flags */
#define REDIS_NODE_MASTER 1     /* The node is a master */
#define REDIS_NODE_SLAVE 2      /* The node is a slave */
#define REDIS_NODE_PFAIL 4      /* Failure? Need acknowledge */
#define REDIS_NODE_FAIL 8       /* The node is believed to be malfunctioning */
#define REDIS_NODE_MYSELF 16    /* This node is myself */
#define REDIS_NODE_HANDSHAKE 32 /* We have still to exchange the first ping */
#define REDIS_NODE_NOADDR   64  /* We don't know the address of this node */
#define REDIS_NODE_MEET 128     /* Send a MEET message to this node */
A
antirez 已提交
600
#define REDIS_NODE_PROMOTED 256 /* Master was a slave propoted by failover */
A
antirez 已提交
601 602
#define REDIS_NODE_NULL_NAME "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"

603 604 605 606 607 608
/* This structure represent elements of node->fail_reports. */
struct clusterNodeFailReport {
    struct clusterNode *node;  /* Node reporting the failure condition. */
    time_t time;               /* Time of the last report from this node. */
} typedef clusterNodeFailReport;

A
antirez 已提交
609 610 611 612
struct clusterNode {
    char name[REDIS_CLUSTER_NAMELEN]; /* Node name, hex string, sha1-size */
    int flags;      /* REDIS_NODE_... */
    unsigned char slots[REDIS_CLUSTER_SLOTS/8]; /* slots handled by this node */
613
    int numslots;   /* Number of slots handled by this node */
A
antirez 已提交
614 615 616 617 618
    int numslaves;  /* Number of slave nodes, if this is a master */
    struct clusterNode **slaves; /* pointers to slave nodes */
    struct clusterNode *slaveof; /* pointer to the master node */
    time_t ping_sent;       /* Unix time we sent latest ping */
    time_t pong_received;   /* Unix time we received the pong */
A
antirez 已提交
619
    time_t fail_time;       /* Unix time when FAIL flag was set */
A
antirez 已提交
620
    char ip[REDIS_IP_STR_LEN];  /* Latest known IP address of this node */
A
antirez 已提交
621 622
    int port;                   /* Latest known port of this node */
    clusterLink *link;          /* TCP/IP link with this node */
623
    list *fail_reports;         /* List of nodes signaling this as failing */
A
antirez 已提交
624 625 626 627 628 629
};
typedef struct clusterNode clusterNode;

typedef struct {
    clusterNode *myself;  /* This node */
    int state;            /* REDIS_CLUSTER_OK, REDIS_CLUSTER_FAIL, ... */
630
    int size;             /* Num of master nodes with at least one slot */
A
antirez 已提交
631 632 633 634
    dict *nodes;          /* Hash table of name -> clusterNode structures */
    clusterNode *migrating_slots_to[REDIS_CLUSTER_SLOTS];
    clusterNode *importing_slots_from[REDIS_CLUSTER_SLOTS];
    clusterNode *slots[REDIS_CLUSTER_SLOTS];
635
    zskiplist *slots_to_keys;
636 637
    int failover_auth_time;     /* Time at which we sent the AUTH request. */
    int failover_auth_count;    /* Number of authorizations received. */
A
antirez 已提交
638 639 640 641 642
} clusterState;

/* Redis cluster messages header */

/* Note that the PING, PONG and MEET messages are actually the same exact
G
guiquanz 已提交
643
 * kind of packet. PONG is the reply to ping, in the exact format as a PING,
A
antirez 已提交
644 645 646 647 648 649
 * while MEET is a special PING that forces the receiver to add the sender
 * as a node (if it is not already in the list). */
#define CLUSTERMSG_TYPE_PING 0          /* Ping */
#define CLUSTERMSG_TYPE_PONG 1          /* Pong (reply to Ping) */
#define CLUSTERMSG_TYPE_MEET 2          /* Meet "let's join" message */
#define CLUSTERMSG_TYPE_FAIL 3          /* Mark node xxx as failing */
G
guiquanz 已提交
650
#define CLUSTERMSG_TYPE_PUBLISH 4       /* Pub/Sub Publish propagation */
651
#define CLUSTERMSG_TYPE_FAILOVER_AUTH_REQUEST 5 /* May I failover? */
652
#define CLUSTERMSG_TYPE_FAILOVER_AUTH_ACK 6     /* Yes, you can failover. */
A
antirez 已提交
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670

/* Initially we don't know our "name", but we'll find it once we connect
 * to the first node, using the getsockname() function. Then we'll use this
 * address for all the next messages. */
typedef struct {
    char nodename[REDIS_CLUSTER_NAMELEN];
    uint32_t ping_sent;
    uint32_t pong_received;
    char ip[16];    /* IP address last time it was seen */
    uint16_t port;  /* port last time it was seen */
    uint16_t flags;
    uint32_t notused; /* for 64 bit alignment */
} clusterMsgDataGossip;

typedef struct {
    char nodename[REDIS_CLUSTER_NAMELEN];
} clusterMsgDataFail;

671 672 673 674 675 676
typedef struct {
    uint32_t channel_len;
    uint32_t message_len;
    unsigned char bulk_data[8]; /* defined as 8 just for alignment concerns. */
} clusterMsgDataPublish;

A
antirez 已提交
677 678 679 680 681 682
union clusterMsgData {
    /* PING, MEET and PONG */
    struct {
        /* Array of N clusterMsgDataGossip structures */
        clusterMsgDataGossip gossip[1];
    } ping;
683

A
antirez 已提交
684 685 686 687
    /* FAIL */
    struct {
        clusterMsgDataFail about;
    } fail;
688 689 690 691 692

    /* PUBLISH */
    struct {
        clusterMsgDataPublish msg;
    } publish;
A
antirez 已提交
693 694 695 696 697 698 699 700 701
};

typedef struct {
    uint32_t totlen;    /* Total length of this message */
    uint16_t type;      /* Message type */
    uint16_t count;     /* Only used for some kind of messages. */
    char sender[REDIS_CLUSTER_NAMELEN]; /* Name of the sender node */
    unsigned char myslots[REDIS_CLUSTER_SLOTS/8];
    char slaveof[REDIS_CLUSTER_NAMELEN];
702
    char notused1[32];  /* 32 bytes reserved for future usage. */
A
antirez 已提交
703
    uint16_t port;      /* Sender TCP base port */
704
    uint16_t flags;     /* Sender node flags */
A
antirez 已提交
705
    unsigned char state; /* Cluster state from the POV of the sender */
706
    unsigned char notused2[3]; /* Reserved for future use. For alignment. */
A
antirez 已提交
707 708 709
    union clusterMsgData data;
} clusterMsg;

710 711
#define CLUSTERMSG_MIN_LEN (sizeof(clusterMsg)-sizeof(union clusterMsgData))

A
antirez 已提交
712 713 714 715
/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

716
struct redisServer {
717
    /* General */
718
    char *configfile;           /* Absolute config file path, or NULL */
719
    int hz;                     /* serverCron() calls frequency in hertz */
720
    redisDb *db;
721 722
    dict *commands;             /* Command table */
    dict *orig_commands;        /* Command table before command renaming. */
723
    aeEventLoop *el;
724 725 726 727 728 729
    unsigned lruclock:22;       /* Clock incrementing every minute, for LRU */
    unsigned lruclock_padding:10;
    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 */
730
    int arch_bits;              /* 32 or 64 depending on sizeof(long) */
731
    int cronloops;              /* Number of times the cron function run */
A
antirez 已提交
732
    char runid[REDIS_RUN_ID_SIZE+1];  /* ID always different at every exec. */
733
    int sentinel_mode;          /* True if this instance is a Sentinel. */
734
    /* Networking */
735
    int port;                   /* TCP listening port */
A
antirez 已提交
736 737
    char *bindaddr[REDIS_BINDADDR_MAX]; /* Addresses we should bind to */
    int bindaddr_count;         /* Number of addresses in server.bindaddr[] */
738 739
    char *unixsocket;           /* UNIX socket path */
    mode_t unixsocketperm;      /* UNIX socket permission */
740 741
    int ipfd[REDIS_BINDADDR_MAX]; /* TCP socket file descriptors */
    int ipfd_count;             /* Used slots in ipfd[] */
742
    int sofd;                   /* Unix socket file descriptor */
743 744
    int cfd[REDIS_BINDADDR_MAX];/* Cluster bus listening socket */
    int cfd_count;              /* Used slots in cfd[] */
745
    list *clients;              /* List of active clients */
746
    list *clients_to_close;     /* Clients to close asynchronously */
747
    list *slaves, *monitors;    /* List of slaves and MONITORs */
748
    redisClient *current_client; /* Current client, only used on crash report */
A
antirez 已提交
749 750
    char neterr[ANET_ERR_LEN];   /* Error buffer for anet.c */
    dict *migrate_cached_sockets;/* MIGRATE cached sockets */
751
    /* RDB / AOF loading information */
752
    int loading;                /* We are loading data from disk if true */
753 754 755
    off_t loading_total_bytes;
    off_t loading_loaded_bytes;
    time_t loading_start_time;
756
    /* Fast pointers to often looked up command */
757 758
    struct redisCommand *delCommand, *multiCommand, *lpushCommand, *lpopCommand,
                        *rpopCommand;
759
    /* Fields used only for stats */
760 761 762 763 764 765 766 767
    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 已提交
768
    long long stat_fork_time;       /* Time needed to perform latest fork() */
769
    long long stat_rejected_conn;   /* Clients rejected because of maxclients */
770 771 772
    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. */
773 774 775 776
    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 */
777 778 779 780 781 782
    /* The following two are used to track instantaneous "load" in terms
     * of operations per second. */
    long long ops_sec_last_sample_time; /* Timestamp of last sample (in ms) */
    long long ops_sec_last_sample_ops;  /* numcommands in last sample */
    long long ops_sec_samples[REDIS_OPS_SEC_SAMPLES];
    int ops_sec_idx;
783
    /* Configuration */
784 785
    int verbosity;                  /* Loglevel in redis.conf */
    int maxidletime;                /* Client timeout in seconds */
786
    int tcpkeepalive;               /* Set SO_KEEPALIVE if non-zero. */
A
antirez 已提交
787
    int active_expire_enabled;      /* Can be disabled for testing purposes. */
788 789 790
    size_t client_max_querybuf_len; /* Limit for client query buffer length */
    int dbnum;                      /* Total number of configured DBs */
    int daemonize;                  /* True if running as a daemon */
791
    clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES];
792 793
    /* AOF persistence */
    int aof_state;                  /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
794 795 796 797 798 799 800 801
    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 已提交
802
    pid_t aof_child_pid;            /* PID if rewriting process */
803
    list *aof_rewrite_buf_blocks;   /* Hold changes during an AOF rewrite. */
A
antirez 已提交
804 805 806
    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 */
807
    time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
A
antirez 已提交
808
    time_t aof_last_fsync;            /* UNIX time of last fsync() */
809 810
    time_t aof_rewrite_time_last;   /* Time used by last AOF rewrite run. */
    time_t aof_rewrite_time_start;  /* Current AOF rewrite start time. */
811
    int aof_lastbgrewrite_status;   /* REDIS_OK or REDIS_ERR */
812
    unsigned long aof_delayed_fsync;  /* delayed AOF fsync() counter */
813
    int aof_rewrite_incremental_fsync;/* fsync incrementally while rewriting? */
814 815 816
    /* 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 已提交
817
    pid_t rdb_child_pid;            /* PID of RDB saving child */
818 819
    struct saveparam *saveparams;   /* Save points array for RDB */
    int saveparamslen;              /* Number of saving points */
A
antirez 已提交
820 821
    char *rdb_filename;             /* Name of RDB file */
    int rdb_compression;            /* Use compression in RDB? */
822
    int rdb_checksum;               /* Use RDB checksum? */
G
guiquanz 已提交
823
    time_t lastsave;                /* Unix time of last successful save */
824
    time_t lastbgsave_try;          /* Unix time of last attempted bgsave */
825 826
    time_t rdb_save_time_last;      /* Time used by last RDB save run. */
    time_t rdb_save_time_start;     /* Current RDB save start time. */
827
    int lastbgsave_status;          /* REDIS_OK or REDIS_ERR */
828
    int stop_writes_on_bgsave_err;  /* Don't allow writes if can't BGSAVE */
829
    /* Propagation of commands in AOF / replication */
830
    redisOpArray also_propagate;    /* Additional command to propagate. */
831
    /* Logging */
832 833 834 835
    char *logfile;                  /* Path of log file */
    int syslog_enabled;             /* Is syslog enabled? */
    char *syslog_ident;             /* Syslog ident */
    int syslog_facility;            /* Syslog facility */
836 837 838 839 840 841 842 843 844 845 846 847 848 849
    /* 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. */
850 851 852
    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. */
853
    /* Replication (slave) */
854 855 856 857 858
    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 */
    redisClient *master;     /* Client that is master for this slave */
859
    redisClient *cached_master; /* Cached master to be reused for PSYNC. */
860
    int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
A
antirez 已提交
861
    int repl_state;          /* Replication status if the instance is a slave */
862 863 864
    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. */
865 866 867 868
    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 */
869
    int repl_serve_stale_data; /* Serve stale data when link is down? */
870
    int repl_slave_ro;          /* Slave is read only? */
871
    time_t repl_down_since; /* Unix time at which link with master went down */
872
    int repl_disable_tcp_nodelay;   /* Disable TCP_NODELAY after SYNC? */
873
    int slave_priority;             /* Reported in INFO and used by Sentinel. */
874 875
    char repl_master_runid[REDIS_RUN_ID_SIZE+1];  /* Master run id for PSYNC. */
    long long repl_master_initial_offset;         /* Master PSYNC offset. */
876 877 878 879
    /* Replication script cache. */
    dict *repl_scriptcache_dict;        /* SHA1 all slaves are aware of. */
    list *repl_scriptcache_fifo;        /* First in, first out LRU eviction. */
    int repl_scriptcache_size;          /* Max number of elements. */
880
    /* Limits */
881 882
    unsigned int maxclients;        /* Max number of simultaneous clients */
    unsigned long long maxmemory;   /* Max number of memory bytes to use */
G
guiquanz 已提交
883
    int maxmemory_policy;           /* Policy for key eviction */
884
    int maxmemory_samples;          /* Pricision of random sampling */
885
    /* Blocked clients */
886
    unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */
887
    list *unblocked_clients; /* list of clients to unblock before next loop */
888
    list *ready_keys;        /* List of readyList structures for BLPOP & co */
889 890 891 892 893
    /* 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;
894
    /* Zip structure config, see redis.conf for more information  */
895 896
    size_t hash_max_ziplist_entries;
    size_t hash_max_ziplist_value;
897 898
    size_t list_max_ziplist_entries;
    size_t list_max_ziplist_value;
899
    size_t set_max_intset_entries;
900 901
    size_t zset_max_ziplist_entries;
    size_t zset_max_ziplist_value;
902
    time_t unixtime;        /* Unix time sampled every second. */
903
    /* Pubsub */
904 905
    dict *pubsub_channels;  /* Map channels to list of subscribed clients */
    list *pubsub_patterns;  /* A list of pubsub_patterns */
906 907
    int notify_keyspace_events; /* Events to propagate via Pub/Sub. This is an
                                   xor of REDIS_NOTIFY... flags. */
908
    /* Cluster */
909
    int cluster_enabled;      /* Is cluster enabled? */
910
    int cluster_node_timeout; /* Cluster node timeout. */
911 912
    char *cluster_configfile; /* Cluster auto-generated config file name. */
    clusterState *cluster;  /* State of the cluster */
913
    /* Scripting */
914
    lua_State *lua; /* The Lua interpreter. We use just one for all clients */
915 916 917 918 919
    redisClient *lua_client;   /* The "fake client" to query Redis from Lua */
    redisClient *lua_caller;   /* The client running EVAL right now, or NULL */
    dict *lua_scripts;         /* A dictionary of SHA1 -> Lua scripts */
    long long lua_time_limit;  /* Script timeout in seconds */
    long long lua_time_start;  /* Start time of script */
920 921
    int lua_write_dirty;  /* True if a write command was called during the
                             execution of the current script. */
922
    int lua_random_dirty; /* True if a random command was called during the
923
                             execution of the current script. */
924 925
    int lua_timedout;     /* True if we reached the time limit for script
                             execution. */
926
    int lua_kill;         /* Kill the script if true. */
G
guiquanz 已提交
927
    /* Assert & bug reporting */
A
antirez 已提交
928 929 930
    char *assert_failed;
    char *assert_file;
    int assert_line;
931
    int bug_report_start; /* True if bug report header was already logged. */
A
antirez 已提交
932
    int watchdog_period;  /* Software watchdog period in ms. 0 = off */
933 934 935 936 937 938 939 940
};

typedef struct pubsubPattern {
    redisClient *client;
    robj *pattern;
} pubsubPattern;

typedef void redisCommandProc(redisClient *c);
941
typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
942 943 944 945
struct redisCommand {
    char *name;
    redisCommandProc *proc;
    int arity;
G
guiquanz 已提交
946
    char *sflags; /* Flags as string representation, one char per flag. */
947
    int flags;    /* The actual flags, obtained from the 'sflags' field. */
948
    /* Use a function to determine keys arguments in a command line.
A
antirez 已提交
949
     * Used for Redis Cluster redirect. */
950
    redisGetKeysProc *getkeys_proc;
951
    /* What keys should be loaded in background when calling this command? */
952
    int firstkey; /* The first argument that's a key (0 = no keys) */
G
guiquanz 已提交
953
    int lastkey;  /* The last argument that's a key */
954
    int keystep;  /* The step between first and last key */
955
    long long microseconds, calls;
956 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 982 983 984 985 986 987 988 989 990 991
};

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 */
    unsigned char *zi;
    listNode *ln;
} listTypeIterator;

/* Structure for an entry while iterating over a list. */
typedef struct {
    listTypeIterator *li;
    unsigned char *zi;  /* Entry in ziplist */
    listNode *ln;       /* Entry in linked list */
} listTypeEntry;

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

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

    unsigned char *fptr, *vptr;
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024

    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 已提交
1025
extern dictType clusterNodesDictType;
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 1046 1047 1048
/* networking.c -- Networking and Client related operations */
redisClient *createClient(int fd);
void closeTimedoutClients(void);
void freeClient(redisClient *c);
1049
void freeClientAsync(redisClient *c);
1050 1051 1052
void resetClient(redisClient *c);
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
void addReply(redisClient *c, robj *obj);
1053 1054
void *addDeferredMultiBulkLength(redisClient *c);
void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
1055 1056
void addReplySds(redisClient *c, sds s);
void processInputBuffer(redisClient *c);
1057 1058
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
1059 1060 1061
void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
void addReplyBulk(redisClient *c, robj *obj);
void addReplyBulkCString(redisClient *c, char *s);
1062 1063
void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
void addReplyBulkLongLong(redisClient *c, long long ll);
1064 1065 1066
void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void addReply(redisClient *c, robj *obj);
void addReplySds(redisClient *c, sds s);
1067 1068
void addReplyError(redisClient *c, char *err);
void addReplyStatus(redisClient *c, char *status);
1069 1070
void addReplyDouble(redisClient *c, double d);
void addReplyLongLong(redisClient *c, long long ll);
1071
void addReplyMultiBulkLen(redisClient *c, long length);
1072
void copyClientOutputBuffer(redisClient *dst, redisClient *src);
1073
void *dupClientReplyValue(void *o);
1074 1075
void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer);
A
antirez 已提交
1076
void getClientPeerId(redisClient *client, char *peerid, size_t peerid_len);
1077
sds getClientInfoString(redisClient *client);
1078
sds getAllClientsInfoString(void);
1079
void rewriteClientCommandVector(redisClient *c, int argc, ...);
1080
void rewriteClientCommandArgument(redisClient *c, int i, robj *newval);
1081
unsigned long getClientOutputBufferMemoryUsage(redisClient *c);
1082
void freeClientsInAsyncFreeQueue(void);
1083
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c);
1084 1085
int getClientLimitClassByName(char *name);
char *getClientLimitClassName(int class);
A
antirez 已提交
1086
void flushSlavesOutputBuffers(void);
1087
void disconnectSlaves(void);
1088

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

1099 1100 1101 1102 1103
/* 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);
1104
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
1105 1106 1107 1108 1109 1110 1111 1112
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);
void listTypeDelete(listTypeEntry *entry);
void listTypeConvert(robj *subject, int enc);
void unblockClientWaitingData(redisClient *c);
1113
void handleClientsBlockedOnLists(void);
1114 1115 1116 1117 1118 1119
void popGenericCommand(redisClient *c, int where);

/* MULTI/EXEC/WATCH... */
void unwatchAllKeys(redisClient *c);
void initClientMultiState(redisClient *c);
void freeClientMultiState(redisClient *c);
1120
void queueMultiCommand(redisClient *c);
1121 1122
void touchWatchedKey(redisDb *db, robj *key);
void touchWatchedKeysOnFlush(int dbid);
1123
void discardTransaction(redisClient *c);
A
antirez 已提交
1124
void flagTransaction(redisClient *c);
1125 1126

/* Redis object implementation */
1127 1128
void decrRefCount(robj *o);
void decrRefCountVoid(void *o);
1129
void incrRefCount(robj *o);
1130
robj *resetRefCount(robj *obj);
1131 1132 1133 1134 1135 1136 1137 1138
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);
robj *createStringObject(char *ptr, size_t len);
robj *dupStringObject(robj *o);
1139
int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
1140 1141 1142 1143
robj *tryObjectEncoding(robj *o);
robj *getDecodedObject(robj *o);
size_t stringObjectLen(robj *o);
robj *createStringObjectFromLongLong(long long value);
A
antirez 已提交
1144
robj *createStringObjectFromLongDouble(long double value);
1145 1146 1147
robj *createListObject(void);
robj *createZiplistObject(void);
robj *createSetObject(void);
1148
robj *createIntsetObject(void);
1149 1150
robj *createHashObject(void);
robj *createZsetObject(void);
1151
robj *createZsetZiplistObject(void);
1152 1153 1154 1155 1156
int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
int checkType(redisClient *c, robj *o, int type);
int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
int getLongLongFromObject(robj *o, long long *target);
A
antirez 已提交
1157 1158
int getLongDoubleFromObject(robj *o, long double *target);
int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
1159 1160 1161
char *strEncoding(int encoding);
int compareStringObjects(robj *a, robj *b);
int equalStringObjects(robj *a, robj *b);
1162
unsigned long estimateObjectIdleTime(robj *o);
1163

1164
/* Synchronous I/O with timeout */
1165 1166 1167
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);
1168

1169 1170
/* Replication */
void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
1171
void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc);
1172
void updateSlavesWaitingBgsave(int bgsaveerr);
1173
void replicationCron(void);
1174 1175 1176
void replicationHandleMasterDisconnection(void);
void replicationCacheMaster(redisClient *c);
void resizeReplicationBacklog(long long newsize);
1177 1178
void replicationSetMaster(char *ip, int port);
void replicationUnsetMaster(void);
1179
void refreshGoodSlavesCount(void);
1180 1181 1182 1183
void replicationScriptCacheInit(void);
void replicationScriptCacheFlush(void);
void replicationScriptCacheAdd(sds sha1);
int replicationScriptCacheExists(sds sha1);
1184

1185 1186 1187 1188 1189
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

1190
/* RDB persistence */
1191
#include "rdb.h"
1192 1193

/* AOF persistence */
1194
void flushAppendOnlyFile(int force);
1195 1196 1197 1198 1199 1200
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);
1201
void backgroundRewriteDoneHandler(int exitcode, int bysignal);
1202 1203
void aofRewriteBufferReset(void);
unsigned long aofRewriteBufferSize(void);
1204 1205

/* Sorted sets data type */
1206 1207 1208 1209 1210 1211 1212

/* Struct to hold a inclusive/exclusive range spec. */
typedef struct {
    double min, max;
    int minex, maxex; /* are min or max exclusive? */
} zrangespec;

1213 1214
zskiplist *zslCreate(void);
void zslFree(zskiplist *zsl);
1215
zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
1216
unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
1217 1218
int zslDelete(zskiplist *zsl, double score, robj *obj);
zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
1219
zskiplistNode *zslLastInRange(zskiplist *zsl, zrangespec range);
1220 1221 1222
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);
1223 1224
unsigned int zsetLength(robj *zobj);
void zsetConvert(robj *zobj, int encoding);
1225
unsigned long zslGetRank(zskiplist *zsl, double score, robj *o);
1226 1227

/* Core functions */
1228
int freeMemoryIfNeeded(void);
1229
int processCommand(redisClient *c);
1230
void setupSignalHandlers(void);
1231 1232
struct redisCommand *lookupCommand(sds name);
struct redisCommand *lookupCommandByCString(char *s);
1233
struct redisCommand *lookupCommandOrOriginal(sds name);
1234
void call(redisClient *c, int flags);
A
antirez 已提交
1235
void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1236
void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
A
antirez 已提交
1237
void forceCommandPropagation(redisClient *c, int flags);
1238
int prepareForShutdown();
1239 1240 1241 1242
#ifdef __GNUC__
void redisLog(int level, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
#else
1243
void redisLog(int level, const char *fmt, ...);
1244
#endif
1245
void redisLogRaw(int level, const char *msg);
A
antirez 已提交
1246
void redisLogFromHandler(int level, const char *msg);
1247 1248 1249 1250
void usage();
void updateDictResizePolicy(void);
int htNeedsResize(dict *dict);
void oom(const char *msg);
1251
void populateCommandTable(void);
1252
void resetCommandTableStats(void);
A
antirez 已提交
1253
void adjustOpenFilesLimit(void);
1254
void closeListeningSockets(int unlink_unix_socket);
1255

1256 1257 1258 1259 1260
/* 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);
1261 1262
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
1263 1264
int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
robj *setTypeNextObject(setTypeIterator *si);
A
antirez 已提交
1265
int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1266 1267 1268
unsigned long setTypeSize(robj *subject);
void setTypeConvert(robj *subject, int enc);

1269
/* Hash data type */
1270
void hashTypeConvert(robj *o, int enc);
1271 1272
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1273
robj *hashTypeGetObject(robj *o, robj *key);
1274 1275 1276 1277 1278 1279 1280
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);
1281 1282 1283 1284 1285
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 已提交
1286
robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1287 1288 1289 1290 1291 1292 1293
robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);

/* Pub / Sub */
int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
void freePubsubPattern(void *p);
int listMatchPubsubPattern(void *a, void *b);
1294
int pubsubPublishMessage(robj *channel, robj *message);
1295 1296 1297 1298 1299

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

/* Configuration */
1302
void loadServerConfig(char *filename, char *options);
1303 1304 1305 1306 1307
void appendServerSaveParams(time_t seconds, int changes);
void resetServerSaveParams();

/* db.c -- Keyspace access API */
int removeExpire(redisDb *db, robj *key);
1308
void propagateExpire(redisDb *db, robj *key);
1309
int expireIfNeeded(redisDb *db, robj *key);
1310 1311
long long getExpire(redisDb *db, robj *key);
void setExpire(redisDb *db, robj *key, long long when);
1312 1313 1314 1315 1316
robj *lookupKey(redisDb *db, robj *key);
robj *lookupKeyRead(redisDb *db, robj *key);
robj *lookupKeyWrite(redisDb *db, robj *key);
robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
1317 1318 1319
void dbAdd(redisDb *db, robj *key, robj *val);
void dbOverwrite(redisDb *db, robj *key, robj *val);
void setKey(redisDb *db, robj *key, robj *val);
1320 1321 1322 1323 1324
int dbExists(redisDb *db, robj *key);
robj *dbRandomKey(redisDb *db);
int dbDelete(redisDb *db, robj *key);
long long emptyDb();
int selectDb(redisClient *c, int id);
1325 1326
void signalModifiedKey(redisDb *db, robj *key);
void signalFlushedDb(int dbid);
1327 1328
unsigned int getKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
unsigned int countKeysInSlot(unsigned int hashslot);
1329
int verifyClusterConfigWithData(void);
1330

1331 1332 1333 1334 1335 1336 1337 1338 1339
/* API to get key arguments from commands */
#define REDIS_GETKEYS_ALL 0
#define REDIS_GETKEYS_PRELOAD 1
int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
void getKeysFreeResult(int *result);
int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);

A
antirez 已提交
1340 1341 1342 1343 1344 1345 1346
/* Cluster */
void clusterInit(void);
unsigned short crc16(const char *buf, int len);
unsigned int keyHashSlot(char *key, int keylen);
clusterNode *createClusterNode(char *nodename, int flags);
int clusterAddNode(clusterNode *node);
void clusterCron(void);
1347
clusterNode *getNodeByQuery(redisClient *c, struct redisCommand *cmd, robj **argv, int argc, int *hashslot, int *ask);
1348
void clusterPropagatePublish(robj *channel, robj *message);
A
antirez 已提交
1349
void migrateCloseTimedoutSockets(void);
A
antirez 已提交
1350

1351 1352 1353 1354 1355 1356
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);

1357 1358 1359
/* Scripting */
void scriptingInit(void);

1360 1361 1362
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);
1363
uint64_t redisBuildId(void);
1364 1365 1366 1367 1368 1369 1370 1371

/* Commands prototypes */
void authCommand(redisClient *c);
void pingCommand(redisClient *c);
void echoCommand(redisClient *c);
void setCommand(redisClient *c);
void setnxCommand(redisClient *c);
void setexCommand(redisClient *c);
1372
void psetexCommand(redisClient *c);
1373 1374 1375
void getCommand(redisClient *c);
void delCommand(redisClient *c);
void existsCommand(redisClient *c);
P
Pieter Noordhuis 已提交
1376 1377
void setbitCommand(redisClient *c);
void getbitCommand(redisClient *c);
1378
void setrangeCommand(redisClient *c);
1379
void getrangeCommand(redisClient *c);
1380 1381 1382 1383
void incrCommand(redisClient *c);
void decrCommand(redisClient *c);
void incrbyCommand(redisClient *c);
void decrbyCommand(redisClient *c);
A
antirez 已提交
1384
void incrbyfloatCommand(redisClient *c);
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
void selectCommand(redisClient *c);
void randomkeyCommand(redisClient *c);
void keysCommand(redisClient *c);
void dbsizeCommand(redisClient *c);
void lastsaveCommand(redisClient *c);
void saveCommand(redisClient *c);
void bgsaveCommand(redisClient *c);
void bgrewriteaofCommand(redisClient *c);
void shutdownCommand(redisClient *c);
void moveCommand(redisClient *c);
void renameCommand(redisClient *c);
void renamenxCommand(redisClient *c);
void lpushCommand(redisClient *c);
void rpushCommand(redisClient *c);
void lpushxCommand(redisClient *c);
void rpushxCommand(redisClient *c);
void linsertCommand(redisClient *c);
void lpopCommand(redisClient *c);
void rpopCommand(redisClient *c);
void llenCommand(redisClient *c);
void lindexCommand(redisClient *c);
void lrangeCommand(redisClient *c);
void ltrimCommand(redisClient *c);
void typeCommand(redisClient *c);
void lsetCommand(redisClient *c);
void saddCommand(redisClient *c);
void sremCommand(redisClient *c);
void smoveCommand(redisClient *c);
void sismemberCommand(redisClient *c);
void scardCommand(redisClient *c);
void spopCommand(redisClient *c);
void srandmemberCommand(redisClient *c);
void sinterCommand(redisClient *c);
void sinterstoreCommand(redisClient *c);
void sunionCommand(redisClient *c);
void sunionstoreCommand(redisClient *c);
void sdiffCommand(redisClient *c);
void sdiffstoreCommand(redisClient *c);
void syncCommand(redisClient *c);
void flushdbCommand(redisClient *c);
void flushallCommand(redisClient *c);
void sortCommand(redisClient *c);
void lremCommand(redisClient *c);
1428
void rpoplpushCommand(redisClient *c);
1429 1430 1431 1432 1433
void infoCommand(redisClient *c);
void mgetCommand(redisClient *c);
void monitorCommand(redisClient *c);
void expireCommand(redisClient *c);
void expireatCommand(redisClient *c);
1434 1435
void pexpireCommand(redisClient *c);
void pexpireatCommand(redisClient *c);
1436 1437
void getsetCommand(redisClient *c);
void ttlCommand(redisClient *c);
1438
void pttlCommand(redisClient *c);
A
antirez 已提交
1439
void persistCommand(redisClient *c);
1440 1441 1442 1443 1444 1445 1446 1447
void slaveofCommand(redisClient *c);
void debugCommand(redisClient *c);
void msetCommand(redisClient *c);
void msetnxCommand(redisClient *c);
void zaddCommand(redisClient *c);
void zincrbyCommand(redisClient *c);
void zrangeCommand(redisClient *c);
void zrangebyscoreCommand(redisClient *c);
1448
void zrevrangebyscoreCommand(redisClient *c);
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
void zcountCommand(redisClient *c);
void zrevrangeCommand(redisClient *c);
void zcardCommand(redisClient *c);
void zremCommand(redisClient *c);
void zscoreCommand(redisClient *c);
void zremrangebyscoreCommand(redisClient *c);
void multiCommand(redisClient *c);
void execCommand(redisClient *c);
void discardCommand(redisClient *c);
void blpopCommand(redisClient *c);
void brpopCommand(redisClient *c);
D
Damian Janowski &amp; Michel Martens 已提交
1460
void brpoplpushCommand(redisClient *c);
1461
void appendCommand(redisClient *c);
A
antirez 已提交
1462
void strlenCommand(redisClient *c);
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
void zrankCommand(redisClient *c);
void zrevrankCommand(redisClient *c);
void hsetCommand(redisClient *c);
void hsetnxCommand(redisClient *c);
void hgetCommand(redisClient *c);
void hmsetCommand(redisClient *c);
void hmgetCommand(redisClient *c);
void hdelCommand(redisClient *c);
void hlenCommand(redisClient *c);
void zremrangebyrankCommand(redisClient *c);
void zunionstoreCommand(redisClient *c);
void zinterstoreCommand(redisClient *c);
void hkeysCommand(redisClient *c);
void hvalsCommand(redisClient *c);
void hgetallCommand(redisClient *c);
void hexistsCommand(redisClient *c);
void configCommand(redisClient *c);
void hincrbyCommand(redisClient *c);
A
antirez 已提交
1481
void hincrbyfloatCommand(redisClient *c);
1482 1483 1484 1485 1486
void subscribeCommand(redisClient *c);
void unsubscribeCommand(redisClient *c);
void psubscribeCommand(redisClient *c);
void punsubscribeCommand(redisClient *c);
void publishCommand(redisClient *c);
A
antirez 已提交
1487
void pubsubCommand(redisClient *c);
1488 1489
void watchCommand(redisClient *c);
void unwatchCommand(redisClient *c);
A
antirez 已提交
1490 1491 1492
void clusterCommand(redisClient *c);
void restoreCommand(redisClient *c);
void migrateCommand(redisClient *c);
1493
void askingCommand(redisClient *c);
1494
void dumpCommand(redisClient *c);
A
antirez 已提交
1495
void objectCommand(redisClient *c);
A
antirez 已提交
1496
void clientCommand(redisClient *c);
1497
void evalCommand(redisClient *c);
A
antirez 已提交
1498
void evalShaCommand(redisClient *c);
1499
void scriptCommand(redisClient *c);
A
antirez 已提交
1500
void timeCommand(redisClient *c);
A
antirez 已提交
1501 1502
void bitopCommand(redisClient *c);
void bitcountCommand(redisClient *c);
A
antirez 已提交
1503
void replconfCommand(redisClient *c);
1504

1505 1506 1507 1508 1509 1510 1511
#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

1512
/* Debugging stuff */
1513
void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1514 1515
void _redisAssert(char *estr, char *file, int line);
void _redisPanic(char *msg, char *file, int line);
A
antirez 已提交
1516
void bugReportStart(void);
1517
void redisLogObjectDebugInfo(robj *o);
1518 1519
void sigsegvHandler(int sig, siginfo_t *info, void *secret);
sds genRedisInfoString(char *section);
A
antirez 已提交
1520 1521 1522
void enableWatchdog(int period);
void disableWatchdog(void);
void watchdogScheduleSignal(int period);
1523
void redisLogHexDump(int level, char *descr, void *value, size_t len);
1524 1525 1526 1527 1528 1529

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

1530
#endif