redis.h 57.4 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
A
antirez 已提交
123
#define REDIS_BINDADDR_MAX 16
124

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

138 139 140
/* Hash table parameters */
#define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */

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

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

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

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

202 203 204 205 206
/* 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 */

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

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

231 232 233 234 235
/* 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
236
#define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
237

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

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

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

/* 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 */
283 284 285
#define AOF_FSYNC_NO 0
#define AOF_FSYNC_ALWAYS 1
#define AOF_FSYNC_EVERYSEC 2
286
#define REDIS_DEFAULT_AOF_FSYNC AOF_FSYNC_EVERYSEC
287 288

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

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

302 303 304 305 306 307
/* 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
308
#define REDIS_MAXMEMORY_NO_EVICTION 5
309
#define REDIS_DEFAULT_MAXMEMORY_POLICY REDIS_MAXMEMORY_VOLATILE_LRU
310

A
antirez 已提交
311
/* Scripting */
312
#define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
313

314 315 316 317
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

318 319 320 321 322
/* 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. */

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

335 336 337 338 339 340 341 342 343 344 345 346 347 348
/* 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 */

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

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

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

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

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

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

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

524
typedef struct clientBufferLimitsConfig {
525 526
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
527 528 529
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

530 531
extern clientBufferLimitsConfig clientBufferLimitsDefaults[REDIS_CLIENT_LIMIT_NUM_CLASSES];

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

A
antirez 已提交
556 557 558 559
/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

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

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

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

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;

826 827 828 829 830 831
/* Structure to hold set iteration abstraction. */
typedef struct {
    robj *subject;
    int encoding;
    int ii; /* intset iterator */
    dictIterator *di;
832
} setTypeIterator;
833

G
guiquanz 已提交
834
/* Structure to hold hash iteration abstraction. Note that iteration over
835 836 837 838
 * 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 {
839
    robj *subject;
840
    int encoding;
841 842

    unsigned char *fptr, *vptr;
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858

    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;
859
extern dictType dbDictType;
A
antirez 已提交
860
extern dictType shaScriptObjectDictType;
861
extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
862
extern dictType hashDictType;
863
extern dictType replScriptCacheDictType;
864 865 866 867 868

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

869 870
/* Utils */
long long ustime(void);
871
long long mstime(void);
872
void getRandomHexChars(char *p, unsigned int len);
873
uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
874
void exitFromChild(int retcode);
875
size_t redisPopcount(void *s, long count);
876
void redisSetProcTitle(char *title);
877

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

921 922 923 924 925 926 927 928 929 930
#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

931 932 933 934 935
/* 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);
936
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
937 938 939 940 941 942 943 944
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);
945
void handleClientsBlockedOnLists(void);
946 947 948 949 950 951
void popGenericCommand(redisClient *c, int where);

/* MULTI/EXEC/WATCH... */
void unwatchAllKeys(redisClient *c);
void initClientMultiState(redisClient *c);
void freeClientMultiState(redisClient *c);
952
void queueMultiCommand(redisClient *c);
953 954
void touchWatchedKey(redisDb *db, robj *key);
void touchWatchedKeysOnFlush(int dbid);
955
void discardTransaction(redisClient *c);
A
antirez 已提交
956
void flagTransaction(redisClient *c);
957 958

/* Redis object implementation */
959 960
void decrRefCount(robj *o);
void decrRefCountVoid(void *o);
961
void incrRefCount(robj *o);
962
robj *resetRefCount(robj *obj);
963 964 965 966 967 968 969 970
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);
971
int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
972 973 974 975
robj *tryObjectEncoding(robj *o);
robj *getDecodedObject(robj *o);
size_t stringObjectLen(robj *o);
robj *createStringObjectFromLongLong(long long value);
A
antirez 已提交
976
robj *createStringObjectFromLongDouble(long double value);
977 978 979
robj *createListObject(void);
robj *createZiplistObject(void);
robj *createSetObject(void);
980
robj *createIntsetObject(void);
981 982
robj *createHashObject(void);
robj *createZsetObject(void);
983
robj *createZsetZiplistObject(void);
984 985 986 987 988
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 已提交
989 990
int getLongDoubleFromObject(robj *o, long double *target);
int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
991 992 993
char *strEncoding(int encoding);
int compareStringObjects(robj *a, robj *b);
int equalStringObjects(robj *a, robj *b);
994
unsigned long estimateObjectIdleTime(robj *o);
995

996
/* Synchronous I/O with timeout */
997 998 999
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);
1000

1001 1002
/* Replication */
void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
1003
void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc);
1004
void updateSlavesWaitingBgsave(int bgsaveerr);
1005
void replicationCron(void);
1006 1007 1008
void replicationHandleMasterDisconnection(void);
void replicationCacheMaster(redisClient *c);
void resizeReplicationBacklog(long long newsize);
1009
void refreshGoodSlavesCount(void);
1010 1011 1012 1013
void replicationScriptCacheInit(void);
void replicationScriptCacheFlush(void);
void replicationScriptCacheAdd(sds sha1);
int replicationScriptCacheExists(sds sha1);
1014

