redis.h 50.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*
 * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Redis nor the names of its contributors may be used
 *     to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
#ifndef __REDIS_H
#define __REDIS_H

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

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

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

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

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

/* Static server configuration */
70
#define REDIS_HZ                100     /* Time interrupt calls/sec. */
71
#define REDIS_SERVERPORT        6379    /* TCP port */
72
#define REDIS_MAXIDLETIME       0       /* default client timeout: infinite */
73 74 75
#define REDIS_DEFAULT_DBNUM     16
#define REDIS_CONFIGLINE_MAX    1024
#define REDIS_EXPIRELOOKUPS_PER_CRON    10 /* lookup 10 expires per loop */
76
#define REDIS_EXPIRELOOKUPS_TIME_PERC   25 /* CPU max % for keys collection */
77
#define REDIS_MAX_WRITE_PER_EVENT (1024*64)
78
#define REDIS_SHARED_SELECT_CMDS 10
79
#define REDIS_SHARED_INTEGERS 10000
80
#define REDIS_SHARED_BULKHDR_LEN 32
J
Jonah H. Harris 已提交
81
#define REDIS_MAX_LOGMSG_LEN    1024 /* Default maximum length of syslog messages */
82 83 84
#define REDIS_AOF_REWRITE_PERC  100
#define REDIS_AOF_REWRITE_MIN_SIZE (1024*1024)
#define REDIS_AOF_REWRITE_ITEMS_PER_CMD 64
85
#define REDIS_SLOWLOG_LOG_SLOWER_THAN 10000
86
#define REDIS_SLOWLOG_MAX_LEN 128
87
#define REDIS_MAX_CLIENTS 10000
88
#define REDIS_AUTHPASS_MAX_LEN 512
89
#define REDIS_DEFAULT_SLAVE_PRIORITY 100
A
7c6da73  
antirez 已提交
90 91
#define REDIS_REPL_TIMEOUT 60
#define REDIS_REPL_PING_SLAVE_PERIOD 10
92
#define REDIS_RUN_ID_SIZE 40
93
#define REDIS_OPS_SEC_SAMPLES 16
94

95 96 97 98
/* 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 */
99
#define REDIS_INLINE_MAX_SIZE   (1024*64) /* Max size of inline reads */
100
#define REDIS_MBULK_BIG_ARG     (1024*32)
A
7c6da73  
antirez 已提交
101

102 103 104
/* Hash table parameters */
#define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */

105 106 107 108 109 110 111 112
/* 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 */
113 114
#define REDIS_CMD_NOSCRIPT  64              /* "s" flag */
#define REDIS_CMD_RANDOM 128                /* "R" flag */
115
#define REDIS_CMD_SORT_FOR_SCRIPT 256       /* "S" flag */
116 117
#define REDIS_CMD_LOADING 512               /* "l" flag */
#define REDIS_CMD_STALE 1024                /* "t" flag */
118
#define REDIS_CMD_SKIP_MONITOR 2048         /* "M" flag */
119 120 121 122 123 124 125

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

127 128 129 130 131 132 133 134 135
/* 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 */
136
#define REDIS_ENCODING_INTSET 6  /* Encoded as intset */
137
#define REDIS_ENCODING_SKIPLIST 7  /* Encoded as skiplist */
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165

/* 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
 * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
 * 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.
 *
 * Lenghts up to 63 are stored using a single byte, most DB keys, and may
 * 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 */

166 167 168 169 170
/* 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 */

171
/* Client flags */
A
antirez 已提交
172 173 174 175 176 177 178 179 180 181 182 183 184 185
#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 */
186 187 188 189

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

191 192 193 194 195
/* 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
196
#define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
197

198
/* Slave replication state - slave side */
199 200
#define REDIS_REPL_NONE 0 /* No active replication */
#define REDIS_REPL_CONNECT 1 /* Must connect to master */
201
#define REDIS_REPL_CONNECTING 2 /* Connecting to master */
202 203 204
#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 */
205

206 207
/* Synchronous read timeout - slave side */
#define REDIS_REPL_SYNCIO_TIMEOUT 5
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232

/* Slave replication state - from the point of view of master
 * Note that in SEND_BULK and ONLINE state the slave receives new updates
 * 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. */
#define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
#define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
#define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
#define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */

