redis.h 56.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 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

124 125 126 127
/* 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 */
128
#define REDIS_INLINE_MAX_SIZE   (1024*64) /* Max size of inline reads */
129
#define REDIS_MBULK_BIG_ARG     (1024*32)
130
#define REDIS_LONGSTR_SIZE      21          /* Bytes needed for long -> str */
131
#define REDIS_AOF_AUTOSYNC_BYTES (1024*1024*32) /* fdatasync every 32MB */
A
7c6da73  
antirez 已提交
132

133 134 135
/* Hash table parameters */
#define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */

136 137 138 139 140 141 142 143
/* 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 */
#define REDIS_CMD_FORCE_REPLICATION 8       /* "f" flag */
#define REDIS_CMD_ADMIN 16                  /* "a" flag */
#define REDIS_CMD_PUBSUB 32                 /* "p" flag */
144 145
#define REDIS_CMD_NOSCRIPT  64              /* "s" flag */
#define REDIS_CMD_RANDOM 128                /* "R" flag */
146
#define REDIS_CMD_SORT_FOR_SCRIPT 256       /* "S" flag */
147 148
#define REDIS_CMD_LOADING 512               /* "l" flag */
#define REDIS_CMD_STALE 1024                /* "t" flag */
149
#define REDIS_CMD_SKIP_MONITOR 2048         /* "M" flag */
150 151 152 153 154 155 156

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

158 159 160 161 162 163 164 165 166
/* 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 */
167
#define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
168
#define REDIS_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
169 170 171 172 173 174 175

/* 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 已提交
176
 * 10|000000 [32 bit integer] => if it's 10, a full 32 bit len will follow
177 178 179 180
 * 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 已提交
181
 * Lengths up to 63 are stored using a single byte, most DB keys, and may
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
 * 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 */

197 198 199 200 201
/* 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 */

202
/* Client flags */
A
antirez 已提交
203 204 205 206 207 208 209 210 211 212 213 214 215 216
#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 */
217
#define REDIS_MASTER_FORCE_REPLY (1<<13)  /* Queue replies even if is master */
218 219 220 221

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

223 224 225 226 227
/* 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
228
#define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
229

230
/* Slave replication state - from the point of view of the slave. */
231 232
#define REDIS_REPL_NONE 0 /* No active replication */
#define REDIS_REPL_CONNECT 1 /* Must connect to master */
233
#define REDIS_REPL_CONNECTING 2 /* Connecting to master */
234 235 236
#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 */
237

238 239
/* Slave replication state - from the point of view of the master.
 * In SEND_BULK and ONLINE state the slave receives new updates
240 241
 * 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. */
242 243 244 245 246 247 248
#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
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264

/* 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 已提交
265
#define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
266
#define REDIS_DEFAULT_VERBOSITY REDIS_NOTICE
267 268 269 270 271 272 273 274

/* 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 */
275 276 277
#define AOF_FSYNC_NO 0
#define AOF_FSYNC_ALWAYS 1
#define AOF_FSYNC_EVERYSEC 2
278
#define REDIS_DEFAULT_AOF_FSYNC AOF_FSYNC_EVERYSEC
279 280

/* Zip structure related defaults */
281 282
#define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
#define REDIS_HASH_MAX_ZIPLIST_VALUE 64
283 284 285
#define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
#define REDIS_LIST_MAX_ZIPLIST_VALUE 64
#define REDIS_SET_MAX_INTSET_ENTRIES 512
286 287
#define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
#define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
288 289 290 291 292 293

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

294 295 296 297 298 299
/* 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
300
#define REDIS_MAXMEMORY_NO_EVICTION 5
301
#define REDIS_DEFAULT_MAXMEMORY_POLICY REDIS_MAXMEMORY_VOLATILE_LRU
302

A
antirez 已提交
303
/* Scripting */
304
#define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
305

306 307 308 309
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

310 311 312 313 314
/* 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. */

315 316 317 318 319 320 321
/* 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 已提交
322 323 324 325 326
/* Command propagation flags, see propagate() function */
#define REDIS_PROPAGATE_NONE 0
#define REDIS_PROPAGATE_AOF 1
#define REDIS_PROPAGATE_REPL 2

327 328 329 330 331 332 333 334 335 336 337 338 339 340
/* 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 */

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

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

