src/redis.h

   1 /*
   2  * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  *   * Redistributions of source code must retain the above copyright notice,
   9  *     this list of conditions and the following disclaimer.
  10  *   * Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  *   * Neither the name of Redis nor the names of its contributors may be used
  14  *     to endorse or promote products derived from this software without
  15  *     specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27  * POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __REDIS_H
  31 #define __REDIS_H
  32
  33 #include "fmacros.h"
  34 #include "config.h"
  35
  36 #if defined(__sun)
  37 #include "solarisfixes.h"
  38 #endif
  39
  40 #include <stdio.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43 #include <time.h>
  44 #include <limits.h>
  45 #include <unistd.h>
  46 #include <errno.h>
  47 #include <inttypes.h>
  48 #include <pthread.h>
  49 #include <syslog.h>
  50 #include <netinet/in.h>
  51 #include <lua.h>
  52 #include <signal.h>
  53
  54 #include "ae.h"      /* Event driven programming library */
  55 #include "sds.h"     /* Dynamic safe strings */
  56 #include "dict.h"    /* Hash tables */
  57 #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 #include "intset.h"  /* Compact integer set structure */
  62 #include "version.h" /* Version macro */
  63 #include "util.h"    /* Misc functions useful in many places */
  64
  65 /* Error codes */
  66 #define REDIS_OK                0
  67 #define REDIS_ERR               -1
  68
  69 /* 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 #define REDIS_DEFAULT_DBNUM     16
  74 #define REDIS_CONFIGLINE_MAX    1024
  75 #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
  81 #define REDIS_MAX_LOGMSG_LEN    1024 /* Default maximum length of syslog messages */
  82 #define REDIS_AOF_REWRITE_PERC  100
  83 #define REDIS_AOF_REWRITE_MIN_SIZE (1024*1024)
  84 #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
  90 #define REDIS_REPL_TIMEOUT 60
  91 #define REDIS_REPL_PING_SLAVE_PERIOD 10
  92 #define REDIS_RUN_ID_SIZE 40
  93 #define REDIS_OPS_SEC_SAMPLES 16
  94
  95 /* Protocol and I/O related defines */
  96 #define REDIS_MAX_QUERYBUF_LEN  (1024*1024*1024) /* 1GB max query buffer. */
  97 #define REDIS_IOBUF_LEN         (1024*16)  /* Generic I/O buffer size */
  98 #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)
 101
 102 /* Hash table parameters */
 103 #define REDIS_HT_MINFILL        10      /* Minimal hash table fill 10% */
 104
 105 /* Command flags. Please check the command table defined in the redis.c file
 106  * for more information about the meaning of every flag. */
 107 #define REDIS_CMD_WRITE 1                   /* "w" flag */
 108 #define REDIS_CMD_READONLY 2                /* "r" flag */
 109 #define REDIS_CMD_DENYOOM 4                 /* "m" flag */
 110 #define REDIS_CMD_FORCE_REPLICATION 8       /* "f" flag */
 111 #define REDIS_CMD_ADMIN 16                  /* "a" flag */
 112 #define REDIS_CMD_PUBSUB 32                 /* "p" flag */
 113 #define REDIS_CMD_NOSCRIPT  64              /* "s" flag */
 114 #define REDIS_CMD_RANDOM 128                /* "R" flag */
 115 #define REDIS_CMD_SORT_FOR_SCRIPT 256       /* "S" flag */
 116 #define REDIS_CMD_LOADING 512               /* "l" flag */
 117 #define REDIS_CMD_STALE 1024                /* "t" flag */
 118 #define REDIS_CMD_SKIP_MONITOR 2048         /* "M" flag */
 119
 120 /* Object types */
 121 #define REDIS_STRING 0
 122 #define REDIS_LIST 1
 123 #define REDIS_SET 2
 124 #define REDIS_ZSET 3
 125 #define REDIS_HASH 4
 126
 127 /* Objects encoding. Some kind of objects like Strings and Hashes can be
 128  * internally represented in multiple ways. The 'encoding' field of the object
 129  * is set to one of this fields for this object. */
 130 #define REDIS_ENCODING_RAW 0     /* Raw representation */
 131 #define REDIS_ENCODING_INT 1     /* Encoded as integer */
 132 #define REDIS_ENCODING_HT 2      /* Encoded as hash table */
 133 #define REDIS_ENCODING_ZIPMAP 3  /* Encoded as zipmap */
 134 #define REDIS_ENCODING_LINKEDLIST 4 /* Encoded as regular linked list */
 135 #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 /* Defines related to the dump file format. To store 32 bits lengths for short
 140  * keys requires a lot of space, so we check the most significant 2 bits of
 141  * the first byte to interpreter the length:
 142  *
 143  * 00|000000 => if the two MSB are 00 the len is the 6 bits of this byte
 144  * 01|000000 00000000 =>  01, the len is 14 byes, 6 bits + 8 bits of next byte
 145  * 10|000000 [32 bit integer] => if it's 01, a full 32 bit len will follow
 146  * 11|000000 this means: specially encoded object will follow. The six bits
 147  *           number specify the kind of object that follows.
 148  *           See the REDIS_RDB_ENC_* defines.
 149  *
 150  * Lenghts up to 63 are stored using a single byte, most DB keys, and may
 151  * values, will fit inside. */
 152 #define REDIS_RDB_6BITLEN 0
 153 #define REDIS_RDB_14BITLEN 1
 154 #define REDIS_RDB_32BITLEN 2
 155 #define REDIS_RDB_ENCVAL 3
 156 #define REDIS_RDB_LENERR UINT_MAX
 157
 158 /* When a length of a string object stored on disk has the first two bits
 159  * set, the remaining two bits specify a special encoding for the object
 160  * accordingly to the following defines: */
 161 #define REDIS_RDB_ENC_INT8 0        /* 8 bit signed integer */
 162 #define REDIS_RDB_ENC_INT16 1       /* 16 bit signed integer */
 163 #define REDIS_RDB_ENC_INT32 2       /* 32 bit signed integer */
 164 #define REDIS_RDB_ENC_LZF 3         /* string compressed with FASTLZ */
 165
 166 /* AOF states */
 167 #define REDIS_AOF_OFF 0             /* AOF is off */
 168 #define REDIS_AOF_ON 1              /* AOF is on */
 169 #define REDIS_AOF_WAIT_REWRITE 2    /* AOF waits rewrite to start appending */
 170
 171 /* Client flags */
 172 #define REDIS_SLAVE (1<<0)   /* This client is a slave server */
 173 #define REDIS_MASTER (1<<1)  /* This client is a master server */
 174 #define REDIS_MONITOR (1<<2) /* This client is a slave monitor, see MONITOR */
 175 #define REDIS_MULTI (1<<3)   /* This client is in a MULTI context */
 176 #define REDIS_BLOCKED (1<<4) /* The client is waiting in a blocking operation */
 177 #define REDIS_DIRTY_CAS (1<<5) /* Watched keys modified. EXEC will fail. */
 178 #define REDIS_CLOSE_AFTER_REPLY (1<<6) /* Close after writing entire reply. */
 179 #define REDIS_UNBLOCKED (1<<7) /* This client was unblocked and is stored in
 180                                   server.unblocked_clients */
 181 #define REDIS_LUA_CLIENT (1<<8) /* This is a non connected client used by Lua */
 182 #define REDIS_ASKING (1<<9)     /* Client issued the ASKING command */
 183 #define REDIS_CLOSE_ASAP (1<<10)/* Close this client ASAP */
 184 #define REDIS_UNIX_SOCKET (1<<11) /* Client connected via Unix domain socket */
 185 #define REDIS_DIRTY_EXEC (1<<12)  /* EXEC will fail for errors while queueing */
 186
 187 /* Client request types */
 188 #define REDIS_REQ_INLINE 1
 189 #define REDIS_REQ_MULTIBULK 2
 190
 191 /* Client classes for client limits, currently used only for
 192  * the max-client-output-buffer limit implementation. */
 193 #define REDIS_CLIENT_LIMIT_CLASS_NORMAL 0
 194 #define REDIS_CLIENT_LIMIT_CLASS_SLAVE 1
 195 #define REDIS_CLIENT_LIMIT_CLASS_PUBSUB 2
 196 #define REDIS_CLIENT_LIMIT_NUM_CLASSES 3
 197
 198 /* Slave replication state - slave side */
 199 #define REDIS_REPL_NONE 0 /* No active replication */
 200 #define REDIS_REPL_CONNECT 1 /* Must connect to master */
 201 #define REDIS_REPL_CONNECTING 2 /* Connecting to master */
 202 #define REDIS_REPL_RECEIVE_PONG 3 /* Wait for PING reply */
 203 #define REDIS_REPL_TRANSFER 4 /* Receiving .rdb from master */
 204 #define REDIS_REPL_CONNECTED 5 /* Connected to master */
 205
 206 /* Synchronous read timeout - slave side */
 207 #define REDIS_REPL_SYNCIO_TIMEOUT 5
 208
 209 /* Slave replication state - from the point of view of master
 210  * Note that in SEND_BULK and ONLINE state the slave receives new updates
 211  * in its output queue. In the WAIT_BGSAVE state instead the server is waiting
 212  * to start the next background saving in order to send updates to it. */
 213 #define REDIS_REPL_WAIT_BGSAVE_START 3 /* master waits bgsave to start feeding it */
 214 #define REDIS_REPL_WAIT_BGSAVE_END 4 /* master waits bgsave to start bulk DB transmission */
 215 #define REDIS_REPL_SEND_BULK 5 /* master is sending the bulk DB */
 216 #define REDIS_REPL_ONLINE 6 /* bulk DB already transmitted, receive updates */
 217
 218 /* List related stuff */
 219 #define REDIS_HEAD 0
 220 #define REDIS_TAIL 1
 221
 222 /* Sort operations */
 223 #define REDIS_SORT_GET 0
 224 #define REDIS_SORT_ASC 1
 225 #define REDIS_SORT_DESC 2
 226 #define REDIS_SORTKEY_MAX 1024
 227
 228 /* Log levels */
 229 #define REDIS_DEBUG 0
 230 #define REDIS_VERBOSE 1
 231 #define REDIS_NOTICE 2
 232 #define REDIS_WARNING 3
 233 #define REDIS_LOG_RAW (1<<10) /* Modifier to log without timestamp */
 234
 235 /* Anti-warning macro... */
 236 #define REDIS_NOTUSED(V) ((void) V)
 237
 238 #define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^32 elements */
 239 #define ZSKIPLIST_P 0.25      /* Skiplist P = 1/4 */
 240
 241 /* Append only defines */
 242 #define AOF_FSYNC_NO 0
 243 #define AOF_FSYNC_ALWAYS 1
 244 #define AOF_FSYNC_EVERYSEC 2
 245
 246 /* Zip structure related defaults */
 247 #define REDIS_HASH_MAX_ZIPLIST_ENTRIES 512
 248 #define REDIS_HASH_MAX_ZIPLIST_VALUE 64
 249 #define REDIS_LIST_MAX_ZIPLIST_ENTRIES 512
 250 #define REDIS_LIST_MAX_ZIPLIST_VALUE 64
 251 #define REDIS_SET_MAX_INTSET_ENTRIES 512
 252 #define REDIS_ZSET_MAX_ZIPLIST_ENTRIES 128
 253 #define REDIS_ZSET_MAX_ZIPLIST_VALUE 64
 254
 255 /* Sets operations codes */
 256 #define REDIS_OP_UNION 0
 257 #define REDIS_OP_DIFF 1
 258 #define REDIS_OP_INTER 2
 259
 260 /* Redis maxmemory strategies */
 261 #define REDIS_MAXMEMORY_VOLATILE_LRU 0
 262 #define REDIS_MAXMEMORY_VOLATILE_TTL 1
 263 #define REDIS_MAXMEMORY_VOLATILE_RANDOM 2
 264 #define REDIS_MAXMEMORY_ALLKEYS_LRU 3
 265 #define REDIS_MAXMEMORY_ALLKEYS_RANDOM 4
 266 #define REDIS_MAXMEMORY_NO_EVICTION 5
 267
 268 /* Scripting */
 269 #define REDIS_LUA_TIME_LIMIT 5000 /* milliseconds */
 270
 271 /* Units */
 272 #define UNIT_SECONDS 0
 273 #define UNIT_MILLISECONDS 1
 274
 275 /* SHUTDOWN flags */
 276 #define REDIS_SHUTDOWN_SAVE 1       /* Force SAVE on SHUTDOWN even if no save
 277                                        points are configured. */
 278 #define REDIS_SHUTDOWN_NOSAVE 2     /* Don't SAVE on SHUTDOWN. */
 279
 280 /* Command call flags, see call() function */
 281 #define REDIS_CALL_NONE 0
 282 #define REDIS_CALL_SLOWLOG 1
 283 #define REDIS_CALL_STATS 2
 284 #define REDIS_CALL_PROPAGATE 4
 285 #define REDIS_CALL_FULL (REDIS_CALL_SLOWLOG | REDIS_CALL_STATS | REDIS_CALL_PROPAGATE)
 286
 287 /* Command propagation flags, see propagate() function */
 288 #define REDIS_PROPAGATE_NONE 0
 289 #define REDIS_PROPAGATE_AOF 1
 290 #define REDIS_PROPAGATE_REPL 2
 291
 292 /* Using the following macro you can run code inside serverCron() with the
 293  * specified period, specified in milliseconds.
 294  * The actual resolution depends on REDIS_HZ. */
 295 #define run_with_period(_ms_) if (!(server.cronloops%((_ms_)/(1000/REDIS_HZ))))
 296
 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 #define redisAssert(_e) ((_e)?(void)0 : (_redisAssert(#_e,__FILE__,__LINE__),_exit(1)))
 300 #define redisPanic(_e) _redisPanic(#_e,__FILE__,__LINE__),_exit(1)
 301
 302 /*-----------------------------------------------------------------------------
 303  * Data types
 304  *----------------------------------------------------------------------------*/
 305
 306 /* A redis object, that is a type able to hold a string / list / set */
 307
 308 /* 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 typedef struct redisObject {
 312     unsigned type:4;
 313     unsigned notused:2;     /* Not used */
 314     unsigned encoding:4;
 315     unsigned lru:22;        /* lru time (relative to server.lruclock) */
 316     int refcount;
 317     void *ptr;
 318 } robj;
 319
 320 /* Macro used to initalize a Redis object allocated on the stack.
 321  * Note that this macro is taken near the structure definition to make sure
 322  * we'll update it when the structure is changed, to avoid bugs like
 323  * bug #85 introduced exactly in this way. */
 324 #define initStaticStringObject(_var,_ptr) do { \
 325     _var.refcount = 1; \
 326     _var.type = REDIS_STRING; \
 327     _var.encoding = REDIS_ENCODING_RAW; \
 328     _var.ptr = _ptr; \
 329 } while(0);
 330
 331 typedef struct redisDb {
 332     dict *dict;                 /* The keyspace for this DB */
 333     dict *expires;              /* Timeout of keys with a timeout set */
 334     dict *blocking_keys;        /* Keys with clients waiting for data (BLPOP) */
 335     dict *ready_keys;           /* Blocked keys that received a PUSH */
 336     dict *watched_keys;         /* WATCHED keys for MULTI/EXEC CAS */
 337     int id;
 338 } redisDb;
 339
 340 /* Client MULTI/EXEC state */
 341 typedef struct multiCmd {
 342     robj **argv;
 343     int argc;
 344     struct redisCommand *cmd;
 345 } multiCmd;
 346
 347 typedef struct multiState {
 348     multiCmd *commands;     /* Array of MULTI commands */
 349     int count;              /* Total number of MULTI commands */
 350 } multiState;
 351
 352 typedef struct blockingState {
 353     dict *keys;             /* The keys we are waiting to terminate a blocking
 354                              * operation such as BLPOP. Otherwise NULL. */
 355     time_t timeout;         /* Blocking operation timeout. If UNIX current time
 356                              * is >= timeout then the operation timed out. */
 357     robj *target;           /* The key that should receive the element,
 358                              * for BRPOPLPUSH. */
 359 } blockingState;
 360
 361 /* The following structure represents a node in the server.ready_keys list,
 362  * where we accumulate all the keys that had clients blocked with a blocking
 363  * operation such as B[LR]POP, but received new data in the context of the
 364  * last executed command.
 365  *
 366  * After the execution of every command or script, we run this list to check
 367  * if as a result we should serve data to clients blocked, unblocking them.
 368  * Note that server.ready_keys will not have duplicates as there dictionary
 369  * also called ready_keys in every structure representing a Redis database,
 370  * where we make sure to remember if a given key was already added in the
 371  * server.ready_keys list. */
 372 typedef struct readyList {
 373     redisDb *db;
 374     robj *key;
 375 } readyList;
 376
 377 /* With multiplexing we need to take per-clinet state.
 378  * Clients are taken in a liked list. */
 379 typedef struct redisClient {
 380     int fd;
 381     redisDb *db;
 382     int dictid;
 383     sds querybuf;
 384     size_t querybuf_peak;   /* Recent (100ms or more) peak of querybuf size */
 385     int argc;
 386     robj **argv;
 387     struct redisCommand *cmd, *lastcmd;
 388     int reqtype;
 389     int multibulklen;       /* number of multi bulk arguments left to read */
 390     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     int flags;              /* REDIS_SLAVE | REDIS_MONITOR | REDIS_MULTI ... */
 398     int slaveseldb;         /* slave selected db, if this client is a slave */
 399     int authenticated;      /* when requirepass is non-NULL */
 400     int replstate;          /* replication state if this is a slave */
 401     int repldbfd;           /* replication DB file descriptor */
 402     long repldboff;         /* replication DB file offset */
 403     off_t repldbsize;       /* replication DB file size */
 404     int slave_listening_port; /* As configured with: SLAVECONF listening-port */
 405     multiState mstate;      /* MULTI/EXEC state */
 406     blockingState bpop;   /* blocking state */
 407     list *io_keys;          /* Keys this client is waiting to be loaded from the
 408                              * swap file in order to continue. */
 409     list *watched_keys;     /* Keys WATCHED for MULTI/EXEC CAS */
 410     dict *pubsub_channels;  /* channels a client is interested in (SUBSCRIBE) */
 411     list *pubsub_patterns;  /* patterns a client is interested in (SUBSCRIBE) */
 412
 413     /* Response buffer */
 414     int bufpos;
 415     char buf[REDIS_REPLY_CHUNK_BYTES];
 416 } redisClient;
 417
 418 struct saveparam {
 419     time_t seconds;
 420     int changes;
 421 };
 422
 423 struct sharedObjectsStruct {
 424     robj *crlf, *ok, *err, *emptybulk, *czero, *cone, *cnegone, *pong, *space,
 425     *colon, *nullbulk, *nullmultibulk, *queued,
 426     *emptymultibulk, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr,
 427     *outofrangeerr, *noscripterr, *loadingerr, *slowscripterr, *bgsaveerr,
 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     *integers[REDIS_SHARED_INTEGERS],
 434     *mbulkhdr[REDIS_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */
 435     *bulkhdr[REDIS_SHARED_BULKHDR_LEN];  /* "$<value>\r\n" */
 436 };
 437
 438 /* ZSETs use a specialized version of Skiplists */
 439 typedef struct zskiplistNode {
 440     robj *obj;
 441     double score;
 442     struct zskiplistNode *backward;
 443     struct zskiplistLevel {
 444         struct zskiplistNode *forward;
 445         unsigned int span;
 446     } level[];
 447 } zskiplistNode;
 448
 449 typedef struct zskiplist {
 450     struct zskiplistNode *header, *tail;
 451     unsigned long length;
 452     int level;
 453 } zskiplist;
 454
 455 typedef struct zset {
 456     dict *dict;
 457     zskiplist *zsl;
 458 } zset;
 459
 460 typedef struct clientBufferLimitsConfig {
 461     unsigned long long hard_limit_bytes;
 462     unsigned long long soft_limit_bytes;
 463     time_t soft_limit_seconds;
 464 } clientBufferLimitsConfig;
 465
 466 /* The redisOp structure defines a Redis Operation, that is an instance of
 467  * a command with an argument vector, database ID, propagation target
 468  * (REDIS_PROPAGATE_*), and command pointer.
 469  *
 470  * Currently only used to additionally propagate more commands to AOF/Replication
 471  * after the propagation of the executed command. */
 472 typedef struct redisOp {
 473     robj **argv;
 474     int argc, dbid, target;
 475     struct redisCommand *cmd;
 476 } redisOp;
 477
 478 /* Defines an array of Redis operations. There is an API to add to this
 479  * structure in a easy way.
 480  *
 481  * redisOpArrayInit();
 482  * redisOpArrayAppend();
 483  * redisOpArrayFree();
 484  */
 485 typedef struct redisOpArray {
 486     redisOp *ops;
 487     int numops;
 488 } redisOpArray;
 489
 490 /*-----------------------------------------------------------------------------
 491  * Global server state
 492  *----------------------------------------------------------------------------*/
 493
 494 struct redisServer {
 495     /* General */
 496     redisDb *db;
 497     dict *commands;             /* Command table hash table */
 498     aeEventLoop *el;
 499     unsigned lruclock:22;       /* Clock incrementing every minute, for LRU */
 500     unsigned lruclock_padding:10;
 501     int shutdown_asap;          /* SHUTDOWN needed ASAP */
 502     int activerehashing;        /* Incremental rehash in serverCron() */
 503     char *requirepass;          /* Pass for AUTH command, or NULL */
 504     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 */
 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     int port;                   /* TCP listening port */
 511     char *bindaddr;             /* Bind address or NULL */
 512     char *unixsocket;           /* UNIX socket path */
 513     mode_t unixsocketperm;      /* UNIX socket permission */
 514     int ipfd;                   /* TCP socket file descriptor */
 515     int sofd;                   /* Unix socket file descriptor */
 516     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     off_t loading_total_bytes;
 524     off_t loading_loaded_bytes;
 525     time_t loading_start_time;
 526     /* Fast pointers to often looked up command */
 527     struct redisCommand *delCommand, *multiCommand, *lpushCommand, *lpopCommand,
 528                         *rpopCommand;
 529     /* Fields used only for stats */
 530     time_t stat_starttime;          /* Server start time */
 531     long long stat_numcommands;     /* Number of processed commands */
 532     long long stat_numconnections;  /* Number of connections received */
 533     long long stat_expiredkeys;     /* Number of expired keys */
 534     long long stat_evictedkeys;     /* Number of evicted keys (maxmemory) */
 535     long long stat_keyspace_hits;   /* Number of successful lookups of keys */
 536     long long stat_keyspace_misses; /* Number of failed lookups of keys */
 537     size_t stat_peak_memory;        /* Max used memory record */
 538     long long stat_fork_time;       /* Time needed to perform latets fork() */
 539     long long stat_rejected_conn;   /* Clients rejected because of maxclients */
 540     list *slowlog;                  /* SLOWLOG list of commands */
 541     long long slowlog_entry_id;     /* SLOWLOG current entry ID */
 542     long long slowlog_log_slower_than; /* SLOWLOG time limit (to get logged) */
 543     unsigned long slowlog_max_len;     /* SLOWLOG max number of items logged */
 544     /* The following two are used to track instantaneous "load" in terms
 545      * of operations per second. */
 546     long long ops_sec_last_sample_time; /* Timestamp of last sample (in ms) */
 547     long long ops_sec_last_sample_ops;  /* numcommands in last sample */
 548     long long ops_sec_samples[REDIS_OPS_SEC_SAMPLES];
 549     int ops_sec_idx;
 550     /* Configuration */
 551     int verbosity;                  /* Loglevel in redis.conf */
 552     int maxidletime;                /* Client timeout in seconds */
 553     size_t client_max_querybuf_len; /* Limit for client query buffer length */
 554     int dbnum;                      /* Total number of configured DBs */
 555     int daemonize;                  /* True if running as a daemon */
 556     clientBufferLimitsConfig client_obuf_limits[REDIS_CLIENT_LIMIT_NUM_CLASSES];
 557     /* AOF persistence */
 558     int aof_state;                  /* REDIS_AOF_(ON|OFF|WAIT_REWRITE) */
 559     int aof_fsync;                  /* Kind of fsync() policy */
 560     char *aof_filename;             /* Name of the AOF file */
 561     int aof_no_fsync_on_rewrite;    /* Don't fsync if a rewrite is in prog. */
 562     int aof_rewrite_perc;           /* Rewrite AOF if % growth is > M and... */
 563     off_t aof_rewrite_min_size;     /* the AOF file is at least N bytes. */
 564     off_t aof_rewrite_base_size;    /* AOF size on latest startup or rewrite. */
 565     off_t aof_current_size;         /* AOF current size. */
 566     int aof_rewrite_scheduled;      /* Rewrite once BGSAVE terminates. */
 567     pid_t aof_child_pid;            /* PID if rewriting process */
 568     list *aof_rewrite_buf_blocks;   /* Hold changes during an AOF rewrite. */
 569     sds aof_buf;      /* AOF buffer, written before entering the event loop */
 570     int aof_fd;       /* File descriptor of currently selected AOF file */
 571     int aof_selected_db; /* Currently selected DB in AOF */
 572     time_t aof_flush_postponed_start; /* UNIX time of postponed AOF flush */
 573     time_t aof_last_fsync;            /* UNIX time of last fsync() */
 574     time_t aof_rewrite_time_last;   /* Time used by last AOF rewrite run. */
 575     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     /* RDB persistence */
 579     long long dirty;                /* Changes to DB from the last save */
 580     long long dirty_before_bgsave;  /* Used to restore dirty on failed BGSAVE */
 581     pid_t rdb_child_pid;            /* PID of RDB saving child */
 582     struct saveparam *saveparams;   /* Save points array for RDB */
 583     int saveparamslen;              /* Number of saving points */
 584     char *rdb_filename;             /* Name of RDB file */
 585     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     time_t rdb_save_time_last;      /* Time used by last RDB save run. */
 589     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     char *logfile;                  /* Path of log file */
 596     int syslog_enabled;             /* Is syslog enabled? */
 597     char *syslog_ident;             /* Syslog ident */
 598     int syslog_facility;            /* Syslog facility */
 599     /* Slave specific fields */
 600     char *masterauth;               /* AUTH with this password with master */
 601     char *masterhost;               /* Hostname of master */
 602     int masterport;                 /* Port of master */
 603     int repl_ping_slave_period;     /* Master pings the slave every N seconds */
 604     int repl_timeout;               /* Timeout after N seconds of master idle */
 605     redisClient *master;     /* Client that is master for this slave */
 606     int repl_syncio_timeout; /* Timeout for synchronous I/O calls */
 607     int repl_state;          /* Replication status if the instance is a slave */
 608     off_t repl_transfer_size; /* Size of RDB to read from master during sync. */
 609     off_t repl_transfer_read; /* Amount of RDB read from master during sync. */
 610     off_t repl_transfer_last_fsync_off; /* Offset when we fsync-ed last time. */
 611     int repl_transfer_s;     /* Slave -> Master SYNC socket */
 612     int repl_transfer_fd;    /* Slave -> Master SYNC temp file descriptor */
 613     char *repl_transfer_tmpfile; /* Slave-> master SYNC temp file name */
 614     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     unsigned int maxclients;        /* Max number of simultaneous clients */
 621     unsigned long long maxmemory;   /* Max number of memory bytes to use */
 622     int maxmemory_policy;           /* Policy for key evition */
 623     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     /* Sort parameters - qsort_r() is only available under BSD so we
 629      * have to take this state global, in order to pass it to sortCompare() */
 630     int sort_desc;
 631     int sort_alpha;
 632     int sort_bypattern;
 633     /* Zip structure config, see redis.conf for more information  */
 634     size_t hash_max_ziplist_entries;
 635     size_t hash_max_ziplist_value;
 636     size_t list_max_ziplist_entries;
 637     size_t list_max_ziplist_value;
 638     size_t set_max_intset_entries;
 639     size_t zset_max_ziplist_entries;
 640     size_t zset_max_ziplist_value;
 641     time_t unixtime;        /* Unix time sampled every second. */
 642     /* Pubsub */
 643     dict *pubsub_channels;  /* Map channels to list of subscribed clients */
 644     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     redisClient *lua_client;   /* The "fake client" to query Redis from Lua */
 648     redisClient *lua_caller;   /* The client running EVAL right now, or NULL */
 649     dict *lua_scripts;         /* A dictionary of SHA1 -> Lua scripts */
 650     long long lua_time_limit;  /* Script timeout in seconds */
 651     long long lua_time_start;  /* Start time of script */
 652     int lua_write_dirty;  /* True if a write command was called during the
 653                              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     int lua_timedout;     /* True if we reached the time limit for script
 657                              execution. */
 658     int lua_kill;         /* Kill the script if true. */
 659     /* Assert & bug reportign */
 660     char *assert_failed;
 661     char *assert_file;
 662     int assert_line;
 663     int bug_report_start; /* True if bug report header was already logged. */
 664     int watchdog_period;  /* Software watchdog period in ms. 0 = off */
 665 };
 666
 667 typedef struct pubsubPattern {
 668     redisClient *client;
 669     robj *pattern;
 670 } pubsubPattern;
 671
 672 typedef void redisCommandProc(redisClient *c);
 673 typedef int *redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
 674 struct redisCommand {
 675     char *name;
 676     redisCommandProc *proc;
 677     int arity;
 678     char *sflags; /* Flags as string represenation, one char per flag. */
 679     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     int firstkey; /* The first argument that's a key (0 = no keys) */
 684     int lastkey;  /* THe last argument that's a key */
 685     int keystep;  /* The step between first and last key */
 686     long long microseconds, calls;
 687 };
 688
 689 struct redisFunctionSym {
 690     char *name;
 691     unsigned long pointer;
 692 };
 693
 694 typedef struct _redisSortObject {
 695     robj *obj;
 696     union {
 697         double score;
 698         robj *cmpobj;
 699     } u;
 700 } redisSortObject;
 701
 702 typedef struct _redisSortOperation {
 703     int type;
 704     robj *pattern;
 705 } redisSortOperation;
 706
 707 /* Structure to hold list iteration abstraction. */
 708 typedef struct {
 709     robj *subject;
 710     unsigned char encoding;
 711     unsigned char direction; /* Iteration direction */
 712     unsigned char *zi;
 713     listNode *ln;
 714 } listTypeIterator;
 715
 716 /* Structure for an entry while iterating over a list. */
 717 typedef struct {
 718     listTypeIterator *li;
 719     unsigned char *zi;  /* Entry in ziplist */
 720     listNode *ln;       /* Entry in linked list */
 721 } listTypeEntry;
 722
 723 /* Structure to hold set iteration abstraction. */
 724 typedef struct {
 725     robj *subject;
 726     int encoding;
 727     int ii; /* intset iterator */
 728     dictIterator *di;
 729 } setTypeIterator;
 730
 731 /* Structure to hold hash iteration abstration. Note that iteration over
 732  * hashes involves both fields and values. Because it is possible that
 733  * not both are required, store pointers in the iterator to avoid
 734  * unnecessary memory allocation for fields/values. */
 735 typedef struct {
 736     robj *subject;
 737     int encoding;
 738
 739     unsigned char *fptr, *vptr;
 740
 741     dictIterator *di;
 742     dictEntry *de;
 743 } hashTypeIterator;
 744
 745 #define REDIS_HASH_KEY 1
 746 #define REDIS_HASH_VALUE 2
 747
 748 /*-----------------------------------------------------------------------------
 749  * Extern declarations
 750  *----------------------------------------------------------------------------*/
 751
 752 extern struct redisServer server;
 753 extern struct sharedObjectsStruct shared;
 754 extern dictType setDictType;
 755 extern dictType zsetDictType;
 756 extern dictType dbDictType;
 757 extern dictType shaScriptObjectDictType;
 758 extern double R_Zero, R_PosInf, R_NegInf, R_Nan;
 759 extern dictType hashDictType;
 760
 761 /*-----------------------------------------------------------------------------
 762  * Functions prototypes
 763  *----------------------------------------------------------------------------*/
 764
 765 /* Utils */
 766 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 /* networking.c -- Networking and Client related operations */
 773 redisClient *createClient(int fd);
 774 void closeTimedoutClients(void);
 775 void freeClient(redisClient *c);
 776 void resetClient(redisClient *c);
 777 void sendReplyToClient(aeEventLoop *el, int fd, void *privdata, int mask);
 778 void addReply(redisClient *c, robj *obj);
 779 void *addDeferredMultiBulkLength(redisClient *c);
 780 void setDeferredMultiBulkLength(redisClient *c, void *node, long length);
 781 void addReplySds(redisClient *c, sds s);
 782 void processInputBuffer(redisClient *c);
 783 void acceptTcpHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 784 void acceptUnixHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 785 void readQueryFromClient(aeEventLoop *el, int fd, void *privdata, int mask);
 786 void addReplyBulk(redisClient *c, robj *obj);
 787 void addReplyBulkCString(redisClient *c, char *s);
 788 void addReplyBulkCBuffer(redisClient *c, void *p, size_t len);
 789 void addReplyBulkLongLong(redisClient *c, long long ll);
 790 void acceptHandler(aeEventLoop *el, int fd, void *privdata, int mask);
 791 void addReply(redisClient *c, robj *obj);
 792 void addReplySds(redisClient *c, sds s);
 793 void addReplyError(redisClient *c, char *err);
 794 void addReplyStatus(redisClient *c, char *status);
 795 void addReplyDouble(redisClient *c, double d);
 796 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 void getClientsMaxBuffers(unsigned long *longest_output_list,
 801                           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 int getClientLimitClassByName(char *name);
 810 char *getClientLimitClassName(int class);
 811 void flushSlavesOutputBuffers(void);
 812 void disconnectSlaves(void);
 813
 814 #ifdef __GNUC__
 815 void addReplyErrorFormat(redisClient *c, const char *fmt, ...)
 816     __attribute__((format(printf, 2, 3)));
 817 void addReplyStatusFormat(redisClient *c, const char *fmt, ...)
 818     __attribute__((format(printf, 2, 3)));
 819 #else
 820 void addReplyErrorFormat(redisClient *c, const char *fmt, ...);
 821 void addReplyStatusFormat(redisClient *c, const char *fmt, ...);
 822 #endif
 823
 824 /* List data type */
 825 void listTypeTryConversion(robj *subject, robj *value);
 826 void listTypePush(robj *subject, robj *value, int where);
 827 robj *listTypePop(robj *subject, int where);
 828 unsigned long listTypeLength(robj *subject);
 829 listTypeIterator *listTypeInitIterator(robj *subject, long index, unsigned char direction);
 830 void listTypeReleaseIterator(listTypeIterator *li);
 831 int listTypeNext(listTypeIterator *li, listTypeEntry *entry);
 832 robj *listTypeGet(listTypeEntry *entry);
 833 void listTypeInsert(listTypeEntry *entry, robj *value, int where);
 834 int listTypeEqual(listTypeEntry *entry, robj *o);
 835 void listTypeDelete(listTypeEntry *entry);
 836 void listTypeConvert(robj *subject, int enc);
 837 void unblockClientWaitingData(redisClient *c);
 838 void handleClientsBlockedOnLists(void);
 839 void popGenericCommand(redisClient *c, int where);
 840
 841 /* MULTI/EXEC/WATCH... */
 842 void unwatchAllKeys(redisClient *c);
 843 void initClientMultiState(redisClient *c);
 844 void freeClientMultiState(redisClient *c);
 845 void queueMultiCommand(redisClient *c);
 846 void touchWatchedKey(redisDb *db, robj *key);
 847 void touchWatchedKeysOnFlush(int dbid);
 848 void discardTransaction(redisClient *c);
 849 void flagTransaction(redisClient *c);
 850
 851 /* Redis object implementation */
 852 void decrRefCount(void *o);
 853 void incrRefCount(robj *o);
 854 robj *resetRefCount(robj *obj);
 855 void freeStringObject(robj *o);
 856 void freeListObject(robj *o);
 857 void freeSetObject(robj *o);
 858 void freeZsetObject(robj *o);
 859 void freeHashObject(robj *o);
 860 robj *createObject(int type, void *ptr);
 861 robj *createStringObject(char *ptr, size_t len);
 862 robj *dupStringObject(robj *o);
 863 int isObjectRepresentableAsLongLong(robj *o, long long *llongval);
 864 robj *tryObjectEncoding(robj *o);
 865 robj *getDecodedObject(robj *o);
 866 size_t stringObjectLen(robj *o);
 867 robj *createStringObjectFromLongLong(long long value);
 868 robj *createStringObjectFromLongDouble(long double value);
 869 robj *createListObject(void);
 870 robj *createZiplistObject(void);
 871 robj *createSetObject(void);
 872 robj *createIntsetObject(void);
 873 robj *createHashObject(void);
 874 robj *createZsetObject(void);
 875 robj *createZsetZiplistObject(void);
 876 int getLongFromObjectOrReply(redisClient *c, robj *o, long *target, const char *msg);
 877 int checkType(redisClient *c, robj *o, int type);
 878 int getLongLongFromObjectOrReply(redisClient *c, robj *o, long long *target, const char *msg);
 879 int getDoubleFromObjectOrReply(redisClient *c, robj *o, double *target, const char *msg);
 880 int getLongLongFromObject(robj *o, long long *target);
 881 int getLongDoubleFromObject(robj *o, long double *target);
 882 int getLongDoubleFromObjectOrReply(redisClient *c, robj *o, long double *target, const char *msg);
 883 char *strEncoding(int encoding);
 884 int compareStringObjects(robj *a, robj *b);
 885 int equalStringObjects(robj *a, robj *b);
 886 unsigned long estimateObjectIdleTime(robj *o);
 887
 888 /* Synchronous I/O with timeout */
 889 ssize_t syncWrite(int fd, char *ptr, ssize_t size, long long timeout);
 890 ssize_t syncRead(int fd, char *ptr, ssize_t size, long long timeout);
 891 ssize_t syncReadLine(int fd, char *ptr, ssize_t size, long long timeout);
 892
 893 /* Replication */
 894 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 /* Generic persistence functions */
 900 void startLoading(FILE *fp);
 901 void loadingProgress(off_t pos);
 902 void stopLoading(void);
 903
 904 /* RDB persistence */
 905 #include "rdb.h"
 906
 907 /* AOF persistence */
 908 void flushAppendOnlyFile(int force);
 909 void feedAppendOnlyFile(struct redisCommand *cmd, int dictid, robj **argv, int argc);
 910 void aofRemoveTempFile(pid_t childpid);
 911 int rewriteAppendOnlyFileBackground(void);
 912 int loadAppendOnlyFile(char *filename);
 913 void stopAppendOnly(void);
 914 int startAppendOnly(void);
 915 void backgroundRewriteDoneHandler(int exitcode, int bysignal);
 916 void aofRewriteBufferReset(void);
 917 unsigned long aofRewriteBufferSize(void);
 918
 919 /* Sorted sets data type */
 920
 921 /* Struct to hold a inclusive/exclusive range spec. */
 922 typedef struct {
 923     double min, max;
 924     int minex, maxex; /* are min or max exclusive? */
 925 } zrangespec;
 926
 927 zskiplist *zslCreate(void);
 928 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 int zslDelete(zskiplist *zsl, double score, robj *obj);
 932 zskiplistNode *zslFirstInRange(zskiplist *zsl, zrangespec range);
 933 double zzlGetScore(unsigned char *sptr);
 934 void zzlNext(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
 935 void zzlPrev(unsigned char *zl, unsigned char **eptr, unsigned char **sptr);
 936 unsigned int zsetLength(robj *zobj);
 937 void zsetConvert(robj *zobj, int encoding);
 938
 939 /* Core functions */
 940 int freeMemoryIfNeeded(void);
 941 int processCommand(redisClient *c);
 942 void setupSignalHandlers(void);
 943 struct redisCommand *lookupCommand(sds name);
 944 struct redisCommand *lookupCommandByCString(char *s);
 945 void call(redisClient *c, int flags);
 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 int prepareForShutdown();
 949 void redisLog(int level, const char *fmt, ...);
 950 void redisLogRaw(int level, const char *msg);
 951 void redisLogFromHandler(int level, const char *msg);
 952 void usage();
 953 void updateDictResizePolicy(void);
 954 int htNeedsResize(dict *dict);
 955 void oom(const char *msg);
 956 void populateCommandTable(void);
 957 void resetCommandTableStats(void);
 958
 959 /* Set data type */
 960 robj *setTypeCreate(robj *value);
 961 int setTypeAdd(robj *subject, robj *value);
 962 int setTypeRemove(robj *subject, robj *value);
 963 int setTypeIsMember(robj *subject, robj *value);
 964 setTypeIterator *setTypeInitIterator(robj *subject);
 965 void setTypeReleaseIterator(setTypeIterator *si);
 966 int setTypeNext(setTypeIterator *si, robj **objele, int64_t *llele);
 967 robj *setTypeNextObject(setTypeIterator *si);
 968 int setTypeRandomElement(robj *setobj, robj **objele, int64_t *llele);
 969 unsigned long setTypeSize(robj *subject);
 970 void setTypeConvert(robj *subject, int enc);
 971
 972 /* Hash data type */
 973 void hashTypeConvert(robj *o, int enc);
 974 void hashTypeTryConversion(robj *subject, robj **argv, int start, int end);
 975 void hashTypeTryObjectEncoding(robj *subject, robj **o1, robj **o2);
 976 robj *hashTypeGetObject(robj *o, robj *key);
 977 int hashTypeExists(robj *o, robj *key);
 978 int hashTypeSet(robj *o, robj *key, robj *value);
 979 int hashTypeDelete(robj *o, robj *key);
 980 unsigned long hashTypeLength(robj *o);
 981 hashTypeIterator *hashTypeInitIterator(robj *subject);
 982 void hashTypeReleaseIterator(hashTypeIterator *hi);
 983 int hashTypeNext(hashTypeIterator *hi);
 984 void hashTypeCurrentFromZiplist(hashTypeIterator *hi, int what,
 985                                 unsigned char **vstr,
 986                                 unsigned int *vlen,
 987                                 long long *vll);
 988 void hashTypeCurrentFromHashTable(hashTypeIterator *hi, int what, robj **dst);
 989 robj *hashTypeCurrentObject(hashTypeIterator *hi, int what);
 990 robj *hashTypeLookupWriteOrCreate(redisClient *c, robj *key);
 991
 992 /* Pub / Sub */
 993 int pubsubUnsubscribeAllChannels(redisClient *c, int notify);
 994 int pubsubUnsubscribeAllPatterns(redisClient *c, int notify);
 995 void freePubsubPattern(void *p);
 996 int listMatchPubsubPattern(void *a, void *b);
 997 int pubsubPublishMessage(robj *channel, robj *message);
 998
 999 /* Configuration */
1000 void loadServerConfig(char *filename, char *options);
1001 void appendServerSaveParams(time_t seconds, int changes);
1002 void resetServerSaveParams();
1003
1004 /* db.c -- Keyspace access API */
1005 int removeExpire(redisDb *db, robj *key);
1006 void propagateExpire(redisDb *db, robj *key);
1007 int expireIfNeeded(redisDb *db, robj *key);
1008 long long getExpire(redisDb *db, robj *key);
1009 void setExpire(redisDb *db, robj *key, long long when);
1010 robj *lookupKey(redisDb *db, robj *key);
1011 robj *lookupKeyRead(redisDb *db, robj *key);
1012 robj *lookupKeyWrite(redisDb *db, robj *key);
1013 robj *lookupKeyReadOrReply(redisClient *c, robj *key, robj *reply);
1014 robj *lookupKeyWriteOrReply(redisClient *c, robj *key, robj *reply);
1015 void dbAdd(redisDb *db, robj *key, robj *val);
1016 void dbOverwrite(redisDb *db, robj *key, robj *val);
1017 void setKey(redisDb *db, robj *key, robj *val);
1018 int dbExists(redisDb *db, robj *key);
1019 robj *dbRandomKey(redisDb *db);
1020 int dbDelete(redisDb *db, robj *key);
1021 long long emptyDb();
1022 int selectDb(redisClient *c, int id);
1023 void signalModifiedKey(redisDb *db, robj *key);
1024 void signalFlushedDb(int dbid);
1025 unsigned int GetKeysInSlot(unsigned int hashslot, robj **keys, unsigned int count);
1026
1027 /* API to get key arguments from commands */
1028 #define REDIS_GETKEYS_ALL 0
1029 #define REDIS_GETKEYS_PRELOAD 1
1030 int *getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, int *numkeys, int flags);
1031 void getKeysFreeResult(int *result);
1032 int *noPreloadGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1033 int *renameGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1034 int *zunionInterGetKeys(struct redisCommand *cmd,robj **argv, int argc, int *numkeys, int flags);
1035
1036 /* Sentinel */
1037 void initSentinelConfig(void);
1038 void initSentinel(void);
1039 void sentinelTimer(void);
1040 char *sentinelHandleConfiguration(char **argv, int argc);
1041
1042 /* Scripting */
1043 void scriptingInit(void);
1044
1045 /* Git SHA1 */
1046 char *redisGitSHA1(void);
1047 char *redisGitDirty(void);
1048
1049 /* Commands prototypes */
1050 void authCommand(redisClient *c);
1051 void pingCommand(redisClient *c);
1052 void echoCommand(redisClient *c);
1053 void setCommand(redisClient *c);
1054 void setnxCommand(redisClient *c);
1055 void setexCommand(redisClient *c);
1056 void psetexCommand(redisClient *c);
1057 void getCommand(redisClient *c);
1058 void delCommand(redisClient *c);
1059 void existsCommand(redisClient *c);
1060 void setbitCommand(redisClient *c);
1061 void getbitCommand(redisClient *c);
1062 void setrangeCommand(redisClient *c);
1063 void getrangeCommand(redisClient *c);
1064 void incrCommand(redisClient *c);
1065 void decrCommand(redisClient *c);
1066 void incrbyCommand(redisClient *c);
1067 void decrbyCommand(redisClient *c);
1068 void incrbyfloatCommand(redisClient *c);
1069 void selectCommand(redisClient *c);
1070 void randomkeyCommand(redisClient *c);
1071 void keysCommand(redisClient *c);
1072 void dbsizeCommand(redisClient *c);
1073 void lastsaveCommand(redisClient *c);
1074 void saveCommand(redisClient *c);
1075 void bgsaveCommand(redisClient *c);
1076 void bgrewriteaofCommand(redisClient *c);
1077 void shutdownCommand(redisClient *c);
1078 void moveCommand(redisClient *c);
1079 void renameCommand(redisClient *c);
1080 void renamenxCommand(redisClient *c);
1081 void lpushCommand(redisClient *c);
1082 void rpushCommand(redisClient *c);
1083 void lpushxCommand(redisClient *c);
1084 void rpushxCommand(redisClient *c);
1085 void linsertCommand(redisClient *c);
1086 void lpopCommand(redisClient *c);
1087 void rpopCommand(redisClient *c);
1088 void llenCommand(redisClient *c);
1089 void lindexCommand(redisClient *c);
1090 void lrangeCommand(redisClient *c);
1091 void ltrimCommand(redisClient *c);
1092 void typeCommand(redisClient *c);
1093 void lsetCommand(redisClient *c);
1094 void saddCommand(redisClient *c);
1095 void sremCommand(redisClient *c);
1096 void smoveCommand(redisClient *c);
1097 void sismemberCommand(redisClient *c);
1098 void scardCommand(redisClient *c);
1099 void spopCommand(redisClient *c);
1100 void srandmemberCommand(redisClient *c);
1101 void sinterCommand(redisClient *c);
1102 void sinterstoreCommand(redisClient *c);
1103 void sunionCommand(redisClient *c);
1104 void sunionstoreCommand(redisClient *c);
1105 void sdiffCommand(redisClient *c);
1106 void sdiffstoreCommand(redisClient *c);
1107 void syncCommand(redisClient *c);
1108 void flushdbCommand(redisClient *c);
1109 void flushallCommand(redisClient *c);
1110 void sortCommand(redisClient *c);
1111 void lremCommand(redisClient *c);
1112 void rpoplpushCommand(redisClient *c);
1113 void infoCommand(redisClient *c);
1114 void mgetCommand(redisClient *c);
1115 void monitorCommand(redisClient *c);
1116 void expireCommand(redisClient *c);
1117 void expireatCommand(redisClient *c);
1118 void pexpireCommand(redisClient *c);
1119 void pexpireatCommand(redisClient *c);
1120 void getsetCommand(redisClient *c);
1121 void ttlCommand(redisClient *c);
1122 void pttlCommand(redisClient *c);
1123 void persistCommand(redisClient *c);
1124 void slaveofCommand(redisClient *c);
1125 void debugCommand(redisClient *c);
1126 void msetCommand(redisClient *c);
1127 void msetnxCommand(redisClient *c);
1128 void zaddCommand(redisClient *c);
1129 void zincrbyCommand(redisClient *c);
1130 void zrangeCommand(redisClient *c);
1131 void zrangebyscoreCommand(redisClient *c);
1132 void zrevrangebyscoreCommand(redisClient *c);
1133 void zcountCommand(redisClient *c);
1134 void zrevrangeCommand(redisClient *c);
1135 void zcardCommand(redisClient *c);
1136 void zremCommand(redisClient *c);
1137 void zscoreCommand(redisClient *c);
1138 void zremrangebyscoreCommand(redisClient *c);
1139 void multiCommand(redisClient *c);
1140 void execCommand(redisClient *c);
1141 void discardCommand(redisClient *c);
1142 void blpopCommand(redisClient *c);
1143 void brpopCommand(redisClient *c);
1144 void brpoplpushCommand(redisClient *c);
1145 void appendCommand(redisClient *c);
1146 void strlenCommand(redisClient *c);
1147 void zrankCommand(redisClient *c);
1148 void zrevrankCommand(redisClient *c);
1149 void hsetCommand(redisClient *c);
1150 void hsetnxCommand(redisClient *c);
1151 void hgetCommand(redisClient *c);
1152 void hmsetCommand(redisClient *c);
1153 void hmgetCommand(redisClient *c);
1154 void hdelCommand(redisClient *c);
1155 void hlenCommand(redisClient *c);
1156 void zremrangebyrankCommand(redisClient *c);
1157 void zunionstoreCommand(redisClient *c);
1158 void zinterstoreCommand(redisClient *c);
1159 void hkeysCommand(redisClient *c);
1160 void hvalsCommand(redisClient *c);
1161 void hgetallCommand(redisClient *c);
1162 void hexistsCommand(redisClient *c);
1163 void configCommand(redisClient *c);
1164 void hincrbyCommand(redisClient *c);
1165 void hincrbyfloatCommand(redisClient *c);
1166 void subscribeCommand(redisClient *c);
1167 void unsubscribeCommand(redisClient *c);
1168 void psubscribeCommand(redisClient *c);
1169 void punsubscribeCommand(redisClient *c);
1170 void publishCommand(redisClient *c);
1171 void watchCommand(redisClient *c);
1172 void unwatchCommand(redisClient *c);
1173 void restoreCommand(redisClient *c);
1174 void migrateCommand(redisClient *c);
1175 void dumpCommand(redisClient *c);
1176 void objectCommand(redisClient *c);
1177 void clientCommand(redisClient *c);
1178 void evalCommand(redisClient *c);
1179 void evalShaCommand(redisClient *c);
1180 void scriptCommand(redisClient *c);
1181 void timeCommand(redisClient *c);
1182 void bitopCommand(redisClient *c);
1183 void bitcountCommand(redisClient *c);
1184 void replconfCommand(redisClient *c);
1185
1186 #if defined(__GNUC__)
1187 void *calloc(size_t count, size_t size) __attribute__ ((deprecated));
1188 void free(void *ptr) __attribute__ ((deprecated));
1189 void *malloc(size_t size) __attribute__ ((deprecated));
1190 void *realloc(void *ptr, size_t size) __attribute__ ((deprecated));
1191 #endif
1192
1193 /* Debugging stuff */
1194 void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line);
1195 void _redisAssert(char *estr, char *file, int line);
1196 void _redisPanic(char *msg, char *file, int line);
1197 void bugReportStart(void);
1198 void redisLogObjectDebugInfo(robj *o);
1199 void sigsegvHandler(int sig, siginfo_t *info, void *secret);
1200 sds genRedisInfoString(char *section);
1201 void enableWatchdog(int period);
1202 void disableWatchdog(void);
1203 void watchdogScheduleSignal(int period);
1204 void redisLogHexDump(int level, char *descr, void *value, size_t len);
1205
1206 #define redisDebug(fmt, ...) \
1207     printf("DEBUG %s:%d > " fmt "\n", __FILE__, __LINE__, __VA_ARGS__)
1208 #define redisDebugMark() \
1209     printf("-- MARK %s:%d --\n", __FILE__, __LINE__)
1210
1211 #endif