/* 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 已提交
233
#define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
234 235 236 237 238 239 240 241

/* 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 */
242 243 244
#define AOF_FSYNC_NO 0
#define AOF_FSYNC_ALWAYS 1
#define AOF_FSYNC_EVERYSEC 2
245 246

/* Zip structure related defaults */
247 248
#define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
#define REDIS_HASH_MAX_ZIPLIST_VALUE 64
249 250 251
#define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
#define REDIS_LIST_MAX_ZIPLIST_VALUE 64
#define REDIS_SET_MAX_INTSET_ENTRIES 512
252 253
#define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
#define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
254 255 256 257 258 259

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

260 261 262 263 264 265
/* 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
266
#define REDIS_MAXMEMORY_NO_EVICTION 5
267

A
antirez 已提交
268
/* Scripting */
269
#define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
A
antirez 已提交
270

271 272 273 274
/* Units */
#define UNIT_SECONDS 0
#define UNIT_MILLISECONDS 1

275 276 277 278 279
/* 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. */

280 281 282 283 284 285 286
/* 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 已提交
287 288 289 290 291
/* Command propagation flags, see propagate() function */
#define REDIS_PROPAGATE_NONE 0
#define REDIS_PROPAGATE_AOF 1
#define REDIS_PROPAGATE_REPL 2

292 293 294 295 296
/* Using the following macro you can run code inside serverCron() with the
 * specified period, specified in milliseconds.
 * The actual resolution depends on REDIS_HZ. */
#define run_with_period(_ms_) if (!(server.cronloops%((_ms_)/(1000/REDIS_HZ))))

297
/* We can print the stacktrace, so our assert is defined this way: */
298
#define redisAssertWithInfo(_c,_o,_e) ((_e)?(void)0 : (_redisAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),_exit(1)))
299 300 301 302 303 304 305 306 307 308
#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 */
309
#define REDIS_LRU_CLOCK_MAX ((1<<21)-1) /* Max value of obj->lru */
310
#define REDIS_LRU_CLOCK_RESOLUTION 10 /* LRU clock resolution in seconds */
311 312
typedef struct redisObject {
    unsigned type:4;
313
    unsigned notused:2;     /* Not used */
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
    unsigned encoding:4;
    unsigned lru:22;        /* lru time (relative to server.lruclock) */
    int refcount;
    void *ptr;
} robj;

/* Macro used to initalize a Redis object allocated on the stack.
 * 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) */
335
    dict *ready_keys;           /* Blocked keys that received a PUSH */
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
    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 */
} multiState;

352
typedef struct blockingState {
353
    dict *keys;             /* The keys we are waiting to terminate a blocking
354 355 356 357 358 359 360
                             * operation such as BLPOP. Otherwise NULL. */
    time_t timeout;         /* Blocking operation timeout. If UNIX current time
                             * is >= timeout then the operation timed out. */
    robj *target;           /* The key that should receive the element,
                             * for BRPOPLPUSH. */
} blockingState;

361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
/* 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;

377 378 379 380 381 382 383
/* With multiplexing we need to take per-clinet state.
 * Clients are taken in a liked list. */
typedef struct redisClient {
    int fd;
    redisDb *db;
    int dictid;
    sds querybuf;
384
    size_t querybuf_peak;   /* Recent (100ms or more) peak of querybuf size */
385 386
    int argc;
    robj **argv;
387
    struct redisCommand *cmd, *lastcmd;
388 389 390
    int reqtype;
    int multibulklen;       /* number of multi bulk arguments left to read */
    long bulklen;           /* length of bulk argument in multi bulk request */
391
    list *reply;
392
    unsigned long reply_bytes; /* Tot bytes of objects in reply list */
393
    int sentlen;
394
    time_t ctime;           /* Client creation time */
395
    time_t lastinteraction; /* time of the last interaction, used for timeout */
396
    time_t obuf_soft_limit_reached_time;
397 398 399 400 401 402 403
    int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
    int slaveseldb;         /* slave selected db, if this client is a slave */
    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 */
A
antirez 已提交
404
    int slave_listening_port; /* As configured with: SLAVECONF listening-port */
405
    multiState mstate;      /* MULTI/EXEC state */
406
    blockingState bpop;   /* blocking state */
407 408 409 410 411
    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) */
412 413 414

    /* Response buffer */
    int bufpos;
415
    char buf[REDIS_REPLY_CHUNK_BYTES];
416 417 418 419 420 421 422 423 424 425 426
} 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,
427
    *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