G
guiquanz 已提交
369
/* Macro used to initialize a Redis object allocated on the stack.
370 371 372 373 374 375 376 377 378 379 380 381 382 383
 * 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) */
384
    dict *ready_keys;           /* Blocked keys that received a PUSH */
385 386 387 388 389 390 391 392 393 394 395 396 397 398
    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 */
399 400
    int minreplicas;        /* MINREPLICAS for synchronous replication */
    time_t minreplicas_timeout; /* MINREPLICAS timeout as unixtime. */
401 402
} multiState;

403
typedef struct blockingState {
404
    dict *keys;             /* The keys we are waiting to terminate a blocking
405 406
                             * operation such as BLPOP. Otherwise NULL. */
    time_t timeout;         /* Blocking operation timeout. If UNIX current time
407
                             * is > timeout then the operation timed out. */
408 409 410 411
    robj *target;           /* The key that should receive the element,
                             * for BRPOPLPUSH. */
} blockingState;

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
/* 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 已提交
428
/* With multiplexing we need to take per-client state.
429 430 431 432 433
 * Clients are taken in a liked list. */
typedef struct redisClient {
    int fd;
    redisDb *db;
    int dictid;
434
    robj *name;             /* As set by CLIENT SETNAME */
435
    sds querybuf;
436
    size_t querybuf_peak;   /* Recent (100ms or more) peak of querybuf size */
437 438
    int argc;
    robj **argv;
439
    struct redisCommand *cmd, *lastcmd;
440 441 442
    int reqtype;
    int multibulklen;       /* number of multi bulk arguments left to read */
    long bulklen;           /* length of bulk argument in multi bulk request */
443
    list *reply;
444
    unsigned long reply_bytes; /* Tot bytes of objects in reply list */
445 446
    int sentlen;            /* Amount of bytes already sent in the current
                               buffer or object being sent. */
447
    time_t ctime;           /* Client creation time */
448
    time_t lastinteraction; /* time of the last interaction, used for timeout */
449
    time_t obuf_soft_limit_reached_time;
450 451 452 453 454 455
    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 */
456
    long long reploff;      /* replication offset if this is our master */
A
antirez 已提交
457 458
    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 */
459
    char replrunid[REDIS_RUN_ID_SIZE+1]; /* master run id if this is a master */
A
antirez 已提交
460
    int slave_listening_port; /* As configured with: SLAVECONF listening-port */
461
    multiState mstate;      /* MULTI/EXEC state */
462
    blockingState bpop;   /* blocking state */
463 464 465 466 467
    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) */
468 469 470

    /* Response buffer */
    int bufpos;
471
    char buf[REDIS_REPLY_CHUNK_BYTES];
472 473 474 475 476 477 478 479 480 481 482
} 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,
483
    *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
484
    *masterdownerr, *roslaveerr, *execaborterr, *noautherr, *noreplicaserr,
485
    *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
486
    *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
487
    *lpush,
488
    *select[REDIS_SHARED_SELECT_CMDS],
489 490 491
    *integers[REDIS_SHARED_INTEGERS],
    *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
    *bulkhdr[REDIS_SHARED_BULKHDR_LEN];  /* "$<value>\r\n" */
492 493
};

494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
/* 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;

516
typedef struct clientBufferLimitsConfig {
517 518
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
519 520 521
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

522 523
extern clientBufferLimitsConfig clientBufferLimitsDefaults[REDIS_CLIENT_LIMIT_NUM_CLASSES];

524 525 526 527 528 529 530
/* 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 {
531 532 533
    robj **argv;
    int argc, dbid, target;
    struct redisCommand *cmd;
534 535 536 537 538 539 540 541 542 543 544 545 546
} 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;
547

A
antirez 已提交
548 549 550 551
/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

552
struct redisServer {
553
    /* General */
554
    char *configfile;           /* Absolute config file path, or NULL */
555
    int hz;                     /* serverCron() calls frequency in hertz */
556
    redisDb *db;
557 558
    dict *commands;             /* Command table */
    dict *orig_commands;        /* Command table before command renaming. */
559
    aeEventLoop *el;
560 561 562 563 564 565
    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 */
566
    int arch_bits;              /* 32 or 64 depending on sizeof(long) */
567
    int cronloops;              /* Number of times the cron function run */
