]> git.saurik.com Git - redis.git/blame - src/rdb.c
Move rdbLoad* to top; update comments
[redis.git] / src / rdb.c
CommitLineData
e2641e09 1#include <math.h>
3688d7f3 2#include <sys/types.h>
3#include <sys/time.h>
4#include <sys/resource.h>
5#include <sys/wait.h>
6#include <arpa/inet.h>
97e7f8ae 7#include <sys/stat.h>
2e4b0e77
PN
8#include "rdb.h"
9#include "lzf.h" /* LZF compression library */
e2641e09 10
2e4b0e77
PN
11static int rdbWriteRaw(rio *rdb, void *p, size_t len) {
12 if (rioWrite(rdb,p,len) == 0)
13 return -1;
14 return 1;
9a68cf91
PN
15}
16
2e4b0e77
PN
17int rdbSaveType(rio *rdb, unsigned char type) {
18 return rdbWriteRaw(rdb,&type,1);
e2641e09 19}
20
221782cc
PN
21int rdbLoadType(rio *rdb) {
22 unsigned char type;
23 if (rioRead(rdb,&type,1) == 0) return -1;
24 return type;
25}
26
2e4b0e77 27int rdbSaveTime(rio *rdb, time_t t) {
e2641e09 28 int32_t t32 = (int32_t) t;
2e4b0e77 29 return rdbWriteRaw(rdb,&t32,4);
e2641e09 30}
31
221782cc
PN
32time_t rdbLoadTime(rio *rdb) {
33 int32_t t32;
34 if (rioRead(rdb,&t32,4) == 0) return -1;
35 return (time_t)t32;
36}
37
38/* Saves an encoded length. The first two bits in the first byte are used to
39 * hold the encoding type. See the REDIS_RDB_* definitions for more information
40 * on the types of encoding. */
2e4b0e77 41int rdbSaveLen(rio *rdb, uint32_t len) {
e2641e09 42 unsigned char buf[2];
2e4b0e77 43 size_t nwritten;
e2641e09 44
45 if (len < (1<<6)) {
46 /* Save a 6 bit len */
47 buf[0] = (len&0xFF)|(REDIS_RDB_6BITLEN<<6);
2e4b0e77 48 if (rdbWriteRaw(rdb,buf,1) == -1) return -1;
8a623a98 49 nwritten = 1;
e2641e09 50 } else if (len < (1<<14)) {
51 /* Save a 14 bit len */
52 buf[0] = ((len>>8)&0xFF)|(REDIS_RDB_14BITLEN<<6);
53 buf[1] = len&0xFF;
2e4b0e77 54 if (rdbWriteRaw(rdb,buf,2) == -1) return -1;
8a623a98 55 nwritten = 2;
e2641e09 56 } else {
57 /* Save a 32 bit len */
58 buf[0] = (REDIS_RDB_32BITLEN<<6);
2e4b0e77 59 if (rdbWriteRaw(rdb,buf,1) == -1) return -1;
e2641e09 60 len = htonl(len);
2e4b0e77 61 if (rdbWriteRaw(rdb,&len,4) == -4) return -1;
8a623a98 62 nwritten = 1+4;
e2641e09 63 }
8a623a98 64 return nwritten;
e2641e09 65}
66
221782cc
PN
67/* Load an encoded length. The "isencoded" argument is set to 1 if the length
68 * is not actually a length but an "encoding type". See the REDIS_RDB_ENC_*
69 * definitions in rdb.h for more information. */
70uint32_t rdbLoadLen(rio *rdb, int *isencoded) {
71 unsigned char buf[2];
72 uint32_t len;
73 int type;
74
75 if (isencoded) *isencoded = 0;
76 if (rioRead(rdb,buf,1) == 0) return REDIS_RDB_LENERR;
77 type = (buf[0]&0xC0)>>6;
78 if (type == REDIS_RDB_ENCVAL) {
79 /* Read a 6 bit encoding type. */
80 if (isencoded) *isencoded = 1;
81 return buf[0]&0x3F;
82 } else if (type == REDIS_RDB_6BITLEN) {
83 /* Read a 6 bit len. */
84 return buf[0]&0x3F;
85 } else if (type == REDIS_RDB_14BITLEN) {
86 /* Read a 14 bit len. */
87 if (rioRead(rdb,buf+1,1) == 0) return REDIS_RDB_LENERR;
88 return ((buf[0]&0x3F)<<8)|buf[1];
89 } else {
90 /* Read a 32 bit len. */
91 if (rioRead(rdb,&len,4) == 0) return REDIS_RDB_LENERR;
92 return ntohl(len);
93 }
94}
95
96/* Encodes the "value" argument as integer when it fits in the supported ranges
97 * for encoded types. If the function successfully encodes the integer, the
98 * representation is stored in the buffer pointer to by "enc" and the string
99 * length is returned. Otherwise 0 is returned. */
e2641e09 100int rdbEncodeInteger(long long value, unsigned char *enc) {
e2641e09 101 if (value >= -(1<<7) && value <= (1<<7)-1) {
102 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT8;
103 enc[1] = value&0xFF;
104 return 2;
105 } else if (value >= -(1<<15) && value <= (1<<15)-1) {
106 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT16;
107 enc[1] = value&0xFF;
108 enc[2] = (value>>8)&0xFF;
109 return 3;
110 } else if (value >= -((long long)1<<31) && value <= ((long long)1<<31)-1) {
111 enc[0] = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_INT32;
112 enc[1] = value&0xFF;
113 enc[2] = (value>>8)&0xFF;
114 enc[3] = (value>>16)&0xFF;
115 enc[4] = (value>>24)&0xFF;
116 return 5;
117 } else {
118 return 0;
119 }
120}
121
221782cc
PN
122/* Loads an integer-encoded object with the specified encoding type "enctype".
123 * If the "encode" argument is set the function may return an integer-encoded
124 * string object, otherwise it always returns a raw string object. */
125robj *rdbLoadIntegerObject(rio *rdb, int enctype, int encode) {
126 unsigned char enc[4];
127 long long val;
128
129 if (enctype == REDIS_RDB_ENC_INT8) {
130 if (rioRead(rdb,enc,1) == 0) return NULL;
131 val = (signed char)enc[0];
132 } else if (enctype == REDIS_RDB_ENC_INT16) {
133 uint16_t v;
134 if (rioRead(rdb,enc,2) == 0) return NULL;
135 v = enc[0]|(enc[1]<<8);
136 val = (int16_t)v;
137 } else if (enctype == REDIS_RDB_ENC_INT32) {
138 uint32_t v;
139 if (rioRead(rdb,enc,4) == 0) return NULL;
140 v = enc[0]|(enc[1]<<8)|(enc[2]<<16)|(enc[3]<<24);
141 val = (int32_t)v;
142 } else {
143 val = 0; /* anti-warning */
144 redisPanic("Unknown RDB integer encoding type");
145 }
146 if (encode)
147 return createStringObjectFromLongLong(val);
148 else
149 return createObject(REDIS_STRING,sdsfromlonglong(val));
150}
151
e2641e09 152/* String objects in the form "2391" "-100" without any space and with a
153 * range of values that can fit in an 8, 16 or 32 bit signed value can be
154 * encoded as integers to save space */
155int rdbTryIntegerEncoding(char *s, size_t len, unsigned char *enc) {
156 long long value;
157 char *endptr, buf[32];
158
159 /* Check if it's possible to encode this value as a number */
160 value = strtoll(s, &endptr, 10);
161 if (endptr[0] != '\0') return 0;
162 ll2string(buf,32,value);
163
164 /* If the number converted back into a string is not identical
165 * then it's not possible to encode the string as integer */
166 if (strlen(buf) != len || memcmp(buf,s,len)) return 0;
167
168 return rdbEncodeInteger(value,enc);
169}
170
2e4b0e77 171int rdbSaveLzfStringObject(rio *rdb, unsigned char *s, size_t len) {
e2641e09 172 size_t comprlen, outlen;
173 unsigned char byte;
8a623a98 174 int n, nwritten = 0;
e2641e09 175 void *out;
176
177 /* We require at least four bytes compression for this to be worth it */
178 if (len <= 4) return 0;
179 outlen = len-4;
180 if ((out = zmalloc(outlen+1)) == NULL) return 0;
181 comprlen = lzf_compress(s, len, out, outlen);
182 if (comprlen == 0) {
183 zfree(out);
184 return 0;
185 }
186 /* Data compressed! Let's save it on disk */
187 byte = (REDIS_RDB_ENCVAL<<6)|REDIS_RDB_ENC_LZF;
2e4b0e77 188 if ((n = rdbWriteRaw(rdb,&byte,1)) == -1) goto writeerr;
9a68cf91 189 nwritten += n;
8a623a98 190
2e4b0e77 191 if ((n = rdbSaveLen(rdb,comprlen)) == -1) goto writeerr;
8a623a98
PN
192 nwritten += n;
193
2e4b0e77 194 if ((n = rdbSaveLen(rdb,len)) == -1) goto writeerr;
8a623a98
PN
195 nwritten += n;
196
2e4b0e77 197 if ((n = rdbWriteRaw(rdb,out,comprlen)) == -1) goto writeerr;
9a68cf91 198 nwritten += n;
8a623a98 199
e2641e09 200 zfree(out);
8a623a98 201 return nwritten;
e2641e09 202
203writeerr:
204 zfree(out);
205 return -1;
206}
207
221782cc
PN
208robj *rdbLoadLzfStringObject(rio *rdb) {
209 unsigned int len, clen;
210 unsigned char *c = NULL;
211 sds val = NULL;
212
213 if ((clen = rdbLoadLen(rdb,NULL)) == REDIS_RDB_LENERR) return NULL;
214 if ((len = rdbLoadLen(rdb,NULL)) == REDIS_RDB_LENERR) return NULL;
215 if ((c = zmalloc(clen)) == NULL) goto err;
216 if ((val = sdsnewlen(NULL,len)) == NULL) goto err;
217 if (rioRead(rdb,c,clen) == 0) goto err;
218 if (lzf_decompress(c,clen,val,len) == 0) goto err;
219 zfree(c);
220 return createObject(REDIS_STRING,val);
221err:
222 zfree(c);
223 sdsfree(val);
224 return NULL;
225}
226
e2641e09 227/* Save a string objet as [len][data] on disk. If the object is a string
2cc99365 228 * representation of an integer value we try to save it in a special form */
2e4b0e77 229int rdbSaveRawString(rio *rdb, unsigned char *s, size_t len) {
e2641e09 230 int enclen;
8a623a98 231 int n, nwritten = 0;
e2641e09 232
233 /* Try integer encoding */
234 if (len <= 11) {
235 unsigned char buf[5];
236 if ((enclen = rdbTryIntegerEncoding((char*)s,len,buf)) > 0) {
2e4b0e77 237 if (rdbWriteRaw(rdb,buf,enclen) == -1) return -1;
8a623a98 238 return enclen;
e2641e09 239 }
240 }
241
242 /* Try LZF compression - under 20 bytes it's unable to compress even
243 * aaaaaaaaaaaaaaaaaa so skip it */
244 if (server.rdbcompression && len > 20) {
2e4b0e77 245 n = rdbSaveLzfStringObject(rdb,s,len);
8a623a98
PN
246 if (n == -1) return -1;
247 if (n > 0) return n;
248 /* Return value of 0 means data can't be compressed, save the old way */
e2641e09 249 }
250
251 /* Store verbatim */
2e4b0e77 252 if ((n = rdbSaveLen(rdb,len)) == -1) return -1;
8a623a98
PN
253 nwritten += n;
254 if (len > 0) {
2e4b0e77 255 if (rdbWriteRaw(rdb,s,len) == -1) return -1;
8a623a98
PN
256 nwritten += len;
257 }
258 return nwritten;
e2641e09 259}
260
261/* Save a long long value as either an encoded string or a string. */
2e4b0e77 262int rdbSaveLongLongAsStringObject(rio *rdb, long long value) {
e2641e09 263 unsigned char buf[32];
8a623a98 264 int n, nwritten = 0;
e2641e09 265 int enclen = rdbEncodeInteger(value,buf);
266 if (enclen > 0) {
2e4b0e77 267 return rdbWriteRaw(rdb,buf,enclen);
e2641e09 268 } else {
269 /* Encode as string */
270 enclen = ll2string((char*)buf,32,value);
271 redisAssert(enclen < 32);
2e4b0e77 272 if ((n = rdbSaveLen(rdb,enclen)) == -1) return -1;
8a623a98 273 nwritten += n;
2e4b0e77 274 if ((n = rdbWriteRaw(rdb,buf,enclen)) == -1) return -1;
9a68cf91 275 nwritten += n;
e2641e09 276 }
8a623a98 277 return nwritten;
e2641e09 278}
279
280/* Like rdbSaveStringObjectRaw() but handle encoded objects */
2e4b0e77 281int rdbSaveStringObject(rio *rdb, robj *obj) {
e2641e09 282 /* Avoid to decode the object, then encode it again, if the
283 * object is alrady integer encoded. */
284 if (obj->encoding == REDIS_ENCODING_INT) {
2e4b0e77 285 return rdbSaveLongLongAsStringObject(rdb,(long)obj->ptr);
e2641e09 286 } else {
287 redisAssert(obj->encoding == REDIS_ENCODING_RAW);
2e4b0e77 288 return rdbSaveRawString(rdb,obj->ptr,sdslen(obj->ptr));
e2641e09 289 }
290}
291
221782cc
PN
292robj *rdbGenericLoadStringObject(rio *rdb, int encode) {
293 int isencoded;
294 uint32_t len;
295 sds val;
296
297 len = rdbLoadLen(rdb,&isencoded);
298 if (isencoded) {
299 switch(len) {
300 case REDIS_RDB_ENC_INT8:
301 case REDIS_RDB_ENC_INT16:
302 case REDIS_RDB_ENC_INT32:
303 return rdbLoadIntegerObject(rdb,len,encode);
304 case REDIS_RDB_ENC_LZF:
305 return rdbLoadLzfStringObject(rdb);
306 default:
307 redisPanic("Unknown RDB encoding type");
308 }
309 }
310
311 if (len == REDIS_RDB_LENERR) return NULL;
312 val = sdsnewlen(NULL,len);
313 if (len && rioRead(rdb,val,len) == 0) {
314 sdsfree(val);
315 return NULL;
316 }
317 return createObject(REDIS_STRING,val);
318}
319
320robj *rdbLoadStringObject(rio *rdb) {
321 return rdbGenericLoadStringObject(rdb,0);
322}
323
324robj *rdbLoadEncodedStringObject(rio *rdb) {
325 return rdbGenericLoadStringObject(rdb,1);
326}
327
e2641e09 328/* Save a double value. Doubles are saved as strings prefixed by an unsigned
329 * 8 bit integer specifing the length of the representation.
330 * This 8 bit integer has special values in order to specify the following
331 * conditions:
332 * 253: not a number
333 * 254: + inf
334 * 255: - inf
335 */
2e4b0e77 336int rdbSaveDoubleValue(rio *rdb, double val) {
e2641e09 337 unsigned char buf[128];
338 int len;
339
340 if (isnan(val)) {
341 buf[0] = 253;
342 len = 1;
343 } else if (!isfinite(val)) {
344 len = 1;
345 buf[0] = (val < 0) ? 255 : 254;
346 } else {
347#if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
348 /* Check if the float is in a safe range to be casted into a
349 * long long. We are assuming that long long is 64 bit here.
350 * Also we are assuming that there are no implementations around where
351 * double has precision < 52 bit.
352 *
353 * Under this assumptions we test if a double is inside an interval
354 * where casting to long long is safe. Then using two castings we
355 * make sure the decimal part is zero. If all this is true we use
356 * integer printing function that is much faster. */
357 double min = -4503599627370495; /* (2^52)-1 */
358 double max = 4503599627370496; /* -(2^52) */
359 if (val > min && val < max && val == ((double)((long long)val)))
360 ll2string((char*)buf+1,sizeof(buf),(long long)val);
361 else
362#endif
363 snprintf((char*)buf+1,sizeof(buf)-1,"%.17g",val);
364 buf[0] = strlen((char*)buf+1);
365 len = buf[0]+1;
366 }
2e4b0e77 367 return rdbWriteRaw(rdb,buf,len);
e2641e09 368}
369
221782cc
PN
370/* For information about double serialization check rdbSaveDoubleValue() */
371int rdbLoadDoubleValue(rio *rdb, double *val) {
372 char buf[128];
373 unsigned char len;
374
375 if (rioRead(rdb,&len,1) == 0) return -1;
376 switch(len) {
377 case 255: *val = R_NegInf; return 0;
378 case 254: *val = R_PosInf; return 0;
379 case 253: *val = R_Nan; return 0;
380 default:
381 if (rioRead(rdb,buf,len) == 0) return -1;
382 buf[len] = '\0';
383 sscanf(buf, "%lg", val);
384 return 0;
385 }
386}
387
388/* Save the object type of object "o". */
389int rdbSaveObjectType(rio *rdb, robj *o) {
390 switch (o->type) {
391 case REDIS_STRING:
392 return rdbSaveType(rdb,REDIS_RDB_TYPE_STRING);
393 case REDIS_LIST:
394 if (o->encoding == REDIS_ENCODING_ZIPLIST)
395 return rdbSaveType(rdb,REDIS_RDB_TYPE_LIST_ZIPLIST);
396 else if (o->encoding == REDIS_ENCODING_LINKEDLIST)
397 return rdbSaveType(rdb,REDIS_RDB_TYPE_LIST);
398 else
399 redisPanic("Unknown list encoding");
400 case REDIS_SET:
401 if (o->encoding == REDIS_ENCODING_INTSET)
402 return rdbSaveType(rdb,REDIS_RDB_TYPE_SET_INTSET);
403 else if (o->encoding == REDIS_ENCODING_HT)
404 return rdbSaveType(rdb,REDIS_RDB_TYPE_SET);
405 else
406 redisPanic("Unknown set encoding");
407 case REDIS_ZSET:
408 if (o->encoding == REDIS_ENCODING_ZIPLIST)
409 return rdbSaveType(rdb,REDIS_RDB_TYPE_ZSET_ZIPLIST);
410 else if (o->encoding == REDIS_ENCODING_SKIPLIST)
411 return rdbSaveType(rdb,REDIS_RDB_TYPE_ZSET);
412 else
413 redisPanic("Unknown sorted set encoding");
414 case REDIS_HASH:
415 if (o->encoding == REDIS_ENCODING_ZIPMAP)
416 return rdbSaveType(rdb,REDIS_RDB_TYPE_HASH_ZIPMAP);
417 else if (o->encoding == REDIS_ENCODING_HT)
418 return rdbSaveType(rdb,REDIS_RDB_TYPE_HASH);
419 else
420 redisPanic("Unknown hash encoding");
421 default:
422 redisPanic("Unknown object type");
423 }
424 return -1; /* avoid warning */
425}
426
427/* Load object type. Return -1 when the byte doesn't contain an object type. */
428int rdbLoadObjectType(rio *rdb) {
429 int type;
430 if ((type = rdbLoadType(rdb)) == -1) return -1;
431 if (!rdbIsObjectType(type)) return -1;
432 return type;
433}
434
ecc91094 435/* Save a Redis object. Returns -1 on error, 0 on success. */
2e4b0e77 436int rdbSaveObject(rio *rdb, robj *o) {
8a623a98
PN
437 int n, nwritten = 0;
438
e2641e09 439 if (o->type == REDIS_STRING) {
440 /* Save a string value */
2e4b0e77 441 if ((n = rdbSaveStringObject(rdb,o)) == -1) return -1;
8a623a98 442 nwritten += n;
e2641e09 443 } else if (o->type == REDIS_LIST) {
444 /* Save a list value */
445 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
26117e84 446 size_t l = ziplistBlobLen((unsigned char*)o->ptr);
e2641e09 447
2e4b0e77 448 if ((n = rdbSaveRawString(rdb,o->ptr,l)) == -1) return -1;
8a623a98 449 nwritten += n;
e2641e09 450 } else if (o->encoding == REDIS_ENCODING_LINKEDLIST) {
451 list *list = o->ptr;
452 listIter li;
453 listNode *ln;
454
2e4b0e77 455 if ((n = rdbSaveLen(rdb,listLength(list))) == -1) return -1;
8a623a98
PN
456 nwritten += n;
457
e2641e09 458 listRewind(list,&li);
459 while((ln = listNext(&li))) {
460 robj *eleobj = listNodeValue(ln);
2e4b0e77 461 if ((n = rdbSaveStringObject(rdb,eleobj)) == -1) return -1;
8a623a98 462 nwritten += n;
e2641e09 463 }
464 } else {
465 redisPanic("Unknown list encoding");
466 }
467 } else if (o->type == REDIS_SET) {
468 /* Save a set value */
96ffb2fe
PN
469 if (o->encoding == REDIS_ENCODING_HT) {
470 dict *set = o->ptr;
471 dictIterator *di = dictGetIterator(set);
472 dictEntry *de;
e2641e09 473
2e4b0e77 474 if ((n = rdbSaveLen(rdb,dictSize(set))) == -1) return -1;
8a623a98
PN
475 nwritten += n;
476
96ffb2fe
PN
477 while((de = dictNext(di)) != NULL) {
478 robj *eleobj = dictGetEntryKey(de);
2e4b0e77 479 if ((n = rdbSaveStringObject(rdb,eleobj)) == -1) return -1;
8a623a98 480 nwritten += n;
96ffb2fe
PN
481 }
482 dictReleaseIterator(di);
483 } else if (o->encoding == REDIS_ENCODING_INTSET) {
26117e84 484 size_t l = intsetBlobLen((intset*)o->ptr);
96ffb2fe 485
2e4b0e77 486 if ((n = rdbSaveRawString(rdb,o->ptr,l)) == -1) return -1;
8a623a98 487 nwritten += n;
96ffb2fe
PN
488 } else {
489 redisPanic("Unknown set encoding");
e2641e09 490 }
e2641e09 491 } else if (o->type == REDIS_ZSET) {
e12b27ac
PN
492 /* Save a sorted set value */
493 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
494 size_t l = ziplistBlobLen((unsigned char*)o->ptr);
e2641e09 495
2e4b0e77 496 if ((n = rdbSaveRawString(rdb,o->ptr,l)) == -1) return -1;
8a623a98 497 nwritten += n;
100ed062 498 } else if (o->encoding == REDIS_ENCODING_SKIPLIST) {
e12b27ac
PN
499 zset *zs = o->ptr;
500 dictIterator *di = dictGetIterator(zs->dict);
501 dictEntry *de;
502
2e4b0e77 503 if ((n = rdbSaveLen(rdb,dictSize(zs->dict))) == -1) return -1;
8a623a98 504 nwritten += n;
e12b27ac
PN
505
506 while((de = dictNext(di)) != NULL) {
507 robj *eleobj = dictGetEntryKey(de);
508 double *score = dictGetEntryVal(de);
509
2e4b0e77 510 if ((n = rdbSaveStringObject(rdb,eleobj)) == -1) return -1;
e12b27ac 511 nwritten += n;
2e4b0e77 512 if ((n = rdbSaveDoubleValue(rdb,*score)) == -1) return -1;
e12b27ac
PN
513 nwritten += n;
514 }
515 dictReleaseIterator(di);
516 } else {
4cc4d164 517 redisPanic("Unknown sorted set encoding");
e2641e09 518 }
e2641e09 519 } else if (o->type == REDIS_HASH) {
520 /* Save a hash value */
521 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
2cc99365 522 size_t l = zipmapBlobLen((unsigned char*)o->ptr);
e2641e09 523
2e4b0e77 524 if ((n = rdbSaveRawString(rdb,o->ptr,l)) == -1) return -1;
8a623a98 525 nwritten += n;
e2641e09 526 } else {
527 dictIterator *di = dictGetIterator(o->ptr);
528 dictEntry *de;
529
2e4b0e77 530 if ((n = rdbSaveLen(rdb,dictSize((dict*)o->ptr))) == -1) return -1;
8a623a98
PN
531 nwritten += n;
532
e2641e09 533 while((de = dictNext(di)) != NULL) {
534 robj *key = dictGetEntryKey(de);
535 robj *val = dictGetEntryVal(de);
536
2e4b0e77 537 if ((n = rdbSaveStringObject(rdb,key)) == -1) return -1;
8a623a98 538 nwritten += n;
2e4b0e77 539 if ((n = rdbSaveStringObject(rdb,val)) == -1) return -1;
8a623a98 540 nwritten += n;
e2641e09 541 }
542 dictReleaseIterator(di);
543 }
544 } else {
545 redisPanic("Unknown object type");
546 }
8a623a98 547 return nwritten;
e2641e09 548}
549
550/* Return the length the object will have on disk if saved with
551 * the rdbSaveObject() function. Currently we use a trick to get
552 * this length with very little changes to the code. In the future
553 * we could switch to a faster solution. */
bd70a5f5
PN
554off_t rdbSavedObjectLen(robj *o) {
555 int len = rdbSaveObject(NULL,o);
556 redisAssert(len != -1);
557 return len;
e2641e09 558}
559
4ab98823 560/* Save a key-value pair, with expire time, type, key, value.
561 * On error -1 is returned.
562 * On success if the key was actaully saved 1 is returned, otherwise 0
563 * is returned (the key was already expired). */
2e4b0e77 564int rdbSaveKeyValuePair(rio *rdb, robj *key, robj *val,
05600eb8 565 time_t expiretime, time_t now)
4ab98823 566{
4ab98823 567 /* Save the expire time */
568 if (expiretime != -1) {
569 /* If this key is already expired skip it */
570 if (expiretime < now) return 0;
f1d8e496 571 if (rdbSaveType(rdb,REDIS_RDB_OPCODE_EXPIRETIME) == -1) return -1;
2e4b0e77 572 if (rdbSaveTime(rdb,expiretime) == -1) return -1;
4ab98823 573 }
f1d8e496 574
4ab98823 575 /* Save type, key, value */
f1d8e496 576 if (rdbSaveObjectType(rdb,val) == -1) return -1;
2e4b0e77
PN
577 if (rdbSaveStringObject(rdb,key) == -1) return -1;
578 if (rdbSaveObject(rdb,val) == -1) return -1;
4ab98823 579 return 1;
580}
581
e2641e09 582/* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
583int rdbSave(char *filename) {
584 dictIterator *di = NULL;
585 dictEntry *de;
e2641e09 586 char tmpfile[256];
587 int j;
588 time_t now = time(NULL);
2e4b0e77
PN
589 FILE *fp;
590 rio rdb;
e2641e09 591
249ad25f 592 if (server.ds_enabled) {
593 cacheForcePointInTime();
594 return dsRdbSave(filename);
595 }
e2641e09 596
597 snprintf(tmpfile,256,"temp-%d.rdb", (int) getpid());
598 fp = fopen(tmpfile,"w");
599 if (!fp) {
5b8ce853 600 redisLog(REDIS_WARNING, "Failed opening .rdb for saving: %s",
601 strerror(errno));
e2641e09 602 return REDIS_ERR;
603 }
2e4b0e77
PN
604
605 rdb = rioInitWithFile(fp);
606 if (rdbWriteRaw(&rdb,"REDIS0002",9) == -1) goto werr;
607
e2641e09 608 for (j = 0; j < server.dbnum; j++) {
609 redisDb *db = server.db+j;
610 dict *d = db->dict;
611 if (dictSize(d) == 0) continue;
612 di = dictGetIterator(d);
613 if (!di) {
614 fclose(fp);
615 return REDIS_ERR;
616 }
617
618 /* Write the SELECT DB opcode */
f1d8e496 619 if (rdbSaveType(&rdb,REDIS_RDB_OPCODE_SELECTDB) == -1) goto werr;
2e4b0e77 620 if (rdbSaveLen(&rdb,j) == -1) goto werr;
e2641e09 621
622 /* Iterate this DB writing every entry */
623 while((de = dictNext(di)) != NULL) {
624 sds keystr = dictGetEntryKey(de);
625 robj key, *o = dictGetEntryVal(de);
05600eb8 626 time_t expire;
e2641e09 627
628 initStaticStringObject(key,keystr);
05600eb8 629 expire = getExpire(db,&key);
2e4b0e77 630 if (rdbSaveKeyValuePair(&rdb,&key,o,expire,now) == -1) goto werr;
e2641e09 631 }
632 dictReleaseIterator(di);
633 }
634 /* EOF opcode */
f1d8e496 635 if (rdbSaveType(&rdb,REDIS_RDB_OPCODE_EOF) == -1) goto werr;
e2641e09 636
637 /* Make sure data will not remain on the OS's output buffers */
638 fflush(fp);
639 fsync(fileno(fp));
640 fclose(fp);
641
642 /* Use RENAME to make sure the DB file is changed atomically only
643 * if the generate DB file is ok. */
644 if (rename(tmpfile,filename) == -1) {
645 redisLog(REDIS_WARNING,"Error moving temp DB file on the final destination: %s", strerror(errno));
646 unlink(tmpfile);
647 return REDIS_ERR;
648 }
649 redisLog(REDIS_NOTICE,"DB saved on disk");
650 server.dirty = 0;
651 server.lastsave = time(NULL);
652 return REDIS_OK;
653
654werr:
655 fclose(fp);
656 unlink(tmpfile);
657 redisLog(REDIS_WARNING,"Write error saving DB on disk: %s", strerror(errno));
658 if (di) dictReleaseIterator(di);
659 return REDIS_ERR;
660}
661
662int rdbSaveBackground(char *filename) {
663 pid_t childpid;
664
36c17a53 665 if (server.bgsavechildpid != -1 ||
666 server.bgsavethread != (pthread_t) -1) return REDIS_ERR;
249ad25f 667
2f6b31c3 668 server.dirty_before_bgsave = server.dirty;
249ad25f 669
36c17a53 670 if (server.ds_enabled) {
671 cacheForcePointInTime();
cc275067 672 return dsRdbSaveBackground(filename);
36c17a53 673 }
674
e2641e09 675 if ((childpid = fork()) == 0) {
249ad25f 676 int retval;
677
e2641e09 678 /* Child */
a5639e7d
PN
679 if (server.ipfd > 0) close(server.ipfd);
680 if (server.sofd > 0) close(server.sofd);
36c17a53 681 retval = rdbSave(filename);
249ad25f 682 _exit((retval == REDIS_OK) ? 0 : 1);
e2641e09 683 } else {
684 /* Parent */
685 if (childpid == -1) {
686 redisLog(REDIS_WARNING,"Can't save in background: fork: %s",
687 strerror(errno));
688 return REDIS_ERR;
689 }
690 redisLog(REDIS_NOTICE,"Background saving started by pid %d",childpid);
691 server.bgsavechildpid = childpid;
692 updateDictResizePolicy();
693 return REDIS_OK;
694 }
695 return REDIS_OK; /* unreached */
696}
697
698void rdbRemoveTempFile(pid_t childpid) {
699 char tmpfile[256];
700
701 snprintf(tmpfile,256,"temp-%d.rdb", (int) childpid);
702 unlink(tmpfile);
703}
704
e2641e09 705/* Load a Redis object of the specified type from the specified file.
706 * On success a newly allocated object is returned, otherwise NULL. */
f1d8e496 707robj *rdbLoadObject(int rdbtype, rio *rdb) {
e2641e09 708 robj *o, *ele, *dec;
709 size_t len;
96ffb2fe 710 unsigned int i;
e2641e09 711
f1d8e496
PN
712 redisLog(REDIS_DEBUG,"LOADING OBJECT %d (at %d)\n",rdbtype,rdb->tell(rdb));
713 if (rdbtype == REDIS_RDB_TYPE_STRING) {
e2641e09 714 /* Read string value */
2e4b0e77 715 if ((o = rdbLoadEncodedStringObject(rdb)) == NULL) return NULL;
e2641e09 716 o = tryObjectEncoding(o);
f1d8e496 717 } else if (rdbtype == REDIS_RDB_TYPE_LIST) {
e2641e09 718 /* Read list value */
2e4b0e77 719 if ((len = rdbLoadLen(rdb,NULL)) == REDIS_RDB_LENERR) return NULL;
e2641e09 720
721 /* Use a real list when there are too many entries */
722 if (len > server.list_max_ziplist_entries) {
723 o = createListObject();
724 } else {
725 o = createZiplistObject();
726 }
727
728 /* Load every single element of the list */
729 while(len--) {
2e4b0e77 730 if ((ele = rdbLoadEncodedStringObject(rdb)) == NULL) return NULL;
e2641e09 731
732 /* If we are using a ziplist and the value is too big, convert
733 * the object to a real list. */
734 if (o->encoding == REDIS_ENCODING_ZIPLIST &&
735 ele->encoding == REDIS_ENCODING_RAW &&
736 sdslen(ele->ptr) > server.list_max_ziplist_value)
737 listTypeConvert(o,REDIS_ENCODING_LINKEDLIST);
738
739 if (o->encoding == REDIS_ENCODING_ZIPLIST) {
740 dec = getDecodedObject(ele);
741 o->ptr = ziplistPush(o->ptr,dec->ptr,sdslen(dec->ptr),REDIS_TAIL);
742 decrRefCount(dec);
743 decrRefCount(ele);
744 } else {
745 ele = tryObjectEncoding(ele);
746 listAddNodeTail(o->ptr,ele);
747 }
748 }
f1d8e496 749 } else if (rdbtype == REDIS_RDB_TYPE_SET) {
e2641e09 750 /* Read list/set value */
2e4b0e77 751 if ((len = rdbLoadLen(rdb,NULL)) == REDIS_RDB_LENERR) return NULL;
96ffb2fe
PN
752
753 /* Use a regular set when there are too many entries. */
754 if (len > server.set_max_intset_entries) {
755 o = createSetObject();
756 /* It's faster to expand the dict to the right size asap in order
757 * to avoid rehashing */
758 if (len > DICT_HT_INITIAL_SIZE)
759 dictExpand(o->ptr,len);
760 } else {
761 o = createIntsetObject();
762 }
763
e2641e09 764 /* Load every single element of the list/set */
96ffb2fe
PN
765 for (i = 0; i < len; i++) {
766 long long llval;
2e4b0e77 767 if ((ele = rdbLoadEncodedStringObject(rdb)) == NULL) return NULL;
e2641e09 768 ele = tryObjectEncoding(ele);
96ffb2fe
PN
769
770 if (o->encoding == REDIS_ENCODING_INTSET) {
771 /* Fetch integer value from element */
2df84b72 772 if (isObjectRepresentableAsLongLong(ele,&llval) == REDIS_OK) {
96ffb2fe
PN
773 o->ptr = intsetAdd(o->ptr,llval,NULL);
774 } else {
775 setTypeConvert(o,REDIS_ENCODING_HT);
776 dictExpand(o->ptr,len);
777 }
778 }
779
780 /* This will also be called when the set was just converted
781 * to regular hashtable encoded set */
782 if (o->encoding == REDIS_ENCODING_HT) {
783 dictAdd((dict*)o->ptr,ele,NULL);
bad7d097 784 } else {
785 decrRefCount(ele);
96ffb2fe 786 }
e2641e09 787 }
f1d8e496 788 } else if (rdbtype == REDIS_RDB_TYPE_ZSET) {
e2641e09 789 /* Read list/set value */
790 size_t zsetlen;
df26a0ae 791 size_t maxelelen = 0;
e2641e09 792 zset *zs;
793
2e4b0e77 794 if ((zsetlen = rdbLoadLen(rdb,NULL)) == REDIS_RDB_LENERR) return NULL;
e2641e09 795 o = createZsetObject();
796 zs = o->ptr;
df26a0ae 797
e2641e09 798 /* Load every single element of the list/set */
799 while(zsetlen--) {
800 robj *ele;
56e52b69
PN
801 double score;
802 zskiplistNode *znode;
e2641e09 803
2e4b0e77 804 if ((ele = rdbLoadEncodedStringObject(rdb)) == NULL) return NULL;
e2641e09 805 ele = tryObjectEncoding(ele);
2e4b0e77 806 if (rdbLoadDoubleValue(rdb,&score) == -1) return NULL;
df26a0ae
PN
807
808 /* Don't care about integer-encoded strings. */
809 if (ele->encoding == REDIS_ENCODING_RAW &&
810 sdslen(ele->ptr) > maxelelen)
811 maxelelen = sdslen(ele->ptr);
812
56e52b69
PN
813 znode = zslInsert(zs->zsl,score,ele);
814 dictAdd(zs->dict,ele,&znode->score);
e2641e09 815 incrRefCount(ele); /* added to skiplist */
816 }
df26a0ae
PN
817
818 /* Convert *after* loading, since sorted sets are not stored ordered. */
819 if (zsetLength(o) <= server.zset_max_ziplist_entries &&
820 maxelelen <= server.zset_max_ziplist_value)
821 zsetConvert(o,REDIS_ENCODING_ZIPLIST);
f1d8e496 822 } else if (rdbtype == REDIS_RDB_TYPE_HASH) {
e2641e09 823 size_t hashlen;
824
2e4b0e77 825 if ((hashlen = rdbLoadLen(rdb,NULL)) == REDIS_RDB_LENERR) return NULL;
e2641e09 826 o = createHashObject();
827 /* Too many entries? Use an hash table. */
828 if (hashlen > server.hash_max_zipmap_entries)
829 convertToRealHash(o);
830 /* Load every key/value, then set it into the zipmap or hash
831 * table, as needed. */
832 while(hashlen--) {
833 robj *key, *val;
834
2e4b0e77
PN
835 if ((key = rdbLoadEncodedStringObject(rdb)) == NULL) return NULL;
836 if ((val = rdbLoadEncodedStringObject(rdb)) == NULL) return NULL;
e2641e09 837 /* If we are using a zipmap and there are too big values
838 * the object is converted to real hash table encoding. */
839 if (o->encoding != REDIS_ENCODING_HT &&
840 ((key->encoding == REDIS_ENCODING_RAW &&
841 sdslen(key->ptr) > server.hash_max_zipmap_value) ||
842 (val->encoding == REDIS_ENCODING_RAW &&
843 sdslen(val->ptr) > server.hash_max_zipmap_value)))
844 {
845 convertToRealHash(o);
846 }
847
848 if (o->encoding == REDIS_ENCODING_ZIPMAP) {
849 unsigned char *zm = o->ptr;
850 robj *deckey, *decval;
851
852 /* We need raw string objects to add them to the zipmap */
853 deckey = getDecodedObject(key);
854 decval = getDecodedObject(val);
855 zm = zipmapSet(zm,deckey->ptr,sdslen(deckey->ptr),
856 decval->ptr,sdslen(decval->ptr),NULL);
857 o->ptr = zm;
858 decrRefCount(deckey);
859 decrRefCount(decval);
860 decrRefCount(key);
861 decrRefCount(val);
862 } else {
863 key = tryObjectEncoding(key);
864 val = tryObjectEncoding(val);
865 dictAdd((dict*)o->ptr,key,val);
866 }
867 }
f1d8e496
PN
868 } else if (rdbtype == REDIS_RDB_TYPE_HASH_ZIPMAP ||
869 rdbtype == REDIS_RDB_TYPE_LIST_ZIPLIST ||
870 rdbtype == REDIS_RDB_TYPE_SET_INTSET ||
871 rdbtype == REDIS_RDB_TYPE_ZSET_ZIPLIST)
26117e84 872 {
2e4b0e77 873 robj *aux = rdbLoadStringObject(rdb);
2cc99365 874
875 if (aux == NULL) return NULL;
26117e84 876 o = createObject(REDIS_STRING,NULL); /* string is just placeholder */
2cc99365 877 o->ptr = zmalloc(sdslen(aux->ptr));
878 memcpy(o->ptr,aux->ptr,sdslen(aux->ptr));
879 decrRefCount(aux);
26117e84 880
881 /* Fix the object encoding, and make sure to convert the encoded
882 * data type into the base type if accordingly to the current
883 * configuration there are too many elements in the encoded data
884 * type. Note that we only check the length and not max element
885 * size as this is an O(N) scan. Eventually everything will get
886 * converted. */
f1d8e496
PN
887 switch(rdbtype) {
888 case REDIS_RDB_TYPE_HASH_ZIPMAP:
26117e84 889 o->type = REDIS_HASH;
890 o->encoding = REDIS_ENCODING_ZIPMAP;
891 if (zipmapLen(o->ptr) > server.hash_max_zipmap_entries)
892 convertToRealHash(o);
893 break;
f1d8e496 894 case REDIS_RDB_TYPE_LIST_ZIPLIST:
26117e84 895 o->type = REDIS_LIST;
896 o->encoding = REDIS_ENCODING_ZIPLIST;
897 if (ziplistLen(o->ptr) > server.list_max_ziplist_entries)
898 listTypeConvert(o,REDIS_ENCODING_LINKEDLIST);
899 break;
f1d8e496 900 case REDIS_RDB_TYPE_SET_INTSET:
26117e84 901 o->type = REDIS_SET;
902 o->encoding = REDIS_ENCODING_INTSET;
903 if (intsetLen(o->ptr) > server.set_max_intset_entries)
904 setTypeConvert(o,REDIS_ENCODING_HT);
905 break;
f1d8e496 906 case REDIS_RDB_TYPE_ZSET_ZIPLIST:
e12b27ac
PN
907 o->type = REDIS_ZSET;
908 o->encoding = REDIS_ENCODING_ZIPLIST;
df26a0ae 909 if (zsetLength(o) > server.zset_max_ziplist_entries)
d4d3a70d 910 zsetConvert(o,REDIS_ENCODING_SKIPLIST);
e12b27ac 911 break;
26117e84 912 default:
d4d3a70d 913 redisPanic("Unknown encoding");
26117e84 914 break;
f8956ed6 915 }
e2641e09 916 } else {
917 redisPanic("Unknown object type");
918 }
919 return o;
920}
921
97e7f8ae 922/* Mark that we are loading in the global state and setup the fields
923 * needed to provide loading stats. */
924void startLoading(FILE *fp) {
925 struct stat sb;
926
927 /* Load the DB */
928 server.loading = 1;
929 server.loading_start_time = time(NULL);
930 if (fstat(fileno(fp), &sb) == -1) {
931 server.loading_total_bytes = 1; /* just to avoid division by zero */
932 } else {
933 server.loading_total_bytes = sb.st_size;
934 }
935}
936
937/* Refresh the loading progress info */
938void loadingProgress(off_t pos) {
939 server.loading_loaded_bytes = pos;
940}
941
942/* Loading finished */
943void stopLoading(void) {
944 server.loading = 0;
945}
946
e2641e09 947int rdbLoad(char *filename) {
e2641e09 948 uint32_t dbid;
949 int type, retval, rdbver;
e2641e09 950 redisDb *db = server.db+0;
951 char buf[1024];
952 time_t expiretime, now = time(NULL);
97e7f8ae 953 long loops = 0;
2e4b0e77
PN
954 FILE *fp;
955 rio rdb;
e2641e09 956
957 fp = fopen(filename,"r");
958 if (!fp) return REDIS_ERR;
959 if (fread(buf,9,1,fp) == 0) goto eoferr;
960 buf[9] = '\0';
961 if (memcmp(buf,"REDIS",5) != 0) {
962 fclose(fp);
963 redisLog(REDIS_WARNING,"Wrong signature trying to load DB from file");
964 return REDIS_ERR;
965 }
966 rdbver = atoi(buf+5);
6b52ad87 967 if (rdbver < 1 || rdbver > 2) {
e2641e09 968 fclose(fp);
969 redisLog(REDIS_WARNING,"Can't handle RDB format version %d",rdbver);
970 return REDIS_ERR;
971 }
97e7f8ae 972
973 startLoading(fp);
2e4b0e77 974 rdb = rioInitWithFile(fp);
e2641e09 975 while(1) {
976 robj *key, *val;
e2641e09 977 expiretime = -1;
97e7f8ae 978
979 /* Serve the clients from time to time */
980 if (!(loops++ % 1000)) {
2e4b0e77 981 loadingProgress(rdb.tell(&rdb));
97e7f8ae 982 aeProcessEvents(server.el, AE_FILE_EVENTS|AE_DONT_WAIT);
983 }
984
e2641e09 985 /* Read type. */
2e4b0e77 986 if ((type = rdbLoadType(&rdb)) == -1) goto eoferr;
f1d8e496 987 if (type == REDIS_RDB_OPCODE_EXPIRETIME) {
2e4b0e77 988 if ((expiretime = rdbLoadTime(&rdb)) == -1) goto eoferr;
f1d8e496 989 /* We read the time so we need to read the object type again. */
2e4b0e77 990 if ((type = rdbLoadType(&rdb)) == -1) goto eoferr;
e2641e09 991 }
f1d8e496
PN
992
993 if (type == REDIS_RDB_OPCODE_EOF)
994 break;
995
e2641e09 996 /* Handle SELECT DB opcode as a special case */
f1d8e496 997 if (type == REDIS_RDB_OPCODE_SELECTDB) {
2e4b0e77 998 if ((dbid = rdbLoadLen(&rdb,NULL)) == REDIS_RDB_LENERR)
e2641e09 999 goto eoferr;
1000 if (dbid >= (unsigned)server.dbnum) {
1001 redisLog(REDIS_WARNING,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server.dbnum);
1002 exit(1);
1003 }
1004 db = server.db+dbid;
1005 continue;
1006 }
1007 /* Read key */
2e4b0e77 1008 if ((key = rdbLoadStringObject(&rdb)) == NULL) goto eoferr;
e2641e09 1009 /* Read value */
2e4b0e77 1010 if ((val = rdbLoadObject(type,&rdb)) == NULL) goto eoferr;
e2641e09 1011 /* Check if the key already expired */
1012 if (expiretime != -1 && expiretime < now) {
1013 decrRefCount(key);
1014 decrRefCount(val);
1015 continue;
1016 }
1017 /* Add the new object in the hash table */
1018 retval = dbAdd(db,key,val);
1019 if (retval == REDIS_ERR) {
1020 redisLog(REDIS_WARNING,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key->ptr);
1021 exit(1);
1022 }
1023 /* Set the expire time if needed */
1024 if (expiretime != -1) setExpire(db,key,expiretime);
1025
e2641e09 1026 decrRefCount(key);
e2641e09 1027 }
1028 fclose(fp);
97e7f8ae 1029 stopLoading();
e2641e09 1030 return REDIS_OK;
1031
1032eoferr: /* unexpected end of file is handled here with a fatal exit */
1033 redisLog(REDIS_WARNING,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
1034 exit(1);
1035 return REDIS_ERR; /* Just to avoid warning */
1036}
1037
1038/* A background saving child (BGSAVE) terminated its work. Handle this. */
36c17a53 1039void backgroundSaveDoneHandler(int exitcode, int bysignal) {
e2641e09 1040 if (!bysignal && exitcode == 0) {
1041 redisLog(REDIS_NOTICE,
1042 "Background saving terminated with success");
2f6b31c3 1043 server.dirty = server.dirty - server.dirty_before_bgsave;
e2641e09 1044 server.lastsave = time(NULL);
1045 } else if (!bysignal && exitcode != 0) {
1046 redisLog(REDIS_WARNING, "Background saving error");
1047 } else {
1048 redisLog(REDIS_WARNING,
36c17a53 1049 "Background saving terminated by signal %d", bysignal);
e2641e09 1050 rdbRemoveTempFile(server.bgsavechildpid);
1051 }
1052 server.bgsavechildpid = -1;
36c17a53 1053 server.bgsavethread = (pthread_t) -1;
1054 server.bgsavethread_state = REDIS_BGSAVE_THREAD_UNACTIVE;
e2641e09 1055 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1056 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1057 updateSlavesWaitingBgsave(exitcode == 0 ? REDIS_OK : REDIS_ERR);
1058}
36c17a53 1059
1060void saveCommand(redisClient *c) {
5b8ce853 1061 if (server.bgsavechildpid != -1 || server.bgsavethread != (pthread_t)-1) {
36c17a53 1062 addReplyError(c,"Background save already in progress");
1063 return;
1064 }
1065 if (rdbSave(server.dbfilename) == REDIS_OK) {
1066 addReply(c,shared.ok);
1067 } else {
1068 addReply(c,shared.err);
1069 }
1070}
1071
1072void bgsaveCommand(redisClient *c) {
5b8ce853 1073 if (server.bgsavechildpid != -1 || server.bgsavethread != (pthread_t)-1) {
36c17a53 1074 addReplyError(c,"Background save already in progress");
1075 return;
1076 }
1077 if (rdbSaveBackground(server.dbfilename) == REDIS_OK) {
1078 addReplyStatus(c,"Background saving started");
1079 } else {
1080 addReply(c,shared.err);
1081 }
1082}