A
antirez 已提交
428
    *masterdownerr, *roslaveerr, *execaborterr,
429
    *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk,
430
    *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *rpop, *lpop,
431
    *lpush,
432
    *select[REDIS_SHARED_SELECT_CMDS],
433 434 435
    *integers[REDIS_SHARED_INTEGERS],
    *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
    *bulkhdr[REDIS_SHARED_BULKHDR_LEN];  /* "$<value>\r\n" */
436 437
};

438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
/* 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;

460
typedef struct clientBufferLimitsConfig {
461 462
    unsigned long long hard_limit_bytes;
    unsigned long long soft_limit_bytes;
463 464 465
    time_t soft_limit_seconds;
} clientBufferLimitsConfig;

466 467 468 469 470 471 472
/* 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 {
473 474 475
    robj **argv;
    int argc, dbid, target;
    struct redisCommand *cmd;
476 477 478 479 480 481 482 483 484 485 486 487 488
} 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;
489

A
antirez 已提交
490 491 492 493
/*-----------------------------------------------------------------------------
 * Global server state
 *----------------------------------------------------------------------------*/

494
struct redisServer {
495 496
    /* General */
    redisDb *db;
497
    dict *commands;             /* Command table hash table */
498
    aeEventLoop *el;
499 500 501 502 503 504
    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 */
505
    int arch_bits;              /* 32 or 64 depending on sizeof(long) */
506
    int cronloops;              /* Number of times the cron function run */
A
antirez 已提交
507
    char runid[REDIS_RUN_ID_SIZE+1];  /* ID always different at every exec. */
508
    int sentinel_mode;          /* True if this instance is a Sentinel. */
509
    /* Networking */
510 511 512 513 514 515 516
    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 */
517
    list *clients_to_close;     /* Clients to close asynchronously */
518
    list *slaves, *monitors;    /* List of slaves and MONITORs */
519
    redisClient *current_client; /* Current client, only used on crash report */
520
    char neterr[ANET_ERR_LEN];  /* Error buffer for anet.c */
521
    /* RDB / AOF loading information */
522
    int loading;                /* We are loading data from disk if true */
523 524 525
    off_t loading_total_bytes;
    off_t loading_loaded_bytes;
    time_t loading_start_time;
526
    /* Fast pointers to often looked up command */
527 528
    struct redisCommand *delCommand, *multiCommand, *lpushCommand, *lpopCommand,
                        *rpopCommand;
529
    /* Fields used only for stats */
530 531 532 533 534 535 536 537 538 539 540 541 542 543
    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 */
    long long stat_fork_time;       /* Time needed to perform latets fork() */
    long long stat_rejected_conn;   /* Clients rejected because of maxclients */
    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 */
544 545 546 547 548 549
    /* 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;
550
    /* Configuration */
551 552 553 554 555
    int verbosity;                  /* Loglevel in redis.conf */
    int maxidletime;                /* Client timeout in seconds */
    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 */
556
    clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES];
557 558
    /* AOF persistence */
    int aof_state;                  /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
559 560 561 562 563 564 565 566
    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 已提交
567
    pid_t aof_child_pid;            /* PID if rewriting process */
568
    list *aof_rewrite_buf_blocks;   /* Hold changes during an AOF rewrite. */
A
antirez 已提交
569 570 571
    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 */
572
    time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
A
antirez 已提交
573
    time_t aof_last_fsync;            /* UNIX time of last fsync() */
574 575
    time_t aof_rewrite_time_last;   /* Time used by last AOF rewrite run. */
    time_t aof_rewrite_time_start;  /* Current AOF rewrite start time. */
576
    int aof_lastbgrewrite_status;   /* REDIS_OK or REDIS_ERR */
577
    unsigned long aof_delayed_fsync;  /* delayed AOF fsync() counter */
578 579 580
    /* 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 已提交
581
    pid_t rdb_child_pid;            /* PID of RDB saving child */
582 583
    struct saveparam *saveparams;   /* Save points array for RDB */
    int saveparamslen;              /* Number of saving points */
A
antirez 已提交
584 585
    char *rdb_filename;             /* Name of RDB file */
    int rdb_compression;            /* Use compression in RDB? */
586
    int rdb_checksum;               /* Use RDB checksum? */
587
    time_t lastsave;                /* Unix time of last save succeeede */