A
antirez 已提交
568
    char runid[REDIS_RUN_ID_SIZE+1];  /* ID always different at every exec. */
569
    int sentinel_mode;          /* True if this instance is a Sentinel. */
570
    /* Networking */
571 572 573 574 575 576 577
    int port;                   /* TCP listening port */
    char *bindaddr;             /* Bind address or NULL */
    char *unixsocket;           /* UNIX socket path */
    mode_t unixsocketperm;      /* UNIX socket permission */
    int ipfd;                   /* TCP socket file descriptor */
    int sofd;                   /* Unix socket file descriptor */
    list *clients;              /* List of active clients */
578
    list *clients_to_close;     /* Clients to close asynchronously */
579
    list *slaves, *monitors;    /* List of slaves and MONITORs */
580
    redisClient *current_client; /* Current client, only used on crash report */
581
    char neterr[ANET_ERR_LEN];  /* Error buffer for anet.c */
582
    /* RDB / AOF loading information */
583
    int loading;                /* We are loading data from disk if true */
584 585 586
    off_t loading_total_bytes;
    off_t loading_loaded_bytes;
    time_t loading_start_time;
587
    /* Fast pointers to often looked up command */
588 589
    struct redisCommand *delCommand, *multiCommand, *lpushCommand, *lpopCommand,
                        *rpopCommand;
590
    /* Fields used only for stats */
591 592 593 594 595 596 597 598
    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 已提交
599
    long long stat_fork_time;       /* Time needed to perform latest fork() */
600
    long long stat_rejected_conn;   /* Clients rejected because of maxclients */
601 602 603
    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. */
604 605 606 607
    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 */
608 609 610 611 612 613
    /* 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;
614
    /* Configuration */
615 616
    int verbosity;                  /* Loglevel in redis.conf */
    int maxidletime;                /* Client timeout in seconds */
617
    int tcpkeepalive;               /* Set SO_KEEPALIVE if non-zero. */
A
antirez 已提交
618
    int active_expire_enabled;      /* Can be disabled for testing purposes. */
619 620 621
    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 */
622
    clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES];
623 624
    /* AOF persistence */
    int aof_state;                  /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
625 626 627 628 629 630 631 632
    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 已提交
633
    pid_t aof_child_pid;            /* PID if rewriting process */
634
    list *aof_rewrite_buf_blocks;   /* Hold changes during an AOF rewrite. */
A
antirez 已提交
635 636 637
    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 */
638
    time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
A
antirez 已提交
639
    time_t aof_last_fsync;            /* UNIX time of last fsync() */
640 641
    time_t aof_rewrite_time_last;   /* Time used by last AOF rewrite run. */
    time_t aof_rewrite_time_start;  /* Current AOF rewrite start time. */
642
    int aof_lastbgrewrite_status;   /* REDIS_OK or REDIS_ERR */
643
    unsigned long aof_delayed_fsync;  /* delayed AOF fsync() counter */
644
    int aof_rewrite_incremental_fsync;/* fsync incrementally while rewriting? */
645 646 647
    /* 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 已提交
648
    pid_t rdb_child_pid;            /* PID of RDB saving child */
649 650
    struct saveparam *saveparams;   /* Save points array for RDB */
    int saveparamslen;              /* Number of saving points */
A
antirez 已提交
651 652
    char *rdb_filename;             /* Name of RDB file */
    int rdb_compression;            /* Use compression in RDB? */
653
    int rdb_checksum;               /* Use RDB checksum? */
G
guiquanz 已提交
654
    time_t lastsave;                /* Unix time of last successful save */
655
    time_t lastbgsave_try;          /* Unix time of last attempted bgsave */
656 657
    time_t rdb_save_time_last;      /* Time used by last RDB save run. */
    time_t rdb_save_time_start;     /* Current RDB save start time. */
658
    int lastbgsave_status;          /* REDIS_OK or REDIS_ERR */
659
    int stop_writes_on_bgsave_err;  /* Don't allow writes if can't BGSAVE */
660
    /* Propagation of commands in AOF / replication */
661
    redisOpArray also_propagate;    /* Additional command to propagate. */
662
    /* Logging */
663 664 665 666
    char *logfile;                  /* Path of log file */
    int syslog_enabled;             /* Is syslog enabled? */
    char *syslog_ident;             /* Syslog ident */
    int syslog_facility;            /* Syslog facility */
