aboutsummaryrefslogtreecommitdiff
path: root/examples/redis-unstable/src/rdb.h
diff options
context:
space:
mode:
Diffstat (limited to 'examples/redis-unstable/src/rdb.h')
-rw-r--r--examples/redis-unstable/src/rdb.h170
1 files changed, 170 insertions, 0 deletions
diff --git a/examples/redis-unstable/src/rdb.h b/examples/redis-unstable/src/rdb.h
new file mode 100644
index 0000000..a020ff6
--- /dev/null
+++ b/examples/redis-unstable/src/rdb.h
@@ -0,0 +1,170 @@
1/*
2 * Copyright (c) 2009-Present, Redis Ltd.
3 * All rights reserved.
4 *
5 * Licensed under your choice of (a) the Redis Source Available License 2.0
6 * (RSALv2); or (b) the Server Side Public License v1 (SSPLv1); or (c) the
7 * GNU Affero General Public License v3 (AGPLv3).
8 */
9
10#ifndef __RDB_H
11#define __RDB_H
12
13#include <stdio.h>
14#include "rio.h"
15
16/* TBD: include only necessary headers. */
17#include "server.h"
18
19/* The current RDB version. When the format changes in a way that is no longer
20 * backward compatible this number gets incremented. */
21#define RDB_VERSION 13
22
23/* Defines related to the dump file format. To store 32 bits lengths for short
24 * keys requires a lot of space, so we check the most significant 2 bits of
25 * the first byte to interpreter the length:
26 *
27 * 00|XXXXXX => if the two MSB are 00 the len is the 6 bits of this byte
28 * 01|XXXXXX XXXXXXXX => 01, the len is 14 bits, 6 bits + 8 bits of next byte
29 * 10|000000 [32 bit integer] => A full 32 bit len in net byte order will follow
30 * 10|000001 [64 bit integer] => A full 64 bit len in net byte order will follow
31 * 11|OBKIND this means: specially encoded object will follow. The six bits
32 * number specify the kind of object that follows.
33 * See the RDB_ENC_* defines.
34 *
35 * Lengths up to 63 are stored using a single byte, most DB keys, and may
36 * values, will fit inside. */
37#define RDB_6BITLEN 0
38#define RDB_14BITLEN 1
39#define RDB_32BITLEN 0x80
40#define RDB_64BITLEN 0x81
41#define RDB_ENCVAL 3
42#define RDB_LENERR UINT64_MAX
43
44/* When a length of a string object stored on disk has the first two bits
45 * set, the remaining six bits specify a special encoding for the object
46 * accordingly to the following defines: */
47#define RDB_ENC_INT8 0 /* 8 bit signed integer */
48#define RDB_ENC_INT16 1 /* 16 bit signed integer */
49#define RDB_ENC_INT32 2 /* 32 bit signed integer */
50#define RDB_ENC_LZF 3 /* string compressed with FASTLZ */
51
52/* Map object types to RDB object types. Macros starting with OBJ_ are for
53 * memory storage and may change. Instead RDB types must be fixed because
54 * we store them on disk. */
55#define RDB_TYPE_STRING 0
56#define RDB_TYPE_LIST 1
57#define RDB_TYPE_SET 2
58#define RDB_TYPE_ZSET 3
59#define RDB_TYPE_HASH 4
60#define RDB_TYPE_ZSET_2 5 /* ZSET version 2 with doubles stored in binary. */
61#define RDB_TYPE_MODULE_PRE_GA 6 /* Used in 4.0 release candidates */
62#define RDB_TYPE_MODULE_2 7 /* Module value with annotations for parsing without
63 the generating module being loaded. */
64#define RDB_TYPE_HASH_ZIPMAP 9
65#define RDB_TYPE_LIST_ZIPLIST 10
66#define RDB_TYPE_SET_INTSET 11
67#define RDB_TYPE_ZSET_ZIPLIST 12
68#define RDB_TYPE_HASH_ZIPLIST 13
69#define RDB_TYPE_LIST_QUICKLIST 14
70#define RDB_TYPE_STREAM_LISTPACKS 15
71#define RDB_TYPE_HASH_LISTPACK 16
72#define RDB_TYPE_ZSET_LISTPACK 17
73#define RDB_TYPE_LIST_QUICKLIST_2 18
74#define RDB_TYPE_STREAM_LISTPACKS_2 19
75#define RDB_TYPE_SET_LISTPACK 20
76#define RDB_TYPE_STREAM_LISTPACKS_3 21
77#define RDB_TYPE_HASH_METADATA_PRE_GA 22 /* Hash with HFEs. Doesn't attach min TTL at start (7.4 RC) */
78#define RDB_TYPE_HASH_LISTPACK_EX_PRE_GA 23 /* Hash LP with HFEs. Doesn't attach min TTL at start (7.4 RC) */
79#define RDB_TYPE_HASH_METADATA 24 /* Hash with HFEs. Attach min TTL at start */
80#define RDB_TYPE_HASH_LISTPACK_EX 25 /* Hash LP with HFEs. Attach min TTL at start */
81#define RDB_TYPE_STREAM_LISTPACKS_4 26 /* Stream with IDMP support */
82/* NOTE: WHEN ADDING NEW RDB TYPE, UPDATE rdbIsObjectType(), and rdb_type_string[] */
83
84/* Test if a type is an object type. */
85#define rdbIsObjectType(t) (((t) >= 0 && (t) <= 7) || ((t) >= 9 && (t) <= 26))
86
87/* Special RDB opcodes (saved/loaded with rdbSaveType/rdbLoadType). */
88#define RDB_OPCODE_KEY_META 243 /* Key metadata (module metadata classes). */
89#define RDB_OPCODE_SLOT_INFO 244 /* Individual slot info, such as slot id and size (cluster mode only). */
90#define RDB_OPCODE_FUNCTION2 245 /* function library data */
91#define RDB_OPCODE_FUNCTION_PRE_GA 246 /* old function library data for 7.0 rc1 and rc2 */
92#define RDB_OPCODE_MODULE_AUX 247 /* Module auxiliary data. */
93#define RDB_OPCODE_IDLE 248 /* LRU idle time. */
94#define RDB_OPCODE_FREQ 249 /* LFU frequency. */
95#define RDB_OPCODE_AUX 250 /* RDB aux field. */
96#define RDB_OPCODE_RESIZEDB 251 /* Hash table resize hint. */
97#define RDB_OPCODE_EXPIRETIME_MS 252 /* Expire time in milliseconds. */
98#define RDB_OPCODE_EXPIRETIME 253 /* Old expire time in seconds. */
99#define RDB_OPCODE_SELECTDB 254 /* DB number of the following keys. */
100#define RDB_OPCODE_EOF 255 /* End of the RDB file. */
101
102/* Module serialized values sub opcodes */
103#define RDB_MODULE_OPCODE_EOF 0 /* End of module value. */
104#define RDB_MODULE_OPCODE_SINT 1 /* Signed integer. */
105#define RDB_MODULE_OPCODE_UINT 2 /* Unsigned integer. */
106#define RDB_MODULE_OPCODE_FLOAT 3 /* Float. */
107#define RDB_MODULE_OPCODE_DOUBLE 4 /* Double. */
108#define RDB_MODULE_OPCODE_STRING 5 /* String. */
109
110/* rdbLoad...() functions flags. */
111#define RDB_LOAD_NONE 0
112#define RDB_LOAD_ENC (1<<0)
113#define RDB_LOAD_PLAIN (1<<1)
114#define RDB_LOAD_SDS (1<<2)
115
116/* flags on the purpose of rdb save or load */
117#define RDBFLAGS_NONE 0 /* No special RDB loading or saving. */
118#define RDBFLAGS_AOF_PREAMBLE (1<<0) /* Load/save the RDB as AOF preamble. */
119#define RDBFLAGS_REPLICATION (1<<1) /* Load/save for SYNC. */
120#define RDBFLAGS_ALLOW_DUP (1<<2) /* Allow duplicated keys when loading.*/
121#define RDBFLAGS_FEED_REPL (1<<3) /* Feed replication stream when loading.*/
122#define RDBFLAGS_KEEP_CACHE (1<<4) /* Don't reclaim cache after rdb file is generated */
123
124/* When rdbLoadObject() returns NULL, the err flag is
125 * set to hold the type of error that occurred */
126#define RDB_LOAD_ERR_EMPTY_KEY 1 /* Error of empty key */
127#define RDB_LOAD_ERR_OTHER 2 /* Any other errors */
128
129ssize_t rdbWriteRaw(rio *rdb, void *p, size_t len);
130int rdbSaveType(rio *rdb, unsigned char type);
131int rdbLoadType(rio *rdb);
132time_t rdbLoadTime(rio *rdb);
133int rdbSaveLen(rio *rdb, uint64_t len);
134ssize_t rdbSaveMillisecondTime(rio *rdb, long long t);
135long long rdbLoadMillisecondTime(rio *rdb, int rdbver);
136uint64_t rdbLoadLen(rio *rdb, int *isencoded);
137int rdbLoadLenByRef(rio *rdb, int *isencoded, uint64_t *lenptr);
138int rdbSaveObjectType(rio *rdb, robj *o);
139int rdbLoadObjectType(rio *rdb);
140int rdbLoadWithEmptyFunc(char *filename, rdbSaveInfo *rsi, int rdbflags, void (*emptyDbFunc)(void));
141int rdbLoad(char *filename, rdbSaveInfo *rsi, int rdbflags);
142int rdbSaveBackground(int req, char *filename, rdbSaveInfo *rsi, int rdbflags);
143int rdbSaveToSlavesSockets(int req, rdbSaveInfo *rsi);
144void rdbRemoveTempFile(pid_t childpid, int from_signal);
145int rdbSaveToFile(const char *filename);
146int rdbSave(int req, char *filename, rdbSaveInfo *rsi, int rdbflags);
147ssize_t rdbSaveObject(rio *rdb, robj *o, robj *key, int dbid);
148size_t rdbSavedObjectLen(robj *o, robj *key, int dbid);
149robj *rdbLoadObject(int rdbtype, rio *rdb, sds key, int dbid, int *error);
150void backgroundSaveDoneHandler(int exitcode, int bysignal);
151int rdbSaveKeyValuePair(rio *rdb, robj *key, robj *val, long long expiretime,int dbid);
152ssize_t rdbSaveSingleModuleAux(rio *rdb, int when, moduleType *mt);
153robj *rdbLoadCheckModuleValue(rio *rdb, char *modulename);
154int rdbResolveKeyType(rio *rdb, int *type, int dbid, KeyMetaSpec *keymeta);
155robj *rdbLoadStringObject(rio *rdb);
156ssize_t rdbSaveStringObject(rio *rdb, robj *obj);
157ssize_t rdbSaveRawString(rio *rdb, unsigned char *s, size_t len);
158void *rdbGenericLoadStringObject(rio *rdb, int flags, size_t *lenptr);
159int rdbSaveBinaryDoubleValue(rio *rdb, double val);
160int rdbLoadBinaryDoubleValue(rio *rdb, double *val);
161int rdbSaveBinaryFloatValue(rio *rdb, float val);
162int rdbLoadBinaryFloatValue(rio *rdb, float *val);
163int rdbLoadRio(rio *rdb, int rdbflags, rdbSaveInfo *rsi);
164int rdbLoadRioWithLoadingCtx(rio *rdb, int rdbflags, rdbSaveInfo *rsi, rdbLoadingCtx *rdb_loading_ctx);
165int rdbFunctionLoad(rio *rdb, int ver, functionsLibCtx* lib_ctx, int rdbflags, sds *err);
166int rdbSaveRio(int req, rio *rdb, int *error, int rdbflags, rdbSaveInfo *rsi);
167ssize_t rdbSaveFunctions(rio *rdb);
168rdbSaveInfo *rdbPopulateSaveInfo(rdbSaveInfo *rsi);
169
170#endif