588 589
    time_t rdb_save_time_last;      /* Time used by last RDB save run. */
    time_t rdb_save_time_start;     /* Current RDB save start time. */
590
    int lastbgsave_status;          /* REDIS_OK or REDIS_ERR */
591
    int stop_writes_on_bgsave_err;  /* Don't allow writes if can't BGSAVE */
592
    /* Propagation of commands in AOF / replication */
593
    redisOpArray also_propagate;    /* Additional command to propagate. */
594
    /* Logging */
595 596 597 598
    char *logfile;                  /* Path of log file */
    int syslog_enabled;             /* Is syslog enabled? */
    char *syslog_ident;             /* Syslog ident */
    int syslog_facility;            /* Syslog facility */
599
    /* Slave specific fields */
600 601 602
    char *masterauth;               /* AUTH with this password with master */
    char *masterhost;               /* Hostname of master */
    int masterport;                 /* Port of master */
603
    int repl_ping_slave_period;     /* Master pings the slave every N seconds */
604 605 606
    int repl_timeout;               /* Timeout after N seconds of master idle */
    redisClient *master;     /* Client that is master for this slave */
    int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
A
antirez 已提交
607
    int repl_state;          /* Replication status if the instance is a slave */
608 609 610
    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. */
611 612 613 614
    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 */
615
    int repl_serve_stale_data; /* Serve stale data when link is down? */
616
    int repl_slave_ro;          /* Slave is read only? */
617
    time_t repl_down_since; /* Unix time at which link with master went down */
618
    int slave_priority;             /* Reported in INFO and used by Sentinel. */
619
    /* Limits */
620 621 622 623
    unsigned int maxclients;        /* Max number of simultaneous clients */
    unsigned long long maxmemory;   /* Max number of memory bytes to use */
    int maxmemory_policy;           /* Policy for key evition */
    int maxmemory_samples;          /* Pricision of random sampling */
624
    /* Blocked clients */
625
    unsigned int bpop_blocked_clients; /* Number of clients blocked by lists */
626
    list *unblocked_clients; /* list of clients to unblock before next loop */
627
    list *ready_keys;        /* List of readyList structures for BLPOP & co */
628 629 630 631 632
    /* 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;
633
    /* Zip structure config, see redis.conf for more information  */
634 635
    size_t hash_max_ziplist_entries;
    size_t hash_max_ziplist_value;
636 637
    size_t list_max_ziplist_entries;
    size_t list_max_ziplist_value;
638
    size_t set_max_intset_entries;
639 640
    size_t zset_max_ziplist_entries;
    size_t zset_max_ziplist_value;
641
    time_t unixtime;        /* Unix time sampled every second. */
642
    /* Pubsub */
643 644
    dict *pubsub_channels;  /* Map channels to list of subscribed clients */
    list *pubsub_patterns;  /* A list of pubsub_patterns */
645
    /* Scripting */
646
    lua_State *lua; /* The Lua interpreter. We use just one for all clients */
647 648 649 650 651
    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 */
652 653
    int lua_write_dirty;  /* True if a write command was called during the
                             execution of the current script. */
654
    int lua_random_dirty; /* True if a random command was called during the
655
                             execution of the current script. */
656 657
    int lua_timedout;     /* True if we reached the time limit for script
                             execution. */
658
    int lua_kill;         /* Kill the script if true. */
A
antirez 已提交
659 660 661 662
    /* Assert & bug reportign */
    char *assert_failed;
    char *assert_file;
    int assert_line;
663
    int bug_report_start; /* True if bug report header was already logged. */
A
antirez 已提交
664
    int watchdog_period;  /* Software watchdog period in ms. 0 = off */
665 666 667 668 669 670 671 672
};

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

typedef void redisCommandProc(redisClient *c);
673
typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
674 675 676 677
struct redisCommand {
    char *name;
    redisCommandProc *proc;
    int arity;
678 679
    char *sflags; /* Flags as string represenation, one char per flag. */
    int flags;    /* The actual flags, obtained from the 'sflags' field. */
680
    /* Use a function to determine keys arguments in a command line. */
681
    redisGetKeysProc *getkeys_proc;
682
    /* What keys should be loaded in background when calling this command? */
683 684 685
    int firstkey; /* The first argument that's a key (0 = no keys) */
    int lastkey;  /* THe last argument that's a key */
    int keystep;  /* The step between first and last key */
686
    long long microseconds, calls;
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
};

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;