667 668 669 670 671 672 673 674 675 676 677 678 679 680
    /* 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. */
681 682 683
    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. */
684
    /* Replication (slave) */
685 686 687 688 689
    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 */
690
    redisClient *cached_master; /* Cached master to be reused for PSYNC. */
691
    int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
A
antirez 已提交
692
    int repl_state;          /* Replication status if the instance is a slave */
693 694 695
    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. */
696 697 698 699
    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 */
700
    int repl_serve_stale_data; /* Serve stale data when link is down? */
701
    int repl_slave_ro;          /* Slave is read only? */
702
    time_t repl_down_since; /* Unix time at which link with master went down */
703
    int repl_disable_tcp_nodelay;   /* Disable TCP_NODELAY after SYNC? */
704
    int slave_priority;             /* Reported in INFO and used by Sentinel. */
705 706
    char repl_master_runid[REDIS_RUN_ID_SIZE+1];  /* Master run id for PSYNC. */
    long long repl_master_initial_offset;         /* Master PSYNC offset. */
707
    /* Limits */
708 709
    unsigned int maxclients;        /* Max number of simultaneous clients */
    unsigned long long maxmemory;   /* Max number of memory bytes to use */
G
guiquanz 已提交
710
    int maxmemory_policy;           /* Policy for key eviction */
711
    int maxmemory_samples;          /* Pricision of random sampling */
712
    /* Blocked clients */
713
    unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */
714
    list *unblocked_clients; /* list of clients to unblock before next loop */
715
    list *ready_keys;        /* List of readyList structures for BLPOP & co */
716 717 718 719 720
    /* 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;
721
    /* Zip structure config, see redis.conf for more information  */
722 723
    size_t hash_max_ziplist_entries;
    size_t hash_max_ziplist_value;
724 725
    size_t list_max_ziplist_entries;
    size_t list_max_ziplist_value;
726
    size_t set_max_intset_entries;
727 728
    size_t zset_max_ziplist_entries;
    size_t zset_max_ziplist_value;
729
    time_t unixtime;        /* Unix time sampled every second. */
730
    /* Pubsub */
731 732
    dict *pubsub_channels;  /* Map channels to list of subscribed clients */
    list *pubsub_patterns;  /* A list of pubsub_patterns */
733 734
    int notify_keyspace_events; /* Events to propagate via Pub/Sub. This is an
                                   xor of REDIS_NOTIFY... flags. */
735
    /* Scripting */
736
    lua_State *lua; /* The Lua interpreter. We use just one for all clients */
737 738 739 740 741
    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 */
742 743
    int lua_write_dirty;  /* True if a write command was called during the
                             execution of the current script. */
744
    int lua_random_dirty; /* True if a random command was called during the
745
                             execution of the current script. */
746 747
    int lua_timedout;     /* True if we reached the time limit for script
                             execution. */
748
    int lua_kill;         /* Kill the script if true. */
G
guiquanz 已提交
749
    /* Assert & bug reporting */
A
antirez 已提交
750 751 752
    char *assert_failed;
    char *assert_file;
    int assert_line;
753
    int bug_report_start; /* True if bug report header was already logged. */
A
antirez 已提交
754
    int watchdog_period;  /* Software watchdog period in ms. 0 = off */
755 756 757 758 759 760 761 762
};

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

typedef void redisCommandProc(redisClient *c);
763
typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
764 765 766 767
struct redisCommand {
    char *name;
    redisCommandProc *proc;
    int arity;
G
guiquanz 已提交
768
    char *sflags; /* Flags as string representation, one char per flag. */
769
    int flags;    /* The actual flags, obtained from the 'sflags' field. */
770
    /* Use a function to determine keys arguments in a command line. */
771
    redisGetKeysProc *getkeys_proc;
772
    /* What keys should be loaded in background when calling this command? */
773
    int firstkey; /* The first argument that's a key (0 = no keys) */
G
guiquanz 已提交
774
    int lastkey;  /* The last argument that's a key */
775
    int keystep;  /* The step between first and last key */
776
    long long microseconds, calls;
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
};

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;

813 814 815 816 817 818
/* Structure to hold set iteration abstraction. */
typedef struct {
    robj *subject;
    int encoding;
    int ii; /* intset iterator */
    dictIterator *di;
819
} setTypeIterator;
820

