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