723 724 725 726 727 728
/* Structure to hold set iteration abstraction. */
typedef struct {
    robj *subject;
    int encoding;
    int ii; /* intset iterator */
    dictIterator *di;
729
} setTypeIterator;
730

731 732 733 734 735
/* Structure to hold hash iteration abstration. Note that iteration over
 * 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 {
736
    robj *subject;
737
    int encoding;
738 739

    unsigned char *fptr, *vptr;
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755

    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;
756
extern dictType dbDictType;
A
antirez 已提交
757
extern dictType shaScriptObjectDictType;
758
extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
759
extern dictType hashDictType;
760 761 762 763 764

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

765 766
/* Utils */
long long ustime(void);
767
long long mstime(void);
768
void getRandomHexChars(char *p, unsigned int len);
769
uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l);
770
void exitFromChild(int retcode);
771

772 773 774 775 776 777 778
/* networking.c -- Networking and Client related operations */
redisClient *createClient(int fd);
void closeTimedoutClients(void);
void freeClient(redisClient *c);
void resetClient(redisClient *c);
void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
void addReply(redisClient *c, robj *obj);
779 780
void *addDeferredMultiBulkLength(redisClient *c);
void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
781 782
void addReplySds(redisClient *c, sds s);
void processInputBuffer(redisClient *c);
783 784
void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
785 786 787
void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
void addReplyBulk(redisClient *c, robj *obj);
void addReplyBulkCString(redisClient *c, char *s);
788 789
void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
void addReplyBulkLongLong(redisClient *c, long long ll);
790 791 792
void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
void addReply(redisClient *c, robj *obj);
void addReplySds(redisClient *c, sds s);
793 794
void addReplyError(redisClient *c, char *err);
void addReplyStatus(redisClient *c, char *status);
795 796
void addReplyDouble(redisClient *c, double d);
void addReplyLongLong(redisClient *c, long long ll);
797
void addReplyMultiBulkLen(redisClient *c, long length);
798
void copyClientOutputBuffer(redisClient *dst, redisClient *src);
799
void *dupClientReplyValue(void *o);
800 801
void getClientsMaxBuffers(unsigned long *longest_output_list,
                          unsigned long *biggest_input_buffer);
802
sds getClientInfoString(redisClient *client);
803
sds getAllClientsInfoString(void);
804
void rewriteClientCommandVector(redisClient *c, int argc, ...);
805
void rewriteClientCommandArgument(redisClient *c, int i, robj *newval);
806
unsigned long getClientOutputBufferMemoryUsage(redisClient *c);
807
void freeClientsInAsyncFreeQueue(void);
808
void asyncCloseClientOnOutputBufferLimitReached(redisClient *c);
809 810
int getClientLimitClassByName(char *name);
char *getClientLimitClassName(int class);
A
antirez 已提交
811
void flushSlavesOutputBuffers(void);
812
void disconnectSlaves(void);
813

814 815 816 817 818 819 820 821 822 823
#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

824 825 826 827 828
/* 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);
829
listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
830 831 832 833 834 835 836 837
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);
838
void handleClientsBlockedOnLists(void);
839 840 841 842 843 844
void popGenericCommand(redisClient *c, int where);

/* MULTI/EXEC/WATCH... */
void unwatchAllKeys(redisClient *c);
void initClientMultiState(redisClient *c);
void freeClientMultiState(redisClient *c);
845
void queueMultiCommand(redisClient *c);
846 847
void touchWatchedKey(redisDb *db, robj *key);
void touchWatchedKeysOnFlush(int dbid);
848
void discardTransaction(redisClient *c);
A
antirez 已提交
849
void flagTransaction(redisClient *c);
850 851 852 853

/* Redis object implementation */
void decrRefCount(void *o);
void incrRefCount(robj *o);
854
robj *resetRefCount(robj *obj);
855 856 857 858 859 860 861 862
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);
863
int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
864 865 866 867
robj *tryObjectEncoding(robj *o);
robj *getDecodedObject(robj *o);
size_t stringObjectLen(robj *o);
robj *createStringObjectFromLongLong(long long value);
A
antirez 已提交
868
robj *createStringObjectFromLongDouble(long double value);
869 870 871
robj *createListObject(void);
robj *createZiplistObject(void);
robj *createSetObject(void);
872
robj *createIntsetObject(void);
873 874
robj *createHashObject(void);
robj *createZsetObject(void);
875
robj *createZsetZiplistObject(void);
876 877 878 879 880
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 已提交
881 882
int getLongDoubleFromObject(robj *o, long double *target);
int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
883 884 885
char *strEncoding(int encoding);
int compareStringObjects(robj *a, robj *b);
int equalStringObjects(robj *a, robj *b);
886
unsigned long estimateObjectIdleTime(robj *o);
887