G
guiquanz 已提交
821
/* Structure to hold hash iteration abstraction. Note that iteration over
822 823 824 825
 * 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 {
826
    robj *subject;
827
    int encoding;
828 829

    unsigned char *fptr, *vptr;
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845

    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;
846
extern dictType dbDictType;
A
antirez 已提交
847
extern dictType shaScriptObjectDictType;
848
extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
849
extern dictType hashDictType;
850 851 852 853 854

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

855 856
/* Utils */
long long ustime(void);
857
long long mstime(void);
858
void getRandomHexChars(char *p, unsigned int len);
859
uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
860
void exitFromChild(int retcode);
861
void redisSetProcTitle(char *title);
862

863 864 865 866
/* networking.c -- Networking and Client related operations */
redisClient *createClient(int fd);
void closeTimedoutClients(void);
void freeClient(redisClient *c);
867
void freeClientAsync(redisClient *c);
868 869 870
void resetClient(redisClient *c);
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
void addReply(redisClient *c, robj *obj);
871 872
void *addDeferredMultiBulkLength(redisClient *c);
void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
873 874
void addReplySds(redisClient *c, sds s);
void processInputBuffer(redisClient *c);
875 876
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
877 878 879
void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
void addReplyBulk(redisClient *c, robj *obj);
void addReplyBulkCString(redisClient *c, char *s);
880 881
void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
void addReplyBulkLongLong(redisClient *c, long long ll);
882 883 884
void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void addReply(redisClient *c, robj *obj);
void addReplySds(redisClient *c, sds s);
885 886
void addReplyError(redisClient *c, char *err);
void addReplyStatus(redisClient *c, char *status);
887 888
void addReplyDouble(redisClient *c, double d);
void addReplyLongLong(redisClient *c, long long ll);
889
void addReplyMultiBulkLen(redisClient *c, long length);
890
void copyClientOutputBuffer(redisClient *dst, redisClient *src);
891
void *dupClientReplyValue(void *o);
892 893
void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer);
894
sds getClientInfoString(redisClient *client);
895
sds getAllClientsInfoString(void);
896
void rewriteClientCommandVector(redisClient *c, int argc, ...);
897
void rewriteClientCommandArgument(redisClient *c, int i, robj *newval);
898
unsigned long getClientOutputBufferMemoryUsage(redisClient *c);
899
void freeClientsInAsyncFreeQueue(void);
900
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c);
901 902
int getClientLimitClassByName(char *name);
char *getClientLimitClassName(int class);
A
antirez 已提交
903
void flushSlavesOutputBuffers(void);
904
void disconnectSlaves(void);
905

906 907 908 909 910 911 912 913 914 915
#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

916 917 918 919 920
/* 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);
921
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
922 923 924 925 926 927 928 929
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);
930
void handleClientsBlockedOnLists(void);
931 932 933 934 935 936
void popGenericCommand(redisClient *c, int where);

/* MULTI/EXEC/WATCH... */
void unwatchAllKeys(redisClient *c);
void initClientMultiState(redisClient *c);
void freeClientMultiState(redisClient *c);
937
void queueMultiCommand(redisClient *c);
938 939
void touchWatchedKey(redisDb *db, robj *key);
void touchWatchedKeysOnFlush(int dbid);
940
void discardTransaction(redisClient *c);
A
antirez 已提交
941
void flagTransaction(redisClient *c);
942 943

/* Redis object implementation */
944 945
void decrRefCount(robj *o);
void decrRefCountVoid(void *o);
946
void incrRefCount(robj *o);
947
robj *resetRefCount(robj *obj);
948 949 950 951 952 953 954 955
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);
956
int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
957 958 959 960
robj *tryObjectEncoding(robj *o);
robj *getDecodedObject(robj *o);
size_t stringObjectLen(robj *o);
robj *createStringObjectFromLongLong(long long value);
A
antirez 已提交
961
robj *createStringObjectFromLongDouble(long double value);
962 963 964
robj *createListObject(void);
robj *createZiplistObject(void);
robj *createSetObject(void);
965
robj *createIntsetObject(void);
966 967
robj *createHashObject(void);
robj *createZsetObject(void);
968
robj *createZsetZiplistObject(void);
969 970 971 972 973
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 已提交
974 975
int getLongDoubleFromObject(robj *o, long double *target);
int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
976 977 978
char *strEncoding(int encoding);
int compareStringObjects(robj *a, robj *b);
int equalStringObjects(robj *a, robj *b);
979
unsigned long estimateObjectIdleTime(robj *o);
980