1015 1016 1017 1018 1019
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

1020
/* RDB persistence */
1021
#include "rdb.h"
1022 1023

/* AOF persistence */
1024
void flushAppendOnlyFile(int force);
1025 1026 1027 1028 1029 1030
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);
1031
void backgroundRewriteDoneHandler(int exitcode, int bysignal);
1032 1033
void aofRewriteBufferReset(void);
unsigned long aofRewriteBufferSize(void);
1034 1035

/* Sorted sets data type */
1036 1037 1038 1039 1040 1041 1042

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

1043 1044
zskiplist *zslCreate(void);
void zslFree(zskiplist *zsl);
1045
zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
1046
unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
1047 1048
int zslDelete(zskiplist *zsl, double score, robj *obj);
zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
1049 1050 1051
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);
1052 1053
unsigned int zsetLength(robj *zobj);
void zsetConvert(robj *zobj, int encoding);
1054 1055

/* Core functions */
1056
int freeMemoryIfNeeded(void);
1057
int processCommand(redisClient *c);
1058
void setupSignalHandlers(void);
1059 1060
struct redisCommand *lookupCommand(sds name);
struct redisCommand *lookupCommandByCString(char *s);
1061
struct redisCommand *lookupCommandOrOriginal(sds name);
1062
void call(redisClient *c, int flags);
A
antirez 已提交
1063
void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
1064
void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
A
antirez 已提交
1065
void forceCommandPropagation(redisClient *c, int flags);
1066
int prepareForShutdown();
1067 1068 1069 1070
#ifdef __GNUC__
void redisLog(int level, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
#else
1071
void redisLog(int level, const char *fmt, ...);
1072
#endif
1073
void redisLogRaw(int level, const char *msg);
A
antirez 已提交
1074
void redisLogFromHandler(int level, const char *msg);
1075 1076 1077 1078
void usage();
void updateDictResizePolicy(void);
int htNeedsResize(dict *dict);
void oom(const char *msg);
1079
void populateCommandTable(void);
1080
void resetCommandTableStats(void);
A
antirez 已提交
1081
void adjustOpenFilesLimit(void);
1082

1083 1084 1085 1086 1087
/* 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);
1088 1089
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
1090 1091
int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
robj *setTypeNextObject(setTypeIterator *si);
A
antirez 已提交
1092
int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
1093 1094 1095
unsigned long setTypeSize(robj *subject);
void setTypeConvert(robj *subject, int enc);

1096
/* Hash data type */
1097
void hashTypeConvert(robj *o, int enc);
1098 1099
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
1100
robj *hashTypeGetObject(robj *o, robj *key);
1101 1102 1103 1104 1105 1106 1107
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);
1108 1109 1110 1111 1112
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 已提交
1113
robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
1114 1115 1116 1117 1118 1119 1120
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);
1121
int pubsubPublishMessage(robj *channel, robj *message);
1122 1123 1124 1125 1126

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

/* Configuration */
1129
void loadServerConfig(char *filename, char *options);
1130 1131 1132 1133 1134
void appendServerSaveParams(time_t seconds, int changes);
void resetServerSaveParams();

/* db.c -- Keyspace access API */
int removeExpire(redisDb *db, robj *key);
1135
void propagateExpire(redisDb *db, robj *key);
1136
int expireIfNeeded(redisDb *db, robj *key);
1137 1138
long long getExpire(redisDb *db, robj *key);
void setExpire(redisDb *db, robj *key, long long when);
1139 1140 1141 1142 1143
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);
1144 1145 1146
void dbAdd(redisDb *db, robj *key, robj *val);
void dbOverwrite(redisDb *db, robj *key, robj *val);
void setKey(redisDb *db, robj *key, robj *val);
1147 1148 1149 1150 1151
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);
1152 1153
void signalModifiedKey(redisDb *db, robj *key);
void signalFlushedDb(int dbid);
A
antirez 已提交
1154
unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
1155

1156 1157 1158 1159 1160 1161 1162 1163 1164
/* 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);

1165 1166 1167 1168 1169 1170
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);

1171 1172 1173
/* Scripting */
void scriptingInit(void);

1174 1175 1176
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);
1177
uint64_t redisBuildId(void);
1178 1179 1180 1181 1182 1183 1184 1185

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

1317 1318 1319 1320 1321 1322 1323
#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

1324
/* Debugging stuff */
1325
void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1326 1327
void _redisAssert(char *estr, char *file, int line);
void _redisPanic(char *msg, char *file, int line);
A
antirez 已提交
1328
void bugReportStart(void);
1329
void redisLogObjectDebugInfo(robj *o);
1330 1331
void sigsegvHandler(int sig, siginfo_t *info, void *secret);
sds genRedisInfoString(char *section);
A
antirez 已提交
1332 1333 1334
void enableWatchdog(int period);
void disableWatchdog(void);
void watchdogScheduleSignal(int period);
1335
void redisLogHexDump(int level, char *descr, void *value, size_t len);
1336 1337 1338 1339 1340 1341

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

1342
#endif