2 #include "lzf.h" /* LZF compression library */
4 #include "endianconv.h"
9 #include <sys/resource.h>
11 #include <arpa/inet.h>
14 static int rdbWriteRaw(rio
*rdb
, void *p
, size_t len
) {
15 if (rdb
&& rioWrite(rdb
,p
,len
) == 0)
20 int rdbSaveType(rio
*rdb
, unsigned char type
) {
21 return rdbWriteRaw(rdb
,&type
,1);
24 /* Load a "type" in RDB format, that is a one byte unsigned integer.
25 * This function is not only used to load object types, but also special
26 * "types" like the end-of-file type, the EXPIRE type, and so forth. */
27 int rdbLoadType(rio
*rdb
) {
29 if (rioRead(rdb
,&type
,1) == 0) return -1;
33 time_t rdbLoadTime(rio
*rdb
) {
35 if (rioRead(rdb
,&t32
,4) == 0) return -1;
39 int rdbSaveMillisecondTime(rio
*rdb
, long long t
) {
40 int64_t t64
= (int64_t) t
;
41 return rdbWriteRaw(rdb
,&t64
,8);
44 long long rdbLoadMillisecondTime(rio
*rdb
) {
46 if (rioRead(rdb
,&t64
,8) == 0) return -1;
47 return (long long)t64
;
50 /* Saves an encoded length. The first two bits in the first byte are used to
51 * hold the encoding type. See the REDIS_RDB_* definitions for more information
52 * on the types of encoding. */
53 int rdbSaveLen(rio
*rdb
, uint32_t len
) {
58 /* Save a 6 bit len */
59 buf
[0] = (len
&0xFF)|(REDIS_RDB_6BITLEN
<<6);
60 if (rdbWriteRaw(rdb
,buf
,1) == -1) return -1;
62 } else if (len
< (1<<14)) {
63 /* Save a 14 bit len */
64 buf
[0] = ((len
>>8)&0xFF)|(REDIS_RDB_14BITLEN
<<6);
66 if (rdbWriteRaw(rdb
,buf
,2) == -1) return -1;
69 /* Save a 32 bit len */
70 buf
[0] = (REDIS_RDB_32BITLEN
<<6);
71 if (rdbWriteRaw(rdb
,buf
,1) == -1) return -1;
73 if (rdbWriteRaw(rdb
,&len
,4) == -4) return -1;
79 /* Load an encoded length. The "isencoded" argument is set to 1 if the length
80 * is not actually a length but an "encoding type". See the REDIS_RDB_ENC_*
81 * definitions in rdb.h for more information. */
82 uint32_t rdbLoadLen(rio
*rdb
, int *isencoded
) {
87 if (isencoded
) *isencoded
= 0;
88 if (rioRead(rdb
,buf
,1) == 0) return REDIS_RDB_LENERR
;
89 type
= (buf
[0]&0xC0)>>6;
90 if (type
== REDIS_RDB_ENCVAL
) {
91 /* Read a 6 bit encoding type. */
92 if (isencoded
) *isencoded
= 1;
94 } else if (type
== REDIS_RDB_6BITLEN
) {
95 /* Read a 6 bit len. */
97 } else if (type
== REDIS_RDB_14BITLEN
) {
98 /* Read a 14 bit len. */
99 if (rioRead(rdb
,buf
+1,1) == 0) return REDIS_RDB_LENERR
;
100 return ((buf
[0]&0x3F)<<8)|buf
[1];
102 /* Read a 32 bit len. */
103 if (rioRead(rdb
,&len
,4) == 0) return REDIS_RDB_LENERR
;
108 /* Encodes the "value" argument as integer when it fits in the supported ranges
109 * for encoded types. If the function successfully encodes the integer, the
110 * representation is stored in the buffer pointer to by "enc" and the string
111 * length is returned. Otherwise 0 is returned. */
112 int rdbEncodeInteger(long long value
, unsigned char *enc
) {
113 if (value
>= -(1<<7) && value
<= (1<<7)-1) {
114 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT8
;
117 } else if (value
>= -(1<<15) && value
<= (1<<15)-1) {
118 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT16
;
120 enc
[2] = (value
>>8)&0xFF;
122 } else if (value
>= -((long long)1<<31) && value
<= ((long long)1<<31)-1) {
123 enc
[0] = (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_INT32
;
125 enc
[2] = (value
>>8)&0xFF;
126 enc
[3] = (value
>>16)&0xFF;
127 enc
[4] = (value
>>24)&0xFF;
134 /* Loads an integer-encoded object with the specified encoding type "enctype".
135 * If the "encode" argument is set the function may return an integer-encoded
136 * string object, otherwise it always returns a raw string object. */
137 robj
*rdbLoadIntegerObject(rio
*rdb
, int enctype
, int encode
) {
138 unsigned char enc
[4];
141 if (enctype
== REDIS_RDB_ENC_INT8
) {
142 if (rioRead(rdb
,enc
,1) == 0) return NULL
;
143 val
= (signed char)enc
[0];
144 } else if (enctype
== REDIS_RDB_ENC_INT16
) {
146 if (rioRead(rdb
,enc
,2) == 0) return NULL
;
147 v
= enc
[0]|(enc
[1]<<8);
149 } else if (enctype
== REDIS_RDB_ENC_INT32
) {
151 if (rioRead(rdb
,enc
,4) == 0) return NULL
;
152 v
= enc
[0]|(enc
[1]<<8)|(enc
[2]<<16)|(enc
[3]<<24);
155 val
= 0; /* anti-warning */
156 redisPanic("Unknown RDB integer encoding type");
159 return createStringObjectFromLongLong(val
);
161 return createObject(REDIS_STRING
,sdsfromlonglong(val
));
164 /* String objects in the form "2391" "-100" without any space and with a
165 * range of values that can fit in an 8, 16 or 32 bit signed value can be
166 * encoded as integers to save space */
167 int rdbTryIntegerEncoding(char *s
, size_t len
, unsigned char *enc
) {
169 char *endptr
, buf
[32];
171 /* Check if it's possible to encode this value as a number */
172 value
= strtoll(s
, &endptr
, 10);
173 if (endptr
[0] != '\0') return 0;
174 ll2string(buf
,32,value
);
176 /* If the number converted back into a string is not identical
177 * then it's not possible to encode the string as integer */
178 if (strlen(buf
) != len
|| memcmp(buf
,s
,len
)) return 0;
180 return rdbEncodeInteger(value
,enc
);
183 int rdbSaveLzfStringObject(rio
*rdb
, unsigned char *s
, size_t len
) {
184 size_t comprlen
, outlen
;
189 /* We require at least four bytes compression for this to be worth it */
190 if (len
<= 4) return 0;
192 if ((out
= zmalloc(outlen
+1)) == NULL
) return 0;
193 comprlen
= lzf_compress(s
, len
, out
, outlen
);
198 /* Data compressed! Let's save it on disk */
199 byte
= (REDIS_RDB_ENCVAL
<<6)|REDIS_RDB_ENC_LZF
;
200 if ((n
= rdbWriteRaw(rdb
,&byte
,1)) == -1) goto writeerr
;
203 if ((n
= rdbSaveLen(rdb
,comprlen
)) == -1) goto writeerr
;
206 if ((n
= rdbSaveLen(rdb
,len
)) == -1) goto writeerr
;
209 if ((n
= rdbWriteRaw(rdb
,out
,comprlen
)) == -1) goto writeerr
;
220 robj
*rdbLoadLzfStringObject(rio
*rdb
) {
221 unsigned int len
, clen
;
222 unsigned char *c
= NULL
;
225 if ((clen
= rdbLoadLen(rdb
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
226 if ((len
= rdbLoadLen(rdb
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
227 if ((c
= zmalloc(clen
)) == NULL
) goto err
;
228 if ((val
= sdsnewlen(NULL
,len
)) == NULL
) goto err
;
229 if (rioRead(rdb
,c
,clen
) == 0) goto err
;
230 if (lzf_decompress(c
,clen
,val
,len
) == 0) goto err
;
232 return createObject(REDIS_STRING
,val
);
239 /* Save a string objet as [len][data] on disk. If the object is a string
240 * representation of an integer value we try to save it in a special form */
241 int rdbSaveRawString(rio
*rdb
, unsigned char *s
, size_t len
) {
245 /* Try integer encoding */
247 unsigned char buf
[5];
248 if ((enclen
= rdbTryIntegerEncoding((char*)s
,len
,buf
)) > 0) {
249 if (rdbWriteRaw(rdb
,buf
,enclen
) == -1) return -1;
254 /* Try LZF compression - under 20 bytes it's unable to compress even
255 * aaaaaaaaaaaaaaaaaa so skip it */
256 if (server
.rdb_compression
&& len
> 20) {
257 n
= rdbSaveLzfStringObject(rdb
,s
,len
);
258 if (n
== -1) return -1;
260 /* Return value of 0 means data can't be compressed, save the old way */
264 if ((n
= rdbSaveLen(rdb
,len
)) == -1) return -1;
267 if (rdbWriteRaw(rdb
,s
,len
) == -1) return -1;
273 /* Save a long long value as either an encoded string or a string. */
274 int rdbSaveLongLongAsStringObject(rio
*rdb
, long long value
) {
275 unsigned char buf
[32];
277 int enclen
= rdbEncodeInteger(value
,buf
);
279 return rdbWriteRaw(rdb
,buf
,enclen
);
281 /* Encode as string */
282 enclen
= ll2string((char*)buf
,32,value
);
283 redisAssert(enclen
< 32);
284 if ((n
= rdbSaveLen(rdb
,enclen
)) == -1) return -1;
286 if ((n
= rdbWriteRaw(rdb
,buf
,enclen
)) == -1) return -1;
292 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
293 int rdbSaveStringObject(rio
*rdb
, robj
*obj
) {
294 /* Avoid to decode the object, then encode it again, if the
295 * object is alrady integer encoded. */
296 if (obj
->encoding
== REDIS_ENCODING_INT
) {
297 return rdbSaveLongLongAsStringObject(rdb
,(long)obj
->ptr
);
299 redisAssertWithInfo(NULL
,obj
,obj
->encoding
== REDIS_ENCODING_RAW
);
300 return rdbSaveRawString(rdb
,obj
->ptr
,sdslen(obj
->ptr
));
304 robj
*rdbGenericLoadStringObject(rio
*rdb
, int encode
) {
309 len
= rdbLoadLen(rdb
,&isencoded
);
312 case REDIS_RDB_ENC_INT8
:
313 case REDIS_RDB_ENC_INT16
:
314 case REDIS_RDB_ENC_INT32
:
315 return rdbLoadIntegerObject(rdb
,len
,encode
);
316 case REDIS_RDB_ENC_LZF
:
317 return rdbLoadLzfStringObject(rdb
);
319 redisPanic("Unknown RDB encoding type");
323 if (len
== REDIS_RDB_LENERR
) return NULL
;
324 val
= sdsnewlen(NULL
,len
);
325 if (len
&& rioRead(rdb
,val
,len
) == 0) {
329 return createObject(REDIS_STRING
,val
);
332 robj
*rdbLoadStringObject(rio
*rdb
) {
333 return rdbGenericLoadStringObject(rdb
,0);
336 robj
*rdbLoadEncodedStringObject(rio
*rdb
) {
337 return rdbGenericLoadStringObject(rdb
,1);
340 /* Save a double value. Doubles are saved as strings prefixed by an unsigned
341 * 8 bit integer specifing the length of the representation.
342 * This 8 bit integer has special values in order to specify the following
348 int rdbSaveDoubleValue(rio
*rdb
, double val
) {
349 unsigned char buf
[128];
355 } else if (!isfinite(val
)) {
357 buf
[0] = (val
< 0) ? 255 : 254;
359 #if (DBL_MANT_DIG >= 52) && (LLONG_MAX == 0x7fffffffffffffffLL)
360 /* Check if the float is in a safe range to be casted into a
361 * long long. We are assuming that long long is 64 bit here.
362 * Also we are assuming that there are no implementations around where
363 * double has precision < 52 bit.
365 * Under this assumptions we test if a double is inside an interval
366 * where casting to long long is safe. Then using two castings we
367 * make sure the decimal part is zero. If all this is true we use
368 * integer printing function that is much faster. */
369 double min
= -4503599627370495; /* (2^52)-1 */
370 double max
= 4503599627370496; /* -(2^52) */
371 if (val
> min
&& val
< max
&& val
== ((double)((long long)val
)))
372 ll2string((char*)buf
+1,sizeof(buf
),(long long)val
);
375 snprintf((char*)buf
+1,sizeof(buf
)-1,"%.17g",val
);
376 buf
[0] = strlen((char*)buf
+1);
379 return rdbWriteRaw(rdb
,buf
,len
);
382 /* For information about double serialization check rdbSaveDoubleValue() */
383 int rdbLoadDoubleValue(rio
*rdb
, double *val
) {
387 if (rioRead(rdb
,&len
,1) == 0) return -1;
389 case 255: *val
= R_NegInf
; return 0;
390 case 254: *val
= R_PosInf
; return 0;
391 case 253: *val
= R_Nan
; return 0;
393 if (rioRead(rdb
,buf
,len
) == 0) return -1;
395 sscanf(buf
, "%lg", val
);
400 /* Save the object type of object "o". */
401 int rdbSaveObjectType(rio
*rdb
, robj
*o
) {
404 return rdbSaveType(rdb
,REDIS_RDB_TYPE_STRING
);
406 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
)
407 return rdbSaveType(rdb
,REDIS_RDB_TYPE_LIST_ZIPLIST
);
408 else if (o
->encoding
== REDIS_ENCODING_LINKEDLIST
)
409 return rdbSaveType(rdb
,REDIS_RDB_TYPE_LIST
);
411 redisPanic("Unknown list encoding");
413 if (o
->encoding
== REDIS_ENCODING_INTSET
)
414 return rdbSaveType(rdb
,REDIS_RDB_TYPE_SET_INTSET
);
415 else if (o
->encoding
== REDIS_ENCODING_HT
)
416 return rdbSaveType(rdb
,REDIS_RDB_TYPE_SET
);
418 redisPanic("Unknown set encoding");
420 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
)
421 return rdbSaveType(rdb
,REDIS_RDB_TYPE_ZSET_ZIPLIST
);
422 else if (o
->encoding
== REDIS_ENCODING_SKIPLIST
)
423 return rdbSaveType(rdb
,REDIS_RDB_TYPE_ZSET
);
425 redisPanic("Unknown sorted set encoding");
427 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
)
428 return rdbSaveType(rdb
,REDIS_RDB_TYPE_HASH_ZIPLIST
);
429 else if (o
->encoding
== REDIS_ENCODING_HT
)
430 return rdbSaveType(rdb
,REDIS_RDB_TYPE_HASH
);
432 redisPanic("Unknown hash encoding");
434 redisPanic("Unknown object type");
436 return -1; /* avoid warning */
439 /* Use rdbLoadType() to load a TYPE in RDB format, but returns -1 if the
440 * type is not specifically a valid Object Type. */
441 int rdbLoadObjectType(rio
*rdb
) {
443 if ((type
= rdbLoadType(rdb
)) == -1) return -1;
444 if (!rdbIsObjectType(type
)) return -1;
448 /* Save a Redis object. Returns -1 on error, 0 on success. */
449 int rdbSaveObject(rio
*rdb
, robj
*o
) {
452 if (o
->type
== REDIS_STRING
) {
453 /* Save a string value */
454 if ((n
= rdbSaveStringObject(rdb
,o
)) == -1) return -1;
456 } else if (o
->type
== REDIS_LIST
) {
457 /* Save a list value */
458 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
459 size_t l
= ziplistBlobLen((unsigned char*)o
->ptr
);
461 if ((n
= rdbSaveRawString(rdb
,o
->ptr
,l
)) == -1) return -1;
463 } else if (o
->encoding
== REDIS_ENCODING_LINKEDLIST
) {
468 if ((n
= rdbSaveLen(rdb
,listLength(list
))) == -1) return -1;
471 listRewind(list
,&li
);
472 while((ln
= listNext(&li
))) {
473 robj
*eleobj
= listNodeValue(ln
);
474 if ((n
= rdbSaveStringObject(rdb
,eleobj
)) == -1) return -1;
478 redisPanic("Unknown list encoding");
480 } else if (o
->type
== REDIS_SET
) {
481 /* Save a set value */
482 if (o
->encoding
== REDIS_ENCODING_HT
) {
484 dictIterator
*di
= dictGetIterator(set
);
487 if ((n
= rdbSaveLen(rdb
,dictSize(set
))) == -1) return -1;
490 while((de
= dictNext(di
)) != NULL
) {
491 robj
*eleobj
= dictGetKey(de
);
492 if ((n
= rdbSaveStringObject(rdb
,eleobj
)) == -1) return -1;
495 dictReleaseIterator(di
);
496 } else if (o
->encoding
== REDIS_ENCODING_INTSET
) {
497 size_t l
= intsetBlobLen((intset
*)o
->ptr
);
499 if ((n
= rdbSaveRawString(rdb
,o
->ptr
,l
)) == -1) return -1;
502 redisPanic("Unknown set encoding");
504 } else if (o
->type
== REDIS_ZSET
) {
505 /* Save a sorted set value */
506 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
507 size_t l
= ziplistBlobLen((unsigned char*)o
->ptr
);
509 if ((n
= rdbSaveRawString(rdb
,o
->ptr
,l
)) == -1) return -1;
511 } else if (o
->encoding
== REDIS_ENCODING_SKIPLIST
) {
513 dictIterator
*di
= dictGetIterator(zs
->dict
);
516 if ((n
= rdbSaveLen(rdb
,dictSize(zs
->dict
))) == -1) return -1;
519 while((de
= dictNext(di
)) != NULL
) {
520 robj
*eleobj
= dictGetKey(de
);
521 double *score
= dictGetVal(de
);
523 if ((n
= rdbSaveStringObject(rdb
,eleobj
)) == -1) return -1;
525 if ((n
= rdbSaveDoubleValue(rdb
,*score
)) == -1) return -1;
528 dictReleaseIterator(di
);
530 redisPanic("Unknown sorted set encoding");
532 } else if (o
->type
== REDIS_HASH
) {
533 /* Save a hash value */
534 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
535 size_t l
= ziplistBlobLen((unsigned char*)o
->ptr
);
537 if ((n
= rdbSaveRawString(rdb
,o
->ptr
,l
)) == -1) return -1;
540 } else if (o
->encoding
== REDIS_ENCODING_HT
) {
541 dictIterator
*di
= dictGetIterator(o
->ptr
);
544 if ((n
= rdbSaveLen(rdb
,dictSize((dict
*)o
->ptr
))) == -1) return -1;
547 while((de
= dictNext(di
)) != NULL
) {
548 robj
*key
= dictGetKey(de
);
549 robj
*val
= dictGetVal(de
);
551 if ((n
= rdbSaveStringObject(rdb
,key
)) == -1) return -1;
553 if ((n
= rdbSaveStringObject(rdb
,val
)) == -1) return -1;
556 dictReleaseIterator(di
);
559 redisPanic("Unknown hash encoding");
563 redisPanic("Unknown object type");
568 /* Return the length the object will have on disk if saved with
569 * the rdbSaveObject() function. Currently we use a trick to get
570 * this length with very little changes to the code. In the future
571 * we could switch to a faster solution. */
572 off_t
rdbSavedObjectLen(robj
*o
) {
573 int len
= rdbSaveObject(NULL
,o
);
574 redisAssertWithInfo(NULL
,o
,len
!= -1);
578 /* Save a key-value pair, with expire time, type, key, value.
579 * On error -1 is returned.
580 * On success if the key was actaully saved 1 is returned, otherwise 0
581 * is returned (the key was already expired). */
582 int rdbSaveKeyValuePair(rio
*rdb
, robj
*key
, robj
*val
,
583 long long expiretime
, long long now
)
585 /* Save the expire time */
586 if (expiretime
!= -1) {
587 /* If this key is already expired skip it */
588 if (expiretime
< now
) return 0;
589 if (rdbSaveType(rdb
,REDIS_RDB_OPCODE_EXPIRETIME_MS
) == -1) return -1;
590 if (rdbSaveMillisecondTime(rdb
,expiretime
) == -1) return -1;
593 /* Save type, key, value */
594 if (rdbSaveObjectType(rdb
,val
) == -1) return -1;
595 if (rdbSaveStringObject(rdb
,key
) == -1) return -1;
596 if (rdbSaveObject(rdb
,val
) == -1) return -1;
600 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
601 int rdbSave(char *filename
) {
602 dictIterator
*di
= NULL
;
607 long long now
= mstime();
612 snprintf(tmpfile
,256,"temp-%d.rdb", (int) getpid());
613 fp
= fopen(tmpfile
,"w");
615 redisLog(REDIS_WARNING
, "Failed opening .rdb for saving: %s",
620 rioInitWithFile(&rdb
,fp
);
621 if (server
.rdb_checksum
)
622 rdb
.update_cksum
= rioGenericUpdateChecksum
;
623 snprintf(magic
,sizeof(magic
),"REDIS%04d",REDIS_RDB_VERSION
);
624 if (rdbWriteRaw(&rdb
,magic
,9) == -1) goto werr
;
626 for (j
= 0; j
< server
.dbnum
; j
++) {
627 redisDb
*db
= server
.db
+j
;
629 if (dictSize(d
) == 0) continue;
630 di
= dictGetSafeIterator(d
);
636 /* Write the SELECT DB opcode */
637 if (rdbSaveType(&rdb
,REDIS_RDB_OPCODE_SELECTDB
) == -1) goto werr
;
638 if (rdbSaveLen(&rdb
,j
) == -1) goto werr
;
640 /* Iterate this DB writing every entry */
641 while((de
= dictNext(di
)) != NULL
) {
642 sds keystr
= dictGetKey(de
);
643 robj key
, *o
= dictGetVal(de
);
646 initStaticStringObject(key
,keystr
);
647 expire
= getExpire(db
,&key
);
648 if (rdbSaveKeyValuePair(&rdb
,&key
,o
,expire
,now
) == -1) goto werr
;
650 dictReleaseIterator(di
);
652 di
= NULL
; /* So that we don't release it again on error. */
655 if (rdbSaveType(&rdb
,REDIS_RDB_OPCODE_EOF
) == -1) goto werr
;
657 /* CRC64 checksum. It will be zero if checksum computation is disabled, the
658 * loading code skips the check in this case. */
660 memrev64ifbe(&cksum
);
661 rioWrite(&rdb
,&cksum
,8);
663 /* Make sure data will not remain on the OS's output buffers */
668 /* Use RENAME to make sure the DB file is changed atomically only
669 * if the generate DB file is ok. */
670 if (rename(tmpfile
,filename
) == -1) {
671 redisLog(REDIS_WARNING
,"Error moving temp DB file on the final destination: %s", strerror(errno
));
675 redisLog(REDIS_NOTICE
,"DB saved on disk");
677 server
.lastsave
= time(NULL
);
678 server
.lastbgsave_status
= REDIS_OK
;
684 redisLog(REDIS_WARNING
,"Write error saving DB on disk: %s", strerror(errno
));
685 if (di
) dictReleaseIterator(di
);
689 int rdbSaveBackground(char *filename
) {
693 if (server
.rdb_child_pid
!= -1) return REDIS_ERR
;
695 server
.dirty_before_bgsave
= server
.dirty
;
698 if ((childpid
= fork()) == 0) {
702 if (server
.ipfd
> 0) close(server
.ipfd
);
703 if (server
.sofd
> 0) close(server
.sofd
);
704 retval
= rdbSave(filename
);
705 exitFromChild((retval
== REDIS_OK
) ? 0 : 1);
708 server
.stat_fork_time
= ustime()-start
;
709 if (childpid
== -1) {
710 redisLog(REDIS_WARNING
,"Can't save in background: fork: %s",
714 redisLog(REDIS_NOTICE
,"Background saving started by pid %d",childpid
);
715 server
.rdb_save_time_start
= time(NULL
);
716 server
.rdb_child_pid
= childpid
;
717 updateDictResizePolicy();
720 return REDIS_OK
; /* unreached */
723 void rdbRemoveTempFile(pid_t childpid
) {
726 snprintf(tmpfile
,256,"temp-%d.rdb", (int) childpid
);
730 /* Load a Redis object of the specified type from the specified file.
731 * On success a newly allocated object is returned, otherwise NULL. */
732 robj
*rdbLoadObject(int rdbtype
, rio
*rdb
) {
737 redisLog(REDIS_DEBUG
,"LOADING OBJECT %d (at %d)\n",rdbtype
,rioTell(rdb
));
738 if (rdbtype
== REDIS_RDB_TYPE_STRING
) {
739 /* Read string value */
740 if ((o
= rdbLoadEncodedStringObject(rdb
)) == NULL
) return NULL
;
741 o
= tryObjectEncoding(o
);
742 } else if (rdbtype
== REDIS_RDB_TYPE_LIST
) {
743 /* Read list value */
744 if ((len
= rdbLoadLen(rdb
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
746 /* Use a real list when there are too many entries */
747 if (len
> server
.list_max_ziplist_entries
) {
748 o
= createListObject();
750 o
= createZiplistObject();
753 /* Load every single element of the list */
755 if ((ele
= rdbLoadEncodedStringObject(rdb
)) == NULL
) return NULL
;
757 /* If we are using a ziplist and the value is too big, convert
758 * the object to a real list. */
759 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
&&
760 ele
->encoding
== REDIS_ENCODING_RAW
&&
761 sdslen(ele
->ptr
) > server
.list_max_ziplist_value
)
762 listTypeConvert(o
,REDIS_ENCODING_LINKEDLIST
);
764 if (o
->encoding
== REDIS_ENCODING_ZIPLIST
) {
765 dec
= getDecodedObject(ele
);
766 o
->ptr
= ziplistPush(o
->ptr
,dec
->ptr
,sdslen(dec
->ptr
),REDIS_TAIL
);
770 ele
= tryObjectEncoding(ele
);
771 listAddNodeTail(o
->ptr
,ele
);
774 } else if (rdbtype
== REDIS_RDB_TYPE_SET
) {
775 /* Read list/set value */
776 if ((len
= rdbLoadLen(rdb
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
778 /* Use a regular set when there are too many entries. */
779 if (len
> server
.set_max_intset_entries
) {
780 o
= createSetObject();
781 /* It's faster to expand the dict to the right size asap in order
782 * to avoid rehashing */
783 if (len
> DICT_HT_INITIAL_SIZE
)
784 dictExpand(o
->ptr
,len
);
786 o
= createIntsetObject();
789 /* Load every single element of the list/set */
790 for (i
= 0; i
< len
; i
++) {
792 if ((ele
= rdbLoadEncodedStringObject(rdb
)) == NULL
) return NULL
;
793 ele
= tryObjectEncoding(ele
);
795 if (o
->encoding
== REDIS_ENCODING_INTSET
) {
796 /* Fetch integer value from element */
797 if (isObjectRepresentableAsLongLong(ele
,&llval
) == REDIS_OK
) {
798 o
->ptr
= intsetAdd(o
->ptr
,llval
,NULL
);
800 setTypeConvert(o
,REDIS_ENCODING_HT
);
801 dictExpand(o
->ptr
,len
);
805 /* This will also be called when the set was just converted
806 * to a regular hash table encoded set */
807 if (o
->encoding
== REDIS_ENCODING_HT
) {
808 dictAdd((dict
*)o
->ptr
,ele
,NULL
);
813 } else if (rdbtype
== REDIS_RDB_TYPE_ZSET
) {
814 /* Read list/set value */
816 size_t maxelelen
= 0;
819 if ((zsetlen
= rdbLoadLen(rdb
,NULL
)) == REDIS_RDB_LENERR
) return NULL
;
820 o
= createZsetObject();
823 /* Load every single element of the list/set */
827 zskiplistNode
*znode
;
829 if ((ele
= rdbLoadEncodedStringObject(rdb
)) == NULL
) return NULL
;
830 ele
= tryObjectEncoding(ele
);
831 if (rdbLoadDoubleValue(rdb
,&score
) == -1) return NULL
;
833 /* Don't care about integer-encoded strings. */
834 if (ele
->encoding
== REDIS_ENCODING_RAW
&&
835 sdslen(ele
->ptr
) > maxelelen
)
836 maxelelen
= sdslen(ele
->ptr
);
838 znode
= zslInsert(zs
->zsl
,score
,ele
);
839 dictAdd(zs
->dict
,ele
,&znode
->score
);
840 incrRefCount(ele
); /* added to skiplist */
843 /* Convert *after* loading, since sorted sets are not stored ordered. */
844 if (zsetLength(o
) <= server
.zset_max_ziplist_entries
&&
845 maxelelen
<= server
.zset_max_ziplist_value
)
846 zsetConvert(o
,REDIS_ENCODING_ZIPLIST
);
847 } else if (rdbtype
== REDIS_RDB_TYPE_HASH
) {
851 len
= rdbLoadLen(rdb
, NULL
);
852 if (len
== REDIS_RDB_LENERR
) return NULL
;
854 o
= createHashObject();
856 /* Too many entries? Use an hash table. */
857 if (len
> server
.hash_max_ziplist_entries
)
858 hashTypeConvert(o
, REDIS_ENCODING_HT
);
860 /* Load every field and value into the ziplist */
861 while (o
->encoding
== REDIS_ENCODING_ZIPLIST
&& len
> 0) {
865 /* Load raw strings */
866 field
= rdbLoadStringObject(rdb
);
867 if (field
== NULL
) return NULL
;
868 redisAssert(field
->encoding
== REDIS_ENCODING_RAW
);
869 value
= rdbLoadStringObject(rdb
);
870 if (value
== NULL
) return NULL
;
871 redisAssert(field
->encoding
== REDIS_ENCODING_RAW
);
873 /* Add pair to ziplist */
874 o
->ptr
= ziplistPush(o
->ptr
, field
->ptr
, sdslen(field
->ptr
), ZIPLIST_TAIL
);
875 o
->ptr
= ziplistPush(o
->ptr
, value
->ptr
, sdslen(value
->ptr
), ZIPLIST_TAIL
);
876 /* Convert to hash table if size threshold is exceeded */
877 if (sdslen(field
->ptr
) > server
.hash_max_ziplist_value
||
878 sdslen(value
->ptr
) > server
.hash_max_ziplist_value
)
882 hashTypeConvert(o
, REDIS_ENCODING_HT
);
889 /* Load remaining fields and values into the hash table */
890 while (o
->encoding
== REDIS_ENCODING_HT
&& len
> 0) {
894 /* Load encoded strings */
895 field
= rdbLoadEncodedStringObject(rdb
);
896 if (field
== NULL
) return NULL
;
897 value
= rdbLoadEncodedStringObject(rdb
);
898 if (value
== NULL
) return NULL
;
900 field
= tryObjectEncoding(field
);
901 value
= tryObjectEncoding(value
);
903 /* Add pair to hash table */
904 ret
= dictAdd((dict
*)o
->ptr
, field
, value
);
905 redisAssert(ret
== REDIS_OK
);
908 /* All pairs should be read by now */
909 redisAssert(len
== 0);
911 } else if (rdbtype
== REDIS_RDB_TYPE_HASH_ZIPMAP
||
912 rdbtype
== REDIS_RDB_TYPE_LIST_ZIPLIST
||
913 rdbtype
== REDIS_RDB_TYPE_SET_INTSET
||
914 rdbtype
== REDIS_RDB_TYPE_ZSET_ZIPLIST
||
915 rdbtype
== REDIS_RDB_TYPE_HASH_ZIPLIST
)
917 robj
*aux
= rdbLoadStringObject(rdb
);
919 if (aux
== NULL
) return NULL
;
920 o
= createObject(REDIS_STRING
,NULL
); /* string is just placeholder */
921 o
->ptr
= zmalloc(sdslen(aux
->ptr
));
922 memcpy(o
->ptr
,aux
->ptr
,sdslen(aux
->ptr
));
925 /* Fix the object encoding, and make sure to convert the encoded
926 * data type into the base type if accordingly to the current
927 * configuration there are too many elements in the encoded data
928 * type. Note that we only check the length and not max element
929 * size as this is an O(N) scan. Eventually everything will get
932 case REDIS_RDB_TYPE_HASH_ZIPMAP
:
933 /* Convert to ziplist encoded hash. This must be deprecated
934 * when loading dumps created by Redis 2.4 gets deprecated. */
936 unsigned char *zl
= ziplistNew();
937 unsigned char *zi
= zipmapRewind(o
->ptr
);
938 unsigned char *fstr
, *vstr
;
939 unsigned int flen
, vlen
;
940 unsigned int maxlen
= 0;
942 while ((zi
= zipmapNext(zi
, &fstr
, &flen
, &vstr
, &vlen
)) != NULL
) {
943 if (flen
> maxlen
) maxlen
= flen
;
944 if (vlen
> maxlen
) maxlen
= vlen
;
945 zl
= ziplistPush(zl
, fstr
, flen
, ZIPLIST_TAIL
);
946 zl
= ziplistPush(zl
, vstr
, vlen
, ZIPLIST_TAIL
);
951 o
->type
= REDIS_HASH
;
952 o
->encoding
= REDIS_ENCODING_ZIPLIST
;
954 if (hashTypeLength(o
) > server
.hash_max_ziplist_entries
||
955 maxlen
> server
.hash_max_ziplist_value
)
957 hashTypeConvert(o
, REDIS_ENCODING_HT
);
961 case REDIS_RDB_TYPE_LIST_ZIPLIST
:
962 o
->type
= REDIS_LIST
;
963 o
->encoding
= REDIS_ENCODING_ZIPLIST
;
964 if (ziplistLen(o
->ptr
) > server
.list_max_ziplist_entries
)
965 listTypeConvert(o
,REDIS_ENCODING_LINKEDLIST
);
967 case REDIS_RDB_TYPE_SET_INTSET
:
969 o
->encoding
= REDIS_ENCODING_INTSET
;
970 if (intsetLen(o
->ptr
) > server
.set_max_intset_entries
)
971 setTypeConvert(o
,REDIS_ENCODING_HT
);
973 case REDIS_RDB_TYPE_ZSET_ZIPLIST
:
974 o
->type
= REDIS_ZSET
;
975 o
->encoding
= REDIS_ENCODING_ZIPLIST
;
976 if (zsetLength(o
) > server
.zset_max_ziplist_entries
)
977 zsetConvert(o
,REDIS_ENCODING_SKIPLIST
);
979 case REDIS_RDB_TYPE_HASH_ZIPLIST
:
980 o
->type
= REDIS_HASH
;
981 o
->encoding
= REDIS_ENCODING_ZIPLIST
;
982 if (hashTypeLength(o
) > server
.hash_max_ziplist_entries
)
983 hashTypeConvert(o
, REDIS_ENCODING_HT
);
986 redisPanic("Unknown encoding");
990 redisPanic("Unknown object type");
995 /* Mark that we are loading in the global state and setup the fields
996 * needed to provide loading stats. */
997 void startLoading(FILE *fp
) {
1002 server
.loading_start_time
= time(NULL
);
1003 if (fstat(fileno(fp
), &sb
) == -1) {
1004 server
.loading_total_bytes
= 1; /* just to avoid division by zero */
1006 server
.loading_total_bytes
= sb
.st_size
;
1010 /* Refresh the loading progress info */
1011 void loadingProgress(off_t pos
) {
1012 server
.loading_loaded_bytes
= pos
;
1013 if (server
.stat_peak_memory
< zmalloc_used_memory())
1014 server
.stat_peak_memory
= zmalloc_used_memory();
1017 /* Loading finished */
1018 void stopLoading(void) {
1022 int rdbLoad(char *filename
) {
1025 redisDb
*db
= server
.db
+0;
1027 long long expiretime
, now
= mstime();
1032 fp
= fopen(filename
,"r");
1037 rioInitWithFile(&rdb
,fp
);
1038 if (server
.rdb_checksum
)
1039 rdb
.update_cksum
= rioGenericUpdateChecksum
;
1040 if (rioRead(&rdb
,buf
,9) == 0) goto eoferr
;
1042 if (memcmp(buf
,"REDIS",5) != 0) {
1044 redisLog(REDIS_WARNING
,"Wrong signature trying to load DB from file");
1048 rdbver
= atoi(buf
+5);
1049 if (rdbver
< 1 || rdbver
> REDIS_RDB_VERSION
) {
1051 redisLog(REDIS_WARNING
,"Can't handle RDB format version %d",rdbver
);
1061 /* Serve the clients from time to time */
1062 if (!(loops
++ % 1000)) {
1063 loadingProgress(rioTell(&rdb
));
1064 aeProcessEvents(server
.el
, AE_FILE_EVENTS
|AE_DONT_WAIT
);
1068 if ((type
= rdbLoadType(&rdb
)) == -1) goto eoferr
;
1069 if (type
== REDIS_RDB_OPCODE_EXPIRETIME
) {
1070 if ((expiretime
= rdbLoadTime(&rdb
)) == -1) goto eoferr
;
1071 /* We read the time so we need to read the object type again. */
1072 if ((type
= rdbLoadType(&rdb
)) == -1) goto eoferr
;
1073 /* the EXPIRETIME opcode specifies time in seconds, so convert
1074 * into milliesconds. */
1076 } else if (type
== REDIS_RDB_OPCODE_EXPIRETIME_MS
) {
1077 /* Milliseconds precision expire times introduced with RDB
1079 if ((expiretime
= rdbLoadMillisecondTime(&rdb
)) == -1) goto eoferr
;
1080 /* We read the time so we need to read the object type again. */
1081 if ((type
= rdbLoadType(&rdb
)) == -1) goto eoferr
;
1084 if (type
== REDIS_RDB_OPCODE_EOF
)
1087 /* Handle SELECT DB opcode as a special case */
1088 if (type
== REDIS_RDB_OPCODE_SELECTDB
) {
1089 if ((dbid
= rdbLoadLen(&rdb
,NULL
)) == REDIS_RDB_LENERR
)
1091 if (dbid
>= (unsigned)server
.dbnum
) {
1092 redisLog(REDIS_WARNING
,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server
.dbnum
);
1095 db
= server
.db
+dbid
;
1099 if ((key
= rdbLoadStringObject(&rdb
)) == NULL
) goto eoferr
;
1101 if ((val
= rdbLoadObject(type
,&rdb
)) == NULL
) goto eoferr
;
1102 /* Check if the key already expired. This function is used when loading
1103 * an RDB file from disk, either at startup, or when an RDB was
1104 * received from the master. In the latter case, the master is
1105 * responsible for key expiry. If we would expire keys here, the
1106 * snapshot taken by the master may not be reflected on the slave. */
1107 if (server
.masterhost
== NULL
&& expiretime
!= -1 && expiretime
< now
) {
1112 /* Add the new object in the hash table */
1115 /* Set the expire time if needed */
1116 if (expiretime
!= -1) setExpire(db
,key
,expiretime
);
1120 /* Verify the checksum if RDB version is >= 5 */
1121 if (rdbver
>= 5 && server
.rdb_checksum
) {
1122 uint64_t cksum
, expected
= rdb
.cksum
;
1124 if (rioRead(&rdb
,&cksum
,8) == 0) goto eoferr
;
1125 memrev64ifbe(&cksum
);
1127 redisLog(REDIS_WARNING
,"RDB file was saved with checksum disabled: no check performed.");
1128 } else if (cksum
!= expected
) {
1129 redisLog(REDIS_WARNING
,"Wrong RDB checksum. Aborting now.");
1138 eoferr
: /* unexpected end of file is handled here with a fatal exit */
1139 redisLog(REDIS_WARNING
,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
1141 return REDIS_ERR
; /* Just to avoid warning */
1144 /* A background saving child (BGSAVE) terminated its work. Handle this. */
1145 void backgroundSaveDoneHandler(int exitcode
, int bysignal
) {
1146 if (!bysignal
&& exitcode
== 0) {
1147 redisLog(REDIS_NOTICE
,
1148 "Background saving terminated with success");
1149 server
.dirty
= server
.dirty
- server
.dirty_before_bgsave
;
1150 server
.lastsave
= time(NULL
);
1151 server
.lastbgsave_status
= REDIS_OK
;
1152 } else if (!bysignal
&& exitcode
!= 0) {
1153 redisLog(REDIS_WARNING
, "Background saving error");
1154 server
.lastbgsave_status
= REDIS_ERR
;
1156 redisLog(REDIS_WARNING
,
1157 "Background saving terminated by signal %d", bysignal
);
1158 rdbRemoveTempFile(server
.rdb_child_pid
);
1159 server
.lastbgsave_status
= REDIS_ERR
;
1161 server
.rdb_child_pid
= -1;
1162 server
.rdb_save_time_last
= time(NULL
)-server
.rdb_save_time_start
;
1163 server
.rdb_save_time_start
= -1;
1164 /* Possibly there are slaves waiting for a BGSAVE in order to be served
1165 * (the first stage of SYNC is a bulk transfer of dump.rdb) */
1166 updateSlavesWaitingBgsave(exitcode
== 0 ? REDIS_OK
: REDIS_ERR
);
1169 void saveCommand(redisClient
*c
) {
1170 if (server
.rdb_child_pid
!= -1) {
1171 addReplyError(c
,"Background save already in progress");
1174 if (rdbSave(server
.rdb_filename
) == REDIS_OK
) {
1175 addReply(c
,shared
.ok
);
1177 addReply(c
,shared
.err
);
1181 void bgsaveCommand(redisClient
*c
) {
1182 if (server
.rdb_child_pid
!= -1) {
1183 addReplyError(c
,"Background save already in progress");
1184 } else if (server
.aof_child_pid
!= -1) {
1185 addReplyError(c
,"Can't BGSAVE while AOF log rewriting is in progress");
1186 } else if (rdbSaveBackground(server
.rdb_filename
) == REDIS_OK
) {
1187 addReplyStatus(c
,"Background saving started");
1189 addReply(c
,shared
.err
);