981
/* Synchronous I/O with timeout */
982 983 984
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);
985

986 987
/* Replication */
void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
988
void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc);
989
void updateSlavesWaitingBgsave(int bgsaveerr);
990
void replicationCron(void);
991 992 993
void replicationHandleMasterDisconnection(void);
void replicationCacheMaster(redisClient *c);
void resizeReplicationBacklog(long long newsize);
994
void refreshGoodSlavesCount(void);
995

996 997 998 999 1000
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

1001
/* RDB persistence */
1002
#include "rdb.h"
1003 1004

/* AOF persistence */
1005
void flushAppendOnlyFile(int force);
1006 1007 1008 1009 1010 1011
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);
1012
void backgroundRewriteDoneHandler(int exitcode, int bysignal);
1013 1014
void aofRewriteBufferReset(void);
unsigned long aofRewriteBufferSize(void);
1015 1016

/* Sorted sets data type */
1017 1018 1019 1020 1021 1022 1023

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

1024 1025
zskiplist *zslCreate(void);
void zslFree(zskiplist *zsl);
1026
zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
1027
unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
1028 1029
int zslDelete(zskiplist *zsl, double score, robj *obj);
zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
1030 1031 1032
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);
1033 1034
unsigned int zsetLength(robj *zobj);
void zsetConvert(robj *zobj, int encoding);
1035 1036

/* Core functions */
1037
int freeMemoryIfNeeded(void);
1038
int processCommand(redisClient *c);
1039
void setupSignalHandlers(void);
1040 1041
struct redisCommand *lookupCommand(sds name);
struct redisCommand *lookupCommandByCString(char *s);
1042
struct redisCommand *lookupCommandOrOriginal(sds name);
1043
void call(redisClient *c, int flags);
A
antirez 已提交
1044
void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1045
void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
1046
int prepareForShutdown();
1047 1048 1049 1050
#ifdef __GNUC__
void redisLog(int level, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
#else
1051
void redisLog(int level, const char *fmt, ...);
1052
#endif
1053
void redisLogRaw(int level, const char *msg);
A
antirez 已提交
1054
void redisLogFromHandler(int level, const char *msg);
1055 1056 1057 1058
void usage();
void updateDictResizePolicy(void);
int htNeedsResize(dict *dict);
void oom(const char *msg);
1059
void populateCommandTable(void);
1060
void resetCommandTableStats(void);
1061

1062 1063 1064 1065 1066
/* 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);
1067 1068
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
1069 1070
int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
robj *setTypeNextObject(setTypeIterator *si);
A
antirez 已提交
1071
int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1072 1073 1074
unsigned long setTypeSize(robj *subject);
void setTypeConvert(robj *subject, int enc);

1075
/* Hash data type */
1076
void hashTypeConvert(robj *o, int enc);
1077 1078
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1079
robj *hashTypeGetObject(robj *o, robj *key);
1080 1081 1082 1083 1084 1085 1086
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);
1087 1088 1089 1090 1091
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 已提交
1092
robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1093 1094 1095 1096 1097 1098 1099
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);
1100
int pubsubPublishMessage(robj *channel, robj *message);
1101 1102 1103 1104 1105

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

/* Configuration */
1108
void loadServerConfig(char *filename, char *options);
1109 1110 1111 1112 1113
void appendServerSaveParams(time_t seconds, int changes);
void resetServerSaveParams();

/* db.c -- Keyspace access API */
int removeExpire(redisDb *db, robj *key);
1114
void propagateExpire(redisDb *db, robj *key);
1115
int expireIfNeeded(redisDb *db, robj *key);
1116 1117
long long getExpire(redisDb *db, robj *key);
void setExpire(redisDb *db, robj *key, long long when);
1118 1119 1120 1121 1122
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);
1123 1124 1125
void dbAdd(redisDb *db, robj *key, robj *val);
void dbOverwrite(redisDb *db, robj *key, robj *val);
void setKey(redisDb *db, robj *key, robj *val);
1126 1127 1128 1129 1130
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);
1131 1132
void signalModifiedKey(redisDb *db, robj *key);
void signalFlushedDb(int dbid);
A
antirez 已提交
1133
unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
1134