888
/* Synchronous I/O with timeout */
889 890 891
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);
892

893 894
/* Replication */
void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc);
895
void replicationFeedMonitors(redisClient *c, list *monitors, int dictid, robj **argv, int argc);
896
void updateSlavesWaitingBgsave(int bgsaveerr);
897
void replicationCron(void);
898

899 900 901 902 903
/* Generic persistence functions */
void startLoading(FILE *fp);
void loadingProgress(off_t pos);
void stopLoading(void);

904
/* RDB persistence */
905
#include "rdb.h"
906 907

/* AOF persistence */
908
void flushAppendOnlyFile(int force);
909 910 911 912 913 914
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);
915
void backgroundRewriteDoneHandler(int exitcode, int bysignal);
916 917
void aofRewriteBufferReset(void);
unsigned long aofRewriteBufferSize(void);
918 919

/* Sorted sets data type */
920 921 922 923 924 925 926

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

927 928
zskiplist *zslCreate(void);
void zslFree(zskiplist *zsl);
929
zskiplistNode *zslInsert(zskiplist *zsl, double score, robj *obj);
930
unsigned char *zzlInsert(unsigned char *zl, robj *ele, double score);
931 932
int zslDelete(zskiplist *zsl, double score, robj *obj);
zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
933 934 935
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);
936 937
unsigned int zsetLength(robj *zobj);
void zsetConvert(robj *zobj, int encoding);
938 939

/* Core functions */
940
int freeMemoryIfNeeded(void);
941
int processCommand(redisClient *c);
942
void setupSignalHandlers(void);
943 944
struct redisCommand *lookupCommand(sds name);
struct redisCommand *lookupCommandByCString(char *s);
945
void call(redisClient *c, int flags);
A
antirez 已提交
946
void propagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int flags);
947
void alsoPropagate(struct redisCommand *cmd, int dbid, robj **argv, int argc, int target);
948 949
int prepareForShutdown();
void redisLog(int level, const char *fmt, ...);
950
void redisLogRaw(int level, const char *msg);
A
antirez 已提交
951
void redisLogFromHandler(int level, const char *msg);
952 953 954 955
void usage();
void updateDictResizePolicy(void);
int htNeedsResize(dict *dict);
void oom(const char *msg);
956
void populateCommandTable(void);
957
void resetCommandTableStats(void);
958

959 960 961 962 963
/* 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);
964 965
setTypeIterator *setTypeInitIterator(robj *subject);
void setTypeReleaseIterator(setTypeIterator *si);
966 967
int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
robj *setTypeNextObject(setTypeIterator *si);
A
antirez 已提交
968
int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
969 970 971
unsigned long setTypeSize(robj *subject);
void setTypeConvert(robj *subject, int enc);

972
/* Hash data type */
973
void hashTypeConvert(robj *o, int enc);
974 975
void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
976
robj *hashTypeGetObject(robj *o, robj *key);
977 978 979 980 981 982 983
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);
984 985 986 987 988
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 已提交
989
robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
990 991 992 993 994 995 996
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);
997
int pubsubPublishMessage(robj *channel, robj *message);
998 999

/* Configuration */
1000
void loadServerConfig(char *filename, char *options);
1001 1002 1003 1004 1005
void appendServerSaveParams(time_t seconds, int changes);
void resetServerSaveParams();

/* db.c -- Keyspace access API */
int removeExpire(redisDb *db, robj *key);
1006
void propagateExpire(redisDb *db, robj *key);
1007
int expireIfNeeded(redisDb *db, robj *key);
1008 1009
long long getExpire(redisDb *db, robj *key);
void setExpire(redisDb *db, robj *key, long long when);
1010 1011 1012 1013 1014
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);
1015 1016 1017
void dbAdd(redisDb *db, robj *key, robj *val);
void dbOverwrite(redisDb *db, robj *key, robj *val);
void setKey(redisDb *db, robj *key, robj *val);
1018 1019 1020 1021 1022
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);
1023 1024
void signalModifiedKey(redisDb *db, robj *key);
void signalFlushedDb(int dbid);
A
antirez 已提交
1025
unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
1026

