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