diff options
Diffstat (limited to 'examples/redis-unstable/src/server.h')
| -rw-r--r-- | examples/redis-unstable/src/server.h | 4478 |
1 files changed, 0 insertions, 4478 deletions
diff --git a/examples/redis-unstable/src/server.h b/examples/redis-unstable/src/server.h deleted file mode 100644 index 96eb286..0000000 --- a/examples/redis-unstable/src/server.h +++ /dev/null @@ -1,4478 +0,0 @@ -/* - * Copyright (c) 2009-Present, Redis Ltd. - * All rights reserved. - * - * Copyright (c) 2024-present, Valkey contributors. - * All rights reserved. - * - * Licensed under your choice of (a) the Redis Source Available License 2.0 - * (RSALv2); or (b) the Server Side Public License v1 (SSPLv1); or (c) the - * GNU Affero General Public License v3 (AGPLv3). - * - * Portions of this file are available under BSD3 terms; see REDISCONTRIBUTIONS for more information. - */ - -#ifndef __REDIS_H -#define __REDIS_H - -#include "fmacros.h" -#include "config.h" -#include "solarisfixes.h" -#include "rio.h" -#include "atomicvar.h" -#include "commands.h" -#include "object.h" - -#include <stdio.h> -#include <stdlib.h> -#include <stddef.h> -#include <string.h> -#include <time.h> -#include <limits.h> -#include <unistd.h> -#include <errno.h> -#include <inttypes.h> -#include <pthread.h> -#include <syslog.h> -#include <netinet/in.h> -#include <sys/socket.h> -#include <lua.h> -#include <signal.h> - -#ifdef HAVE_LIBSYSTEMD -#include <systemd/sd-daemon.h> -#endif - -typedef long long mstime_t; /* millisecond time type. */ -typedef long long ustime_t; /* microsecond time type. */ - -#include "ae.h" /* Event driven programming library */ -#include "sds.h" /* Dynamic safe strings */ -#include "entry.h" /* Entry objects (field-value pairs with optional expiration) */ -#include "ebuckets.h" /* expiry data structure */ -#include "dict.h" /* Hash tables */ -#include "kvstore.h" /* Slot-based hash table */ -#include "estore.h" /* Expiration store */ -#include "adlist.h" /* Linked lists */ -#include "zmalloc.h" /* total memory usage aware version of malloc/free */ -#include "anet.h" /* Networking the easy way */ -#include "version.h" /* Version macro */ -#include "util.h" /* Misc functions useful in many places */ -#include "latency.h" /* Latency monitor API */ -#include "sparkline.h" /* ASCII graphs API */ -#include "quicklist.h" /* Lists are encoded as linked lists of - N-elements flat arrays */ -#include "rax.h" /* Radix tree */ -#include "connection.h" /* Connection abstraction */ -#include "eventnotifier.h" /* Event notification */ -#include "memory_prefetch.h" - -/* Forward declarations needed by redismodule.h and keymeta.h */ -struct redisObject; -struct RedisModule; - -/* This is a structure used to export some meta-information such as dbid to the module. */ -struct RedisModuleKeyOptCtx { - struct redisObject *from_key, *to_key; /* Optional name of key processed, NULL when unknown. - In most cases, only 'from_key' is valid, but in callbacks - such as `copy2`, both 'from_key' and 'to_key' are valid. */ - int from_dbid, to_dbid; /* The dbid of the key being processed, -1 when unknown. - In most cases, only 'from_dbid' is valid, but in callbacks such - as `copy2`, 'from_dbid' and 'to_dbid' are both valid. */ -}; - -#define REDISMODULE_CORE 1 - -#include "redismodule.h" /* Redis modules API defines. */ - -/* Following includes allow test functions to be called from Redis main() */ -#include "zipmap.h" -#include "ziplist.h" /* Compact list data structure */ -#include "sha1.h" -#include "endianconv.h" -#include "crc64.h" -#include "keymeta.h" - -struct hdr_histogram; - -/* helpers */ -#define numElements(x) (sizeof(x)/sizeof((x)[0])) - -/* min/max */ -#undef min -#undef max -#define min(a, b) ((a) < (b) ? (a) : (b)) -#define max(a, b) ((a) > (b) ? (a) : (b)) - -/* Get the pointer of the outer struct from a member address */ -#define redis_member2struct(struct_name, member_name, member_addr) \ - ((struct_name *)((char*)member_addr - offsetof(struct_name, member_name))) - -/* Error codes */ -#define C_OK 0 -#define C_ERR -1 -#define C_RETRY -2 - -/* Static server configuration */ -#define CONFIG_DEFAULT_HZ 10 /* Time interrupt calls/sec. */ -#define CONFIG_MIN_HZ 1 -#define CONFIG_MAX_HZ 500 -#define MAX_CLIENTS_PER_CLOCK_TICK 200 /* HZ is adapted based on that. */ -#define CRON_DBS_PER_CALL 16 -#define CRON_DICTS_PER_DB 16 -#define NET_MAX_WRITES_PER_EVENT (1024*64) -#define PROTO_SHARED_SELECT_CMDS 10 -#define OBJ_SHARED_INTEGERS 10000 -#define OBJ_SHARED_BULKHDR_LEN 32 -#define OBJ_SHARED_HDR_STRLEN(_len_) (((_len_) < 10) ? 4 : 5) /* see shared.mbulkhdr etc. */ -#define LOG_MAX_LEN 1024 /* Default maximum length of syslog messages.*/ -#define AOF_REWRITE_ITEMS_PER_CMD 64 -#define AOF_ANNOTATION_LINE_MAX_LEN 1024 -#define CONFIG_RUN_ID_SIZE 40 -#define RDB_EOF_MARK_SIZE 40 -#define CONFIG_REPL_BACKLOG_MIN_SIZE (1024*16) /* 16k */ -#define CONFIG_BGSAVE_RETRY_DELAY 5 /* Wait a few secs before trying again. */ -#define CONFIG_DEFAULT_PID_FILE "/var/run/redis.pid" -#define CONFIG_DEFAULT_BINDADDR_COUNT 2 -#define CONFIG_DEFAULT_BINDADDR { "*", "-::*" } -#define NET_HOST_STR_LEN 256 /* Longest valid hostname */ -#define NET_IP_STR_LEN 46 /* INET6_ADDRSTRLEN is 46, but we need to be sure */ -#define NET_ADDR_STR_LEN (NET_IP_STR_LEN+32) /* Must be enough for ip:port */ -#define NET_HOST_PORT_STR_LEN (NET_HOST_STR_LEN+32) /* Must be enough for hostname:port */ -#define CONFIG_BINDADDR_MAX 16 -#define CONFIG_MIN_RESERVED_FDS 32 -#define CONFIG_DEFAULT_PROC_TITLE_TEMPLATE "{title} {listen-addr} {server-mode}" -#define INCREMENTAL_REHASHING_THRESHOLD_US 1000 -#define CLIENTS_CRON_MIN_ITERATIONS 5 - -/* Stream IDMP configuration limits */ -#define CONFIG_STREAM_IDMP_MIN_DURATION 1 /* Min IDMP duration in seconds. */ -#define CONFIG_STREAM_IDMP_MAX_DURATION 86400 /* Max IDMP duration in seconds (24 hours). */ -#define CONFIG_STREAM_IDMP_MIN_MAXSIZE 1 /* Min IDMP max entries. */ -#define CONFIG_STREAM_IDMP_MAX_MAXSIZE 10000 /* Max IDMP max entries. */ - -/* Bucket sizes for client eviction pools. Each bucket stores clients with - * memory usage of up to twice the size of the bucket below it. */ -#define CLIENT_MEM_USAGE_BUCKET_MIN_LOG 15 /* Bucket sizes start at up to 32KB (2^15) */ -#define CLIENT_MEM_USAGE_BUCKET_MAX_LOG 33 /* Bucket for largest clients: sizes above 4GB (2^32) */ -#define CLIENT_MEM_USAGE_BUCKETS (1+CLIENT_MEM_USAGE_BUCKET_MAX_LOG-CLIENT_MEM_USAGE_BUCKET_MIN_LOG) - -#define ACTIVE_EXPIRE_CYCLE_SLOW 0 -#define ACTIVE_EXPIRE_CYCLE_FAST 1 - -/* Children process will exit with this status code to signal that the - * process terminated without an error: this is useful in order to kill - * a saving child (RDB or AOF one), without triggering in the parent the - * write protection that is normally turned on on write errors. - * Usually children that are terminated with SIGUSR1 will exit with this - * special code. */ -#define SERVER_CHILD_NOERROR_RETVAL 255 - -/* Reading copy-on-write info is sometimes expensive and may slow down child - * processes that report it continuously. We measure the cost of obtaining it - * and hold back additional reading based on this factor. */ -#define CHILD_COW_DUTY_CYCLE 100 - -/* Instantaneous metrics tracking. */ -#define STATS_METRIC_SAMPLES 16 /* Number of samples per metric. */ -#define STATS_METRIC_COMMAND 0 /* Number of commands executed. */ -#define STATS_METRIC_NET_INPUT 1 /* Bytes read from network. */ -#define STATS_METRIC_NET_OUTPUT 2 /* Bytes written to network. */ -#define STATS_METRIC_NET_INPUT_REPLICATION 3 /* Bytes read from network during replication. */ -#define STATS_METRIC_NET_OUTPUT_REPLICATION 4 /* Bytes written to network during replication. */ -#define STATS_METRIC_EL_CYCLE 5 /* Number of eventloop cycled. */ -#define STATS_METRIC_EL_DURATION 6 /* Eventloop duration. */ -#define STATS_METRIC_COUNT 7 - -/* Protocol and I/O related defines */ -#define PROTO_IOBUF_LEN (1024*16) /* Generic I/O buffer size */ -#define PROTO_REPLY_CHUNK_BYTES (16*1024) /* 16k output buffer */ -#define PROTO_INLINE_MAX_SIZE (1024*64) /* Max size of inline reads */ -#define PROTO_MBULK_BIG_ARG (1024*32) -#define PROTO_RESIZE_THRESHOLD (1024*32) /* Threshold for determining whether to resize query buffer */ -#define PROTO_REPLY_MIN_BYTES (1024) /* the lower limit on reply buffer size */ -#define REDIS_AUTOSYNC_BYTES (1024*1024*4) /* Sync file every 4MB. */ - -#define REPLY_BUFFER_DEFAULT_PEAK_RESET_TIME 5000 /* 5 seconds */ - -/* Reply copy avoidance thresholds */ -#define COPY_AVOID_MIN_IO_THREADS 7 /* Minimum number of IO threads for copy avoidance */ -#define COPY_AVOID_MIN_STRING_SIZE 16384 /* Minimum bulk string size for copy avoidance (no IO threads) */ -#define COPY_AVOID_MIN_STRING_SIZE_THREADED 65536 /* Minimum bulk string size for copy avoidance (with IO threads) */ - -/* When configuring the server eventloop, we setup it so that the total number - * of file descriptors we can handle are server.maxclients + RESERVED_FDS + - * a few more to stay safe. Since RESERVED_FDS defaults to 32, we add 96 - * in order to make sure of not over provisioning more than 128 fds. */ -#define CONFIG_FDSET_INCR (CONFIG_MIN_RESERVED_FDS+96) - -/* Default lookahead value */ -#define REDIS_DEFAULT_LOOKAHEAD 16 - -/* OOM Score Adjustment classes. */ -#define CONFIG_OOM_MASTER 0 -#define CONFIG_OOM_REPLICA 1 -#define CONFIG_OOM_BGCHILD 2 -#define CONFIG_OOM_COUNT 3 - -extern int configOOMScoreAdjValuesDefaults[CONFIG_OOM_COUNT]; - -/* Hash table parameters */ -#define HASHTABLE_MAX_LOAD_FACTOR 1.618 /* Maximum hash table load factor. */ - -/* Max number of IO threads */ -#define IO_THREADS_MAX_NUM 128 - -/* To make IO threads and main thread run in parallel, we will transfer clients - * between them if the number of clients in the pending list reaches this value. */ -#define IO_THREAD_MAX_PENDING_CLIENTS 16 - -/* Main thread id for doing IO work, whatever we enable or disable io thread - * the main thread always does IO work, so we can consider that the main thread - * is the io thread 0. */ -#define IOTHREAD_MAIN_THREAD_ID 0 - -/* Command flags. Please check the definition of struct redisCommand in this file - * for more information about the meaning of every flag. */ -#define CMD_WRITE (1ULL<<0) -#define CMD_READONLY (1ULL<<1) -#define CMD_DENYOOM (1ULL<<2) -#define CMD_MODULE (1ULL<<3) /* Command exported by module. */ -#define CMD_ADMIN (1ULL<<4) -#define CMD_PUBSUB (1ULL<<5) -#define CMD_NOSCRIPT (1ULL<<6) -#define CMD_BLOCKING (1ULL<<8) /* Has potential to block. */ -#define CMD_LOADING (1ULL<<9) -#define CMD_STALE (1ULL<<10) -#define CMD_SKIP_MONITOR (1ULL<<11) -#define CMD_SKIP_SLOWLOG (1ULL<<12) -#define CMD_ASKING (1ULL<<13) -#define CMD_FAST (1ULL<<14) -#define CMD_NO_AUTH (1ULL<<15) -#define CMD_MAY_REPLICATE (1ULL<<16) -#define CMD_SENTINEL (1ULL<<17) -#define CMD_ONLY_SENTINEL (1ULL<<18) -#define CMD_NO_MANDATORY_KEYS (1ULL<<19) -#define CMD_PROTECTED (1ULL<<20) -#define CMD_MODULE_GETKEYS (1ULL<<21) /* Use the modules getkeys interface. */ -#define CMD_MODULE_NO_CLUSTER (1ULL<<22) /* Deny on Redis Cluster. */ -#define CMD_NO_ASYNC_LOADING (1ULL<<23) -#define CMD_NO_MULTI (1ULL<<24) -#define CMD_MOVABLE_KEYS (1ULL<<25) /* The legacy range spec doesn't cover all keys. - * Populated by populateCommandLegacyRangeSpec. */ -#define CMD_ALLOW_BUSY ((1ULL<<26)) -#define CMD_MODULE_GETCHANNELS (1ULL<<27) /* Use the modules getchannels interface. */ -#define CMD_TOUCHES_ARBITRARY_KEYS (1ULL<<28) -#define CMD_INTERNAL (1ULL<<29) /* Internal command. */ - -/* Command flags that describe ACLs categories. */ -#define ACL_CATEGORY_KEYSPACE (1ULL<<0) -#define ACL_CATEGORY_READ (1ULL<<1) -#define ACL_CATEGORY_WRITE (1ULL<<2) -#define ACL_CATEGORY_SET (1ULL<<3) -#define ACL_CATEGORY_SORTEDSET (1ULL<<4) -#define ACL_CATEGORY_LIST (1ULL<<5) -#define ACL_CATEGORY_HASH (1ULL<<6) -#define ACL_CATEGORY_STRING (1ULL<<7) -#define ACL_CATEGORY_BITMAP (1ULL<<8) -#define ACL_CATEGORY_HYPERLOGLOG (1ULL<<9) -#define ACL_CATEGORY_GEO (1ULL<<10) -#define ACL_CATEGORY_STREAM (1ULL<<11) -#define ACL_CATEGORY_PUBSUB (1ULL<<12) -#define ACL_CATEGORY_ADMIN (1ULL<<13) -#define ACL_CATEGORY_FAST (1ULL<<14) -#define ACL_CATEGORY_SLOW (1ULL<<15) -#define ACL_CATEGORY_BLOCKING (1ULL<<16) -#define ACL_CATEGORY_DANGEROUS (1ULL<<17) -#define ACL_CATEGORY_CONNECTION (1ULL<<18) -#define ACL_CATEGORY_TRANSACTION (1ULL<<19) -#define ACL_CATEGORY_SCRIPTING (1ULL<<20) - -/* Key-spec flags * - * -------------- */ -/* The following refer what the command actually does with the value or metadata - * of the key, and not necessarily the user data or how it affects it. - * Each key-spec may must have exactly one of these. Any operation that's not - * distinctly deletion, overwrite or read-only would be marked as RW. */ -#define CMD_KEY_RO (1ULL<<0) /* Read-Only - Reads the value of the key, but - * doesn't necessarily returns it. */ -#define CMD_KEY_RW (1ULL<<1) /* Read-Write - Reads and modifies/deletes - * the data stored in the value of the key or - * its metadata. */ -#define CMD_KEY_OW (1ULL<<2) /* Overwrite - Overwrites the data stored in - * the value of the key. */ -#define CMD_KEY_RM (1ULL<<3) /* Deletes the key without reading it's value. */ -/* The following refer to user data inside the value of the key, not the metadata - * like LRU, type, cardinality. It refers to the logical operation on the user's - * data (actual input strings / TTL), being used / returned / copied / changed, - * It doesn't refer to modification or returning of metadata (like type, count, - * presence of data). Any write that's not INSERT or DELETE, would be an UPDATE. - * Each key-spec may have one of the writes with or without access, or none: */ -#define CMD_KEY_ACCESS (1ULL<<4) /* Returns, copies or uses the user data from - * the value of the key. */ -#define CMD_KEY_UPDATE (1ULL<<5) /* Updates data to the value, new value may - * depend on the old value. */ -#define CMD_KEY_INSERT (1ULL<<6) /* Adds data to the value with no chance of - * modification or deletion of existing data. */ -#define CMD_KEY_DELETE (1ULL<<7) /* Explicitly deletes some content - * from the value of the key. */ -/* Other flags: */ -#define CMD_KEY_NOT_KEY (1ULL<<8) /* A 'fake' key that should be routed - * like a key in cluster mode but is - * excluded from other key checks. */ -#define CMD_KEY_INCOMPLETE (1ULL<<9) /* Means that the keyspec might not point - * out to all keys it should cover */ -#define CMD_KEY_VARIABLE_FLAGS (1ULL<<10) /* Means that some keys might have - * different flags depending on arguments */ -#define CMD_KEY_PREFIX (1ULL<<11) /* Given key represents a prefix of a set of keys */ - -/* Key flags for when access type is unknown */ -#define CMD_KEY_FULL_ACCESS (CMD_KEY_RW | CMD_KEY_ACCESS | CMD_KEY_UPDATE) - -/* Key flags for how key is removed */ -#define DB_FLAG_KEY_NONE 0 -#define DB_FLAG_KEY_DELETED (1ULL<<0) -#define DB_FLAG_KEY_EXPIRED (1ULL<<1) -#define DB_FLAG_KEY_EVICTED (1ULL<<2) -#define DB_FLAG_KEY_OVERWRITE (1ULL<<3) -#define DB_FLAG_NO_UPDATE_KEYSIZES (1ULL<<4) /* Don't update keysizes histograms */ - -/* Channel flags share the same flag space as the key flags */ -#define CMD_CHANNEL_PATTERN (1ULL<<11) /* The argument is a channel pattern */ -#define CMD_CHANNEL_SUBSCRIBE (1ULL<<12) /* The command subscribes to channels */ -#define CMD_CHANNEL_UNSUBSCRIBE (1ULL<<13) /* The command unsubscribes to channels */ -#define CMD_CHANNEL_PUBLISH (1ULL<<14) /* The command publishes to channels. */ - -/* AOF states */ -#define AOF_OFF 0 /* AOF is off */ -#define AOF_ON 1 /* AOF is on */ -#define AOF_WAIT_REWRITE 2 /* AOF waits rewrite to start appending */ - -/* AOF return values for loadAppendOnlyFiles() and loadSingleAppendOnlyFile() */ -#define AOF_OK 0 -#define AOF_NOT_EXIST 1 -#define AOF_EMPTY 2 -#define AOF_OPEN_ERR 3 -#define AOF_FAILED 4 -#define AOF_TRUNCATED 5 -#define AOF_BROKEN_RECOVERED 6 - -/* RDB return values for rdbLoad. */ -#define RDB_OK 0 -#define RDB_NOT_EXIST 1 /* RDB file doesn't exist. */ -#define RDB_FAILED 2 /* Failed to load the RDB file. */ - -/* Command doc flags */ -#define CMD_DOC_NONE 0 -#define CMD_DOC_DEPRECATED (1<<0) /* Command is deprecated */ -#define CMD_DOC_SYSCMD (1<<1) /* System (internal) command */ - -/* Client flags */ -#define CLIENT_SLAVE (1<<0) /* This client is a replica */ -#define CLIENT_MASTER (1<<1) /* This client is a master */ -#define CLIENT_MONITOR (1<<2) /* This client is a slave monitor, see MONITOR */ -#define CLIENT_MULTI (1<<3) /* This client is in a MULTI context */ -#define CLIENT_BLOCKED (1<<4) /* The client is waiting in a blocking operation */ -#define CLIENT_DIRTY_CAS (1<<5) /* Watched keys modified. EXEC will fail. */ -#define CLIENT_CLOSE_AFTER_REPLY (1<<6) /* Close after writing entire reply. */ -#define CLIENT_UNBLOCKED (1<<7) /* This client was unblocked and is stored in - server.unblocked_clients */ -#define CLIENT_SCRIPT (1<<8) /* This is a non connected client used by Lua */ -#define CLIENT_ASKING (1<<9) /* Client issued the ASKING command */ -#define CLIENT_CLOSE_ASAP (1<<10)/* Close this client ASAP */ -#define CLIENT_UNIX_SOCKET (1<<11) /* Client connected via Unix domain socket */ -#define CLIENT_DIRTY_EXEC (1<<12) /* EXEC will fail for errors while queueing */ -#define CLIENT_MASTER_FORCE_REPLY (1<<13) /* Queue replies even if is master */ -#define CLIENT_FORCE_AOF (1<<14) /* Force AOF propagation of current cmd. */ -#define CLIENT_FORCE_REPL (1<<15) /* Force replication of current cmd. */ -#define CLIENT_PRE_PSYNC (1<<16) /* Instance don't understand PSYNC. */ -#define CLIENT_READONLY (1<<17) /* Cluster client is in read-only state. */ -#define CLIENT_PUBSUB (1<<18) /* Client is in Pub/Sub mode. */ -#define CLIENT_PREVENT_AOF_PROP (1<<19) /* Don't propagate to AOF. */ -#define CLIENT_PREVENT_REPL_PROP (1<<20) /* Don't propagate to slaves. */ -#define CLIENT_PREVENT_PROP (CLIENT_PREVENT_AOF_PROP|CLIENT_PREVENT_REPL_PROP) -#define CLIENT_PENDING_WRITE (1<<21) /* Client has output to send but a write - handler is yet not installed. */ -#define CLIENT_REPLY_OFF (1<<22) /* Don't send replies to client. */ -#define CLIENT_REPLY_SKIP_NEXT (1<<23) /* Set CLIENT_REPLY_SKIP for next cmd */ -#define CLIENT_REPLY_SKIP (1<<24) /* Don't send just this reply. */ -#define CLIENT_LUA_DEBUG (1<<25) /* Run EVAL in debug mode. */ -#define CLIENT_LUA_DEBUG_SYNC (1<<26) /* EVAL debugging without fork() */ -#define CLIENT_MODULE (1<<27) /* Non connected client used by some module. */ -#define CLIENT_PROTECTED (1<<28) /* Client should not be freed for now. */ -#define CLIENT_EXECUTING_COMMAND (1<<29) /* Indicates that the client is currently in the process of handling - a command. usually this will be marked only during call() - however, blocked clients might have this flag kept until they - will try to reprocess the command. */ - -#define CLIENT_PENDING_COMMAND (1<<30) /* Indicates the client has a fully - * parsed command ready for execution. */ -#define CLIENT_TRACKING (1ULL<<31) /* Client enabled keys tracking in order to - perform client side caching. */ -#define CLIENT_TRACKING_BROKEN_REDIR (1ULL<<32) /* Target client is invalid. */ -#define CLIENT_TRACKING_BCAST (1ULL<<33) /* Tracking in BCAST mode. */ -#define CLIENT_TRACKING_OPTIN (1ULL<<34) /* Tracking in opt-in mode. */ -#define CLIENT_TRACKING_OPTOUT (1ULL<<35) /* Tracking in opt-out mode. */ -#define CLIENT_TRACKING_CACHING (1ULL<<36) /* CACHING yes/no was given, - depending on optin/optout mode. */ -#define CLIENT_TRACKING_NOLOOP (1ULL<<37) /* Don't send invalidation messages - about writes performed by myself.*/ -#define CLIENT_IN_TO_TABLE (1ULL<<38) /* This client is in the timeout table. */ -#define CLIENT_PROTOCOL_ERROR (1ULL<<39) /* Protocol error chatting with it. */ -#define CLIENT_CLOSE_AFTER_COMMAND (1ULL<<40) /* Close after executing commands - * and writing entire reply. */ -#define CLIENT_DENY_BLOCKING (1ULL<<41) /* Indicate that the client should not be blocked. - currently, turned on inside MULTI, Lua, RM_Call, - and AOF client */ -#define CLIENT_REPL_RDBONLY (1ULL<<42) /* This client is a replica that only wants - RDB without replication buffer. */ -#define CLIENT_NO_EVICT (1ULL<<43) /* This client is protected against client - memory eviction. */ -#define CLIENT_ALLOW_OOM (1ULL<<44) /* Client used by RM_Call is allowed to fully execute - scripts even when in OOM */ -#define CLIENT_NO_TOUCH (1ULL<<45) /* This client will not touch LFU/LRU stats. */ -#define CLIENT_PUSHING (1ULL<<46) /* This client is pushing notifications. */ -#define CLIENT_MODULE_AUTH_HAS_RESULT (1ULL<<47) /* Indicates a client in the middle of module based - auth had been authenticated from the Module. */ -#define CLIENT_MODULE_PREVENT_AOF_PROP (1ULL<<48) /* Module client do not want to propagate to AOF */ -#define CLIENT_MODULE_PREVENT_REPL_PROP (1ULL<<49) /* Module client do not want to propagate to replica */ -#define CLIENT_REEXECUTING_COMMAND (1ULL<<50) /* The client is re-executing the command. */ -#define CLIENT_REPL_RDB_CHANNEL (1ULL<<51) /* Client which is used for rdb delivery as part of rdb channel replication */ -#define CLIENT_INTERNAL (1ULL<<52) /* Internal client connection */ -#define CLIENT_ASM_MIGRATING (1ULL<<53) /* Client is migrating RDB/stream data during atomic slot migration. */ -#define CLIENT_ASM_IMPORTING (1ULL<<54) /* Client is importing RDB/stream data during atomic slot migration. */ - -/* Any flag that does not let optimize FLUSH SYNC to run it in bg as blocking client ASYNC */ -#define CLIENT_AVOID_BLOCKING_ASYNC_FLUSH (CLIENT_DENY_BLOCKING|CLIENT_MULTI|CLIENT_LUA_DEBUG|CLIENT_LUA_DEBUG_SYNC|CLIENT_MODULE) - -/* Max deferred objects to be freed by IO thread for each client. */ -#define CLIENT_MAX_DEFERRED_OBJECTS 32 - -/* Client flags for client IO */ -#define CLIENT_IO_READ_ENABLED (1ULL<<0) /* Client can read from socket. */ -#define CLIENT_IO_WRITE_ENABLED (1ULL<<1) /* Client can write to socket. */ -#define CLIENT_IO_PENDING_COMMAND (1ULL<<2) /* Similar to CLIENT_PENDING_COMMAND. */ -#define CLIENT_IO_REUSABLE_QUERYBUFFER (1ULL<<3) /* The client is using the reusable query buffer. */ -#define CLIENT_IO_CLOSE_ASAP (1ULL<<4) /* Close this client ASAP in IO thread. */ -#define CLIENT_IO_PENDING_CRON (1ULL<<5) /* The client is pending cron job, to be processed in main thread. */ - -/* Definitions for client read errors. These error codes are used to indicate - * various issues that can occur while reading or parsing data from a client. */ -#define CLIENT_READ_TOO_BIG_INLINE_REQUEST 1 -#define CLIENT_READ_UNBALANCED_QUOTES 2 -#define CLIENT_READ_MASTER_USING_INLINE_PROTOCAL 3 -#define CLIENT_READ_TOO_BIG_MBULK_COUNT_STRING 4 -#define CLIENT_READ_TOO_BIG_BUCK_COUNT_STRING 5 -#define CLIENT_READ_EXPECTED_DOLLAR 6 -#define CLIENT_READ_INVALID_BUCK_LENGTH 7 -#define CLIENT_READ_UNAUTH_BUCK_LENGTH 8 -#define CLIENT_READ_INVALID_MULTIBUCK_LENGTH 9 -#define CLIENT_READ_UNAUTH_MBUCK_COUNT 10 -#define CLIENT_READ_CONN_DISCONNECTED 11 -#define CLIENT_READ_CONN_CLOSED 12 -#define CLIENT_READ_REACHED_MAX_QUERYBUF 13 -#define CLIENT_READ_COMMAND_NOT_FOUND 14 -#define CLIENT_READ_BAD_ARITY 15 -#define CLIENT_READ_CROSS_SLOT 16 - -/* Client block type (btype field in client structure) - * if CLIENT_BLOCKED flag is set. */ -typedef enum blocking_type { - BLOCKED_NONE, /* Not blocked, no CLIENT_BLOCKED flag set. */ - BLOCKED_LIST, /* BLPOP & co. */ - BLOCKED_WAIT, /* WAIT for synchronous replication. */ - BLOCKED_WAITAOF, /* WAITAOF for AOF file fsync. */ - BLOCKED_MODULE, /* Blocked by a loadable module. */ - BLOCKED_STREAM, /* XREAD. */ - BLOCKED_ZSET, /* BZPOP et al. */ - BLOCKED_POSTPONE, /* Blocked by processCommand, re-try processing later. */ - BLOCKED_POSTPONE_TRIM, /* Master client is blocked due to an active trim job. */ - BLOCKED_SHUTDOWN, /* SHUTDOWN. */ - BLOCKED_LAZYFREE, /* LAZYFREE */ - BLOCKED_NUM, /* Number of blocked states. */ - BLOCKED_END /* End of enumeration */ -} blocking_type; - -/* Client request types */ -#define PROTO_REQ_INLINE 1 -#define PROTO_REQ_MULTIBULK 2 - -/* Client classes for client limits, currently used only for - * the max-client-output-buffer limit implementation. */ -#define CLIENT_TYPE_NORMAL 0 /* Normal req-reply clients + MONITORs */ -#define CLIENT_TYPE_SLAVE 1 /* Slaves. */ -#define CLIENT_TYPE_PUBSUB 2 /* Clients subscribed to PubSub channels. */ -#define CLIENT_TYPE_MASTER 3 /* Master. */ -#define CLIENT_TYPE_COUNT 4 /* Total number of client types. */ -#define CLIENT_TYPE_OBUF_COUNT 3 /* Number of clients to expose to output - buffer configuration. Just the first - three: normal, slave, pubsub. */ - -/* Slave replication state. Used in server.repl_state for slaves to remember - * what to do next. */ -typedef enum { - REPL_STATE_NONE = 0, /* No active replication */ - REPL_STATE_CONNECT, /* Must connect to master */ - REPL_STATE_CONNECTING, /* Connecting to master */ - /* --- Handshake states, must be ordered --- */ - REPL_STATE_RECEIVE_PING_REPLY, /* Wait for PING reply */ - REPL_STATE_SEND_HANDSHAKE, /* Send handshake sequence to master */ - REPL_STATE_RECEIVE_AUTH_REPLY, /* Wait for AUTH reply */ - REPL_STATE_RECEIVE_PORT_REPLY, /* Wait for REPLCONF reply */ - REPL_STATE_RECEIVE_IP_REPLY, /* Wait for REPLCONF reply */ - REPL_STATE_RECEIVE_COMP_REPLY, /* Wait for REPLCONF reply */ - REPL_STATE_RECEIVE_CAPA_REPLY, /* Wait for REPLCONF reply */ - REPL_STATE_SEND_PSYNC, /* Send PSYNC */ - REPL_STATE_RECEIVE_PSYNC_REPLY, /* Wait for PSYNC reply */ - /* --- End of handshake states --- */ - REPL_STATE_TRANSFER, /* Receiving .rdb from master */ - REPL_STATE_CONNECTED, /* Connected to master */ -} repl_state; - -/* Replica rdb channel replication state. Used in server.repl_rdb_ch_state for - * replicas to remember what to do next. */ -typedef enum { - REPL_RDB_CH_STATE_NONE = 0, /* No active rdb channel sync */ - REPL_RDB_CH_SEND_HANDSHAKE, /* Send handshake sequence to master */ - REPL_RDB_CH_RECEIVE_AUTH_REPLY, /* Wait for AUTH reply */ - REPL_RDB_CH_RECEIVE_REPLCONF_REPLY, /* Wait for REPLCONF reply */ - REPL_RDB_CH_RECEIVE_FULLRESYNC, /* Wait for +FULLRESYNC reply */ - REPL_RDB_CH_RDB_LOADING, /* Loading rdb using rdb channel */ -} repl_rdb_channel_state; - -#define REPL_MAIN_CH_NONE (1 << 0) -#define REPL_MAIN_CH_ACCUMULATE_BUF (1 << 1) -#define REPL_MAIN_CH_STREAMING_BUF (1 << 2) -#define REPL_MAIN_CH_CLOSE_ASAP (1 << 3) - -/* Replication debug flags for testing. */ -#define REPL_DEBUG_PAUSE_NONE (1 << 0) -#define REPL_DEBUG_AFTER_FORK (1 << 1) -#define REPL_DEBUG_BEFORE_RDB_CHANNEL (1 << 2) -#define REPL_DEBUG_ON_STREAMING_REPL_BUF (1 << 3) - -/* The state of an in progress coordinated failover */ -typedef enum { - NO_FAILOVER = 0, /* No failover in progress */ - FAILOVER_WAIT_FOR_SYNC, /* Waiting for target replica to catch up */ - FAILOVER_IN_PROGRESS /* Waiting for target replica to accept - * PSYNC FAILOVER request. */ -} failover_state; - -/* State of slaves from the POV of the master. Used in client->replstate. - * In SEND_BULK and ONLINE state the slave receives new updates - * in its output queue. In the WAIT_BGSAVE states instead the server is waiting - * to start the next background saving in order to send updates to it. */ -#define SLAVE_STATE_WAIT_BGSAVE_START 6 /* We need to produce a new RDB file. */ -#define SLAVE_STATE_WAIT_BGSAVE_END 7 /* Waiting RDB file creation to finish. */ -#define SLAVE_STATE_SEND_BULK 8 /* Sending RDB file to slave. */ -#define SLAVE_STATE_ONLINE 9 /* RDB file transmitted, sending just updates. */ -#define SLAVE_STATE_RDB_TRANSMITTED 10 /* RDB file transmitted - This state is used only for - * a replica that only wants RDB without replication buffer */ -#define SLAVE_STATE_WAIT_RDB_CHANNEL 11 /* Main channel of replica is connected, - * we are waiting rdbchannel connection to start delivery.*/ -#define SLAVE_STATE_SEND_BULK_AND_STREAM 12 /* Main channel of a replica which uses rdb channel replication. - * Sending RDB file and replication stream in parallel. */ - -/* Slave capabilities. */ -#define SLAVE_CAPA_NONE 0 -#define SLAVE_CAPA_EOF (1<<0) /* Can parse the RDB EOF streaming format. */ -#define SLAVE_CAPA_PSYNC2 (1<<1) /* Supports PSYNC2 protocol. */ -#define SLAVE_CAPA_RDB_CHANNEL_REPL (1<<2) /* Supports rdb channel replication during full sync */ - -/* Slave requirements */ -#define SLAVE_REQ_NONE 0 -#define SLAVE_REQ_RDB_EXCLUDE_DATA (1 << 0) /* Exclude data from RDB */ -#define SLAVE_REQ_RDB_EXCLUDE_FUNCTIONS (1 << 1) /* Exclude functions from RDB */ -#define SLAVE_REQ_SLOTS_SNAPSHOT (1 << 2) /* Only slots snapshot is required */ -#define SLAVE_REQ_RDB_CHANNEL (1 << 3) /* Use rdb channel replication, transfer RDB background */ -#define SLAVE_REQ_RDB_NO_COMPRESS (1 << 4) /* Don't enable RDB compression */ -/* Mask of all bits in the slave requirements bitfield that represent non-standard (filtered) RDB requirements */ -#define SLAVE_REQ_RDB_MASK (SLAVE_REQ_RDB_EXCLUDE_DATA | SLAVE_REQ_RDB_EXCLUDE_FUNCTIONS | SLAVE_REQ_SLOTS_SNAPSHOT) - -/* Synchronous read timeout - slave side */ -#define CONFIG_REPL_SYNCIO_TIMEOUT 5 - -/* The default number of replication backlog blocks to trim per call. */ -#define REPL_BACKLOG_TRIM_BLOCKS_PER_CALL 64 - -/* In order to quickly find the requested offset for PSYNC requests, - * we index some nodes in the replication buffer linked list into a rax. */ -#define REPL_BACKLOG_INDEX_PER_BLOCKS 64 - -/* List related stuff */ -#define LIST_HEAD 0 -#define LIST_TAIL 1 -#define ZSET_MIN 0 -#define ZSET_MAX 1 - -/* Sort operations */ -#define SORT_OP_GET 0 - -/* Log levels */ -#define LL_DEBUG 0 -#define LL_VERBOSE 1 -#define LL_NOTICE 2 -#define LL_WARNING 3 -#define LL_NOTHING 4 -#define LL_RAW (1<<10) /* Modifier to log without timestamp */ - -/* Supervision options */ -#define SUPERVISED_NONE 0 -#define SUPERVISED_AUTODETECT 1 -#define SUPERVISED_SYSTEMD 2 -#define SUPERVISED_UPSTART 3 - -/* Anti-warning macro... */ -#define UNUSED(V) ((void) V) - -#define ZSKIPLIST_MAXLEVEL 32 /* Should be enough for 2^64 elements */ -#define ZSKIPLIST_P 0.25 /* Skiplist P = 1/4 */ -#define ZSKIPLIST_MAX_SEARCH 10 - -/* Append only defines */ -#define AOF_FSYNC_NO 0 -#define AOF_FSYNC_ALWAYS 1 -#define AOF_FSYNC_EVERYSEC 2 - -/* Replication diskless load defines */ -#define REPL_DISKLESS_LOAD_DISABLED 0 -#define REPL_DISKLESS_LOAD_WHEN_DB_EMPTY 1 -#define REPL_DISKLESS_LOAD_SWAPDB 2 -#define REPL_DISKLESS_LOAD_ALWAYS 3 - -/* TLS Client Authentication */ -#define TLS_CLIENT_AUTH_NO 0 -#define TLS_CLIENT_AUTH_YES 1 -#define TLS_CLIENT_AUTH_OPTIONAL 2 - -/* TLS Client Certfiicate Authentication */ -#define TLS_CLIENT_FIELD_OFF 0 -#define TLS_CLIENT_FIELD_CN 1 - -/* Sanitize dump payload */ -#define SANITIZE_DUMP_NO 0 -#define SANITIZE_DUMP_YES 1 -#define SANITIZE_DUMP_CLIENTS 2 - -/* Enable protected config/command */ -#define PROTECTED_ACTION_ALLOWED_NO 0 -#define PROTECTED_ACTION_ALLOWED_YES 1 -#define PROTECTED_ACTION_ALLOWED_LOCAL 2 - -/* Sets operations codes */ -#define SET_OP_UNION 0 -#define SET_OP_DIFF 1 -#define SET_OP_INTER 2 - -/* oom-score-adj defines */ -#define OOM_SCORE_ADJ_NO 0 -#define OOM_SCORE_RELATIVE 1 -#define OOM_SCORE_ADJ_ABSOLUTE 2 - -/* Redis maxmemory strategies. Instead of using just incremental number - * for this defines, we use a set of flags so that testing for certain - * properties common to multiple policies is faster. */ -#define MAXMEMORY_FLAG_LRU (1<<0) -#define MAXMEMORY_FLAG_LFU (1<<1) -#define MAXMEMORY_FLAG_ALLKEYS (1<<2) -#define MAXMEMORY_FLAG_LRM (1<<3) -#define MAXMEMORY_FLAG_NO_SHARED_INTEGERS \ - (MAXMEMORY_FLAG_LRU|MAXMEMORY_FLAG_LFU|MAXMEMORY_FLAG_LRM) - -#define MAXMEMORY_VOLATILE_LRU ((0<<8)|MAXMEMORY_FLAG_LRU) -#define MAXMEMORY_VOLATILE_LFU ((1<<8)|MAXMEMORY_FLAG_LFU) -#define MAXMEMORY_VOLATILE_TTL (2<<8) -#define MAXMEMORY_VOLATILE_RANDOM (3<<8) -#define MAXMEMORY_ALLKEYS_LRU ((4<<8)|MAXMEMORY_FLAG_LRU|MAXMEMORY_FLAG_ALLKEYS) -#define MAXMEMORY_ALLKEYS_LFU ((5<<8)|MAXMEMORY_FLAG_LFU|MAXMEMORY_FLAG_ALLKEYS) -#define MAXMEMORY_ALLKEYS_RANDOM ((6<<8)|MAXMEMORY_FLAG_ALLKEYS) -#define MAXMEMORY_NO_EVICTION (7<<8) -#define MAXMEMORY_VOLATILE_LRM ((8<<8)|MAXMEMORY_FLAG_LRM) -#define MAXMEMORY_ALLKEYS_LRM ((9<<8)|MAXMEMORY_FLAG_LRM|MAXMEMORY_FLAG_ALLKEYS) - -/* Units */ -#define UNIT_SECONDS 0 -#define UNIT_MILLISECONDS 1 - -/* SHUTDOWN flags */ -#define SHUTDOWN_NOFLAGS 0 /* No flags. */ -#define SHUTDOWN_SAVE 1 /* Force SAVE on SHUTDOWN even if no save - points are configured. */ -#define SHUTDOWN_NOSAVE 2 /* Don't SAVE on SHUTDOWN. */ -#define SHUTDOWN_NOW 4 /* Don't wait for replicas to catch up. */ -#define SHUTDOWN_FORCE 8 /* Don't let errors prevent shutdown. */ - -/* Cluster slot stats flags */ -#define CLUSTER_SLOT_STATS_CPU 1 /* Track CPU usage per slot. */ -#define CLUSTER_SLOT_STATS_NET 2 /* Track network bytes per slot. */ -#define CLUSTER_SLOT_STATS_MEM 4 /* Track memory usage per slot. */ -#define CLUSTER_SLOT_STATS_ALL (CLUSTER_SLOT_STATS_CPU | CLUSTER_SLOT_STATS_NET | CLUSTER_SLOT_STATS_MEM) - -/* IO thread pause status */ -#define IO_THREAD_UNPAUSED 0 -#define IO_THREAD_PAUSING 1 -#define IO_THREAD_PAUSED 2 -#define IO_THREAD_RESUMING 3 - -/* Command call flags, see call() function */ -#define CMD_CALL_NONE 0 -#define CMD_CALL_PROPAGATE_AOF (1<<0) -#define CMD_CALL_PROPAGATE_REPL (1<<1) -#define CMD_CALL_FROM_MODULE (1<<2) /* From RM_Call */ -#define CMD_CALL_PROPAGATE (CMD_CALL_PROPAGATE_AOF|CMD_CALL_PROPAGATE_REPL) -#define CMD_CALL_FULL (CMD_CALL_PROPAGATE) - -/* Command propagation flags, see propagateNow() function */ -#define PROPAGATE_NONE 0 -#define PROPAGATE_AOF 1 -#define PROPAGATE_REPL 2 - -/* Actions pause types */ -#define PAUSE_ACTION_CLIENT_WRITE (1<<0) -#define PAUSE_ACTION_CLIENT_ALL (1<<1) /* must be bigger than PAUSE_ACTION_CLIENT_WRITE */ -#define PAUSE_ACTION_EXPIRE (1<<2) -#define PAUSE_ACTION_EVICT (1<<3) -#define PAUSE_ACTION_REPLICA (1<<4) /* pause replica traffic */ - -/* common sets of actions to pause/unpause */ -#define PAUSE_ACTIONS_CLIENT_WRITE_SET (PAUSE_ACTION_CLIENT_WRITE|\ - PAUSE_ACTION_EXPIRE|\ - PAUSE_ACTION_EVICT|\ - PAUSE_ACTION_REPLICA) -#define PAUSE_ACTIONS_CLIENT_ALL_SET (PAUSE_ACTION_CLIENT_ALL|\ - PAUSE_ACTION_EXPIRE|\ - PAUSE_ACTION_EVICT|\ - PAUSE_ACTION_REPLICA) - -/* Client pause purposes. Each purpose has its own end time and pause type. */ -typedef enum { - PAUSE_BY_CLIENT_COMMAND = 0, - PAUSE_DURING_SHUTDOWN, - PAUSE_DURING_FAILOVER, - PAUSE_DURING_SLOT_HANDOFF, - NUM_PAUSE_PURPOSES /* This value is the number of purposes above. */ -} pause_purpose; - -typedef struct { - uint32_t paused_actions; /* Bitmask of actions */ - mstime_t end; -} pause_event; - -/* Ways that a clusters endpoint can be described */ -typedef enum { - CLUSTER_ENDPOINT_TYPE_IP = 0, /* Show IP address */ - CLUSTER_ENDPOINT_TYPE_HOSTNAME, /* Show hostname */ - CLUSTER_ENDPOINT_TYPE_UNKNOWN_ENDPOINT /* Show NULL or empty */ -} cluster_endpoint_type; - -/* RDB active child save type. */ -#define RDB_CHILD_TYPE_NONE 0 -#define RDB_CHILD_TYPE_DISK 1 /* RDB is written to disk. */ -#define RDB_CHILD_TYPE_SOCKET 2 /* RDB is written to slave socket. */ - -/* Keyspace changes notification classes. Every class is associated with a - * character for configuration purposes. */ -#define NOTIFY_KEYSPACE (1<<0) /* K */ -#define NOTIFY_KEYEVENT (1<<1) /* E */ -#define NOTIFY_GENERIC (1<<2) /* g */ -#define NOTIFY_STRING (1<<3) /* $ */ -#define NOTIFY_LIST (1<<4) /* l */ -#define NOTIFY_SET (1<<5) /* s */ -#define NOTIFY_HASH (1<<6) /* h */ -#define NOTIFY_ZSET (1<<7) /* z */ -#define NOTIFY_EXPIRED (1<<8) /* x */ -#define NOTIFY_EVICTED (1<<9) /* e */ -#define NOTIFY_STREAM (1<<10) /* t */ -#define NOTIFY_KEY_MISS (1<<11) /* m (Note: This one is excluded from NOTIFY_ALL on purpose) */ -#define NOTIFY_LOADED (1<<12) /* module only key space notification, indicate a key loaded from rdb */ -#define NOTIFY_MODULE (1<<13) /* d, module key space notification */ -#define NOTIFY_NEW (1<<14) /* n, new key notification (Note: excluded from NOTIFY_ALL) */ -#define NOTIFY_OVERWRITTEN (1<<15) /* o, key overwrite notification (Note: excluded from NOTIFY_ALL) */ -#define NOTIFY_TYPE_CHANGED (1<<16) /* c, key type changed notification (Note: excluded from NOTIFY_ALL) */ -#define NOTIFY_KEY_TRIMMED (1<<17) /* module only key space notification, indicates a key trimmed during slot migration */ -#define NOTIFY_ALL (NOTIFY_GENERIC | NOTIFY_STRING | NOTIFY_LIST | NOTIFY_SET | NOTIFY_HASH | NOTIFY_ZSET | NOTIFY_EXPIRED | NOTIFY_EVICTED | NOTIFY_STREAM | NOTIFY_MODULE) /* A flag */ - -/* Using the following macro you can run code inside serverCron() with the - * specified period, specified in milliseconds. - * The actual resolution depends on server.hz. */ -#define run_with_period(_ms_) if (((_ms_) <= 1000/server.hz) || !(server.cronloops%((_ms_)/(1000/server.hz)))) - -/* We can print the stacktrace, so our assert is defined this way: */ -#define serverAssertWithInfo(_c,_o,_e) (likely(_e)?(void)0 : (_serverAssertWithInfo(_c,_o,#_e,__FILE__,__LINE__),redis_unreachable())) -#define serverAssert(_e) (likely(_e)?(void)0 : (_serverAssert(#_e,__FILE__,__LINE__),redis_unreachable())) -#define serverPanic(...) _serverPanic(__FILE__,__LINE__,__VA_ARGS__),redis_unreachable() - -/* The following macros provide assertions that are only executed during test builds and should be used to add - * assertions that are too computationally expensive or dangerous to run during normal operations. */ -#ifdef DEBUG_ASSERTIONS -#define debugServerAssertWithInfo(...) serverAssertWithInfo(__VA_ARGS__) -#define debugServerAssert(...) serverAssert(__VA_ARGS__) -#else -#define debugServerAssertWithInfo(...) -#define debugServerAssert(...) -#endif - -/* latency histogram per command init settings */ -#define LATENCY_HISTOGRAM_MIN_VALUE 1L /* >= 1 nanosec */ -#define LATENCY_HISTOGRAM_MAX_VALUE 1000000000L /* <= 1 secs */ -#define LATENCY_HISTOGRAM_PRECISION 2 /* Maintain a value precision of 2 significant digits across LATENCY_HISTOGRAM_MIN_VALUE and LATENCY_HISTOGRAM_MAX_VALUE range. - * Value quantization within the range will thus be no larger than 1/100th (or 1%) of any value. - * The total size per histogram should sit around 40 KiB Bytes. */ - -/* Busy module flags, see busy_module_yield_flags */ -#define BUSY_MODULE_YIELD_NONE (0) -#define BUSY_MODULE_YIELD_EVENTS (1<<0) -#define BUSY_MODULE_YIELD_CLIENTS (1<<1) - -/* Key prefetch configs */ -#define PREFETCH_BATCH_MAX_SIZE 128 - -/*----------------------------------------------------------------------------- - * Data types - *----------------------------------------------------------------------------*/ - -/* A redis object, that is a type able to hold a string / list / set */ - -/* The actual Redis Object */ -#define OBJ_STRING 0 /* String object. */ -#define OBJ_LIST 1 /* List object. */ -#define OBJ_SET 2 /* Set object. */ -#define OBJ_ZSET 3 /* Sorted set object. */ -#define OBJ_HASH 4 /* Hash object. */ -#define OBJ_TYPE_BASIC_MAX 5 /* Max number of basic object types. */ - -/* The "module" object type is a special one that signals that the object - * is one directly managed by a Redis module. In this case the value points - * to a moduleValue struct, which contains the object value (which is only - * handled by the module itself) and the RedisModuleType struct which lists - * function pointers in order to serialize, deserialize, AOF-rewrite and - * free the object. - * - * Inside the RDB file, module types are encoded as OBJ_MODULE followed - * by a 64 bit module type ID, which has a 54 bits module-specific signature - * in order to dispatch the loading to the right module, plus a 10 bits - * encoding version. */ -#define OBJ_MODULE 5 /* Module object. */ -#define OBJ_STREAM 6 /* Stream object. */ -#define OBJ_TYPE_MAX 7 /* Maximum number of object types */ - -/* Extract encver / signature from a module type ID. */ -#define REDISMODULE_TYPE_ENCVER_BITS 10 -#define REDISMODULE_TYPE_ENCVER_MASK ((1<<REDISMODULE_TYPE_ENCVER_BITS)-1) -#define REDISMODULE_TYPE_ENCVER(id) ((id) & REDISMODULE_TYPE_ENCVER_MASK) -#define REDISMODULE_TYPE_SIGN(id) (((id) & ~((uint64_t)REDISMODULE_TYPE_ENCVER_MASK)) >>REDISMODULE_TYPE_ENCVER_BITS) - -/* Bit flags for moduleTypeAuxSaveFunc */ -#define REDISMODULE_AUX_BEFORE_RDB (1<<0) -#define REDISMODULE_AUX_AFTER_RDB (1<<1) - -struct RedisModule; -struct RedisModuleIO; -struct RedisModuleDigest; -struct RedisModuleCtx; -struct moduleLoadQueueEntry; -struct RedisModuleCommand; -struct clusterState; -struct slotRangeArray; - -/* Each module type implementation should export a set of methods in order - * to serialize and deserialize the value in the RDB file, rewrite the AOF - * log, create the digest for "DEBUG DIGEST", and free the value when a key - * is deleted. */ -typedef void *(*moduleTypeLoadFunc)(struct RedisModuleIO *io, int encver); -typedef void (*moduleTypeSaveFunc)(struct RedisModuleIO *io, void *value); -typedef int (*moduleTypeAuxLoadFunc)(struct RedisModuleIO *rdb, int encver, int when); -typedef void (*moduleTypeAuxSaveFunc)(struct RedisModuleIO *rdb, int when); -typedef void (*moduleTypeRewriteFunc)(struct RedisModuleIO *io, struct redisObject *key, void *value); -typedef void (*moduleTypeDigestFunc)(struct RedisModuleDigest *digest, void *value); -typedef size_t (*moduleTypeMemUsageFunc)(const void *value); -typedef void (*moduleTypeFreeFunc)(void *value); -typedef size_t (*moduleTypeFreeEffortFunc)(struct redisObject *key, const void *value); -typedef void (*moduleTypeUnlinkFunc)(struct redisObject *key, void *value); -typedef void *(*moduleTypeCopyFunc)(struct redisObject *fromkey, struct redisObject *tokey, const void *value); -typedef int (*moduleTypeDefragFunc)(struct RedisModuleDefragCtx *ctx, struct redisObject *key, void **value); -typedef size_t (*moduleTypeMemUsageFunc2)(struct RedisModuleKeyOptCtx *ctx, const void *value, size_t sample_size); -typedef void (*moduleTypeFreeFunc2)(struct RedisModuleKeyOptCtx *ctx, void *value); -typedef size_t (*moduleTypeFreeEffortFunc2)(struct RedisModuleKeyOptCtx *ctx, const void *value); -typedef void (*moduleTypeUnlinkFunc2)(struct RedisModuleKeyOptCtx *ctx, void *value); -typedef void *(*moduleTypeCopyFunc2)(struct RedisModuleKeyOptCtx *ctx, const void *value); -typedef int (*moduleTypeAuthCallback)(struct RedisModuleCtx *ctx, void *username, void *password, const char **err); - -/* Module Entity ID: module type or keymeta. */ -typedef struct ModuleEntityId { - struct RedisModule *module; - char name[10]; /* 9 bytes name + null term. Charset: A-Z a-z 0-9 _- */ - uint64_t id; /* Higher 54 bits of type ID + 10 lower bits of encoding ver. */ -} ModuleEntityId; - -/* The module type, which is referenced in each value of a given type, defines - * the methods and links to the module exporting the type. */ -typedef struct RedisModuleType { - ModuleEntityId entity; /* module data type name and ID. */ - moduleTypeLoadFunc rdb_load; - moduleTypeSaveFunc rdb_save; - moduleTypeRewriteFunc aof_rewrite; - moduleTypeMemUsageFunc mem_usage; - moduleTypeDigestFunc digest; - moduleTypeFreeFunc free; - moduleTypeFreeEffortFunc free_effort; - moduleTypeUnlinkFunc unlink; - moduleTypeCopyFunc copy; - moduleTypeDefragFunc defrag; - moduleTypeAuxLoadFunc aux_load; - moduleTypeAuxSaveFunc aux_save; - moduleTypeMemUsageFunc2 mem_usage2; - moduleTypeFreeEffortFunc2 free_effort2; - moduleTypeUnlinkFunc2 unlink2; - moduleTypeCopyFunc2 copy2; - moduleTypeAuxSaveFunc aux_save2; - int aux_save_triggers; -} moduleType; - -/* In Redis objects 'robj' structures of type OBJ_MODULE, the value pointer - * is set to the following structure, referencing the moduleType structure - * in order to work with the value, and at the same time providing a raw - * pointer to the value, as created by the module commands operating with - * the module type. - * - * So for example in order to free such a value, it is possible to use - * the following code: - * - * if (robj->type == OBJ_MODULE) { - * moduleValue *mt = robj->ptr; - * mt->type->free(mt->value); - * zfree(mt); // We need to release this in-the-middle struct as well. - * } - */ -typedef struct moduleValue { - moduleType *type; - void *value; -} moduleValue; - -/* Describe the state of the module during loading, and the indication which configs were loaded / applied already. */ -typedef enum { - MODULE_CONFIGS_DEFAULTS = 0x1, /* The registered defaults were applied. */ - MODULE_CONFIGS_USER_VALS = 0x2, /* The user provided values were applied. */ - MODULE_CONFIGS_ALL_APPLIED = 0x3 /* Both of the above applied. */ -} ModuleConfigsApplied; - -/* This structure represents a module inside the system. */ -struct RedisModule { - void *handle; /* Module dlopen() handle. */ - char *name; /* Module name. */ - int ver; /* Module version. We use just progressive integers. */ - int apiver; /* Module API version as requested during initialization.*/ - list *types; /* Module data types. */ - list *usedby; /* List of modules using APIs from this one. */ - list *using; /* List of modules we use some APIs of. */ - list *filters; /* List of filters the module has registered. */ - list *module_configs; /* List of configurations the module has registered */ - ModuleConfigsApplied configs_initialized; /* Have the module configurations been initialized? */ - int in_call; /* RM_Call() nesting level */ - int in_hook; /* Hooks callback nesting level for this module (0 or 1). */ - int options; /* Module options and capabilities. */ - int blocked_clients; /* Count of RedisModuleBlockedClient in this module. */ - RedisModuleInfoFunc info_cb; /* Callback for module to add INFO fields. */ - RedisModuleDefragFunc defrag_cb; /* Callback for global data defrag. */ - RedisModuleDefragFunc2 defrag_cb_2; /* Version 2 callback for global data defrag. */ - RedisModuleDefragFunc defrag_start_cb; /* Callback indicating defrag started. */ - RedisModuleDefragFunc defrag_end_cb; /* Callback indicating defrag ended. */ - struct moduleLoadQueueEntry *loadmod; /* Module load arguments for config rewrite. */ - int num_commands_with_acl_categories; /* Number of commands in this module included in acl categories */ - int onload; /* Flag to identify if the call is being made from Onload (0 or 1) */ - size_t num_acl_categories_added; /* Number of acl categories added by this module. */ -}; -typedef struct RedisModule RedisModule; - -/* The defrag context, used to manage state during calls to the data type - * defrag callback. - */ -struct RedisModuleDefragCtx { - monotime endtime; - unsigned long *cursor; - struct redisObject *key; /* Optional name of key processed, NULL when unknown. */ - int dbid; /* The dbid of the key being processed, -1 when unknown. */ - long long last_stop_check_hits; /* Number of defrag hits at last check. */ - long long last_stop_check_misses; /* Number of defrag misses at last check. */ - int stopping; /* Flag indicating if defrag should stop. */ -}; -#define INIT_MODULE_DEFRAG_CTX(endtime, cursor, key, dbid) \ - ((RedisModuleDefragCtx) { \ - (endtime), (cursor), (key), (dbid), \ - server.stat_active_defrag_hits, \ - server.stat_active_defrag_misses \ - }) - -/* This is a wrapper for the 'rio' streams used inside rdb.c in Redis, so that - * the user does not have to take the total count of the written bytes nor - * to care about error conditions. */ -struct RedisModuleIO { - size_t bytes; /* Bytes read / written so far. */ - rio *rio; /* Rio stream. */ - ModuleEntityId *entity; /* Module type or keymeta doing the operation. */ - int error; /* True if error condition happened. */ - struct RedisModuleCtx *ctx; /* Optional context, see RM_GetContextFromIO()*/ - struct redisObject *key; /* Optional name of key processed */ - int dbid; /* The dbid of the key being processed, -1 when unknown. */ - sds pre_flush_buffer; /* A buffer that should be flushed before next write operation - * See rdbSaveSingleModuleAux for more details */ -}; - -/* Initialize an IO context. Note that the 'ver' field is populated - * inside rdb.c according to the version of the value to load. */ -static inline void moduleInitIOContext(RedisModuleIO *io, ModuleEntityId *entity, - rio *rioptr, struct redisObject *keyptr, int db) -{ - io->rio = rioptr; - io->entity = entity; - io->bytes = 0; - io->error = 0; - io->key = keyptr; - io->dbid = db; - io->ctx = NULL; - io->pre_flush_buffer = NULL; -} - -/* This is a structure used to export DEBUG DIGEST capabilities to Redis - * modules. We want to capture both the ordered and unordered elements of - * a data structure, so that a digest can be created in a way that correctly - * reflects the values. See the DEBUG DIGEST command implementation for more - * background. */ -struct RedisModuleDigest { - unsigned char o[20]; /* Ordered elements. */ - unsigned char x[20]; /* Xored elements. */ - struct redisObject *key; /* Optional name of key processed */ - int dbid; /* The dbid of the key being processed */ -}; - -/* Just start with a digest composed of all zero bytes. */ -#define moduleInitDigestContext(mdvar) do { \ - memset(mdvar.o,0,sizeof(mdvar.o)); \ - memset(mdvar.x,0,sizeof(mdvar.x)); \ -} while(0) - -/* Macro to check if the client is in the middle of module based authentication. */ -#define clientHasModuleAuthInProgress(c) ((c)->module_auth_ctx != NULL) - -/* The string name for an object's type as listed above - * Native types are checked against the OBJ_STRING, OBJ_LIST, OBJ_* defines, - * and Module types have their registered name returned. */ -char *getObjectTypeName(robj*); - -/* Macro used to initialize 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 = OBJ_STATIC_REFCOUNT; \ - _var.type = OBJ_STRING; \ - _var.encoding = OBJ_ENCODING_RAW; \ - _var.metabits = 0; \ - _var.iskvobj = 0; \ - _var.ptr = _ptr; \ -} while(0) - -struct evictionPoolEntry; /* Defined in evict.c */ - -/* Encoded buffers contain headers followed by either plain replies or - * by bulk string references */ -typedef enum { - PLAIN_REPLY = 0, /* plain reply */ - BULK_STR_REF /* bulk string references */ -} payloadType; - -/* Encoded reply buffers consist of chunks - * Each chunk contains header followed by payload - * The packed attribute is specified because buffer is accessed at arbitrary offsets, - * so no benefit in data structure padding and applying packed saves the space in the buffer */ -typedef struct __attribute__((__packed__)) payloadHeader { - size_t payload_len; /* payload length in a reply buffer */ - uint8_t payload_type; /* one of payloadType */ -} payloadHeader; -static_assert(offsetof(payloadHeader, payload_len) == 0, "payload_len must be at offset 0 to avoid unaligned access"); - -/* To avoid copy of whole string in reply buffer - * we store pointers to object and string itself */ -typedef struct __attribute__((__packed__)) bulkStrRef { - robj *obj; /* pointer to object used for reference count management */ - unsigned int prefix_cnt; - char prefix[LONG_STR_SIZE + 3]; /* $<len>\r\n */ - char crlf[2]; /* \r\n */ -} bulkStrRef; - -/* This structure is used in order to represent the output buffer of a client, - * which is actually a linked list of blocks like that, that is: client->reply. */ -typedef struct clientReplyBlock { - size_t size, used; - char buf_encoded; - char buf[]; -} clientReplyBlock; - -/* Replication buffer blocks is the list of replBufBlock. - * - * +--------------+ +--------------+ +--------------+ - * | refcount = 1 | ... | refcount = 0 | ... | refcount = 2 | - * +--------------+ +--------------+ +--------------+ - * | / \ - * | / \ - * | / \ - * Repl Backlog Replica_A Replica_B - * - * Each replica or replication backlog increments only the refcount of the - * 'ref_repl_buf_node' which it points to. So when replica walks to the next - * node, it should first increase the next node's refcount, and when we trim - * the replication buffer nodes, we remove node always from the head node which - * refcount is 0. If the refcount of the head node is not 0, we must stop - * trimming and never iterate the next node. - * - * For replicas in IO threads we don't update the refcount while sending the - * repl data, but only when the client is sent back to main. This avoids data - * races. In order to achieve this, the replicas keep track of following: - * - io_curr_repl_node - the current node we've reached. - * - io_bound_repl_node - the last node in the replication buffer as seen by - * the replica client before it was sent to IO thread - * - * When the client is sent to IO thread for the first time io_curr_repl_node is - * initialized with ref_repl_buf_node. - * When the client is sent back to main it can decrement ref_repl_buf_node's - * refcount and increment it for io_curr_repl_node, since all the nodes - * in-between are already sent and the client doesn't hold reference to them. - * - * `io_bound_repl_node` is needed because IO thread needs to know when to stop - * sending data. If it was reading directly from the replication buffer, - * there will be a data race, because main thread may be writing to it during - * `feedReplicationBuffer`. `io_bound_repl_node` is cached in the client - * together with its used size just before sending the client to IO thread - * in `enqueuePendingClienstToIOThreads`. */ - -/* Similar with 'clientReplyBlock', it is used for shared buffers between - * all replica clients and replication backlog. */ -typedef struct replBufBlock { - int refcount; /* Number of replicas or repl backlog using. */ - long long id; /* The unique incremental number. */ - long long repl_offset; /* Start replication offset of the block. */ - size_t size; /* Capacity of the buf in bytes */ - size_t used; /* Count of written bytes */ - char buf[]; -} replBufBlock; - -/* Redis database representation. There are multiple databases identified - * by integers from 0 (the default database) up to the max configured - * database. The database number is the 'id' field in the structure. */ -typedef struct redisDb { - kvstore *keys; /* The keyspace for this DB. As metadata, holds keysizes histogram */ - kvstore *expires; /* Timeout of keys with a timeout set */ - estore *subexpires; /* Timeout of sub-keys with a timeout set. (Currently only used for hashes) */ - dict *blocking_keys; /* Keys with clients waiting for data (BLPOP)*/ - dict *blocking_keys_unblock_on_nokey; /* Keys with clients waiting for - * data, and should be unblocked if key is deleted (XREADEDGROUP). - * This is a subset of blocking_keys*/ - dict *stream_claim_pending_keys; /* Keys with clients waiting to claim pending entries */ - dict *stream_idmp_keys; /* Stream keys with IDMP tracking */ - dict *ready_keys; /* Blocked keys that received a PUSH */ - dict *watched_keys; /* WATCHED keys for MULTI/EXEC CAS */ - int id; /* Database ID */ - long long avg_ttl; /* Average TTL, just for stats */ - unsigned long expires_cursor; /* Cursor of the active expire cycle. */ -} redisDb; - -/* maximum number of bins of keysizes histogram */ -#define MAX_KEYSIZES_BINS 60 -#define MAX_KEYSIZES_TYPES 5 /* static_assert at db.c verifies == OBJ_TYPE_BASIC_MAX */ -typedef int64_t keysizesHist[MAX_KEYSIZES_TYPES][MAX_KEYSIZES_BINS]; - -/* Metadata structure used for kvstores with type `kvstoreExType`, managed outside kvstore */ -typedef struct { - keysizesHist keysizes_hist; -} kvstoreMetadata; - -/* Like kvstoreMetadata, this one per dict */ -typedef struct { - kvstoreDictMetaBase base; /* must be first in struct ! */ - size_t alloc_size; /* Total memory used (in bytes) by this slot */ - uint64_t cpu_usec; /* CPU time (in microseconds) spent on given slot */ - uint64_t network_bytes_in; /* Network ingress (in bytes) received for given slot */ - uint64_t network_bytes_out; /* Network egress (in bytes) sent for given slot */ - keysizesHist keysizes_hist; -} kvstoreDictMetadata; - -/* forward declaration for functions ctx */ -typedef struct functionsLibCtx functionsLibCtx; - -/* Holding object that need to be populated during - * rdb loading. On loading end it is possible to decide - * whether not to set those objects on their rightful place. - * For example: dbarray need to be set as main database on - * successful loading and dropped on failure. */ -typedef struct rdbLoadingCtx { - redisDb* dbarray; - functionsLibCtx* functions_lib_ctx; -}rdbLoadingCtx; - -typedef struct pendingCommand pendingCommand; -typedef struct multiState { - pendingCommand **commands; /* Array of pointers to MULTI commands */ - int executing_cmd; /* The index of the currently executed transaction - command (index in commands field) */ - int count; /* Total number of MULTI commands */ - int cmd_flags; /* The accumulated command flags OR-ed together. - So if at least a command has a given flag, it - will be set in this field. */ - int cmd_inv_flags; /* Same as cmd_flags, OR-ing the ~flags. so that it - is possible to know if all the commands have a - certain flag. */ - size_t argv_len_sums; /* mem used by all commands arguments */ - int alloc_count; /* total number of pendingCommand struct memory reserved. */ -} multiState; - -/* This structure holds the blocking operation state for a client. - * The fields used depend on client->btype. */ -typedef struct blockingState { - /* Generic fields. */ - blocking_type btype; /* Type of blocking op if CLIENT_BLOCKED. */ - mstime_t timeout; /* Blocking operation timeout. If UNIX current time - * is > timeout then the operation timed out. */ - int unblock_on_nokey; /* Whether to unblock the client when at least one of the keys - is deleted or does not exist anymore */ - /* BLOCKED_LIST, BLOCKED_ZSET and BLOCKED_STREAM or any other Keys related blocking */ - dict *keys; /* The keys we are blocked on */ - - /* BLOCKED_WAIT and BLOCKED_WAITAOF */ - int numreplicas; /* Number of replicas we are waiting for ACK. */ - int numlocal; /* Indication if WAITAOF is waiting for local fsync. */ - long long reploffset; /* Replication offset to reach. */ - - /* BLOCKED_MODULE */ - void *module_blocked_handle; /* RedisModuleBlockedClient structure. - which is opaque for the Redis core, only - handled in module.c. */ - - void *async_rm_call_handle; /* RedisModuleAsyncRMCallPromise structure. - which is opaque for the Redis core, only - handled in module.c. */ - - /* BLOCKED_LAZYFREE */ - monotime lazyfreeStartTime; -} blockingState; - -/* 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 iterate over 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; - -/* List of pending commands. */ -typedef struct pendingCommandList { - pendingCommand *head; - pendingCommand *tail; - int len; /* Number of commands in the list */ - int ready_len; /* Number of commands that are ready to be processed */ -} pendingCommandList; - -/* Pending command pool management structure */ -#define PENDING_COMMAND_POOL_SIZE 16 -#define PENDING_COMMAND_POOL_MAX_SIZE 1024 -typedef struct pendingCommandPool { - pendingCommand **pool; /* Pool array for reusing pendingCommand objects */ - int size; /* Current number of objects in pool */ - int capacity; /* Current capacity of the pool array */ - int min_size; /* Minimum size since last check (indicates peak usage) */ -} pendingCommandPool; - -/* This structure represents a Redis user. This is useful for ACLs, the - * user is associated to the connection after the connection is authenticated. - * If there is no associated user, the connection uses the default user. */ -#define USER_COMMAND_BITS_COUNT 1024 /* The total number of command bits - in the user structure. The last valid - command ID we can set in the user - is USER_COMMAND_BITS_COUNT-1. */ -#define USER_FLAG_ENABLED (1<<0) /* The user is active. */ -#define USER_FLAG_DISABLED (1<<1) /* The user is disabled. */ -#define USER_FLAG_NOPASS (1<<2) /* The user requires no password, any - provided password will work. For the - default user, this also means that - no AUTH is needed, and every - connection is immediately - authenticated. */ -#define USER_FLAG_SANITIZE_PAYLOAD (1<<3) /* The user require a deep RESTORE - * payload sanitization. */ -#define USER_FLAG_SANITIZE_PAYLOAD_SKIP (1<<4) /* The user should skip the - * deep sanitization of RESTORE - * payload. */ - -#define SELECTOR_FLAG_ROOT (1<<0) /* This is the root user permission - * selector. */ -#define SELECTOR_FLAG_ALLKEYS (1<<1) /* The user can mention any key. */ -#define SELECTOR_FLAG_ALLCOMMANDS (1<<2) /* The user can run all commands. */ -#define SELECTOR_FLAG_ALLCHANNELS (1<<3) /* The user can mention any Pub/Sub - channel. */ - -typedef struct { - sds name; /* The username as an SDS string. */ - redisAtomic uint32_t flags; /* See USER_FLAG_* */ - list *passwords; /* A list of SDS valid passwords for this user. */ - list *selectors; /* A list of selectors this user validates commands - against. This list will always contain at least - one selector for backwards compatibility. */ - robj *acl_string; /* cached string represent of ACLs */ -} user; - -/* With multiplexing we need to take per-client state. - * Clients are taken in a linked list. */ - -#define CLIENT_ID_AOF (UINT64_MAX) /* Reserved ID for the AOF client. If you - need more reserved IDs use UINT64_MAX-1, - -2, ... and so forth. */ - -/* Replication backlog is not a separate memory, it just is one consumer of - * the global replication buffer. This structure records the reference of - * replication buffers. Since the replication buffer block list may be very long, - * it would cost much time to search replication offset on partial resync, so - * we use one rax tree to index some blocks every REPL_BACKLOG_INDEX_PER_BLOCKS - * to make searching offset from replication buffer blocks list faster. */ -typedef struct replBacklog { - listNode *ref_repl_buf_node; /* Referenced node of replication buffer blocks, - * see the definition of replBufBlock. */ - size_t unindexed_count; /* The count from last creating index block. */ - rax *blocks_index; /* The index of recorded blocks of replication - * buffer for quickly searching replication - * offset on partial resynchronization. */ - long long histlen; /* Backlog actual data length */ - long long offset; /* Replication "master offset" of first - * byte in the replication backlog buffer.*/ -} replBacklog; - -/* Used by replDataBuf during rdb channel replication to accumulate replication - * stream on replica side. */ -typedef struct replDataBufBlock { - size_t used; /* Used bytes in the buf */ - size_t size; /* Size of the buf */ - char buf[]; /* Replication data */ -} replDataBufBlock; - -/* Linked list of replDataBufBlock structs, holds replication stream during - * rdb channel replication on replica side. */ -typedef struct replDataBuf { - list *blocks; /* List of replDataBufBlock */ - size_t mem_used; /* Total allocated memory */ - size_t size; /* Total number of bytes available in all blocks. */ - size_t used; /* Total number of bytes actually used in all blocks. */ - size_t peak; /* Peak number of bytes stored in all blocks. */ - size_t last_num_blocks; /* Used to verify we consume more than we read from - * the master connection while streaming buffer to - * the db. */ -} replDataBuf; - -typedef struct { - list *clients; - size_t mem_usage_sum; -} clientMemUsageBucket; - -#define DEFERRED_OBJECT_TYPE_PENDING_COMMAND 1 -#define DEFERRED_OBJECT_TYPE_ROBJ 2 -/* Structure to hold objects that need to be freed later by IO threads. - * This allows the main thread to defer memory cleanup operations to - * IO threads to avoid blocking the main event loop. */ -typedef struct deferredObject { - int type; /* Pointer to the object to be freed */ - void *ptr; /* Type of object: DEFERRED_OBJECT_TYPE_* */ -} deferredObject; - -#define SHOULD_CLUSTER_COMPATIBILITY_SAMPLE() \ - (server.cluster_compatibility_sample_ratio == 100 || \ - (double)rand()/RAND_MAX * 100 < server.cluster_compatibility_sample_ratio) - -#ifdef LOG_REQ_RES -/* Structure used to log client's requests and their - * responses (see logreqres.c) */ -typedef struct { - /* General */ - int argv_logged; /* 1 if the command was logged */ - /* Vars for log buffer */ - unsigned char *buf; /* Buffer holding the data (request and response) */ - size_t used; - size_t capacity; - /* Vars for offsets within the client's reply */ - struct { - /* General */ - int saved; /* 1 if we already saved the offset (first time we call addReply*) */ - /* Offset within the static reply buffer */ - size_t bufpos; - /* Offset within the reply block list */ - struct { - int index; - size_t used; - } last_node; - } offset; -} clientReqResInfo; -#endif - -typedef struct client { - uint64_t id; /* Client incremental unique ID. */ - uint64_t flags; /* Client flags: CLIENT_* macros. */ - connection *conn; - uint8_t tid; /* Thread assigned ID this client is bound to. */ - uint8_t running_tid; /* Thread assigned ID this client is running on. */ - uint8_t io_flags; /* Accessed by both main and IO threads, but not modified concurrently */ - uint8_t read_error; /* Client read error: CLIENT_READ_* macros. */ - int resp; /* RESP protocol version. Can be 2 or 3. */ - redisDb *db; /* Pointer to currently SELECTed DB. */ - robj *name; /* As set by CLIENT SETNAME. */ - robj *lib_name; /* The client library name as set by CLIENT SETINFO. */ - robj *lib_ver; /* The client library version as set by CLIENT SETINFO. */ - sds querybuf; /* Buffer we use to accumulate client queries. */ - size_t qb_pos; /* The position we have read in querybuf. */ - size_t querybuf_peak; /* Recent (100ms or more) peak of querybuf size. */ - int argc; /* Num of arguments of current command. */ - robj **argv; /* Arguments of current command. */ - int argv_len; /* Size of argv array (may be more than argc) */ - int original_argc; /* Num of arguments of original command if arguments were rewritten. */ - robj **original_argv; /* Arguments of original command if arguments were rewritten. */ - size_t all_argv_len_sum; /* Sum of lengths of objects in all pendingCommand argv lists */ - pendingCommandList pending_cmds; /* List of parsed pending commands */ - pendingCommand *current_pending_cmd; - deferredObject *deferred_objects; /* Array of deferred objects to free. */ - int deferred_objects_num; /* Number of deferred objects to free. */ - robj **io_deferred_objects; /* Objects to be freed by main thread, queued by IO thread */ - int io_deferred_objects_num; /* Number of objects in io_deferred_objects */ - int io_deferred_objects_size; /* Allocated size of io_deferred_objects */ - struct redisCommand *cmd, *lastcmd; /* Last command executed. */ - struct redisCommand *lookedcmd; /* Command looked up in lookahead. */ - struct redisCommand *realcmd; /* The original command that was executed by the client, - Used to update error stats in case the c->cmd was modified - during the command invocation (like on GEOADD for example). */ - user *user; /* User associated with this connection. If the - user is set to NULL the connection can do - anything (admin). */ - int reqtype; /* Request protocol type: PROTO_REQ_* */ - int multibulklen; /* Number of multi bulk arguments left to read. */ - long bulklen; /* Length of bulk argument in multi bulk request. */ - list *reply; /* List of reply objects to send to the client. */ - unsigned long long reply_bytes; /* Tot bytes of objects in reply list. */ - list *deferred_reply_errors; /* Used for module thread safe contexts. */ - size_t sentlen; /* Amount of bytes already sent in the current - buffer or object being sent. */ - time_t ctime; /* Client creation time. */ - long duration; /* Current command duration. Used for measuring latency of blocking/non-blocking cmds */ - int slot; /* The slot the client is executing against. Set to -1 if no slot is being used */ - int cluster_compatibility_check_slot; /* The slot the client is executing against for cluster compatibility check. - * -2 means we don't need to check slot violation, or we already found - * a violation, reported it and don't need to continue checking. - * -1 means we're looking for the slot number and didn't find it yet. - * any positive number means we found a slot and no violation yet. */ - dictEntry *cur_script; /* Cached pointer to the dictEntry of the script being executed. */ - time_t lastinteraction; /* Time of the last interaction, used for timeout */ - time_t io_lastinteraction; /* Time of the last interaction as seen from - * IO thread. When the client is moved to main - * it updates its `lastinteraction` value from - * this. */ - time_t obuf_soft_limit_reached_time; - mstime_t io_last_client_cron; /* Timestamp of last invocation of client - * cron if client is running in IO thread */ - mstime_t io_last_repl_cron; /* Timestamp of last invocation of replication - * cron if client is running in IO thread. */ - int authenticated; /* Needed when the default user requires auth. */ - int replstate; /* Replication state if this is a slave. */ - int repl_start_cmd_stream_on_ack; /* Install slave write handler on first ACK. */ - int repldbfd; /* Replication DB file descriptor. */ - off_t repldboff; /* Replication DB file offset. */ - off_t repldbsize; /* Replication DB file size. */ - sds replpreamble; /* Replication DB preamble. */ - long long read_reploff; /* Read replication offset if this is a master. */ - long long io_read_reploff; /* Copy of read_reploff but only used when - * master client is in IO thread so we don't - * have contention with IO thread. */ - long long reploff; /* Applied replication offset if this is a master. */ - long long reploff_next; /* Next value to set for reploff when a command finishes executing */ - long long repl_applied; /* Applied replication data count in querybuf, if this is a replica. */ - long long repl_ack_off; /* Replication ack offset, if this is a slave. */ - long long repl_aof_off; /* Replication AOF fsync ack offset, if this is a slave. */ - long long repl_ack_time;/* Replication ack time, if this is a slave. */ - long long io_repl_ack_time; /* Replication ack time, if this is a replica in - * IO thread. Keeps track of repl_ack_time while - * replica is in IO thread to avoid data races - * with main. repl_ack_time is updated with this - * value when replica returns to main thread. */ - long long repl_last_partial_write; /* The last time the server did a partial write from the RDB child pipe to this replica */ - long long psync_initial_offset; /* FULLRESYNC reply offset other slaves - copying this slave output buffer - should use. */ - char replid[CONFIG_RUN_ID_SIZE+1]; /* Master replication ID (if master). */ - int slave_listening_port; /* As configured with: REPLCONF listening-port */ - char *slave_addr; /* Optionally given by REPLCONF ip-address */ - int slave_capa; /* Slave capabilities: SLAVE_CAPA_* bitwise OR. */ - int slave_req; /* Slave requirements: SLAVE_REQ_* */ - uint64_t main_ch_client_id; /* The client id of this replica's main channel */ - multiState mstate; /* MULTI/EXEC state */ - blockingState bstate; /* blocking state */ - long long woff; /* Last write global replication offset. */ - list *watched_keys; /* Keys WATCHED for MULTI/EXEC CAS */ - dict *pubsub_channels; /* channels a client is interested in (SUBSCRIBE) */ - dict *pubsub_patterns; /* patterns a client is interested in (PSUBSCRIBE) */ - dict *pubsubshard_channels; /* shard level channels a client is interested in (SSUBSCRIBE) */ - sds peerid; /* Cached peer ID. */ - sds sockname; /* Cached connection target address. */ - listNode *client_list_node; /* list node in client list */ - listNode *io_thread_client_list_node; /* list node in io thread client list */ - listNode *postponed_list_node; /* list node within the postponed list */ - void *module_blocked_client; /* Pointer to the RedisModuleBlockedClient associated with this - * client. This is set in case of module authentication before the - * unblocked client is reprocessed to handle reply callbacks. */ - void *module_auth_ctx; /* Ongoing / attempted module based auth callback's ctx. - * This is only tracked within the context of the command attempting - * authentication. If not NULL, it means module auth is in progress. */ - RedisModuleUserChangedFunc auth_callback; /* Module callback to execute - * when the authenticated user - * changes. */ - void *auth_callback_privdata; /* Private data that is passed when the auth - * changed callback is executed. Opaque for - * Redis Core. */ - void *auth_module; /* The module that owns the callback, which is used - * to disconnect the client if the module is - * unloaded for cleanup. Opaque for Redis Core.*/ - - /* If this client is in tracking mode and this field is non zero, - * invalidation messages for keys fetched by this client will be sent to - * the specified client ID. */ - uint64_t client_tracking_redirection; - rax *client_tracking_prefixes; /* A dictionary of prefixes we are already - subscribed to in BCAST mode, in the - context of client side caching. */ - /* In updateClientMemoryUsage() we track the memory usage of - * each client and add it to the sum of all the clients of a given type, - * however we need to remember what was the old contribution of each - * client, and in which category the client was, in order to remove it - * before adding it the new value. */ - size_t last_memory_usage; - int last_memory_type; - - listNode *mem_usage_bucket_node; - clientMemUsageBucket *mem_usage_bucket; - - listNode *ref_repl_buf_node; /* Referenced node of replication buffer blocks, - * see the definition of replBufBlock. */ - size_t ref_block_pos; /* Access position of referenced buffer block, - * i.e. the next offset to send. */ - listNode *io_curr_repl_node; /* Current node we are sending repl data from in - * IO thread. */ - size_t io_curr_block_pos; /* Current position we are sending repl data from - * in IO thread. */ - listNode *io_bound_repl_node;/* Bound node we are sending repl data from in - * IO thread. */ - size_t io_bound_block_pos; /* Bound position we are sending repl data from - * in IO thread. */ - - /* list node in clients_pending_write list */ - listNode clients_pending_write_node; - /* list node in clients_with_pending_ref_reply list */ - listNode *pending_ref_reply_node; - /* Statistics and metrics */ - size_t net_input_bytes_curr_cmd; /* Total network input bytes read for the - * execution of this client's current command. */ - size_t net_output_bytes_curr_cmd; /* Total network output bytes sent to this - * client, by the current command. */ - /* Response buffer */ - size_t buf_peak; /* Peak used size of buffer in last 5 sec interval. */ - mstime_t buf_peak_last_reset_time; /* keeps the last time the buffer peak value was reset */ - size_t bufpos; - size_t buf_usable_size; /* Usable size of buffer. */ - char *buf; - uint8_t buf_encoded; /* True if c->buf content is encoded (e.g. for copy avoidance) */ - payloadHeader *last_header; /* Pointer to the last header in a buffer when using copy avoidance */ -#ifdef LOG_REQ_RES - clientReqResInfo reqres; -#endif - unsigned long long net_input_bytes; /* Total network input bytes read from this client. */ - unsigned long long net_output_bytes; /* Total network output bytes sent to this client. */ - unsigned long long commands_processed; /* Total count of commands this client executed. */ - struct asmTask *task; /* Atomic slot migration task */ - char *node_id; /* Node ID to connect to for atomic slot migration */ - - redisAtomic int pending_read; /* Flag indicating an IO thread client residing - * in main thread has received a read event. */ -} client; - -typedef struct __attribute__((aligned(CACHE_LINE_SIZE))) { - uint8_t id; /* The unique ID assigned, if IO_THREADS_MAX_NUM is more - * than 256, we should also promote the data type. */ - pthread_t tid; /* Pthread ID */ - redisAtomic int paused; /* Paused status for the io thread. */ - redisAtomic int running; /* Running if true, main thread can send clients directly. */ - aeEventLoop *el; /* Main event loop of io thread. */ - list *pending_clients; /* List of clients with pending writes. */ - list *processing_clients; /* List of clients being processed. */ - eventNotifier *pending_clients_notifier; /* Used to wake up the loop when write should be performed. */ - pthread_mutex_t pending_clients_mutex; /* Mutex for pending write list */ - list *pending_clients_to_main_thread; /* Clients that are waiting to be executed by the main thread. */ - list *clients; /* IO thread managed clients. */ -} IOThread; - -/* Context for streaming replDataBuf to database */ -typedef struct replDataBufToDbCtx { - void *privdata; /* Private data of context */ - client *client; /* Client to process commands */ - size_t applied_offset; /* Offset applied to the database */ - int (*should_continue)(void *ctx); /* Check if we should continue */ - void (*yield_callback)(void *ctx); /* Yield to the event loop */ -} replDataBufToDbCtx; - -/* ACL information */ -typedef struct aclInfo { - long long user_auth_failures; /* Auth failure counts on user level */ - long long invalid_cmd_accesses; /* Invalid command accesses that user doesn't have permission to */ - long long invalid_key_accesses; /* Invalid key accesses that user doesn't have permission to */ - long long invalid_channel_accesses; /* Invalid channel accesses that user doesn't have permission to */ - long long acl_access_denied_tls_cert; /* TLS clients with cert not matching any existing user. */ -} aclInfo; - -struct saveparam { - time_t seconds; - int changes; -}; - -struct moduleLoadQueueEntry { - sds path; - int argc; - robj **argv; -}; - -struct sentinelLoadQueueEntry { - int argc; - sds *argv; - int linenum; - sds line; -}; - -struct sentinelConfig { - list *pre_monitor_cfg; - list *monitor_cfg; - list *post_monitor_cfg; -}; - -struct sharedObjectsStruct { - robj *ok, *err, *emptybulk, *czero, *cone, *pong, *space, - *queued, *null[4], *nullarray[4], *emptymap[4], *emptyset[4], - *emptyarray, *wrongtypeerr, *nokeyerr, *syntaxerr, *sameobjecterr, - *outofrangeerr, *noscripterr, *loadingerr, - *slowevalerr, *slowscripterr, *slowmoduleerr, *bgsaveerr, - *masterdownerr, *roslaveerr, *execaborterr, *noautherr, *noreplicaserr, - *busykeyerr, *oomerr, *plus, *messagebulk, *pmessagebulk, *subscribebulk, - *unsubscribebulk, *psubscribebulk, *punsubscribebulk, *del, *unlink, - *rpop, *lpop, *lpush, *rpoplpush, *lmove, *blmove, *zpopmin, *zpopmax, - *emptyscan, *multi, *exec, *left, *right, *hset, *srem, *xgroup, *xclaim, - *script, *replconf, *eval, *persist, *set, *pexpireat, *pexpire, - *hdel, *hpexpireat, *hpersist, *hsetex, - *time, *pxat, *absttl, *retrycount, *force, *justid, *entriesread, - *lastid, *ping, *setid, *keepttl, *load, *createconsumer, *fields, - *getack, *special_asterick, *special_equals, *default_username, *redacted, - *ssubscribebulk,*sunsubscribebulk, *smessagebulk, - *select[PROTO_SHARED_SELECT_CMDS], - *integers[OBJ_SHARED_INTEGERS], - *mbulkhdr[OBJ_SHARED_BULKHDR_LEN], /* "*<value>\r\n" */ - *bulkhdr[OBJ_SHARED_BULKHDR_LEN], /* "$<value>\r\n" */ - *maphdr[OBJ_SHARED_BULKHDR_LEN], /* "%<value>\r\n" */ - *sethdr[OBJ_SHARED_BULKHDR_LEN]; /* "~<value>\r\n" */ - sds minstring, maxstring; -}; - -/* ZSETs use a specialized version of Skiplists */ - -/* Node info placed in level[0].span since it's unused at level 0 (static assert verified) */ -typedef struct zskiplistNodeInfo { - uint16_t sdsoffset; /* Offset from node start to sds data (after sds header) */ - uint8_t levels; /* Number of levels in this node (1-32) */ - uint8_t reserved; -} zskiplistNodeInfo; - -typedef struct zskiplistNode { - double score; - struct zskiplistNode *backward; - struct zskiplistLevel { - struct zskiplistNode *forward; - /* Span is the number of elements between this node and the next node at this level. - * At level 0, span is repurposed to store zskiplistNodeInfo for regular nodes, */ - unsigned long span; - } level[]; - /* sds ele is embedded after level[] array (assist zslGetNodeElement(node) to access it) */ -} zskiplistNode; - -typedef struct zskiplist { - struct zskiplistNode *header, *tail; - unsigned long length; - int level; - size_t alloc_size; -} zskiplist; - -typedef struct zset { - dict *dict; - zskiplist *zsl; -} zset; - -typedef struct clientBufferLimitsConfig { - unsigned long long hard_limit_bytes; - unsigned long long soft_limit_bytes; - time_t soft_limit_seconds; -} clientBufferLimitsConfig; - -extern clientBufferLimitsConfig clientBufferLimitsDefaults[CLIENT_TYPE_OBUF_COUNT]; - -/* The redisOp structure defines a Redis Operation, that is an instance of - * a command with an argument vector, database ID, propagation target - * (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 { - robj **argv; - int argc, dbid, target; -} redisOp; - -/* Defines an array of Redis operations. There is an API to add to this - * structure in an easy way. - * - * int redisOpArrayAppend(redisOpArray *oa, int dbid, robj **argv, int argc, int target); - * void redisOpArrayFree(redisOpArray *oa); - */ -typedef struct redisOpArray { - redisOp *ops; - int numops; - int capacity; -} redisOpArray; - -/* This structure is returned by the getMemoryOverheadData() function in - * order to return memory overhead information. */ -struct redisMemOverhead { - size_t peak_allocated; - size_t total_allocated; - size_t startup_allocated; - size_t repl_backlog; - size_t replica_fullsync_buffer; - size_t clients_slaves; - size_t clients_normal; - size_t cluster_links; - size_t aof_buffer; - size_t eval_caches; - size_t functions_caches; - size_t script_vm; - size_t overhead_total; - size_t dataset; - size_t total_keys; - size_t bytes_per_key; - float dataset_perc; - float peak_perc; - float total_frag; - ssize_t total_frag_bytes; - float allocator_frag; - ssize_t allocator_frag_bytes; - float allocator_rss; - ssize_t allocator_rss_bytes; - float rss_extra; - size_t rss_extra_bytes; - size_t num_dbs; - size_t overhead_db_hashtable_lut; - size_t overhead_db_hashtable_rehashing; - unsigned long db_dict_rehashing_count; - size_t asm_import_input_buffer; - size_t asm_migrate_output_buffer; - struct { - size_t dbid; - size_t overhead_ht_main; - size_t overhead_ht_expires; - } *db; -}; - -/* Replication error behavior determines the replica behavior - * when it receives an error over the replication stream. In - * either case the error is logged. */ -typedef enum { - PROPAGATION_ERR_BEHAVIOR_IGNORE = 0, - PROPAGATION_ERR_BEHAVIOR_PANIC, - PROPAGATION_ERR_BEHAVIOR_PANIC_ON_REPLICAS -} replicationErrorBehavior; - -/* This structure can be optionally passed to RDB save/load functions in - * order to implement additional functionalities, by storing and loading - * metadata to the RDB file. - * - * For example, to use select a DB at load time, useful in - * replication in order to make sure that chained slaves (slaves of slaves) - * select the correct DB and are able to accept the stream coming from the - * top-level master. */ -typedef struct rdbSaveInfo { - /* Used saving and loading. */ - int repl_stream_db; /* DB to select in server.master client. */ - - /* Used only loading. */ - int repl_id_is_set; /* True if repl_id field is set. */ - char repl_id[CONFIG_RUN_ID_SIZE+1]; /* Replication ID. */ - long long repl_offset; /* Replication offset. */ -} rdbSaveInfo; - -#define RDB_SAVE_INFO_INIT {-1,0,"0000000000000000000000000000000000000000",-1} - -struct malloc_stats { - size_t zmalloc_used; - size_t process_rss; - size_t allocator_allocated; - size_t allocator_active; - size_t allocator_resident; - size_t allocator_muzzy; - size_t allocator_frag_smallbins_bytes; - size_t lua_allocator_allocated; - size_t lua_allocator_active; - size_t lua_allocator_resident; - size_t lua_allocator_frag_smallbins_bytes; -}; - -/*----------------------------------------------------------------------------- - * TLS Context Configuration - *----------------------------------------------------------------------------*/ - -typedef struct redisTLSContextConfig { - char *cert_file; /* Server side and optionally client side cert file name */ - char *key_file; /* Private key filename for cert_file */ - char *key_file_pass; /* Optional password for key_file */ - char *client_cert_file; /* Certificate to use as a client; if none, use cert_file */ - char *client_key_file; /* Private key filename for client_cert_file */ - char *client_key_file_pass; /* Optional password for client_key_file */ - int client_auth_user; /* Field to be used for automatic TLS authentication based on client TLS certificate */ - char *dh_params_file; - char *ca_cert_file; - char *ca_cert_dir; - char *protocols; - char *ciphers; - char *ciphersuites; - int prefer_server_ciphers; - int session_caching; - int session_cache_size; - int session_cache_timeout; -} redisTLSContextConfig; - -/*----------------------------------------------------------------------------- - * AOF manifest definition - *----------------------------------------------------------------------------*/ -typedef enum { - AOF_FILE_TYPE_BASE = 'b', /* BASE file */ - AOF_FILE_TYPE_HIST = 'h', /* HISTORY file */ - AOF_FILE_TYPE_INCR = 'i', /* INCR file */ -} aof_file_type; - -typedef struct { - sds file_name; /* file name */ - long long file_seq; /* file sequence */ - aof_file_type file_type; /* file type */ - long long start_offset; /* the start replication offset of the file */ - long long end_offset; /* the end replication offset of the file */ -} aofInfo; - -typedef struct { - aofInfo *base_aof_info; /* BASE file information. NULL if there is no BASE file. */ - list *incr_aof_list; /* INCR AOFs list. We may have multiple INCR AOF when rewrite fails. */ - list *history_aof_list; /* HISTORY AOF list. When the AOFRW success, The aofInfo contained in - `base_aof_info` and `incr_aof_list` will be moved to this list. We - will delete these AOF files when AOFRW finish. */ - long long curr_base_file_seq; /* The sequence number used by the current BASE file. */ - long long curr_incr_file_seq; /* The sequence number used by the current INCR file. */ - int dirty; /* 1 Indicates that the aofManifest in the memory is inconsistent with - disk, we need to persist it immediately. */ -} aofManifest; - -/*----------------------------------------------------------------------------- - * Global server state - *----------------------------------------------------------------------------*/ - -/* AIX defines hz to __hz, we don't use this define and in order to allow - * Redis build on AIX we need to undef it. */ -#ifdef _AIX -#undef hz -#endif - -#define CHILD_TYPE_NONE 0 -#define CHILD_TYPE_RDB 1 -#define CHILD_TYPE_AOF 2 -#define CHILD_TYPE_LDB 3 -#define CHILD_TYPE_MODULE 4 - -typedef enum childInfoType { - CHILD_INFO_TYPE_CURRENT_INFO, - CHILD_INFO_TYPE_AOF_COW_SIZE, - CHILD_INFO_TYPE_RDB_COW_SIZE, - CHILD_INFO_TYPE_MODULE_COW_SIZE -} childInfoType; - -typedef struct hotkeyStats hotkeyStats; - -struct redisServer { - /* General */ - pid_t pid; /* Main process pid. */ - pthread_t main_thread_id; /* Main thread id */ - char *configfile; /* Absolute config file path, or NULL */ - char *executable; /* Absolute executable file path. */ - char **exec_argv; /* Executable argv vector (copy). */ - int dynamic_hz; /* Change hz value depending on # of clients. */ - int config_hz; /* Configured HZ value. May be different than - the actual 'hz' field value if dynamic-hz - is enabled. */ - mode_t umask; /* The umask value of the process on startup */ - int hz; /* serverCron() calls frequency in hertz */ - int in_fork_child; /* indication that this is a fork child */ - redisDb *db; - dict *commands; /* Command table */ - dict *orig_commands; /* Command table before command renaming. */ - aeEventLoop *el; - rax *errors; /* Errors table */ - int errors_enabled; /* If true, errorstats is enabled, and we will add new errors. */ - unsigned int lruclock; /* Clock for LRU eviction */ - redisAtomic int shutdown_asap; /* Shutdown ordered by signal handler. */ - redisAtomic int crashing; /* Server is crashing report. */ - mstime_t shutdown_mstime; /* Timestamp to limit graceful shutdown. */ - redisAtomic int last_sig_received; /* Indicates the last SIGNAL received, if any (e.g., SIGINT or SIGTERM). */ - int shutdown_flags; /* Flags passed to prepareForShutdown(). */ - int activerehashing; /* Incremental rehash in serverCron() */ - int active_defrag_running; /* Active defragmentation running (holds current scan aggressiveness) */ - char *pidfile; /* PID file path */ - int arch_bits; /* 32 or 64 depending on sizeof(long) */ - int cronloops; /* Number of times the cron function run */ - char runid[CONFIG_RUN_ID_SIZE+1]; /* ID always different at every exec. */ - int sentinel_mode; /* True if this instance is a Sentinel. */ - size_t initial_memory_usage; /* Bytes used after initialization. */ - int always_show_logo; /* Show logo even for non-stdout logging. */ - int in_exec; /* Are we inside EXEC? */ - int busy_module_yield_flags; /* Are we inside a busy module? (triggered by RM_Yield). see BUSY_MODULE_YIELD_ flags. */ - const char *busy_module_yield_reply; /* When non-null, we are inside RM_Yield. */ - char *ignore_warnings; /* Config: warnings that should be ignored. */ - int client_pause_in_transaction; /* Was a client pause executed during this Exec? */ - int thp_enabled; /* If true, THP is enabled. */ - size_t page_size; /* The page size of OS. */ - redisAtomic int running; /* Running if true, IO threads can send clients without notification */ - /* Modules */ - dict *moduleapi; /* Exported core APIs dictionary for modules. */ - dict *sharedapi; /* Like moduleapi but containing the APIs that - modules share with each other. */ - dict *module_configs_queue; /* Unmapped configs are queued here, assumed to be module config. Applied after modules are loaded during startup or arguments to loadex. */ - list *loadmodule_queue; /* List of modules to load at startup. */ - int module_pipe[2]; /* Pipe used to awake the event loop by module threads. */ - pid_t child_pid; /* PID of current child */ - int child_type; /* Type of current child */ - redisAtomic int module_gil_acquring; /* Indicates whether the GIL is being acquiring by the main thread. */ - /* Networking */ - int port; /* TCP listening port */ - int tls_port; /* TLS listening port */ - int tcp_backlog; /* TCP listen() backlog */ - char *bindaddr[CONFIG_BINDADDR_MAX]; /* Addresses we should bind to */ - int bindaddr_count; /* Number of addresses in server.bindaddr[] */ - char *bind_source_addr; /* Source address to bind on for outgoing connections */ - char *unixsocket; /* UNIX socket path */ - unsigned int unixsocketperm; /* UNIX socket permission (see mode_t) */ - connListener listeners[CONN_TYPE_MAX]; /* TCP/Unix/TLS even more types */ - uint32_t socket_mark_id; /* ID for listen socket marking */ - connListener clistener; /* Cluster bus listener */ - list *clients; /* List of active clients */ - list *clients_to_close; /* Clients to close asynchronously */ - list *clients_pending_write; /* There is to write or install handler. */ - list *clients_pending_read; /* Client has pending read socket buffers. */ - list *clients_with_pending_ref_reply; /* Clients with referenced reply objects. */ - list *slaves, *monitors; /* List of slaves and MONITORs */ - client *current_client; /* The client that triggered the command execution (External or AOF). */ - client *executing_client; /* The client executing the current command (possibly script or module). */ - -#ifdef LOG_REQ_RES - char *req_res_logfile; /* Path of log file for logging all requests and their replies. If NULL, no logging will be performed */ - unsigned int client_default_resp; -#endif - - /* Stuff for client mem eviction */ - clientMemUsageBucket* client_mem_usage_buckets; - - rax *clients_timeout_table; /* Radix tree for blocked clients timeouts. */ - int execution_nesting; /* Execution nesting level. - * e.g. call(), async module stuff (timers, events, etc.), - * cron stuff (active expire, eviction) */ - rax *clients_index; /* Active clients dictionary by client ID. */ - uint32_t paused_actions; /* Bitmask of actions that are currently paused */ - list *postponed_clients; /* List of postponed clients */ - pause_event client_pause_per_purpose[NUM_PAUSE_PURPOSES]; - char neterr[ANET_ERR_LEN]; /* Error buffer for anet.c */ - dict *migrate_cached_sockets;/* MIGRATE cached sockets */ - redisAtomic uint64_t next_client_id; /* Next client unique ID. Incremental. */ - int protected_mode; /* Don't accept external connections. */ - int io_threads_num; /* Number of IO threads to use. */ - int io_threads_clients_num[IO_THREADS_MAX_NUM]; /* Number of clients assigned to each IO thread. */ - int io_threads_do_reads; /* Read and parse from IO threads? */ - int io_threads_active; /* Is IO threads currently active? */ - pendingCommandPool cmd_pool; /* Shared pool for reusing pendingCommand, - * only when IO threads disabled */ - int prefetch_batch_max_size;/* Maximum number of keys to prefetch in a single batch */ - long long events_processed_while_blocked; /* processEventsWhileBlocked() */ - int enable_protected_configs; /* Enable the modification of protected configs, see PROTECTED_ACTION_ALLOWED_* */ - int enable_debug_cmd; /* Enable DEBUG commands, see PROTECTED_ACTION_ALLOWED_* */ - int enable_module_cmd; /* Enable MODULE commands, see PROTECTED_ACTION_ALLOWED_* */ - - /* RDB / AOF loading information */ - volatile sig_atomic_t loading; /* We are loading data from disk if true */ - volatile sig_atomic_t async_loading; /* We are loading data without blocking the db being served */ - off_t loading_total_bytes; - off_t loading_rdb_used_mem; - off_t loading_loaded_bytes; - time_t loading_start_time; - off_t loading_process_events_interval_bytes; - /* Fields used only for stats */ - 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_expired_subkeys; /* Number of expired subkeys (Currently only hash-fields) */ - double stat_expired_stale_perc; /* Percentage of keys probably expired */ - long long stat_expired_time_cap_reached_count; /* Early expire cycle stops.*/ - long long stat_expire_cycle_time_used; /* Cumulative microseconds used. */ - long long stat_evictedkeys; /* Number of evicted keys (maxmemory) */ - long long stat_evictedclients; /* Number of evicted clients */ - long long stat_evictedscripts; /* Number of evicted lua scripts. */ - long long stat_total_eviction_exceeded_time; /* Total time over the memory limit, unit us */ - monotime stat_last_eviction_exceeded_time; /* Timestamp of current eviction start, unit us */ - long long stat_keyspace_hits; /* Number of successful lookups of keys */ - long long stat_keyspace_misses; /* Number of failed lookups of keys */ - long long stat_active_defrag_hits; /* number of allocations moved */ - long long stat_active_defrag_misses; /* number of allocations scanned but not moved */ - long long stat_active_defrag_key_hits; /* number of keys with moved allocations */ - long long stat_active_defrag_key_misses;/* number of keys scanned and not moved */ - long long stat_active_defrag_scanned; /* number of dictEntries scanned */ - long long stat_total_active_defrag_time; /* Total time memory fragmentation over the limit, unit us */ - monotime stat_last_active_defrag_time; /* Timestamp of current active defrag start */ - size_t stat_peak_memory; /* Max used memory record */ - time_t stat_peak_memory_time; /* Time when stat_peak_memory was recorded */ - long long stat_aof_rewrites; /* number of aof file rewrites performed */ - long long stat_aofrw_consecutive_failures; /* The number of consecutive failures of aofrw */ - long long stat_rdb_saves; /* number of rdb saves performed */ - long long stat_rdb_consecutive_failures; /* The number of consecutive failures of rdb saves */ - long long stat_fork_time; /* Time needed to perform latest fork() */ - double stat_fork_rate; /* Fork rate in GB/sec. */ - long long stat_total_forks; /* Total count of fork. */ - long long stat_rejected_conn; /* Clients rejected because of maxclients */ - long long stat_sync_full; /* Number of full resyncs with slaves. */ - long long stat_sync_partial_ok; /* Number of accepted PSYNC requests. */ - long long stat_sync_partial_err;/* Number of unaccepted PSYNC requests. */ - 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 */ - struct malloc_stats cron_malloc_stats; /* sampled in serverCron(). */ - redisAtomic long long stat_net_input_bytes; /* Bytes read from network. */ - redisAtomic long long stat_net_output_bytes; /* Bytes written to network. */ - redisAtomic long long stat_net_repl_input_bytes; /* Bytes read during replication, added to stat_net_input_bytes in 'info'. */ - redisAtomic long long stat_net_repl_output_bytes; /* Bytes written during replication, added to stat_net_output_bytes in 'info'. */ - size_t stat_current_cow_peak; /* Peak size of copy on write bytes. */ - size_t stat_current_cow_bytes; /* Copy on write bytes while child is active. */ - monotime stat_current_cow_updated; /* Last update time of stat_current_cow_bytes */ - size_t stat_current_save_keys_processed; /* Processed keys while child is active. */ - size_t stat_current_save_keys_total; /* Number of keys when child started. */ - size_t stat_rdb_cow_bytes; /* Copy on write bytes during RDB saving. */ - size_t stat_aof_cow_bytes; /* Copy on write bytes during AOF rewrite. */ - size_t stat_module_cow_bytes; /* Copy on write bytes during module fork. */ - double stat_module_progress; /* Module save progress. */ - size_t stat_clients_type_memory[CLIENT_TYPE_COUNT];/* Mem usage by type */ - size_t stat_cluster_links_memory; /* Mem usage by cluster links */ - long long stat_unexpected_error_replies; /* Number of unexpected (aof-loading, replica to master, etc.) error replies */ - long long stat_total_error_replies; /* Total number of issued error replies ( command + rejected errors ) */ - long long stat_dump_payload_sanitizations; /* Number deep dump payloads integrity validations. */ - redisAtomic long long stat_io_reads_processed[IO_THREADS_MAX_NUM]; /* Number of read events processed by IO / Main threads */ - redisAtomic long long stat_io_writes_processed[IO_THREADS_MAX_NUM]; /* Number of write events processed by IO / Main threads */ - redisAtomic long long stat_client_qbuf_limit_disconnections; /* Total number of clients reached query buf length limit */ - long long stat_client_outbuf_limit_disconnections; /* Total number of clients reached output buf length limit */ - long long stat_cluster_incompatible_ops; /* Number of operations that are incompatible with cluster mode */ - long long stat_total_prefetch_entries; /* Total number of prefetched dict entries */ - long long stat_total_prefetch_batches; /* Total number of prefetched batches */ - /* The following two are used to track instantaneous metrics, like - * number of operations per second, network traffic. */ - struct { - long long last_sample_base; /* The divisor of last sample window */ - long long last_sample_value; /* The dividend of last sample window */ - long long samples[STATS_METRIC_SAMPLES]; - int idx; - } inst_metric[STATS_METRIC_COUNT]; - long long stat_reply_buffer_shrinks; /* Total number of output buffer shrinks */ - long long stat_reply_buffer_expands; /* Total number of output buffer expands */ - monotime el_start; - /* The following two are used to record the max number of commands executed in one eventloop. - * Note that commands in transactions are also counted. */ - long long el_cmd_cnt_start; - long long el_cmd_cnt_max; - /* The sum of active-expire, active-defrag and all other tasks done by cron and beforeSleep, - but excluding read, write and AOF, which are counted by other sets of metrics. */ - monotime el_cron_duration; - durationStats duration_stats[EL_DURATION_TYPE_NUM]; - - /* Hotkey tracking */ - hotkeyStats *hotkeys; - - /* Configuration */ - int verbosity; /* Loglevel in redis.conf */ - int hide_user_data_from_log; /* In the event of an assertion failure, hide command arguments from the operator */ - int maxidletime; /* Client timeout in seconds */ - int tcpkeepalive; /* Set SO_KEEPALIVE if non-zero. */ - int active_expire_enabled; /* Can be disabled for testing purposes. */ - int active_expire_effort; /* From 1 (default) to 10, active effort. */ - int allow_access_expired; /* If > 0, allow access to logically expired keys */ - int allow_access_trimmed; /* If > 0, allow access to logically trimmed keys */ - int active_defrag_enabled; - int sanitize_dump_payload; /* Enables deep sanitization for ziplist and listpack in RDB and RESTORE. */ - int skip_checksum_validation; /* Disable checksum validation for RDB and RESTORE payload. */ - int jemalloc_bg_thread; /* Enable jemalloc background thread */ - int active_defrag_configuration_changed; /* defrag configuration has been changed and need to reconsider - * active_defrag_running in computeDefragCycles. */ - size_t active_defrag_ignore_bytes; /* minimum amount of fragmentation waste to start active defrag */ - int active_defrag_threshold_lower; /* minimum percentage of fragmentation to start active defrag */ - int active_defrag_threshold_upper; /* maximum percentage of fragmentation at which we use maximum effort */ - int active_defrag_cycle_min; /* minimal effort for defrag in CPU percentage */ - int active_defrag_cycle_max; /* maximal effort for defrag in CPU percentage */ - unsigned long active_defrag_max_scan_fields; /* maximum number of fields of set/hash/zset/list to process from within the main dict scan */ - size_t client_max_querybuf_len; /* Limit for client query buffer length */ - int lookahead; /* how many commands in each client pipeline to decode and prefetch */ - int dbnum; /* Total number of configured DBs */ - int supervised; /* 1 if supervised, 0 otherwise. */ - int supervised_mode; /* See SUPERVISED_* */ - int daemonize; /* True if running as a daemon */ - int set_proc_title; /* True if change proc title */ - char *proc_title_template; /* Process title template format */ - clientBufferLimitsConfig client_obuf_limits[CLIENT_TYPE_OBUF_COUNT]; - int pause_cron; /* Don't run cron tasks (debug) */ - int dict_resizing; /* Whether to allow main dict and expired dict to be resized (debug) */ - int latency_tracking_enabled; /* 1 if extended latency tracking is enabled, 0 otherwise. */ - double *latency_tracking_info_percentiles; /* Extended latency tracking info output percentile list configuration. */ - int latency_tracking_info_percentiles_len; - int memory_tracking_per_slot; /* Account used memory per slot */ - unsigned int max_new_tls_conns_per_cycle; /* The maximum number of tls connections that will be accepted during each invocation of the event loop. */ - unsigned int max_new_conns_per_cycle; /* The maximum number of tcp connections that will be accepted during each invocation of the event loop. */ - int cluster_compatibility_sample_ratio; /* Sampling ratio for cluster mode incompatible commands. */ - int lazyexpire_nested_arbitrary_keys; /* If disabled, avoid lazy-expire from commands that touch arbitrary keys (SCAN/RANDOMKEY) within transactions */ - - /* AOF persistence */ - int aof_enabled; /* AOF configuration */ - int aof_state; /* AOF_(ON|OFF|WAIT_REWRITE) */ - int aof_fsync; /* Kind of fsync() policy */ - char *aof_filename; /* Basename of the AOF file and manifest file */ - char *aof_dirname; /* Name of the AOF directory */ - 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 (Including BASE + INCRs). */ - off_t aof_last_incr_size; /* The size of the latest incr AOF. */ - off_t aof_last_incr_fsync_offset; /* AOF offset which is already requested to be synced to disk. - * Compare with the aof_last_incr_size. */ - int aof_flush_sleep; /* Micros to sleep before flush. (used by tests) */ - int aof_rewrite_scheduled; /* Rewrite once BGSAVE terminates. */ - 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 */ - mstime_t aof_flush_postponed_start; /* mstime of postponed AOF flush */ - mstime_t aof_last_fsync; /* mstime of last fsync() */ - time_t aof_rewrite_time_last; /* Time used by last AOF rewrite run. */ - time_t aof_rewrite_time_start; /* Current AOF rewrite start time. */ - time_t aof_cur_timestamp; /* Current record timestamp in AOF */ - int aof_timestamp_enabled; /* Enable record timestamp in AOF */ - int aof_lastbgrewrite_status; /* C_OK or C_ERR */ - unsigned long aof_delayed_fsync; /* delayed AOF fsync() counter */ - int aof_rewrite_incremental_fsync;/* fsync incrementally while aof rewriting? */ - int rdb_save_incremental_fsync; /* fsync incrementally while rdb saving? */ - int aof_last_write_status; /* C_OK or C_ERR */ - int aof_last_write_errno; /* Valid if aof write/fsync status is ERR */ - int aof_load_truncated; /* Don't stop on unexpected AOF EOF. */ - off_t aof_load_corrupt_tail_max_size; /* The max size of broken AOF tail than can be ignored. */ - int aof_use_rdb_preamble; /* Specify base AOF to use RDB encoding on AOF rewrites. */ - redisAtomic int aof_bio_fsync_status; /* Status of AOF fsync in bio job. */ - redisAtomic int aof_bio_fsync_errno; /* Errno of AOF fsync in bio job. */ - aofManifest *aof_manifest; /* Used to track AOFs. */ - int aof_disable_auto_gc; /* If disable automatically deleting HISTORY type AOFs? - default no. (for testings). */ - - /* RDB persistence */ - long long dirty; /* Changes to DB from the last save */ - long long dirty_before_bgsave; /* Used to restore dirty on failed BGSAVE */ - long long rdb_last_load_keys_expired; /* number of expired keys when loading RDB */ - long long rdb_last_load_keys_loaded; /* number of loaded keys when loading RDB */ - int bgsave_aborted; /* Set when killing a child, to treat it as aborted even if it succeeds. */ - struct saveparam *saveparams; /* Save points array for RDB */ - int saveparamslen; /* Number of saving points */ - char *rdb_filename; /* Name of RDB file */ - int rdb_compression; /* Use compression in RDB? */ - int rdb_checksum; /* Use RDB checksum? */ - int rdb_del_sync_files; /* Remove RDB files used only for SYNC if - the instance does not use persistence. */ - time_t lastsave; /* Unix time of last successful save */ - time_t lastbgsave_try; /* Unix time of last attempted bgsave */ - time_t rdb_save_time_last; /* Time used by last RDB save run. */ - time_t rdb_save_time_start; /* Current RDB save start time. */ - int rdb_bgsave_scheduled; /* BGSAVE when possible if true. */ - int rdb_child_type; /* Type of save by active child. */ - int lastbgsave_status; /* C_OK or C_ERR */ - int stop_writes_on_bgsave_err; /* Don't allow writes if can't BGSAVE */ - int rdb_pipe_read; /* RDB pipe used to transfer the rdb data */ - /* to the parent process in diskless repl. */ - int rdb_child_exit_pipe; /* Used by the diskless parent allow child exit. */ - connection **rdb_pipe_conns; /* Connections which are currently the */ - int rdb_pipe_numconns; /* target of diskless rdb fork child. */ - int rdb_pipe_numconns_writing; /* Number of rdb conns with pending writes. */ - char *rdb_pipe_buff; /* In diskless replication, this buffer holds data */ - int rdb_pipe_bufflen; /* that was read from the rdb pipe. */ - int rdb_key_save_delay; /* Delay in microseconds between keys while - * writing aof or rdb. (for testings). negative - * value means fractions of microseconds (on average). */ - int key_load_delay; /* Delay in microseconds between keys while - * loading aof or rdb. (for testings). negative - * value means fractions of microseconds (on average). */ - /* Pipe and data structures for child -> parent info sharing. */ - int child_info_pipe[2]; /* Pipe used to write the child_info_data. */ - int child_info_nread; /* Num of bytes of the last read from pipe */ - /* Propagation of commands in AOF / replication */ - redisOpArray also_propagate; /* Additional command to propagate. */ - int replication_allowed; /* Are we allowed to replicate? */ - /* Logging */ - char *logfile; /* Path of log file */ - int syslog_enabled; /* Is syslog enabled? */ - char *syslog_ident; /* Syslog ident */ - int syslog_facility; /* Syslog facility */ - int crashlog_enabled; /* Enable signal handler for crashlog. - * disable for clean core dumps. */ - int memcheck_enabled; /* Enable memory check on crash. */ - int use_exit_on_panic; /* Use exit() on panic and assert rather than - * abort(). useful for Valgrind. */ - /* Shutdown */ - int shutdown_timeout; /* Graceful shutdown time limit in seconds. */ - int shutdown_on_sigint; /* Shutdown flags configured for SIGINT. */ - int shutdown_on_sigterm; /* Shutdown flags configured for SIGTERM. */ - - /* Replication (master) */ - char replid[CONFIG_RUN_ID_SIZE+1]; /* My current replication ID. */ - char replid2[CONFIG_RUN_ID_SIZE+1]; /* replid inherited from master*/ - long long master_repl_offset; /* My current replication offset */ - long long second_replid_offset; /* Accept offsets up to this for replid2. */ - redisAtomic long long fsynced_reploff_pending;/* Largest replication offset to - * potentially have been fsynced, applied to - fsynced_reploff only when AOF state is AOF_ON - (not during the initial rewrite) */ - long long fsynced_reploff; /* Largest replication offset that has been confirmed to be fsynced */ - int slaveseldb; /* Last SELECTed DB in replication output */ - int repl_ping_slave_period; /* Master pings the slave every N seconds */ - replBacklog *repl_backlog; /* Replication backlog for partial syncs */ - long long repl_backlog_size; /* Backlog circular buffer size */ - long long repl_full_sync_buffer_limit; /* Accumulated repl data limit during rdb channel replication */ - replDataBuf repl_full_sync_buffer; /* Accumulated replication data for rdb channel replication */ - time_t repl_backlog_time_limit; /* Time without slaves after the backlog - gets released. */ - time_t repl_no_slaves_since; /* We have no slaves since that time. - Only valid if server.slaves len is 0. */ - int repl_min_slaves_to_write; /* Min number of slaves to write. */ - int repl_min_slaves_max_lag; /* Max lag of <count> slaves to write. */ - int repl_good_slaves_count; /* Number of slaves with lag <= max_lag. */ - int repl_diskless_sync; /* Master send RDB to slaves sockets directly. */ - int repl_diskless_load; /* Slave parse RDB directly from the socket. - * see REPL_DISKLESS_LOAD_* enum */ - int repl_diskless_sync_delay; /* Delay to start a diskless repl BGSAVE. */ - int repl_diskless_sync_max_replicas;/* Max replicas for diskless repl BGSAVE - * delay (start sooner if they all connect). */ - int repl_rdb_channel; /* Config used to determine if the replica should - * use rdb channel replication for full syncs. */ - int repl_debug_pause; /* Debug config to force the main process to pause. */ - size_t repl_buffer_mem; /* The memory of replication buffer. */ - list *repl_buffer_blocks; /* Replication buffers blocks list - * (serving replica clients and repl backlog) */ - time_t repl_stream_lastio; /* Unix time of the latest sending replication stream. */ - /* Replication (slave) */ - char *masteruser; /* AUTH with this user and masterauth with master */ - sds masterauth; /* AUTH with this password with master */ - char *masterhost; /* Hostname of master */ - int masterport; /* Port of master */ - int repl_timeout; /* Timeout after N seconds of master idle */ - client *master; /* Client that is master for this slave */ - client *cached_master; /* Cached master to be reused for PSYNC. */ - int repl_syncio_timeout; /* Timeout for synchronous I/O calls */ - int repl_state; /* Replication status if the instance is a slave */ - int repl_rdb_ch_state; /* State of the replica's rdb channel during rdb channel replication */ - int repl_main_ch_state; /* State of the replica's main channel during rdb channel replication */ - uint64_t repl_num_master_disconnection; /* Number of master connection was disconnected */ - uint64_t repl_main_ch_client_id; /* Main channel client id received in +RDBCHANNELSYNC reply. */ - 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. */ - connection *repl_transfer_s; /* Slave -> Master SYNC connection */ - connection *repl_rdb_transfer_s; /* Slave -> Master FULL SYNC connection (RDB download) */ - 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 */ - int repl_serve_stale_data; /* Serve stale data when link is down? */ - int repl_slave_ro; /* Slave is read only? */ - int repl_slave_ignore_maxmemory; /* If true slaves do not evict. */ - time_t repl_down_since; /* Unix time at which link with master went down */ - time_t repl_up_since; /* Unix time that master link is fully up and healthy */ - int repl_disable_tcp_nodelay; /* Disable TCP_NODELAY after SYNC? */ - int slave_priority; /* Reported in INFO and used by Sentinel. */ - int replica_announced; /* If true, replica is announced by Sentinel */ - int slave_announce_port; /* Give the master this listening port. */ - char *slave_announce_ip; /* Give the master this ip address. */ - int propagation_error_behavior; /* Configures the behavior of the replica - * when it receives an error on the replication stream */ - int repl_ignore_disk_write_error; /* Configures whether replicas panic when unable to - * persist writes to AOF. */ - /* The following two fields is where we store master PSYNC replid/offset - * while the PSYNC is in progress. At the end we'll copy the fields into - * the server->master client structure. */ - char master_replid[CONFIG_RUN_ID_SIZE+1]; /* Master PSYNC runid. */ - long long master_initial_offset; /* Master PSYNC offset. */ - int repl_slave_lazy_flush; /* Lazy FLUSHALL before loading DB? */ - /* Synchronous replication. */ - list *clients_waiting_acks; /* Clients waiting in WAIT or WAITAOF. */ - int get_ack_from_slaves; /* If true we send REPLCONF GETACK. */ - long long repl_current_sync_attempts; /* Number of times in current configuration, the replica attempted to sync since the last success. */ - long long repl_total_sync_attempts; /* Number of times in current configuration, the replica attempted to sync to a master */ - time_t repl_disconnect_start_time; /* Unix time that master disconnection start */ - time_t repl_total_disconnect_time; /* The total cumulative time we've been disconnected as a replica, visible when the link is up too. */ - /* Limits */ - unsigned int maxclients; /* Max number of simultaneous clients */ - unsigned long long maxmemory; /* Max number of memory bytes to use */ - ssize_t maxmemory_clients; /* Memory limit for total client buffers */ - int maxmemory_policy; /* Policy for key eviction */ - int maxmemory_samples; /* Precision of random sampling */ - int maxmemory_eviction_tenacity;/* Aggressiveness of eviction processing */ - int lfu_log_factor; /* LFU logarithmic counter factor. */ - int lfu_decay_time; /* LFU counter decay factor. */ - long long proto_max_bulk_len; /* Protocol bulk length maximum size. */ - int oom_score_adj_values[CONFIG_OOM_COUNT]; /* Linux oom_score_adj configuration */ - int oom_score_adj; /* If true, oom_score_adj is managed */ - int disable_thp; /* If true, disable THP by syscall */ - /* Blocked clients */ - unsigned int blocked_clients; /* # of clients executing a blocking cmd.*/ - unsigned int blocked_clients_by_type[BLOCKED_NUM]; - list *unblocked_clients; /* list of clients to unblock before next loop */ - list *ready_keys; /* List of readyList structures for BLPOP & co */ - /* Client side caching. */ - unsigned int tracking_clients; /* # of clients with tracking enabled.*/ - size_t tracking_table_max_keys; /* Max number of keys in tracking table. */ - list *tracking_pending_keys; /* tracking invalidation keys pending to flush */ - list *pending_push_messages; /* pending publish or other push messages to flush */ - /* 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; - int sort_store; - /* Zip structure config, see redis.conf for more information */ - size_t hash_max_listpack_entries; - size_t hash_max_listpack_value; - size_t set_max_intset_entries; - size_t set_max_listpack_entries; - size_t set_max_listpack_value; - size_t zset_max_listpack_entries; - size_t zset_max_listpack_value; - size_t hll_sparse_max_bytes; - size_t stream_node_max_bytes; - long long stream_node_max_entries; - /* Stream IDMP parameters */ - long long stream_idmp_duration; /* Default IDMP duration in seconds. */ - long long stream_idmp_maxsize; /* Default IDMP max entries. */ - /* List parameters */ - int list_max_listpack_size; - int list_compress_depth; - /* time cache */ - redisAtomic time_t unixtime; /* Unix time sampled every cron cycle. */ - time_t timezone; /* Cached timezone. As set by tzset(). */ - redisAtomic int daylight_active; /* Currently in daylight saving time. */ - mstime_t mstime; /* 'unixtime' in milliseconds. */ - ustime_t ustime; /* 'unixtime' in microseconds. */ - mstime_t cmd_time_snapshot; /* Time snapshot of the root execution nesting. */ - size_t blocking_op_nesting; /* Nesting level of blocking operation, used to reset blocked_last_cron. */ - long long blocked_last_cron; /* Indicate the mstime of the last time we did cron jobs from a blocking operation */ - /* Pubsub */ - kvstore *pubsub_channels; /* Map channels to list of subscribed clients */ - dict *pubsub_patterns; /* A dict of pubsub_patterns */ - int notify_keyspace_events; /* Events to propagate via Pub/Sub. This is an - xor of NOTIFY_... flags. */ - kvstore *pubsubshard_channels; /* Map shard channels in every slot to list of subscribed clients */ - unsigned int pubsub_clients; /* # of clients in Pub/Sub mode */ - unsigned int watching_clients; /* # of clients are wathcing keys */ - /* Cluster */ - int cluster_enabled; /* Is cluster enabled? */ - int cluster_port; /* Set the cluster port for a node. */ - mstime_t cluster_node_timeout; /* Cluster node timeout. */ - mstime_t cluster_ping_interval; /* A debug configuration for setting how often cluster nodes send ping messages. */ - char *cluster_configfile; /* Cluster auto-generated config file name. */ - long long asm_handoff_max_lag_bytes; /* Maximum lag in bytes before pausing writes for ASM handoff. */ - long long asm_write_pause_timeout; /* Timeout in milliseconds to pause writes during ASM handoff. */ - long long asm_sync_buffer_drain_timeout; /* Timeout in milliseconds for sync buffer to drain during ASM. */ - int asm_max_archived_tasks; /* Maximum number of archived ASM tasks to keep in memory. */ - struct clusterState *cluster; /* State of the cluster */ - int cluster_migration_barrier; /* Cluster replicas migration barrier. */ - int cluster_allow_replica_migration; /* Automatic replica migrations to orphaned masters and from empty masters */ - int cluster_slave_validity_factor; /* Slave max data age for failover. */ - int cluster_require_full_coverage; /* If true, put the cluster down if - there is at least an uncovered slot.*/ - int cluster_slave_no_failover; /* Prevent slave from starting a failover - if the master is in failure state. */ - char *cluster_announce_ip; /* IP address to announce on cluster bus. */ - char *cluster_announce_hostname; /* hostname to announce on cluster bus. */ - char *cluster_announce_human_nodename; /* Human readable node name assigned to a node. */ - int cluster_preferred_endpoint_type; /* Use the announced hostname when available. */ - int cluster_announce_port; /* base port to announce on cluster bus. */ - int cluster_announce_tls_port; /* TLS port to announce on cluster bus. */ - int cluster_announce_bus_port; /* bus port to announce on cluster bus. */ - int cluster_module_flags; /* Set of flags that Redis modules are able - to set in order to suppress certain - native Redis Cluster features. Check the - REDISMODULE_CLUSTER_FLAG_*. */ - int cluster_module_trim_disablers; /* Number of module requests to disable trimming */ - int cluster_allow_reads_when_down; /* Are reads allowed when the cluster - is down? */ - int cluster_config_file_lock_fd; /* cluster config fd, will be flocked. */ - unsigned long long cluster_link_msg_queue_limit_bytes; /* Memory usage limit on individual link msg queue */ - int cluster_drop_packet_filter; /* Debug config that allows tactically - * dropping packets of a specific type */ - int cluster_slot_stats_enabled; /* Cluster slot usage statistics tracking enabled. */ - /* Scripting */ - unsigned int lua_arena; /* eval lua arena used in jemalloc. */ - mstime_t busy_reply_threshold; /* Script / module timeout in milliseconds */ - int pre_command_oom_state; /* OOM before command (script?) was started */ - int script_disable_deny_script; /* Allow running commands marked "noscript" inside a script. */ - int lua_enable_deprecated_api; /* Config to enable deprecated api */ - /* Lazy free */ - int lazyfree_lazy_eviction; - int lazyfree_lazy_expire; - int lazyfree_lazy_server_del; - int lazyfree_lazy_user_del; - int lazyfree_lazy_user_flush; - /* Latency monitor */ - long long latency_monitor_threshold; - dict *latency_events; - /* ACLs */ - char *acl_filename; /* ACL Users file. NULL if not configured. */ - unsigned long acllog_max_len; /* Maximum length of the ACL LOG list. */ - sds requirepass; /* Remember the cleartext password set with - the old "requirepass" directive for - backward compatibility with Redis <= 5. */ - int acl_pubsub_default; /* Default ACL pub/sub channels flag */ - aclInfo acl_info; /* ACL info */ - /* Assert & bug reporting */ - int watchdog_period; /* Software watchdog period in ms. 0 = off */ - /* System hardware info */ - size_t system_memory_size; /* Total memory in system as reported by OS */ - /* TLS Configuration */ - int tls_cluster; - int tls_replication; - int tls_auth_clients; - redisTLSContextConfig tls_ctx_config; - /* cpu affinity */ - char *server_cpulist; /* cpu affinity list of redis server main/io thread. */ - char *bio_cpulist; /* cpu affinity list of bio thread. */ - char *aof_rewrite_cpulist; /* cpu affinity list of aof rewrite process. */ - char *bgsave_cpulist; /* cpu affinity list of bgsave process. */ - /* Sentinel config */ - struct sentinelConfig *sentinel_config; /* sentinel config to load at startup time. */ - /* Coordinate failover info */ - mstime_t failover_end_time; /* Deadline for failover command. */ - int force_failover; /* If true then failover will be forced at the - * deadline, otherwise failover is aborted. */ - char *target_replica_host; /* Failover target host. If null during a - * failover then any replica can be used. */ - int target_replica_port; /* Failover target port */ - int failover_state; /* Failover state */ - int cluster_allow_pubsubshard_when_down; /* Is pubsubshard allowed when the cluster - is down, doesn't affect pubsub global. */ - long reply_buffer_peak_reset_time; /* The amount of time (in milliseconds) to wait between reply buffer peak resets */ - int reply_buffer_resizing_enabled; /* Is reply buffer resizing enabled (1 by default) */ - int reply_copy_avoidance_enabled; /* Is reply copy avoidance enabled (1 by default) */ - /* Local environment */ - char *locale_collate; - int dbg_assert_keysizes; /* Assert keysizes histogram after each command */ - int dbg_assert_alloc_per_slot; /* Assert per-slot alloc_size after each command */ -}; - -/* we use 6 so that all getKeyResult fits a cacheline */ -#define MAX_KEYS_BUFFER 6 - -typedef struct { - int pos; /* The position of the key within the client array */ - int flags; /* The flags associated with the key access, see - CMD_KEY_* for more information */ -} keyReference; - -/* A result structure for the various getkeys function calls. It lists the - * keys as indices to the provided argv. This functionality is also re-used - * for returning channel information. - */ -typedef struct { - int numkeys; /* Number of key indices return */ - int size; /* Available array size */ - keyReference keysbuf[MAX_KEYS_BUFFER]; /* Pre-allocated buffer, to save heap allocations */ - keyReference *keys; /* Key indices array, points to keysbuf or heap */ -} getKeysResult; -#define GETKEYS_RESULT_INIT { 0, MAX_KEYS_BUFFER, {{0}}, NULL } - -/*----------------------------------------------------------------------------- - * Hotkey tracking - *----------------------------------------------------------------------------*/ - -/* Hotkeys tracking metric flags */ -#define HOTKEYS_TRACK_CPU (1ULL << 0) -#define HOTKEYS_TRACK_NET (1ULL << 1) -#define HOTKEYS_METRICS_COUNT 2 /* NOTE: update if adding new metric */ - -/* A structure for tracking hotkey statistics by given metrics. */ -struct hotkeyStats { - struct chkTopK *cpu; - struct chkTopK *net; - mstime_t start; /* Initial time point for wall time tracking */ - - /* Only keys from selected slots will be tracked. If slots are not - * initialized - all keys are tracked. */ - int *slots; - int numslots; - - /* Statistics counters. NOTE, time_* members are saved in microseconds for - * accuracy but displayed in milliseconds during HOTKEYS GET */ - uint64_t time_sampled_commands_selected_slots; /* microseconds */ - uint64_t time_all_commands_selected_slots; /* microseconds */ - uint64_t time_all_commands_all_slots; /* microseconds */ - uint64_t net_bytes_sampled_commands_selected_slots; - uint64_t net_bytes_all_commands_selected_slots; - uint64_t net_bytes_all_commands_all_slots; - - /* rusage stats for CPU time tracking */ - struct timeval ru_utime; - struct timeval ru_stime; - - int tracking_count; /* Count of top hotkeys we want to track */ - int sample_ratio; /* Track a key with probability 1 / sample_ratio */ - int active; /* True if tracking is currently active */ - mstime_t duration; /* Tracking duration */ - uint64_t tracked_metrics; /* Bit flags: HOTKEYS_TRACK_CPU, HOTKEYS_TRACK_NET, etc. */ - mstime_t cpu_time; /* Total CPU time spent updating the topk struct in milliseconds */ - - /* Current command related fields */ - getKeysResult keys_result; /* Key results for current command */ - client *current_client; - int is_sampled; /* Indicates whether or not keys from cmd are sampled via sample_ratio */ - int is_in_selected_slots; /* Indicates whether or not keys from cmd are in selected_slots */ -}; - -typedef struct hotkeyMetrics { - uint64_t cpu_time_usec; - uint64_t net_bytes; -} hotkeyMetrics; - -/* pendingCommand flags */ -enum { - PENDING_CMD_FLAG_INCOMPLETE = 1 << 0, /* Command parsing is incomplete, still waiting for more data */ - PENDING_CMD_FLAG_PREPROCESSED = 1 << 1, /* This command has passed pre-processing */ - PENDING_CMD_KEYS_RESULT_VALID = 1 << 2, /* Command's keys_result is valid and cached */ -}; - -/* Parser state and parse result of a command from a client's input buffer. */ -struct pendingCommand { - int argc; /* Num of arguments of current command. */ - int argv_len; /* Size of argv array (may be more than argc) */ - robj **argv; /* Arguments of current command. */ - size_t argv_len_sum; /* Sum of lengths of objects in argv list. */ - unsigned long long input_bytes; - struct redisCommand *cmd; - getKeysResult keys_result; - long long reploff; /* c->reploff should be set to this value when the command is processed */ - int flags; - int slot; /* The slot the command is executing against. Set to INVALID_CLUSTER_SLOT - * if no slot is being used or if the command has a cross slot error */ - uint8_t read_error; - - struct pendingCommand *next; - struct pendingCommand *prev; -}; - -/* Key specs definitions. - * - * Brief: This is a scheme that tries to describe the location - * of key arguments better than the old [first,last,step] scheme - * which is limited and doesn't fit many commands. - * - * There are two steps: - * 1. begin_search (BS): in which index should we start searching for keys? - * 2. find_keys (FK): relative to the output of BS, how can we will which args are keys? - * - * There are two types of BS: - * 1. index: key args start at a constant index - * 2. keyword: key args start just after a specific keyword - * - * There are two kinds of FK: - * 1. range: keys end at a specific index (or relative to the last argument) - * 2. keynum: there's an arg that contains the number of key args somewhere before the keys themselves - */ - -/* WARNING! Must be synced with generate-command-code.py and RedisModuleKeySpecBeginSearchType */ -typedef enum { - KSPEC_BS_INVALID = 0, /* Must be 0 */ - KSPEC_BS_UNKNOWN, - KSPEC_BS_INDEX, - KSPEC_BS_KEYWORD -} kspec_bs_type; - -/* WARNING! Must be synced with generate-command-code.py and RedisModuleKeySpecFindKeysType */ -typedef enum { - KSPEC_FK_INVALID = 0, /* Must be 0 */ - KSPEC_FK_UNKNOWN, - KSPEC_FK_RANGE, - KSPEC_FK_KEYNUM -} kspec_fk_type; - -/* WARNING! This struct must match RedisModuleCommandKeySpec */ -typedef struct { - /* Declarative data */ - const char *notes; - uint64_t flags; - kspec_bs_type begin_search_type; - union { - struct { - /* The index from which we start the search for keys */ - int pos; - } index; - struct { - /* The keyword that indicates the beginning of key args */ - const char *keyword; - /* An index in argv from which to start searching. - * Can be negative, which means start search from the end, in reverse - * (Example: -2 means to start in reverse from the penultimate arg) */ - int startfrom; - } keyword; - } bs; - kspec_fk_type find_keys_type; - union { - /* NOTE: Indices in this struct are relative to the result of the begin_search step! - * These are: range.lastkey, keynum.keynumidx, keynum.firstkey */ - struct { - /* Index of the last key. - * Can be negative, in which case it's not relative. -1 indicating till the last argument, - * -2 one before the last and so on. */ - int lastkey; - /* How many args should we skip after finding a key, in order to find the next one. */ - int keystep; - /* If lastkey is -1, we use limit to stop the search by a factor. 0 and 1 mean no limit. - * 2 means 1/2 of the remaining args, 3 means 1/3, and so on. */ - int limit; - } range; - struct { - /* Index of the argument containing the number of keys to come */ - int keynumidx; - /* Index of the fist key (Usually it's just after keynumidx, in - * which case it should be set to keynumidx+1). */ - int firstkey; - /* How many args should we skip after finding a key, in order to find the next one. */ - int keystep; - } keynum; - } fk; -} keySpec; - -#ifdef LOG_REQ_RES - -/* Must be synced with generate-command-code.py */ -typedef enum { - JSON_TYPE_STRING, - JSON_TYPE_INTEGER, - JSON_TYPE_BOOLEAN, - JSON_TYPE_OBJECT, - JSON_TYPE_ARRAY, -} jsonType; - -typedef struct jsonObjectElement { - jsonType type; - const char *key; - union { - const char *string; - long long integer; - int boolean; - struct jsonObject *object; - struct { - struct jsonObject **objects; - int length; - } array; - } value; -} jsonObjectElement; - -typedef struct jsonObject { - struct jsonObjectElement *elements; - int length; -} jsonObject; - -#endif - -/* WARNING! This struct must match RedisModuleCommandHistoryEntry */ -typedef struct { - const char *since; - const char *changes; -} commandHistory; - -/* Must be synced with COMMAND_GROUP_STR and generate-command-code.py */ -typedef enum { - COMMAND_GROUP_GENERIC, - COMMAND_GROUP_STRING, - COMMAND_GROUP_LIST, - COMMAND_GROUP_SET, - COMMAND_GROUP_SORTED_SET, - COMMAND_GROUP_HASH, - COMMAND_GROUP_PUBSUB, - COMMAND_GROUP_TRANSACTIONS, - COMMAND_GROUP_CONNECTION, - COMMAND_GROUP_SERVER, - COMMAND_GROUP_SCRIPTING, - COMMAND_GROUP_HYPERLOGLOG, - COMMAND_GROUP_CLUSTER, - COMMAND_GROUP_SENTINEL, - COMMAND_GROUP_GEO, - COMMAND_GROUP_STREAM, - COMMAND_GROUP_BITMAP, - COMMAND_GROUP_MODULE, -} redisCommandGroup; - -typedef void redisCommandProc(client *c); -typedef int redisGetKeysProc(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); - -/* Redis command structure. - * - * Note that the command table is in commands.c and it is auto-generated. - * - * This is the meaning of the flags: - * - * CMD_WRITE: Write command (may modify the key space). - * - * CMD_READONLY: Commands just reading from keys without changing the content. - * Note that commands that don't read from the keyspace such as - * TIME, SELECT, INFO, administrative commands, and connection - * or transaction related commands (multi, exec, discard, ...) - * are not flagged as read-only commands, since they affect the - * server or the connection in other ways. - * - * CMD_DENYOOM: May increase memory usage once called. Don't allow if out - * of memory. - * - * CMD_ADMIN: Administrative command, like SAVE or SHUTDOWN. - * - * CMD_PUBSUB: Pub/Sub related command. - * - * CMD_NOSCRIPT: Command not allowed in scripts. - * - * CMD_BLOCKING: The command has the potential to block the client. - * - * CMD_LOADING: Allow the command while loading the database. - * - * CMD_NO_ASYNC_LOADING: Deny during async loading (when a replica uses diskless - * sync swapdb, and allows access to the old dataset) - * - * CMD_STALE: Allow the command while a slave has stale data but is not - * allowed to serve this data. Normally no command is accepted - * in this condition but just a few. - * - * CMD_SKIP_MONITOR: Do not automatically propagate the command on MONITOR. - * - * CMD_SKIP_SLOWLOG: Do not automatically propagate the command to the slowlog. - * - * CMD_ASKING: Perform an implicit ASKING for this command, so the - * command will be accepted in cluster mode if the slot is marked - * as 'importing'. - * - * CMD_FAST: Fast command: O(1) or O(log(N)) command that should never - * delay its execution as long as the kernel scheduler is giving - * us time. Note that commands that may trigger a DEL as a side - * effect (like SET) are not fast commands. - * - * CMD_NO_AUTH: Command doesn't require authentication - * - * CMD_MAY_REPLICATE: Command may produce replication traffic, but should be - * allowed under circumstances where write commands are disallowed. - * Examples include PUBLISH, which replicates pubsub messages,and - * EVAL, which may execute write commands, which are replicated, - * or may just execute read commands. A command can not be marked - * both CMD_WRITE and CMD_MAY_REPLICATE - * - * CMD_SENTINEL: This command is present in sentinel mode. - * - * CMD_ONLY_SENTINEL: This command is present only when in sentinel mode. - * And should be removed from redis. - * - * CMD_NO_MANDATORY_KEYS: This key arguments for this command are optional. - * - * CMD_NO_MULTI: The command is not allowed inside a transaction - * - * CMD_ALLOW_BUSY: The command can run while another command is running for - * a long time (timedout script, module command that yields) - * - * CMD_TOUCHES_ARBITRARY_KEYS: The command may touch (and cause lazy-expire) - * arbitrary key (i.e not provided in argv) - * - * CMD_INTERNAL: The command may perform operations without performing - * validations such as ACL. - * - * The following additional flags are only used in order to put commands - * in a specific ACL category. Commands can have multiple ACL categories. - * See redis.conf for the exact meaning of each. - * - * @keyspace, @read, @write, @set, @sortedset, @list, @hash, @string, @bitmap, - * @hyperloglog, @stream, @admin, @fast, @slow, @pubsub, @blocking, @dangerous, - * @connection, @transaction, @scripting, @geo. - * - * Note that: - * - * 1) The read-only flag implies the @read ACL category. - * 2) The write flag implies the @write ACL category. - * 3) The fast flag implies the @fast ACL category. - * 4) The admin flag implies the @admin and @dangerous ACL category. - * 5) The pub-sub flag implies the @pubsub ACL category. - * 6) The lack of fast flag implies the @slow ACL category. - * 7) The non obvious "keyspace" category includes the commands - * that interact with keys without having anything to do with - * specific data structures, such as: DEL, RENAME, MOVE, SELECT, - * TYPE, EXPIRE*, PEXPIRE*, TTL, PTTL, ... - */ -struct redisCommand { - /* Declarative data */ - const char *declared_name; /* A string representing the command declared_name. - * It is a const char * for native commands and SDS for module commands. */ - const char *summary; /* Summary of the command (optional). */ - const char *complexity; /* Complexity description (optional). */ - const char *since; /* Debut version of the command (optional). */ - int doc_flags; /* Flags for documentation (see CMD_DOC_*). */ - const char *replaced_by; /* In case the command is deprecated, this is the successor command. */ - const char *deprecated_since; /* In case the command is deprecated, when did it happen? */ - redisCommandGroup group; /* Command group */ - commandHistory *history; /* History of the command */ - int num_history; - const char **tips; /* An array of strings that are meant to be tips for clients/proxies regarding this command */ - int num_tips; - redisCommandProc *proc; /* Command implementation */ - int arity; /* Number of arguments, it is possible to use -N to say >= N */ - uint64_t flags; /* Command flags, see CMD_*. */ - uint64_t acl_categories; /* ACl categories, see ACL_CATEGORY_*. */ - keySpec *key_specs; - int key_specs_num; - /* Use a function to determine keys arguments in a command line. - * Used for Redis Cluster redirect (may be NULL) */ - redisGetKeysProc *getkeys_proc; - int num_args; /* Length of args array. */ - /* Array of subcommands (may be NULL) */ - struct redisCommand *subcommands; - /* Array of arguments (may be NULL) */ - struct redisCommandArg *args; -#ifdef LOG_REQ_RES - /* Reply schema */ - struct jsonObject *reply_schema; -#endif - - /* Runtime populated data */ - long long microseconds, calls, rejected_calls, failed_calls; - int id; /* Command ID. This is a progressive ID starting from 0 that - is assigned at runtime, and is used in order to check - ACLs. A connection is able to execute a given command if - the user associated to the connection has this command - bit set in the bitmap of allowed commands. */ - sds fullname; /* A SDS string representing the command fullname. */ - struct hdr_histogram* latency_histogram; /*points to the command latency command histogram (unit of time nanosecond) */ - keySpec legacy_range_key_spec; /* The legacy (first,last,step) key spec is - * still maintained (if applicable) so that - * we can still support the reply format of - * COMMAND INFO and COMMAND GETKEYS */ - dict *subcommands_dict; /* A dictionary that holds the subcommands, the key is the subcommand sds name - * (not the fullname), and the value is the redisCommand structure pointer. */ - struct redisCommand *parent; - struct RedisModuleCommand *module_cmd; /* A pointer to the module command data (NULL if native command) */ -}; - -struct redisError { - long long count; -}; - -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 *lpi; /* listpack iterator */ - quicklistIter iter; /* quicklist iterator */ -} listTypeIterator; - -/* Structure for an entry while iterating over a list. */ -typedef struct { - listTypeIterator *li; - unsigned char *lpe; /* Entry in listpack */ - quicklistEntry entry; /* Entry in quicklist */ -} listTypeEntry; - -/* Structure to hold set iteration abstraction. */ -typedef struct { - robj *subject; - int encoding; - int ii; /* intset iterator */ - dictIterator di; - unsigned char *lpi; /* listpack iterator */ -} setTypeIterator; - -/* Structure to hold hash iteration abstraction. 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 { - robj *subject; - int encoding; - - unsigned char *fptr, *vptr, *tptr; - uint64_t expire_time; /* Only used with OBJ_ENCODING_LISTPACK_EX */ - - dictIterator di; - dictEntry *de; -} hashTypeIterator; - -#include "stream.h" /* Stream data type header file. */ - -#define OBJ_HASH_KEY 1 -#define OBJ_HASH_VALUE 2 - -/* Hash-field data type (of t_hash.c) - now using entry directly - * Note: entry* is used directly instead of a typedef for clarity */ - -/*----------------------------------------------------------------------------- - * Extern declarations - *----------------------------------------------------------------------------*/ - -extern struct redisServer server; -extern struct sharedObjectsStruct shared; -extern dictType objectKeyPointerValueDictType; -extern dictType objectKeyHeapPointerValueDictType; -extern dictType setDictType; -extern dictType BenchmarkDictType; -extern dictType zsetDictType; -extern dictType dbDictType; -extern double R_Zero, R_PosInf, R_NegInf, R_Nan; -extern dictType hashDictType; -extern dictType entryHashDictType; -extern dictType entryHashDictTypeWithHFE; -extern dictType stringSetDictType; -extern dictType externalStringType; -extern dictType sdsHashDictType; -extern dictType clientDictType; -extern dictType objToDictDictType; -extern dictType dbExpiresDictType; -extern dictType modulesDictType; -extern dictType sdsReplyDictType; -extern dictType keylistDictType; -extern kvstoreType kvstoreBaseType; -extern kvstoreType kvstoreExType; -extern dict *modules; - -extern EbucketsType subexpiresBucketsType; /* global expires */ -extern EbucketsType hashFieldExpireBucketsType; /* local per hash */ - -/*----------------------------------------------------------------------------- - * Functions prototypes - *----------------------------------------------------------------------------*/ - -/* Command metadata */ -void populateCommandLegacyRangeSpec(struct redisCommand *c); - -/* Modules */ -void moduleInitModulesSystem(void); -void moduleInitModulesSystemLast(void); -void modulesCron(void); -int moduleOnLoad(int (*onload)(void *, void **, int), const char *path, void *handle, void **module_argv, int module_argc, int is_loadex); -int moduleLoad(const char *path, void **argv, int argc, int is_loadex); -int moduleUnload(sds name, const char **errmsg, int forced_unload); -void moduleLoadInternalModules(void); -void moduleLoadFromQueue(void); -int moduleGetCommandKeysViaAPI(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int moduleGetCommandChannelsViaAPI(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -moduleType *moduleTypeLookupModuleByID(uint64_t id); -moduleType *moduleTypeLookupModuleByName(const char *name); -moduleType *moduleTypeLookupModuleByNameIgnoreCase(const char *name); -void moduleTypeNameByID(char *name, uint64_t moduleid); -const char *moduleTypeModuleName(moduleType *mt); -const char *moduleNameFromCommand(struct redisCommand *cmd); -void moduleFreeContext(struct RedisModuleCtx *ctx); -void moduleCallCommandUnblockedHandler(client *c); -int isModuleClientUnblocked(client *c); -void unblockClientFromModule(client *c); -void moduleHandleBlockedClients(void); -void moduleBlockedClientTimedOut(client *c); -void modulePipeReadable(aeEventLoop *el, int fd, void *privdata, int mask); -size_t moduleCount(void); -void moduleAcquireGIL(void); -int moduleTryAcquireGIL(void); -void moduleReleaseGIL(void); -void moduleNotifyKeyspaceEvent(int type, const char *event, robj *key, int dbid); -void firePostExecutionUnitJobs(void); -void moduleCallCommandFilters(client *c); -void modulePostExecutionUnitOperations(void); -void ModuleForkDoneHandler(int exitcode, int bysignal); -int TerminateModuleForkChild(int child_pid, int wait); -ssize_t rdbSaveModulesAux(rio *rdb, int when); -int moduleAllDatatypesHandleErrors(void); -int moduleAllModulesHandleReplAsyncLoad(void); -sds modulesCollectInfo(sds info, dict *sections_dict, int for_crash_report, int sections); -void moduleFireServerEvent(uint64_t eid, int subid, void *data); -void processModuleLoadingProgressEvent(int is_aof); -int moduleTryServeClientBlockedOnKey(client *c, robj *key); -void moduleUnblockClient(client *c); -int moduleBlockedClientMayTimeout(client *c); -int moduleClientIsBlockedOnKeys(client *c); -void moduleNotifyUserChanged(client *c); -void moduleNotifyKeyUnlink(robj *key, kvobj *kv, int dbid, int flags); -size_t moduleGetFreeEffort(robj *key, robj *val, int dbid); -size_t moduleGetMemUsage(robj *key, robj *val, size_t sample_size, int dbid); -robj *moduleTypeDupOrReply(client *c, robj *fromkey, robj *tokey, int todb, robj *value); -int moduleDefragValue(robj *key, robj *obj, int dbid); -int moduleLateDefrag(robj *key, robj *value, unsigned long *cursor, monotime endtime, int dbid); -void moduleDefragStart(void); -void moduleDefragEnd(void); -void *moduleGetHandleByName(char *modulename); -int moduleIsModuleCommand(void *module_handle, struct redisCommand *cmd); -int moduleHasSubscribersForKeyspaceEvent(int type); - -/* pcmd */ -void initPendingCommand(pendingCommand *pcmd); -void freePendingCommand(client *c, pendingCommand *pcmd); -void addPendingCommand(pendingCommandList *queue, pendingCommand *cmd); -pendingCommand *popPendingCommandFromHead(pendingCommandList *queue); -pendingCommand *popPendingCommandFromTail(pendingCommandList *queue); -void shrinkPendingCommandPool(void); - -/* Utils */ -long long ustime(void); -mstime_t mstime(void); -mstime_t commandTimeSnapshot(void); -void getRandomHexChars(char *p, size_t len); -void getRandomBytes(unsigned char *p, size_t len); -uint64_t crc64(uint64_t crc, const unsigned char *s, uint64_t l); -void exitFromChild(int retcode, int from_signal); -long long redisPopcount(void *s, long count); -int redisSetProcTitle(char *title); -int validateProcTitleTemplate(const char *template); -int redisCommunicateSystemd(const char *sd_notify_msg); -void redisSetCpuAffinity(const char *cpulist); - -/* afterErrorReply flags */ -#define ERR_REPLY_FLAG_NO_STATS_UPDATE (1ULL<<0) /* Indicating that we should not update - error stats after sending error reply */ -/* networking.c -- Networking and Client related operations */ -client *createClient(connection *conn); -void freeClient(client *c); -void freeClientAsync(client *c); -void deauthenticateAndCloseClient(client *c); -void logInvalidUseAndFreeClientAsync(client *c, const char *fmt, ...); -int beforeNextClient(client *c); -void clearClientConnectionState(client *c); -void resetClient(client *c, int num_pcmds_to_free); -void resetClientQbufState(client *c); -void freeClientOriginalArgv(client *c); -void freeClientArgv(client *c); -void freeClientPendingCommands(client *c, int num_pcmds_to_free); -void tryDeferFreeClientObject(client *c, int type, void *ptr); -void freeClientDeferredObjects(client *c, int free_array); -void freeClientIODeferredObjects(client *c, int free_array); -void sendReplyToClient(connection *conn); -void *addReplyDeferredLen(client *c); -void setDeferredArrayLen(client *c, void *node, long length); -void setDeferredMapLen(client *c, void *node, long length); -void setDeferredSetLen(client *c, void *node, long length); -void setDeferredAttributeLen(client *c, void *node, long length); -void setDeferredPushLen(client *c, void *node, long length); -int isClientReadErrorFatal(client *c); -int processInputBuffer(client *c); -void acceptCommonHandler(connection *conn, int flags, char *ip); -void readQueryFromClient(connection *conn); -int prepareClientToWrite(client *c); -void addReplyNull(client *c); -void addReplyNullArray(client *c); -void addReplyBool(client *c, int b); -void addReplyVerbatim(client *c, const char *s, size_t len, const char *ext); -void addReplyProto(client *c, const char *s, size_t len); -void AddReplyFromClient(client *c, client *src); -void addReplyBulk(client *c, robj *obj); -void addReplyBulkCString(client *c, const char *s); -void addReplyBulkCBuffer(client *c, const void *p, size_t len); -void addReplyBulkLongLong(client *c, long long ll); -void addReply(client *c, robj *obj); -void addReplyStatusLength(client *c, const char *s, size_t len); -void addReplySds(client *c, sds s); -void addReplyBulkSds(client *c, sds s); -void setDeferredReplyBulkSds(client *c, void *node, sds s); -void addReplyErrorObject(client *c, robj *err); -void addReplyOrErrorObject(client *c, robj *reply); -void afterErrorReply(client *c, const char *s, size_t len, int flags); -void addReplyErrorFormatInternal(client *c, int flags, const char *fmt, va_list ap); -void addReplyErrorSdsEx(client *c, sds err, int flags); -void addReplyErrorSds(client *c, sds err); -void addReplyErrorSdsSafe(client *c, sds err); -void addReplyError(client *c, const char *err); -void addReplyErrorArity(client *c); -void addReplyErrorExpireTime(client *c); -void addReplyStatus(client *c, const char *status); -void addReplyDouble(client *c, double d); -void addReplyBigNum(client *c, const char *num, size_t len); -void addReplyHumanLongDouble(client *c, long double d); -void addReplyLongLong(client *c, long long ll); -void addReplyLongLongFromStr(client *c, robj* str); -void addReplyArrayLen(client *c, long length); -void addReplyMapLen(client *c, long length); -void addReplySetLen(client *c, long length); -void addReplyAttributeLen(client *c, long length); -void addReplyPushLen(client *c, long length); -void addReplyHelp(client *c, const char **help); -void addExtendedReplyHelp(client *c, const char **help, const char **extended_help); -void addReplySubcommandSyntaxError(client *c); -void addReplyLoadedModules(client *c); -void copyReplicaOutputBuffer(client *dst, client *src); -void addListRangeReply(client *c, robj *o, long start, long end, int reverse); -void deferredAfterErrorReply(client *c, list *errors); -size_t sdsZmallocSize(sds s); -size_t getStringObjectSdsUsedMemory(robj *o); -void freeClientReplyValue(void *o); -void *dupClientReplyValue(void *o); -char *getClientPeerId(client *client); -char *getClientSockName(client *client); -sds catClientInfoString(sds s, client *client); -sds getAllClientsInfoString(int type); -int clientSetName(client *c, robj *name, const char **err); -void rewriteClientCommandVector(client *c, int argc, ...); -void rewriteClientCommandArgument(client *c, int i, robj *newval); -void replaceClientCommandVector(client *c, int argc, robj **argv); -void redactClientCommandArgument(client *c, int argc); -size_t getClientOutputBufferMemoryUsage(client *c); -size_t getNormalClientPendingReplyBytes(client *c); -size_t getClientMemoryUsage(client *c, size_t *output_buffer_mem_usage); -int freeClientsInAsyncFreeQueue(void); -int closeClientOnOutputBufferLimitReached(client *c, int async); -int getClientType(client *c); -int getClientTypeByName(char *name); -char *getClientTypeName(int class); -void flushSlavesOutputBuffers(void); -void disconnectSlaves(void); -void evictClients(void); -int listenToPort(connListener *fds); -void pauseActions(pause_purpose purpose, mstime_t end, uint32_t actions_bitmask); -void unpauseActions(pause_purpose purpose); -uint32_t isPausedActions(uint32_t action_bitmask); -uint32_t isPausedActionsWithUpdate(uint32_t action_bitmask); -void updatePausedActions(void); -void unblockPostponedClients(void); -void processEventsWhileBlocked(void); -void whileBlockedCron(void); -void blockingOperationStarts(void); -void blockingOperationEnds(void); -int handleClientsWithPendingWrites(void); -int clientHasPendingReplies(client *c); -int updateClientMemUsageAndBucket(client *c); -void removeClientFromMemUsageBucket(client *c, int allow_eviction); -void unlinkClient(client *c); -void tryUnlinkClientFromPendingRefReply(client *c, int force); -int writeToClient(client *c, int handler_installed); -void linkClient(client *c); -void protectClient(client *c); -void unprotectClient(client *c); -client *lookupClientByID(uint64_t id); -int authRequired(client *c); -void putClientInPendingWriteQueue(client *c); -getKeysResult *getClientCachedKeyResult(client *c); -/* reply macros */ -#define ADD_REPLY_BULK_CBUFFER_STRING_CONSTANT(c, str) addReplyBulkCBuffer(c, str, strlen(str)) - -/* iothread.c - the threaded io implementation */ -void initThreadedIO(void); -void killIOThreads(void); -void pauseIOThread(int id); -void resumeIOThread(int id); -void pauseAllIOThreads(void); -void resumeAllIOThreads(void); -void pauseIOThreadsRange(int start, int end); -void resumeIOThreadsRange(int start, int end); -int resizeAllIOThreadsEventLoops(size_t newsize); -int sendPendingClientsToIOThreads(void); -void enqueuePendingClientsToMainThread(client *c, int unbind); -void enqueuePendingClienstToIOThreads(client *c); -void handleClientReadError(client *c); -void unbindClientFromIOThreadEventLoop(client *c); -int processClientsOfAllIOThreads(void); -int processClientsFromMainThread(IOThread *t); -void assignClientToIOThread(client *c); -void keepClientInMainThread(client *c); -void fetchClientFromIOThread(client *c); -int isClientMustHandledByMainThread(client *c); - -/* logreqres.c - logging of requests and responses */ -void reqresReset(client *c, int free_buf); -void reqresSaveClientReplyOffset(client *c); -size_t reqresAppendRequest(client *c); -size_t reqresAppendResponse(client *c); - -#ifdef __GNUC__ -void addReplyErrorFormatEx(client *c, int flags, const char *fmt, ...) - __attribute__((format(printf, 3, 4))); -void addReplyErrorFormat(client *c, const char *fmt, ...) - __attribute__((format(printf, 2, 3))); -void addReplyStatusFormat(client *c, const char *fmt, ...) - __attribute__((format(printf, 2, 3))); -#else -void addReplyErrorFormatEx(client *c, int flags, const char *fmt, ...); -void addReplyErrorFormat(client *c, const char *fmt, ...); -void addReplyStatusFormat(client *c, const char *fmt, ...); -#endif - -/* Client side caching (tracking mode) */ -void enableTracking(client *c, uint64_t redirect_to, uint64_t options, robj **prefix, size_t numprefix); -void disableTracking(client *c); -void trackingRememberKeys(client *tracking, client *executing); -void trackingInvalidateKey(client *c, robj *keyobj, int bcast); -void trackingScheduleKeyInvalidation(uint64_t client_id, robj *keyobj); -void trackingHandlePendingKeyInvalidations(void); -void trackingInvalidateKeysOnFlush(int async); -void freeTrackingRadixTree(rax *rt); -void freeTrackingRadixTreeAsync(rax *rt); -void freeErrorsRadixTreeAsync(rax *errors); -void trackingLimitUsedSlots(void); -uint64_t trackingGetTotalItems(void); -uint64_t trackingGetTotalKeys(void); -uint64_t trackingGetTotalPrefixes(void); -void trackingBroadcastInvalidationMessages(void); -int checkPrefixCollisionsOrReply(client *c, robj **prefix, size_t numprefix); - -/* List data type */ -void listTypePush(robj *subject, robj *value, int where); -robj *listTypePop(robj *subject, int where); -unsigned long listTypeLength(const robj *subject); -size_t listTypeAllocSize(const robj *o); -void listTypeInitIterator(listTypeIterator *li, robj *subject, long index, unsigned char direction); -void listTypeResetIterator(listTypeIterator *li); -void listTypeSetIteratorDirection(listTypeIterator *li, listTypeEntry *entry, unsigned char direction); -int listTypeNext(listTypeIterator *li, listTypeEntry *entry); -robj *listTypeGet(listTypeEntry *entry); -unsigned char *listTypeGetValue(listTypeEntry *entry, size_t *vlen, long long *lval); -void listTypeInsert(listTypeEntry *entry, robj *value, int where); -void listTypeReplace(listTypeEntry *entry, robj *value); -int listTypeEqual(listTypeEntry *entry, robj *o, size_t object_len, - long long *cached_longval, int *cached_valid); -void listTypeDelete(listTypeIterator *iter, listTypeEntry *entry); -robj *listTypeDup(robj *o); -void listTypeDelRange(robj *o, long start, long stop); -void popGenericCommand(client *c, int where); -void listElementsRemoved(client *c, robj *key, int where, robj *o, long count, size_t oldsize, int signal, int *deleted); -typedef enum { - LIST_CONV_AUTO, - LIST_CONV_GROWING, - LIST_CONV_SHRINKING, -} list_conv_type; -typedef void (*beforeConvertCB)(void *data); -void listTypeTryConversion(robj *o, list_conv_type lct, beforeConvertCB fn, void *data); -void listTypeTryConversionAppend(robj *o, robj **argv, int start, int end, beforeConvertCB fn, void *data); - -/* MULTI/EXEC/WATCH... */ -void unwatchAllKeys(client *c); -void initClientMultiState(client *c); -void freeClientMultiState(client *c); -void queueMultiCommand(client *c, uint64_t cmd_flags); -size_t multiStateMemOverhead(client *c); -void touchWatchedKey(redisDb *db, robj *key); -int isWatchedKeyExpired(client *c); -void touchAllWatchedKeysInDb(redisDb *emptied, redisDb *replaced_with, struct slotRangeArray *slots); -void discardTransaction(client *c); -void flagTransaction(client *c); -void execCommandAbort(client *c, sds error); - -unsigned char *getObjectReadOnlyString(robj *o, long *len, char *llbuf); - -unsigned long long estimateObjectIdleTime(robj *o); -#define sdsEncodedObject(objptr) (objptr->encoding == OBJ_ENCODING_RAW || objptr->encoding == OBJ_ENCODING_EMBSTR) - -/* Synchronous I/O with timeout */ -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); - -/* Replication */ -void replicationFeedSlaves(list *slaves, int dictid, robj **argv, int argc); -void replicationFeedStreamFromMasterStream(char *buf, size_t buflen); -void resetReplicationBuffer(void); -void feedReplicationBuffer(char *buf, size_t len); -void freeReplicaReferencedReplBuffer(client *replica); -void replicationFeedMonitors(client *c, list *monitors, int dictid, robj **argv, int argc); -void updateSlavesWaitingBgsave(int bgsaveerr, int type); -void replicationCron(void); -void replicationStartPendingFork(void); -void replicationHandleMasterDisconnection(void); -void replicationCacheMaster(client *c); -void resizeReplicationBacklog(void); -void replicationSetMaster(char *ip, int port); -void replicationUnsetMaster(void); -void refreshGoodSlavesCount(void); -int checkGoodReplicasStatus(void); -void processClientsWaitingReplicas(void); -void unblockClientWaitingReplicas(client *c); -int replicationCountAcksByOffset(long long offset); -int replicationCountAOFAcksByOffset(long long offset); -void replicationSendNewlineToMaster(void); -long long replicationGetSlaveOffset(void); -char *replicationGetSlaveName(client *c); -long long getPsyncInitialOffset(void); -int replicationSetupSlaveForFullResync(client *slave, long long offset); -void changeReplicationId(void); -void clearReplicationId2(void); -void createReplicationBacklog(void); -void freeReplicationBacklog(void); -void replicationCacheMasterUsingMyself(void); -void feedReplicationBacklog(void *ptr, size_t len); -void incrementalTrimReplicationBacklog(size_t blocks); -int canFeedReplicaReplBuffer(client *replica); -void rebaseReplicationBuffer(long long base_repl_offset); -void showLatestBacklog(void); -void rdbPipeReadHandler(struct aeEventLoop *eventLoop, int fd, void *clientData, int mask); -void rdbPipeWriteHandlerConnRemoved(struct connection *conn); -void clearFailoverState(void); -void updateFailoverStatus(void); -void abortFailover(const char *err); -const char *getFailoverStateString(void); -int replicationCheckHasMainChannel(client *slave); -unsigned long replicationLogicalReplicaCount(void); -void replDataBufInit(replDataBuf *buf); -void replDataBufClear(replDataBuf *buf); -void replDataBufReadFromConn(connection *conn, replDataBuf *buf, void (*error_handler)(connection *conn)); -int replDataBufStreamToDb(replDataBuf *buf, replDataBufToDbCtx *ctx); -int replicaFromIOThreadHasPendingRead(client *c); -void putReplicasInPendingClientsToIOThreads(void); -int replicationCronRunMasterClient(void); - -/* Generic persistence functions */ -void startLoadingFile(size_t size, char* filename, int rdbflags); -void startLoading(size_t size, int rdbflags, int async); -void loadingSetFlags(char *filename, size_t size, int async); -void loadingFireEvent(int rdbflags); -void loadingAbsProgress(off_t pos); -void loadingIncrProgress(off_t size); -void stopLoading(int success); -void updateLoadingFileName(char* filename); -void startSaving(int rdbflags); -void stopSaving(int success); -int allPersistenceDisabled(void); - -#define DISK_ERROR_TYPE_AOF 1 /* Don't accept writes: AOF errors. */ -#define DISK_ERROR_TYPE_RDB 2 /* Don't accept writes: RDB errors. */ -#define DISK_ERROR_TYPE_NONE 0 /* No problems, we can accept writes. */ -int writeCommandsDeniedByDiskError(void); -sds writeCommandsGetDiskErrorMessage(int); - -/* RDB persistence */ -#include "rdb.h" -void killRDBChild(void); -int bg_unlink(const char *filename); - -/* AOF persistence */ -void flushAppendOnlyFile(int force); -void feedAppendOnlyFile(int dictid, robj **argv, int argc); -void aofRemoveTempFile(pid_t childpid); -int rewriteAppendOnlyFileBackground(void); -int loadAppendOnlyFiles(aofManifest *am); -void stopAppendOnly(void); -int startAppendOnly(void); -void startAppendOnlyWithRetry(void); -void applyAppendOnlyConfig(void); -void backgroundRewriteDoneHandler(int exitcode, int bysignal); -void killAppendOnlyChild(void); -void aofLoadManifestFromDisk(void); -void aofOpenIfNeededOnServerStart(void); -void aofManifestFree(aofManifest *am); -int aofDelHistoryFiles(void); -int aofRewriteLimited(void); -void updateCurIncrAofEndOffset(void); -void updateReplOffsetAndResetEndOffset(void); -int rewriteObject(rio *r, robj *key, robj *o, int dbid, long long expiretime); - -/* Child info */ -void openChildInfoPipe(void); -void closeChildInfoPipe(void); -void sendChildInfoGeneric(childInfoType info_type, size_t keys, double progress, char *pname); -void sendChildCowInfo(childInfoType info_type, char *pname); -void sendChildInfo(childInfoType info_type, size_t keys, char *pname); -void receiveChildInfo(void); - -/* Fork helpers */ -int redisFork(int purpose); -int hasActiveChildProcess(void); -void resetChildState(void); -int isMutuallyExclusiveChildType(int type); - -/* acl.c -- Authentication related prototypes. */ -extern rax *Users; -extern user *DefaultUser; -void ACLInit(void); -/* Return values for ACLCheckAllPerm(). */ -#define ACL_OK 0 -#define ACL_DENIED_CMD 1 -#define ACL_DENIED_KEY 2 -#define ACL_DENIED_AUTH 3 /* Only used for ACL LOG entries. */ -#define ACL_DENIED_CHANNEL 4 /* Only used for pub/sub commands */ -#define ACL_INVALID_TLS_CERT_AUTH 5 /* Only used for TLS Auto-authentication */ - -/* Context values for addACLLogEntry(). */ -#define ACL_LOG_CTX_TOPLEVEL 0 -#define ACL_LOG_CTX_LUA 1 -#define ACL_LOG_CTX_MULTI 2 -#define ACL_LOG_CTX_MODULE 3 - -/* ACL key permission types */ -#define ACL_READ_PERMISSION (1<<0) -#define ACL_WRITE_PERMISSION (1<<1) -#define ACL_ALL_PERMISSION (ACL_READ_PERMISSION|ACL_WRITE_PERMISSION) - -/* Return codes for Authentication functions to indicate the result. */ -typedef enum { - AUTH_OK = 0, - AUTH_ERR, - AUTH_NOT_HANDLED, - AUTH_BLOCKED -} AuthResult; - -int ACLCheckUserCredentials(robj *username, robj *password); -int ACLAuthenticateUser(client *c, robj *username, robj *password, robj **err); -int checkModuleAuthentication(client *c, robj *username, robj *password, robj **err); -void addAuthErrReply(client *c, robj *err); -unsigned long ACLGetCommandID(sds cmdname); -void ACLClearCommandID(void); -user *ACLGetUserByName(const char *name, size_t namelen); -int ACLUserCheckKeyPerm(user *u, const char *key, int keylen, int flags); -int ACLUserCheckChannelPerm(user *u, sds channel, int literal); -int ACLCheckAllUserCommandPerm(user *u, struct redisCommand *cmd, robj **argv, int argc, getKeysResult *key_result, int *idxptr); -int ACLUserCheckCmdWithUnrestrictedKeyAccess(user *u, struct redisCommand *cmd, robj **argv, int argc, int flags); -int ACLCheckAllPerm(client *c, int *idxptr); -int ACLSetUser(user *u, const char *op, ssize_t oplen); -sds ACLStringSetUser(user *u, sds username, sds *argv, int argc); -uint64_t ACLGetCommandCategoryFlagByName(const char *name); -int ACLAddCommandCategory(const char *name, uint64_t flag); -void ACLCleanupCategoriesOnFailure(size_t num_acl_categories_added); -int ACLAppendUserForLoading(sds *argv, int argc, int *argc_err); -const char *ACLSetUserStringError(void); -int ACLLoadConfiguredUsers(void); -robj *ACLDescribeUser(user *u); -void ACLLoadUsersAtStartup(void); -void addReplyCommandCategories(client *c, struct redisCommand *cmd); -user *ACLCreateUnlinkedUser(void); -void ACLFreeUserAndKillClients(user *u); -void addACLLogEntry(client *c, int reason, int context, int argpos, sds username, sds object); -sds getAclErrorMessage(int acl_res, user *user, struct redisCommand *cmd, sds errored_val, int verbose); -void ACLUpdateDefaultUserPassword(sds password); -sds genRedisInfoStringACLStats(sds info); -void ACLRecomputeCommandBitsFromCommandRulesAllUsers(void); - -/* Sorted sets data type */ - -/* Input flags. */ -#define ZADD_IN_NONE 0 -#define ZADD_IN_INCR (1<<0) /* Increment the score instead of setting it. */ -#define ZADD_IN_NX (1<<1) /* Don't touch elements not already existing. */ -#define ZADD_IN_XX (1<<2) /* Only touch elements already existing. */ -#define ZADD_IN_GT (1<<3) /* Only update existing when new scores are higher. */ -#define ZADD_IN_LT (1<<4) /* Only update existing when new scores are lower. */ - -/* Output flags. */ -#define ZADD_OUT_NOP (1<<0) /* Operation not performed because of conditionals.*/ -#define ZADD_OUT_NAN (1<<1) /* Only touch elements already existing. */ -#define ZADD_OUT_ADDED (1<<2) /* The element was new and was added. */ -#define ZADD_OUT_UPDATED (1<<3) /* The element already existed, score updated. */ - -/* Struct to hold an inclusive/exclusive range spec by score comparison. */ -typedef struct { - double min, max; - int minex, maxex; /* are min or max exclusive? */ -} zrangespec; - -/* Struct to hold an inclusive/exclusive range spec by lexicographic comparison. */ -typedef struct { - sds min, max; /* May be set to shared.(minstring|maxstring) */ - int minex, maxex; /* are min or max exclusive? */ -} zlexrangespec; - -/* flags for incrCommandFailedCalls */ -#define ERROR_COMMAND_REJECTED (1<<0) /* Indicate to update the command rejected stats */ -#define ERROR_COMMAND_FAILED (1<<1) /* Indicate to update the command failed stats */ - -zskiplist *zslCreate(void); -void zslFree(zskiplist *zsl); -size_t zslAllocSize(const zskiplist *zsl); -sds zslGetNodeElement(const zskiplistNode *node); -int zslCompareWithNode(double score, sds ele, const zskiplistNode *n); -zskiplistNode *zslInsert(zskiplist *zsl, double score, sds ele); -unsigned char *zzlInsert(unsigned char *zl, sds ele, double score); -zskiplistNode *zslNthInRange(zskiplist *zsl, zrangespec *range, long n, unsigned long *out_rank); -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); -unsigned char *zzlFirstInRange(unsigned char *zl, zrangespec *range); -unsigned char *zzlLastInRange(unsigned char *zl, zrangespec *range); -unsigned long zsetLength(const robj *zobj); -size_t zsetAllocSize(const robj *o); -void zsetConvert(robj *zobj, int encoding); -void zsetConvertToListpackIfNeeded(robj *zobj, size_t maxelelen, size_t totelelen); -int zsetScore(robj *zobj, sds member, double *score); -unsigned long zslGetRank(zskiplist *zsl, double score, sds o); -int zsetAdd(robj *zobj, double score, sds ele, int in_flags, int *out_flags, double *newscore); -long zsetRank(robj *zobj, sds ele, int reverse, double *score); -int zsetDel(robj *zobj, sds ele); -robj *zsetDup(robj *o); -void genericZpopCommand(client *c, robj **keyv, int keyc, int where, int emitkey, long count, int use_nested_array, int reply_nil_when_empty, int *deleted); -sds lpGetObject(unsigned char *sptr); -int zslValueGteMin(double value, zrangespec *spec); -int zslValueLteMax(double value, zrangespec *spec); -void zslFreeLexRange(zlexrangespec *spec); -int zslParseLexRange(robj *min, robj *max, zlexrangespec *spec); -unsigned char *zzlFirstInLexRange(unsigned char *zl, zlexrangespec *range); -unsigned char *zzlLastInLexRange(unsigned char *zl, zlexrangespec *range); -zskiplistNode *zslNthInLexRange(zskiplist *zsl, zlexrangespec *range, long n, unsigned long *out_rank); -int zzlLexValueGteMin(unsigned char *p, zlexrangespec *spec); -int zzlLexValueLteMax(unsigned char *p, zlexrangespec *spec); -int zslLexValueGteMin(sds value, zlexrangespec *spec); -int zslLexValueLteMax(sds value, zlexrangespec *spec); - -/* Core functions */ -int getMaxmemoryState(size_t *total, size_t *logical, size_t *tofree, float *level); -void updatePeakMemory(void); -size_t freeMemoryGetNotCountedMemory(void); -int overMaxmemoryAfterAlloc(size_t moremem); -uint64_t getCommandFlags(client *c); -void preprocessCommand(client *c, pendingCommand *pcmd); -int processCommand(client *c); -void commandProcessed(client *c); -void prepareForNextCommand(client *c, int update_slot_stats); -int processPendingCommandAndInputBuffer(client *c); -int processCommandAndResetClient(client *c); -int areCommandKeysInSameSlot(client *c, int *hashslot); -void setupSignalHandlers(void); -int createSocketAcceptHandler(connListener *sfd, aeFileProc *accept_handler); -connListener *listenerByType(const char *typename); -int changeListener(connListener *listener); -void closeListener(connListener *listener); -struct redisCommand *lookupSubcommand(struct redisCommand *container, sds sub_name); -struct redisCommand *lookupCommand(robj **argv, int argc); -struct redisCommand *lookupCommandBySdsLogic(dict *commands, sds s); -struct redisCommand *lookupCommandBySds(sds s); -struct redisCommand *lookupCommandByCStringLogic(dict *commands, const char *s); -struct redisCommand *lookupCommandByCString(const char *s); -struct redisCommand *lookupCommandOrOriginal(robj **argv, int argc); -int commandCheckExistence(client *c, sds *err); -int commandCheckArity(struct redisCommand *cmd, int argc, sds *err); -void startCommandExecution(void); -int incrCommandStatsOnError(struct redisCommand *cmd, int flags); -void call(client *c, int flags); -void alsoPropagate(int dbid, robj **argv, int argc, int target); -void postExecutionUnitOperations(void); -int redisOpArrayAppend(redisOpArray *oa, int dbid, robj **argv, int argc, int target); -void redisOpArrayFree(redisOpArray *oa); -void forceCommandPropagation(client *c, int flags); -void preventCommandPropagation(client *c); -void preventCommandAOF(client *c); -void preventCommandReplication(client *c); -void slowlogPushCurrentCommand(client *c, struct redisCommand *cmd, ustime_t duration); -void updateCommandLatencyHistogram(struct hdr_histogram** latency_histogram, int64_t duration_hist); -int prepareForShutdown(int flags); -void replyToClientsBlockedOnShutdown(void); -int abortShutdown(void); -void afterCommand(client *c); -int mustObeyClient(client *c); -#ifdef __GNUC__ -void _serverLog(int level, const char *fmt, ...) - __attribute__((format(printf, 2, 3))); -void serverLogFromHandler(int level, const char *fmt, ...) - __attribute__((format(printf, 2, 3))); -#else -void serverLogFromHandler(int level, const char *fmt, ...); -void _serverLog(int level, const char *fmt, ...); -#endif -void serverLogRaw(int level, const char *msg); -void serverLogRawFromHandler(int level, const char *msg); -void usage(void); -void updateDictResizePolicy(void); -void populateCommandTable(void); -void resetCommandTableStats(dict* commands); -void resetErrorTableStats(void); -void adjustOpenFilesLimit(void); -void incrementErrorCount(const char *fullerr, size_t namelen); -void closeListeningSockets(int unlink_unix_socket); -void updateCachedTime(int update_daylight_info); -void enterExecutionUnit(int update_cached_time, long long us); -void exitExecutionUnit(void); -void resetServerStats(void); -void activeDefragCycle(void); -void defragWhileBlocked(void); -unsigned int getLRUClock(void); -unsigned int LRU_CLOCK(void); -const char *evictPolicyToString(void); -struct redisMemOverhead *getMemoryOverheadData(void); -void freeMemoryOverheadData(struct redisMemOverhead *mh); -void checkChildrenDone(void); -int setOOMScoreAdj(int process_class); -void rejectCommandFormat(client *c, const char *fmt, ...); -void *activeDefragAlloc(void *ptr); -void *activeDefragAllocRaw(size_t size); -void activeDefragFreeRaw(void *ptr); -robj *activeDefragStringOb(robj* ob); -void dismissSds(sds s); -void dismissMemory(void* ptr, size_t size_hint); -void dismissMemoryInChild(void); -int clientsCronRunClient(client *c); - -#define RESTART_SERVER_NONE 0 -#define RESTART_SERVER_GRACEFULLY (1<<0) /* Do proper shutdown. */ -#define RESTART_SERVER_CONFIG_REWRITE (1<<1) /* CONFIG REWRITE before restart.*/ -int restartServer(int flags, mstime_t delay); -int getKeySlot(sds key); -int calculateKeySlot(sds key); - -/* kvstore wrappers */ -int dbExpand(redisDb *db, uint64_t db_size, int try_expand); -int dbExpandExpires(redisDb *db, uint64_t db_size, int try_expand); -kvobj *dbFind(redisDb *db, sds key); -kvobj *dbFindByLink(redisDb *db, sds key, dictEntryLink *link); -kvobj *dbFindExpires(redisDb *db, sds key); -unsigned long long dbSize(redisDb *db); -unsigned long long dbScan(redisDb *db, unsigned long long cursor, dictScanFunction *scan_cb, void *privdata); - -/* Set data type */ -robj *setTypeCreate(sds value, size_t size_hint); -int setTypeAdd(robj *subject, sds value); -int setTypeAddAux(robj *set, char *str, size_t len, int64_t llval, int str_is_sds); -int setTypeRemove(robj *subject, sds value); -int setTypeRemoveAux(robj *set, char *str, size_t len, int64_t llval, int str_is_sds); -int setTypeIsMember(robj *subject, sds value); -int setTypeIsMemberAux(robj *set, char *str, size_t len, int64_t llval, int str_is_sds); -void setTypeInitIterator(setTypeIterator *si, robj *subject); -void setTypeResetIterator(setTypeIterator *si); -int setTypeNext(setTypeIterator *si, char **str, size_t *len, int64_t *llele); -sds setTypeNextObject(setTypeIterator *si); -int setTypeRandomElement(robj *setobj, char **str, size_t *len, int64_t *llele); -unsigned long setTypeSize(const robj *subject); -size_t setTypeAllocSize(const robj *o); -void setTypeConvert(robj *subject, int enc); -int setTypeConvertAndExpand(robj *setobj, int enc, unsigned long cap, int panic); -robj *setTypeDup(robj *o); - -/* Data structure for OBJ_ENCODING_LISTPACK_EX for hash. It contains listpack - * and metadata fields for hash field expiration.*/ -typedef struct listpackEx { - ExpireMeta meta; /* To be used in order to register the hash in the - global ebuckets subexpires with next, minimum, - hash-field to expire. TTL value might be inaccurate - up-to few seconds due to optimization consideration. */ - void *lp; /* listpack that contains 'key-value-ttl' tuples which - are ordered by ttl. */ -} listpackEx; - -/* Each dict of hash object that has fields with time-Expiration will have the - * following metadata attached to dict header. - * Note that alloc_size field must be first because hash objects without expre - * already use sizeof(size_t) bytes of metadata for memory accounting. */ -typedef struct htMetadataEx { - size_t alloc_size; /* Total memory used for keys and values */ - ExpireMeta expireMeta; /* embedded ExpireMeta in dict. - To be used in order to register the hash in the - subexpires DB with next minimum hash-field to expire. - TTL value might be inaccurate up-to few seconds due - to optimization consideration. */ - ebuckets hfe; /* DS of Hash Fields Expiration, associated to each hash */ -} htMetadataEx; - -/* hash metadata helpers */ -static inline htMetadataEx *htGetMetadataEx(dict *d) { - return (htMetadataEx *)dictMetadata(d); -} - -static inline size_t *htGetMetadataSize(dict *d) { - return (size_t *)dictMetadata(d); -} - -/* Hash data type */ -#define HASH_SET_TAKE_FIELD (1<<0) -#define HASH_SET_TAKE_VALUE (1<<1) -#define HASH_SET_COPY 0 - -/* Hash field lazy expiration flags. Used by core hashTypeGetValue() and its callers */ -#define HFE_LAZY_EXPIRE (0) /* Delete expired field, and if last field also the hash */ -#define HFE_LAZY_AVOID_FIELD_DEL (1<<0) /* Avoid deleting expired field */ -#define HFE_LAZY_AVOID_HASH_DEL (1<<1) /* Avoid deleting hash if the field is the last one */ -#define HFE_LAZY_NO_NOTIFICATION (1<<2) /* Do not send notification, used when multiple fields - * may expire and only one notification is desired. */ -#define HFE_LAZY_NO_SIGNAL (1<<3) /* Do not send signal, used when multiple fields - * may expire and only one signal is desired. */ -#define HFE_LAZY_ACCESS_EXPIRED (1<<4) /* Avoid lazy expire and allow access to expired fields */ -#define HFE_LAZY_NO_UPDATE_KEYSIZES (1<<5) /* If field lazy deleted, avoid updating keysizes histogram */ -#define HFE_LAZY_NO_UPDATE_ALLOCSIZES (1<<6) /* If field lazy deleted, avoid updating slot allocation sizes */ - -void hashTypeConvert(redisDb *db, robj *o, int enc); -void hashTypeTryConversion(redisDb *db, kvobj *kv, robj **argv, int start, int end); -int hashTypeExists(redisDb *db, kvobj *kv, sds field, int hfeFlags, int *isHashDeleted); -int hashTypeDelete(robj *o, void *key); -unsigned long hashTypeLength(const robj *o, int subtractExpiredFields); -size_t hashTypeAllocSize(const robj *o); -void hashTypeInitIterator(hashTypeIterator *hi, robj *subject); -void hashTypeResetIterator(hashTypeIterator *hi); -int hashTypeNext(hashTypeIterator *hi, int skipExpiredFields); -void hashTypeCurrentFromListpack(hashTypeIterator *hi, int what, - unsigned char **vstr, - unsigned int *vlen, - long long *vll, - uint64_t *expireTime); -void hashTypeCurrentFromHashTable(hashTypeIterator *hi, int what, char **str, - size_t *len, uint64_t *expireTime); -void hashTypeCurrentObject(hashTypeIterator *hi, int what, unsigned char **vstr, - unsigned int *vlen, long long *vll, uint64_t *expireTime); -sds hashTypeCurrentObjectNewSds(hashTypeIterator *hi, int what); -Entry *hashTypeCurrentObjectNewEntry(hashTypeIterator *hi, size_t *usable); -int hashTypeGetValueObject(redisDb *db, kvobj *kv, sds field, int hfeFlags, - robj **val, uint64_t *expireTime, int *isHashDeleted); -int hashTypeSet(redisDb *db, kvobj *kv, sds field, sds value, int flags); -robj *hashTypeDup(kvobj *kv, uint64_t *minHashExpire); -uint64_t hashTypeActiveExpire(redisDb *db, kvobj *o, uint32_t *quota, int updateSubexpires); -void hashTypeFree(robj *o); -int hashTypeIsExpired(const robj *o, uint64_t expireAt); -unsigned char *hashTypeListpackGetLp(robj *o); -uint64_t hashTypeGetMinExpire(robj *o, int accurate); -ebuckets *hashTypeGetDictMetaHFE(dict *d); -void initDictExpireMetadata(robj *o); -struct listpackEx *listpackExCreate(void); -void listpackExAddNew(robj *o, char *field, size_t flen, - char *value, size_t vlen, uint64_t expireAt); - -/* Pub / Sub */ -int pubsubUnsubscribeAllChannels(client *c, int notify); -int pubsubUnsubscribeShardAllChannels(client *c, int notify); -void pubsubShardUnsubscribeAllChannelsInSlot(unsigned int slot); -int pubsubUnsubscribeAllPatterns(client *c, int notify); -int pubsubPublishMessage(robj *channel, robj *message, int sharded); -int pubsubPublishMessageAndPropagateToCluster(robj *channel, robj *message, int sharded); -void addReplyPubsubMessage(client *c, robj *channel, robj *msg, robj *message_bulk); -int serverPubsubSubscriptionCount(void); -int serverPubsubShardSubscriptionCount(void); -size_t pubsubMemOverhead(client *c); -void unmarkClientAsPubSub(client *c); -int pubsubTotalSubscriptions(void); -dict *getClientPubSubChannels(client *c); -dict *getClientPubSubShardChannels(client *c); - -/* Keyspace events notification */ -void notifyKeyspaceEvent(int type, const char *event, robj *key, int dbid); -int keyspaceEventsStringToFlags(char *classes); -sds keyspaceEventsFlagsToString(int flags); - -/* Configuration */ -/* Configuration Flags */ -#define MODIFIABLE_CONFIG 0 /* This is the implied default for a standard - * config, which is mutable. */ -#define IMMUTABLE_CONFIG (1ULL<<0) /* Can this value only be set at startup? */ -#define SENSITIVE_CONFIG (1ULL<<1) /* Does this value contain sensitive information */ -#define DEBUG_CONFIG (1ULL<<2) /* Values that are useful for debugging. */ -#define MULTI_ARG_CONFIG (1ULL<<3) /* This config receives multiple arguments. */ -#define HIDDEN_CONFIG (1ULL<<4) /* This config is hidden in `config get <pattern>` (used for tests/debugging) */ -#define PROTECTED_CONFIG (1ULL<<5) /* Becomes immutable if enable-protected-configs is enabled. */ -#define DENY_LOADING_CONFIG (1ULL<<6) /* This config is forbidden during loading. */ -#define ALIAS_CONFIG (1ULL<<7) /* For configs with multiple names, this flag is set on the alias. */ -#define MODULE_CONFIG (1ULL<<8) /* This config is a module config */ -#define VOLATILE_CONFIG (1ULL<<9) /* The config is a reference to the config data and not the config data itself (ex. - * a file name containing more configuration like a tls key). In this case we want - * to apply the configuration change even if the new config value is the same as - * the old. */ - -#define INTEGER_CONFIG 0 /* No flags means a simple integer configuration */ -#define MEMORY_CONFIG (1<<0) /* Indicates if this value can be loaded as a memory value */ -#define PERCENT_CONFIG (1<<1) /* Indicates if this value can be loaded as a percent (and stored as a negative int) */ -#define OCTAL_CONFIG (1<<2) /* This value uses octal representation */ - -/* Enum Configs contain an array of configEnum objects that match a string with an integer. */ -typedef struct configEnum { - char *name; - int val; -} configEnum; - -/* Type of configuration. */ -typedef enum { - BOOL_CONFIG, - NUMERIC_CONFIG, - STRING_CONFIG, - SDS_CONFIG, - ENUM_CONFIG, - SPECIAL_CONFIG, -} configType; - -void loadServerConfig(char *filename, char config_from_stdin, char *options); -void appendServerSaveParams(time_t seconds, int changes); -void resetServerSaveParams(void); -struct rewriteConfigState; /* Forward declaration to export API. */ -int rewriteConfigRewriteLine(struct rewriteConfigState *state, const char *option, sds line, int force); -void rewriteConfigMarkAsProcessed(struct rewriteConfigState *state, const char *option); -int rewriteConfig(char *path, int force_write); -void initConfigValues(void); -void removeConfig(sds name); -sds getConfigDebugInfo(void); -int allowProtectedAction(int config, client *c); -void initServerClientMemUsageBuckets(void); -void freeServerClientMemUsageBuckets(void); -static inline int clusterSlotStatsEnabled(int stat) { return server.cluster_enabled && (server.cluster_slot_stats_enabled & stat); } - -/* Module Configuration */ -typedef struct ModuleConfig ModuleConfig; -int performModuleConfigSetFromName(sds name, sds value, const char **err); -int performModuleConfigSetDefaultFromName(sds name, const char **err); -void addModuleBoolConfig(sds name, sds alias, int flags, void *privdata, int default_val); -void addModuleStringConfig(sds name, sds alias, int flags, void *privdata, sds default_val); -void addModuleEnumConfig(sds name, sds alias, int flags, void *privdata, int default_val, configEnum *enum_vals, int num_enum_vals); -void addModuleNumericConfig(sds name, sds alias, int flags, void *privdata, long long default_val, int conf_flags, long long lower, long long upper); -void addModuleConfigApply(list *module_configs, ModuleConfig *module_config); -int moduleConfigApply(ModuleConfig *module_config, const char **err); -int moduleConfigApplyConfig(list *module_configs, const char **err, const char **err_arg_name); -int moduleConfigNeedsApply(ModuleConfig *config); -int getModuleBoolConfig(ModuleConfig *module_config); -int setModuleBoolConfig(ModuleConfig *config, int val, const char **err); -sds getModuleStringConfig(ModuleConfig *module_config); -int setModuleStringConfig(ModuleConfig *config, sds strval, const char **err); -int getModuleEnumConfig(ModuleConfig *module_config); -int setModuleEnumConfig(ModuleConfig *config, int val, const char **err); -long long getModuleNumericConfig(ModuleConfig *module_config); -int setModuleNumericConfig(ModuleConfig *config, long long val, const char **err); - -/* API for modules to access config values. */ -dictIterator *moduleGetConfigIterator(void); -const char *moduleConfigIteratorNext(dictIterator **iter, sds pattern, int is_glob, configType *typehint); -int moduleGetConfigType(sds name, configType *res); -int moduleGetBoolConfig(sds name, int *res); -int moduleGetStringConfig(sds name, sds *res); -int moduleGetEnumConfig(sds name, sds *res); -int moduleGetNumericConfig(sds name, long long *res); -int moduleSetBoolConfig(client *c, sds name, int val, const char **err); -int moduleSetStringConfig(client *c, sds name, const char *val, const char **err); -int moduleSetEnumConfig(client *c, sds name, sds *vals, int vals_cnt, const char **err); -int moduleSetNumericConfig(client *c, sds name, long long val, const char **err); - -/* db.c -- Keyspace access API */ -void updateKeysizesHist(redisDb *db, int didx, uint32_t type, int64_t oldLen, int64_t newLen); -void updateSlotAllocSize(redisDb *db, int didx, size_t oldsize, size_t newsize); -void dbgAssertKeysizesHist(redisDb *db); -void dbgAssertAllocSizePerSlot(redisDb *db); -int removeExpire(redisDb *db, robj *key); -void deleteExpiredKeyAndPropagate(redisDb *db, robj *keyobj); -void deleteEvictedKeyAndPropagate(redisDb *db, robj *keyobj, long long *key_mem_freed); -void propagateDeletion(redisDb *db, robj *key, int lazy); -int keyIsExpired(redisDb *db, sds key, kvobj *kv); -int confAllowsExpireDel(void); -long long getExpire(redisDb *db, sds key, kvobj *kv); -kvobj *setExpire(client *c, redisDb *db, robj *key, long long when); -kvobj *setExpireByLink(client *c, redisDb *db, sds key, long long when, dictEntryLink link); -int checkAlreadyExpired(long long when); -int parseExtendedExpireArgumentsOrReply(client *c, int *flags); -kvobj *lookupKeyRead(redisDb *db, robj *key); -kvobj *lookupKeyWrite(redisDb *db, robj *key); -kvobj *lookupKeyWriteWithLink(redisDb *db, robj *key, dictEntryLink *link); -kvobj *lookupKeyReadOrReply(client *c, robj *key, robj *reply); -kvobj *lookupKeyWriteOrReply(client *c, robj *key, robj *reply); -kvobj *lookupKeyReadWithFlags(redisDb *db, robj *key, int flags); -kvobj *lookupKeyWriteWithFlags(redisDb *db, robj *key, int flags); -kvobj *kvobjCommandLookup(client *c, robj *key); -kvobj *kvobjCommandLookupOrReply(client *c, robj *key, robj *reply); - -#define LOOKUP_NONE 0 -#define LOOKUP_NOTOUCH (1<<0) /* Don't update LRU. */ -#define LOOKUP_NONOTIFY (1<<1) /* Don't trigger keyspace event on key misses. */ -#define LOOKUP_NOSTATS (1<<2) /* Don't update keyspace hits/misses counters. */ -#define LOOKUP_WRITE (1<<3) /* Delete expired keys even in replicas. */ -#define LOOKUP_NOEXPIRE (1<<4) /* Avoid deleting lazy expired keys. */ -#define LOOKUP_ACCESS_EXPIRED (1<<5) /* Allow lookup to expired key. */ -#define LOOKUP_ACCESS_TRIMMED (1<<6) /* Allow lookup to key in slots being trimmed. */ -#define LOOKUP_NOEFFECTS (LOOKUP_NONOTIFY | LOOKUP_NOSTATS | LOOKUP_NOTOUCH | LOOKUP_NOEXPIRE) /* Avoid any effects from fetching the key */ - -static inline kvobj *dictGetKV(const dictEntry *de) {return (kvobj *) dictGetKey(de);} -kvobj *dbAdd(redisDb *db, robj *key, robj **valref); -kvobj *dbAddByLink(redisDb *db, robj *key, robj **valref, dictEntryLink *link); -kvobj *dbAddInternal(redisDb *db, robj *key, robj **valref, dictEntryLink *link, const KeyMetaSpec *m); -kvobj *dbAddRDBLoad(redisDb *db, sds key, robj **valref, const KeyMetaSpec *keyMetaSpec); -void dbReplaceValue(redisDb *db, robj *key, kvobj **ioKeyVal, int updateKeySizes); -void dbReplaceValueWithLink(redisDb *db, robj *key, robj **val, dictEntryLink link); - -#define SETKEY_KEEPTTL 1 -#define SETKEY_NO_SIGNAL 2 -#define SETKEY_ALREADY_EXIST 4 -#define SETKEY_DOESNT_EXIST 8 - -void setKey(client *c, redisDb *db, robj *key, robj **ioval, int flags); -void setKeyByLink(client *c, redisDb *db, robj *key, robj **valref, int flags, dictEntryLink *link); -robj *dbRandomKey(redisDb *db); -int dbGenericDelete(redisDb *db, robj *key, int async, int flags); -int dbSyncDelete(redisDb *db, robj *key); -int dbDelete(redisDb *db, robj *key); -int dbDeleteSkipKeysizesUpdate(redisDb *db, robj *key); -kvobj *dbUnshareStringValue(redisDb *db, robj *key, kvobj *o); -kvobj *dbUnshareStringValueByLink(redisDb *db, robj *key, kvobj *kv, dictEntryLink link); - -#define FLUSH_TYPE_ALL 0 -#define FLUSH_TYPE_DB 1 -#define FLUSH_TYPE_SLOTS 2 -void replySlotsFlushAndFree(client *c, struct slotRangeArray *slots); -int flushCommandCommon(client *c, int type, int flags, struct slotRangeArray *ranges); -#define EMPTYDB_NO_FLAGS 0 /* No flags. */ -#define EMPTYDB_ASYNC (1<<0) /* Reclaim memory in another thread. */ -#define EMPTYDB_NOFUNCTIONS (1<<1) /* Indicate not to flush the functions. */ -long long emptyData(int dbnum, int flags, void(callback)(dict*)); -long long emptyDbStructure(redisDb *dbarray, int dbnum, int async, void(callback)(dict*)); -void flushAllDataAndResetRDB(int flags); -long long dbTotalServerKeyCount(void); -redisDb *initTempDb(void); -void discardTempDb(redisDb *tempDb); - - -int selectDb(client *c, int id); -void keyModified(client *c, redisDb *db, robj *key, robj *val, int signal); -void signalFlushedDb(int dbid, int async, struct slotRangeArray *slots); -void scanGenericCommand(client *c, robj *o, unsigned long long cursor); -int parseScanCursorOrReply(client *c, robj *o, unsigned long long *cursor); -int dbAsyncDelete(redisDb *db, robj *key); -void emptyDbAsync(redisDb *db); -void emptyDbDataAsync(kvstore *keys, kvstore *expires, ebuckets hexpires); -size_t lazyfreeGetPendingObjectsCount(void); -size_t lazyfreeGetFreedObjectsCount(void); -void lazyfreeResetStats(void); -void freeObjAsync(robj *key, robj *obj, int dbid); -void freeReplicationBacklogRefMemAsync(list *blocks, rax *index); - -/* API to get key arguments from commands */ -#define GET_KEYSPEC_DEFAULT 0 -#define GET_KEYSPEC_INCLUDE_NOT_KEYS (1<<0) /* Consider 'fake' keys as keys */ -#define GET_KEYSPEC_RETURN_PARTIAL (1<<1) /* Return all keys that can be found */ - -int getKeysFromCommandWithSpecs(struct redisCommand *cmd, robj **argv, int argc, int search_flags, getKeysResult *result); -keyReference *getKeysPrepareResult(getKeysResult *result, int numkeys); -int getKeysFromCommand(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int getSlotFromCommand(struct redisCommand *cmd, robj **argv, int argc); -int doesCommandHaveKeys(struct redisCommand *cmd); -int getChannelsFromCommand(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int doesCommandHaveChannelsWithFlags(struct redisCommand *cmd, int flags); -void getKeysFreeResult(getKeysResult *result); -int extractKeysAndSlot(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result, int *slot); -int sintercardGetKeys(struct redisCommand *cmd,robj **argv, int argc, getKeysResult *result); -int zunionInterDiffGetKeys(struct redisCommand *cmd,robj **argv, int argc, getKeysResult *result); -int zunionInterDiffStoreGetKeys(struct redisCommand *cmd,robj **argv, int argc, getKeysResult *result); -int evalGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int functionGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int sortGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int sortROGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int migrateGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int georadiusGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int xreadGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int lmpopGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int blmpopGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int zmpopGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int bzmpopGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int setGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int delexGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); -int bitfieldGetKeys(struct redisCommand *cmd, robj **argv, int argc, getKeysResult *result); - -unsigned short crc16(const char *buf, int len); - -/* Sentinel */ -void initSentinelConfig(void); -void initSentinel(void); -void sentinelTimer(void); -const char *sentinelHandleConfiguration(char **argv, int argc); -void queueSentinelConfig(sds *argv, int argc, int linenum, sds line); -void loadSentinelConfigFromQueue(void); -void sentinelIsRunning(void); -void sentinelCheckConfigFile(void); -void sentinelCommand(client *c); -void sentinelInfoCommand(client *c); -void sentinelPublishCommand(client *c); -void sentinelRoleCommand(client *c); - -/* redis-check-rdb & aof */ -int redis_check_rdb(char *rdbfilename, FILE *fp); -int redis_check_rdb_main(int argc, char **argv, FILE *fp); -int redis_check_aof_main(int argc, char **argv); - -/* Scripting */ -void scriptingInit(int setup); -int ldbRemoveChild(pid_t pid); -void ldbKillForkedSessions(void); -int ldbPendingChildren(void); -void luaLdbLineHook(lua_State *lua, lua_Debug *ar); -void freeLuaScriptsSync(dict *lua_scripts, list *lua_scripts_lru_list, lua_State *lua); -void freeLuaScriptsAsync(dict *lua_scripts, list *lua_scripts_lru_list, lua_State *lua); -void freeFunctionsAsync(functionsLibCtx *functions_lib_ctx, dict *engines); -int ldbIsEnabled(void); -void ldbLog(sds entry); -void ldbLogRedisReply(char *reply); -void sha1hex(char *digest, char *script, size_t len); -unsigned long evalScriptsMemoryVM(void); -dict* evalScriptsDict(void); -unsigned long evalScriptsMemoryEngine(void); -uint64_t evalGetCommandFlags(client *c, uint64_t orig_flags); -uint64_t fcallGetCommandFlags(client *c, uint64_t orig_flags); -int isInsideYieldingLongCommand(void); - -typedef struct luaScript { - uint64_t flags; - robj *body; - listNode *node; /* list node in lua_scripts_lru_list list. */ -} luaScript; -/* Cache of recently used small arguments to avoid malloc calls. */ -#define LUA_CMD_OBJCACHE_SIZE 32 -#define LUA_CMD_OBJCACHE_MAX_LEN 64 - -/* Blocked clients API */ -void processUnblockedClients(void); -void initClientBlockingState(client *c); -void blockClient(client *c, int btype); -void unblockClient(client *c, int queue_for_reprocessing); -void unblockClientOnTimeout(client *c); -void unblockClientOnError(client *c, const char *err_str); -void queueClientForReprocessing(client *c); -int blockedClientMayTimeout(client *c); -void replyToBlockedClientTimedOut(client *c); -int getTimeoutFromObjectOrReply(client *c, robj *object, mstime_t *timeout, int unit); -void disconnectAllBlockedClients(void); -void handleClientsBlockedOnKeys(void); -void signalKeyAsReady(redisDb *db, robj *key, int type); -void blockForKeys(client *c, int btype, robj **keys, int numkeys, mstime_t timeout, int unblock_on_nokey); -void blockClientShutdown(client *c); -void blockPostponeClient(client *c); -void blockPostponeClientWithType(client *c, int btype); -void blockForReplication(client *c, mstime_t timeout, long long offset, long numreplicas); -void blockForAofFsync(client *c, mstime_t timeout, long long offset, int numlocal, long numreplicas); -void signalDeletedKeyAsReady(redisDb *db, robj *key, int type); -void updateStatsOnUnblock(client *c, long blocked_us, long reply_us, int had_errors); -void scanDatabaseForDeletedKeys(redisDb *emptied, redisDb *replaced_with, struct slotRangeArray *slots); -void totalNumberOfStatefulKeys(unsigned long *blocking_keys, unsigned long *bloking_keys_on_nokey, unsigned long *watched_keys); -void blockedBeforeSleep(void); - -/* timeout.c -- Blocked clients timeout and connections timeout. */ -void addClientToTimeoutTable(client *c); -void removeClientFromTimeoutTable(client *c); -void handleBlockedClientsTimeout(void); -int clientsCronHandleTimeout(client *c, mstime_t now_ms); - -/* t_stream.c -- Handling of stream data structures */ -void handleClaimableStreamEntries(void); -void handleExpiredIdmpEntries(void); - -/* expire.c -- Handling of expired keys */ -void activeExpireCycle(int type); -void expireSlaveKeys(void); -void rememberSlaveKeyWithExpire(redisDb *db, sds key); -void flushSlaveKeysWithExpireList(void); -size_t getSlaveKeyWithExpireCount(void); -uint64_t activeSubexpires(redisDb *db, int slot, uint32_t maxFieldsToExpire); - -/* evict.c -- maxmemory handling and LRU eviction. */ -void evictionPoolAlloc(void); -#define LFU_INIT_VAL 5 -unsigned long LFUGetTimeInMinutes(void); -uint8_t LFULogIncr(uint8_t value); -unsigned long LFUDecrAndReturn(robj *o); -#define EVICT_OK 0 -#define EVICT_RUNNING 1 -#define EVICT_FAIL 2 -int performEvictions(void); -void startEvictionTimeProc(void); - -/* Keys hashing / comparison functions for dict.c hash tables. */ -uint64_t dictSdsHash(const void *key); -uint64_t dictPtrHash(const void *key); -uint64_t dictSdsCaseHash(const void *key); -size_t dictSdsKeyLen(dict *d, const void *key); -int dictSdsKeyCompare(dictCmpCache *cache, const void *key1, const void *key2); -int dictSdsKeyCaseCompare(dictCmpCache *cache, const void *key1, const void *key2); -void dictSdsDestructor(dict *d, void *val); -void dictListDestructor(dict *d, void *val); -void *dictSdsDup(dict *d, const void *key); - -/* Git SHA1 */ -char *redisGitSHA1(void); -char *redisGitDirty(void); -uint64_t redisBuildId(void); -const char *redisBuildIdRaw(void); -char *redisBuildIdString(void); - -/* XXH3 hash of a string as hex string */ -sds stringDigest(robj *o); -int validateHexDigest(client *c, const sds digest); - -/* Hotkey tracking */ -hotkeyStats *hotkeyStatsCreate(int count, int duration, int sample_ratio, - int *slots, int slots_count, uint64_t tracked_metrics); -void hotkeyStatsRelease(hotkeyStats *hotkeys); -void hotkeyStatsPreCurrentCmd(hotkeyStats *hotkeys, client *c); -void hotkeyStatsUpdateCurrentCmd(hotkeyStats *hotkeys, hotkeyMetrics metrics); -void hotkeyStatsPostCurrentCmd(hotkeyStats *hotkeys); -size_t hotkeysGetMemoryUsage(hotkeyStats *hotkeys); - -/* Commands prototypes */ -void authCommand(client *c); -void pingCommand(client *c); -void echoCommand(client *c); -void commandCommand(client *c); -void commandCountCommand(client *c); -void commandListCommand(client *c); -void commandInfoCommand(client *c); -void commandGetKeysCommand(client *c); -void commandGetKeysAndFlagsCommand(client *c); -void commandHelpCommand(client *c); -void commandDocsCommand(client *c); -void setCommand(client *c); -void setnxCommand(client *c); -void setexCommand(client *c); -void psetexCommand(client *c); -void getCommand(client *c); -void getexCommand(client *c); -void getdelCommand(client *c); -void delCommand(client *c); -void delexCommand(client *c); -void unlinkCommand(client *c); -void existsCommand(client *c); -void setbitCommand(client *c); -void getbitCommand(client *c); -void bitfieldCommand(client *c); -void bitfieldroCommand(client *c); -void setrangeCommand(client *c); -void getrangeCommand(client *c); -void incrCommand(client *c); -void decrCommand(client *c); -void incrbyCommand(client *c); -void decrbyCommand(client *c); -void incrbyfloatCommand(client *c); -void selectCommand(client *c); -void swapdbCommand(client *c); -void randomkeyCommand(client *c); -void keysCommand(client *c); -void scanCommand(client *c); -void dbsizeCommand(client *c); -void lastsaveCommand(client *c); -void saveCommand(client *c); -void bgsaveCommand(client *c); -void bgrewriteaofCommand(client *c); -void shutdownCommand(client *c); -void slowlogCommand(client *c); -void moveCommand(client *c); -void copyCommand(client *c); -void renameCommand(client *c); -void renamenxCommand(client *c); -void lpushCommand(client *c); -void rpushCommand(client *c); -void lpushxCommand(client *c); -void rpushxCommand(client *c); -void linsertCommand(client *c); -void lpopCommand(client *c); -void rpopCommand(client *c); -void lmpopCommand(client *c); -void llenCommand(client *c); -void lindexCommand(client *c); -void lrangeCommand(client *c); -void ltrimCommand(client *c); -void typeCommand(client *c); -void lsetCommand(client *c); -void saddCommand(client *c); -void sremCommand(client *c); -void smoveCommand(client *c); -void sismemberCommand(client *c); -void smismemberCommand(client *c); -void scardCommand(client *c); -void spopCommand(client *c); -void srandmemberCommand(client *c); -void sinterCommand(client *c); -void smembersCommand(client *c); -void sinterCardCommand(client *c); -void sinterstoreCommand(client *c); -void sunionCommand(client *c); -void sunionstoreCommand(client *c); -void sdiffCommand(client *c); -void sdiffstoreCommand(client *c); -void sscanCommand(client *c); -void syncCommand(client *c); -void flushdbCommand(client *c); -void flushallCommand(client *c); -void trimslotsCommand(client *c); -void sortCommand(client *c); -void sortroCommand(client *c); -void lremCommand(client *c); -void lposCommand(client *c); -void rpoplpushCommand(client *c); -void lmoveCommand(client *c); -void infoCommand(client *c); -void mgetCommand(client *c); -void monitorCommand(client *c); -void expireCommand(client *c); -void expireatCommand(client *c); -void pexpireCommand(client *c); -void pexpireatCommand(client *c); -void getsetCommand(client *c); -void ttlCommand(client *c); -void touchCommand(client *c); -void pttlCommand(client *c); -void expiretimeCommand(client *c); -void pexpiretimeCommand(client *c); -void persistCommand(client *c); -void replicaofCommand(client *c); -void roleCommand(client *c); -void debugCommand(client *c); -void msetCommand(client *c); -void msetnxCommand(client *c); -void msetexCommand(client *c); -void zaddCommand(client *c); -void zincrbyCommand(client *c); -void zrangeCommand(client *c); -void zrangebyscoreCommand(client *c); -void zrevrangebyscoreCommand(client *c); -void zrangebylexCommand(client *c); -void zrevrangebylexCommand(client *c); -void zcountCommand(client *c); -void zlexcountCommand(client *c); -void zrevrangeCommand(client *c); -void zcardCommand(client *c); -void zremCommand(client *c); -void zscoreCommand(client *c); -void zmscoreCommand(client *c); -void zremrangebyscoreCommand(client *c); -void zremrangebylexCommand(client *c); -void zpopminCommand(client *c); -void zpopmaxCommand(client *c); -void zmpopCommand(client *c); -void bzpopminCommand(client *c); -void bzpopmaxCommand(client *c); -void bzmpopCommand(client *c); -void zrandmemberCommand(client *c); -void multiCommand(client *c); -void execCommand(client *c); -void discardCommand(client *c); -void blpopCommand(client *c); -void brpopCommand(client *c); -void blmpopCommand(client *c); -void brpoplpushCommand(client *c); -void blmoveCommand(client *c); -void appendCommand(client *c); -void strlenCommand(client *c); -void zrankCommand(client *c); -void zrevrankCommand(client *c); -void hsetCommand(client *c); -void hsetexCommand(client *c); -void hpexpireCommand(client *c); -void hexpireCommand(client *c); -void hpexpireatCommand(client *c); -void hexpireatCommand(client *c); -void httlCommand(client *c); -void hpttlCommand(client *c); -void hexpiretimeCommand(client *c); -void hpexpiretimeCommand(client *c); -void hpersistCommand(client *c); -void hsetnxCommand(client *c); -void hgetCommand(client *c); -void hmgetCommand(client *c); -void hgetexCommand(client *c); -void hgetdelCommand(client *c); -void hdelCommand(client *c); -void hlenCommand(client *c); -void hstrlenCommand(client *c); -void zremrangebyrankCommand(client *c); -void zunionstoreCommand(client *c); -void zinterstoreCommand(client *c); -void zdiffstoreCommand(client *c); -void zunionCommand(client *c); -void zinterCommand(client *c); -void zinterCardCommand(client *c); -void zrangestoreCommand(client *c); -void zdiffCommand(client *c); -void zscanCommand(client *c); -void hkeysCommand(client *c); -void hvalsCommand(client *c); -void hgetallCommand(client *c); -void hexistsCommand(client *c); -void hscanCommand(client *c); -void hrandfieldCommand(client *c); -void configSetCommand(client *c); -void configGetCommand(client *c); -void configResetStatCommand(client *c); -void configRewriteCommand(client *c); -void configHelpCommand(client *c); -int configExists(const sds name); -void hincrbyCommand(client *c); -void hincrbyfloatCommand(client *c); -void subscribeCommand(client *c); -void unsubscribeCommand(client *c); -void psubscribeCommand(client *c); -void punsubscribeCommand(client *c); -void publishCommand(client *c); -void pubsubCommand(client *c); -void spublishCommand(client *c); -void ssubscribeCommand(client *c); -void sunsubscribeCommand(client *c); -void watchCommand(client *c); -void unwatchCommand(client *c); -void clusterCommand(client *c); -void clusterSlotStatsCommand(client *c); -void restoreCommand(client *c); -void migrateCommand(client *c); -void askingCommand(client *c); -void readonlyCommand(client *c); -void readwriteCommand(client *c); -void sflushCommand(client *c); -int verifyDumpPayload(unsigned char *p, size_t len, uint16_t *rdbver_ptr); -void dumpCommand(client *c); -void clientCommand(client *c); -void helloCommand(client *c); -void clientSetinfoCommand(client *c); -void evalCommand(client *c); -void evalRoCommand(client *c); -void evalShaCommand(client *c); -void evalShaRoCommand(client *c); -void scriptCommand(client *c); -void fcallCommand(client *c); -void fcallroCommand(client *c); -void functionLoadCommand(client *c); -void functionDeleteCommand(client *c); -void functionKillCommand(client *c); -void functionStatsCommand(client *c); -void functionListCommand(client *c); -void functionHelpCommand(client *c); -void functionFlushCommand(client *c); -void functionRestoreCommand(client *c); -void functionDumpCommand(client *c); -void timeCommand(client *c); -void bitopCommand(client *c); -void bitcountCommand(client *c); -void bitposCommand(client *c); -void replconfCommand(client *c); -void waitCommand(client *c); -void waitaofCommand(client *c); -void georadiusbymemberCommand(client *c); -void georadiusbymemberroCommand(client *c); -void georadiusCommand(client *c); -void georadiusroCommand(client *c); -void geoaddCommand(client *c); -void geohashCommand(client *c); -void geoposCommand(client *c); -void geodistCommand(client *c); -void geosearchCommand(client *c); -void geosearchstoreCommand(client *c); -void pfselftestCommand(client *c); -void pfaddCommand(client *c); -void pfcountCommand(client *c); -void pfmergeCommand(client *c); -void pfdebugCommand(client *c); -void latencyCommand(client *c); -void moduleCommand(client *c); -void securityWarningCommand(client *c); -void xaddCommand(client *c); -void xrangeCommand(client *c); -void xrevrangeCommand(client *c); -void xlenCommand(client *c); -void xreadCommand(client *c); -void xgroupCommand(client *c); -void xsetidCommand(client *c); -void xackCommand(client *c); -void xackdelCommand(client *c); -void xpendingCommand(client *c); -void xclaimCommand(client *c); -void xautoclaimCommand(client *c); -void xinfoCommand(client *c); -void xcfgsetCommand(client *c); -void xdelCommand(client *c); -void xdelexCommand(client *c); -void xtrimCommand(client *c); -void lolwutCommand(client *c); -void aclCommand(client *c); -void hotkeysCommand(client *c); -void lcsCommand(client *c); -void quitCommand(client *c); -void resetCommand(client *c); -void failoverCommand(client *c); -void digestCommand(client *c); - -#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 - -/* Debugging stuff */ -void _serverAssertWithInfo(const client *c, const robj *o, const char *estr, const char *file, int line); -void _serverAssert(const char *estr, const char *file, int line); -#ifdef __GNUC__ -void _serverPanic(const char *file, int line, const char *msg, ...) - __attribute__ ((format (printf, 3, 4))); -#else -void _serverPanic(const char *file, int line, const char *msg, ...); -#endif -void serverLogObjectDebugInfo(const robj *o); -void setupDebugSigHandlers(void); -void setupSigSegvHandler(void); -void removeSigSegvHandlers(void); -const char *getSafeInfoString(const char *s, size_t len, char **tmp); -dict *genInfoSectionDict(robj **argv, int argc, char **defaults, int *out_all, int *out_everything); -void releaseInfoSectionDict(dict *sec); -sds genRedisInfoString(dict *section_dict, int all_sections, int everything); -sds genModulesInfoString(sds info); -void applyWatchdogPeriod(void); -void watchdogScheduleSignal(int period); -void serverLogHexDump(int level, char *descr, void *value, size_t len); -int memtest_preserving_test(unsigned long *m, size_t bytes, int passes); -void mixDigest(unsigned char *digest, const void *ptr, size_t len); -void xorDigest(unsigned char *digest, const void *ptr, size_t len); -sds catSubCommandFullname(const char *parent_name, const char *sub_name); -void commandAddSubcommand(struct redisCommand *parent, struct redisCommand *subcommand, const char *declared_name); -void debugDelay(int usec); -void killThreads(void); -void makeThreadKillable(void); -void swapMainDbWithTempDb(redisDb *tempDb); -sds getVersion(void); -void debugPauseProcess(void); - -/* Log redaction helpers: return "*redacted*" when hide-user-data-from-log is on. */ -static inline const char *redactLogCstr(const char *s) { - return server.hide_user_data_from_log ? "*redacted*" : (s ? s : "(null)"); -} - -/* Use macro for checking log level to avoid evaluating arguments in cases log - * should be ignored due to low level. */ -#define serverLog(level, ...) do {\ - if (((level)&0xff) < server.verbosity) break;\ - _serverLog(level, __VA_ARGS__);\ - } while(0) - -#define redisDebug(fmt, ...) \ - printf("DEBUG %s:%d > " fmt "\n", __FILE__, __LINE__, __VA_ARGS__) -#define redisDebugMark() \ - printf("-- MARK %s:%d --\n", __FILE__, __LINE__) - -int iAmMaster(void); - -#define STRINGIFY_(x) #x -#define STRINGIFY(x) STRINGIFY_(x) - -#endif |