1027 1028 1029 1030 1031 1032 1033 1034 1035
/* 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);

1036 1037 1038 1039 1040 1041
/* Sentinel */
void initSentinelConfig(void);
void initSentinel(void);
void sentinelTimer(void);
char *sentinelHandleConfiguration(char **argv, int argc);

1042 1043 1044
/* Scripting */
void scriptingInit(void);

1045 1046 1047
/* Git SHA1 */
char *redisGitSHA1(void);
char *redisGitDirty(void);
1048
uint64_t redisBuildId(void);
1049 1050 1051 1052 1053 1054 1055 1056

/* 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);
1057
void psetexCommand(redisClient *c);
1058 1059 1060
void getCommand(redisClient *c);
void delCommand(redisClient *c);
void existsCommand(redisClient *c);
P
Pieter Noordhuis 已提交
1061 1062
void setbitCommand(redisClient *c);
void getbitCommand(redisClient *c);
1063
void setrangeCommand(redisClient *c);
1064
void getrangeCommand(redisClient *c);
1065 1066 1067 1068
void incrCommand(redisClient *c);
void decrCommand(redisClient *c);
void incrbyCommand(redisClient *c);
void decrbyCommand(redisClient *c);
A
antirez 已提交
1069
void incrbyfloatCommand(redisClient *c);
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
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);
1113
void rpoplpushCommand(redisClient *c);
1114 1115 1116 1117 1118
void infoCommand(redisClient *c);
void mgetCommand(redisClient *c);
void monitorCommand(redisClient *c);
void expireCommand(redisClient *c);
void expireatCommand(redisClient *c);
1119 1120
void pexpireCommand(redisClient *c);
void pexpireatCommand(redisClient *c);
1121 1122
void getsetCommand(redisClient *c);
void ttlCommand(redisClient *c);
1123
void pttlCommand(redisClient *c);
A
antirez 已提交
1124
void persistCommand(redisClient *c);
1125 1126 1127 1128 1129 1130 1131 1132
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);
1133
void zrevrangebyscoreCommand(redisClient *c);
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
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 已提交
1145
void brpoplpushCommand(redisClient *c);
1146
void appendCommand(redisClient *c);
A
antirez 已提交
1147
void strlenCommand(redisClient *c);
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
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 已提交
1166
void hincrbyfloatCommand(redisClient *c);
1167 1168 1169 1170 1171 1172 1173
void subscribeCommand(redisClient *c);
void unsubscribeCommand(redisClient *c);
void psubscribeCommand(redisClient *c);
void punsubscribeCommand(redisClient *c);
void publishCommand(redisClient *c);
void watchCommand(redisClient *c);
void unwatchCommand(redisClient *c);
A
antirez 已提交
1174 1175
void restoreCommand(redisClient *c);
void migrateCommand(redisClient *c);
1176
void dumpCommand(redisClient *c);
A
antirez 已提交
1177
void objectCommand(redisClient *c);
A
antirez 已提交
1178
void clientCommand(redisClient *c);
1179
void evalCommand(redisClient *c);
A
antirez 已提交
1180
void evalShaCommand(redisClient *c);
1181
void scriptCommand(redisClient *c);
A
antirez 已提交
1182
void timeCommand(redisClient *c);
A
antirez 已提交
1183 1184
void bitopCommand(redisClient *c);
void bitcountCommand(redisClient *c);
A
antirez 已提交
1185
void replconfCommand(redisClient *c);
1186

1187 1188 1189 1190 1191 1192 1193
#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

1194
/* Debugging stuff */
1195
void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1196 1197
void _redisAssert(char *estr, char *file, int line);
void _redisPanic(char *msg, char *file, int line);
A
antirez 已提交
1198
void bugReportStart(void);
1199
void redisLogObjectDebugInfo(robj *o);
1200 1201
void sigsegvHandler(int sig, siginfo_t *info, void *secret);
sds genRedisInfoString(char *section);
A
antirez 已提交
1202 1203 1204
void enableWatchdog(int period);
void disableWatchdog(void);
void watchdogScheduleSignal(int period);
1205
void redisLogHexDump(int level, char *descr, void *value, size_t len);
1206 1207 1208 1209 1210 1211

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

1212
#endif