1135 1136 1137 1138 1139 1140 1141 1142 1143
/* 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);

1144 1145 1146 1147 1148 1149
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);

1150 1151 1152
/* Scripting */
void scriptingInit(void);

1153 1154 1155
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);
1156
uint64_t redisBuildId(void);
1157 1158 1159 1160 1161 1162 1163 1164

/* 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);
1165
void psetexCommand(redisClient *c);
1166 1167 1168
void getCommand(redisClient *c);
void delCommand(redisClient *c);
void existsCommand(redisClient *c);
P
Pieter Noordhuis 已提交
1169 1170
void setbitCommand(redisClient *c);
void getbitCommand(redisClient *c);
1171
void setrangeCommand(redisClient *c);
1172
void getrangeCommand(redisClient *c);
1173 1174 1175 1176
void incrCommand(redisClient *c);
void decrCommand(redisClient *c);
void incrbyCommand(redisClient *c);
void decrbyCommand(redisClient *c);
A
antirez 已提交
1177
void incrbyfloatCommand(redisClient *c);
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
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);
1221
void rpoplpushCommand(redisClient *c);
1222 1223 1224 1225 1226
void infoCommand(redisClient *c);
void mgetCommand(redisClient *c);
void monitorCommand(redisClient *c);
void expireCommand(redisClient *c);
void expireatCommand(redisClient *c);
1227 1228
void pexpireCommand(redisClient *c);
void pexpireatCommand(redisClient *c);
1229 1230
void getsetCommand(redisClient *c);
void ttlCommand(redisClient *c);
1231
void pttlCommand(redisClient *c);
A
antirez 已提交
1232
void persistCommand(redisClient *c);
1233 1234 1235 1236 1237 1238 1239 1240
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);
1241
void zrevrangebyscoreCommand(redisClient *c);
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
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 已提交
1253
void brpoplpushCommand(redisClient *c);
1254
void appendCommand(redisClient *c);
A
antirez 已提交
1255
void strlenCommand(redisClient *c);
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273
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 已提交
1274
void hincrbyfloatCommand(redisClient *c);
1275 1276 1277 1278 1279
void subscribeCommand(redisClient *c);
void unsubscribeCommand(redisClient *c);
void psubscribeCommand(redisClient *c);
void punsubscribeCommand(redisClient *c);
void publishCommand(redisClient *c);
A
antirez 已提交
1280
void pubsubCommand(redisClient *c);
1281 1282
void watchCommand(redisClient *c);
void unwatchCommand(redisClient *c);
A
antirez 已提交
1283 1284
void restoreCommand(redisClient *c);
void migrateCommand(redisClient *c);
1285
void dumpCommand(redisClient *c);
A
antirez 已提交
1286
void objectCommand(redisClient *c);
A
antirez 已提交
1287
void clientCommand(redisClient *c);
1288
void evalCommand(redisClient *c);
A
antirez 已提交
1289
void evalShaCommand(redisClient *c);
1290
void scriptCommand(redisClient *c);
A
antirez 已提交
1291
void timeCommand(redisClient *c);
A
antirez 已提交
1292 1293
void bitopCommand(redisClient *c);
void bitcountCommand(redisClient *c);
A
antirez 已提交
1294
void replconfCommand(redisClient *c);
1295

1296 1297 1298 1299 1300 1301 1302
#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

1303
/* Debugging stuff */
1304
void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1305 1306
void _redisAssert(char *estr, char *file, int line);
void _redisPanic(char *msg, char *file, int line);
A
antirez 已提交
1307
void bugReportStart(void);
1308
void redisLogObjectDebugInfo(robj *o);
1309 1310
void sigsegvHandler(int sig, siginfo_t *info, void *secret);
sds genRedisInfoString(char *section);
A
antirez 已提交
1311 1312 1313
void enableWatchdog(int period);
void disableWatchdog(void);
void watchdogScheduleSignal(int period);
1314
void redisLogHexDump(int level, char *descr, void *value, size_t len);
1315 1316 1317 1318 1319 1320

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

1321
#endif