src/rdb.c

   1 #include "redis.h"
   2 #include "lzf.h"    /* LZF compression library */
   3
   4 #include <math.h>
   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>
  10 #include <sys/stat.h>
  11
  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. */
  16 static 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
  21 int rdbSaveType(FILE *fp, unsigned char type) {
  22     return rdbWriteRaw(fp,&type,1);
  23 }
  24
  25 int rdbSaveTime(FILE *fp, time_t t) {
  26     int32_t t32 = (int32_t) t;
  27     return rdbWriteRaw(fp,&t32,4);
  28 }
  29
  30 /* check rdbLoadLen() comments for more info */
  31 int rdbSaveLen(FILE *fp, uint32_t len) {
  32     unsigned char buf[2];
  33     int nwritten;
  34
  35     if (len < (1<<6)) {
  36         /* Save a 6 bit len */
  37         buf[0] = (len&0xFF)|(REDIS_RDB_6BITLEN<<6);
  38         if (rdbWriteRaw(fp,buf,1) == -1) return -1;
  39         nwritten = 1;
  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;
  44         if (rdbWriteRaw(fp,buf,2) == -1) return -1;
  45         nwritten = 2;
  46     } else {
  47         /* Save a 32 bit len */
  48         buf[0] = (REDIS_RDB_32BITLEN<<6);
  49         if (rdbWriteRaw(fp,buf,1) == -1) return -1;
  50         len = htonl(len);
  51         if (rdbWriteRaw(fp,&len,4) == -1) return -1;
  52         nwritten = 1+4;
  53     }
  54     return nwritten;
  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. */
  62 int 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 */
  88 int 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
 104 int rdbSaveLzfStringObject(FILE *fp, unsigned char *s, size_t len) {
 105     size_t comprlen, outlen;
 106     unsigned char byte;
 107     int n, nwritten = 0;
 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;
 121     if ((n = rdbWriteRaw(fp,&byte,1)) == -1) goto writeerr;
 122     nwritten += n;
 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
 130     if ((n = rdbWriteRaw(fp,out,comprlen)) == -1) goto writeerr;
 131     nwritten += n;
 132
 133     zfree(out);
 134     return nwritten;
 135
 136 writeerr:
 137     zfree(out);
 138     return -1;
 139 }
 140
 141 /* Save a string objet as [len][data] on disk. If the object is a string
 142  * representation of an integer value we try to save it in a special form */
 143 int rdbSaveRawString(FILE *fp, unsigned char *s, size_t len) {
 144     int enclen;
 145     int n, nwritten = 0;
 146
 147     /* Try integer encoding */
 148     if (len <= 11) {
 149         unsigned char buf[5];
 150         if ((enclen = rdbTryIntegerEncoding((char*)s,len,buf)) > 0) {
 151             if (rdbWriteRaw(fp,buf,enclen) == -1) return -1;
 152             return enclen;
 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) {
 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 */
 163     }
 164
 165     /* Store verbatim */
 166     if ((n = rdbSaveLen(fp,len)) == -1) return -1;
 167     nwritten += n;
 168     if (len > 0) {
 169         if (rdbWriteRaw(fp,s,len) == -1) return -1;
 170         nwritten += len;
 171     }
 172     return nwritten;
 173 }
 174
 175 /* Save a long long value as either an encoded string or a string. */
 176 int rdbSaveLongLongAsStringObject(FILE *fp, long long value) {
 177     unsigned char buf[32];
 178     int n, nwritten = 0;
 179     int enclen = rdbEncodeInteger(value,buf);
 180     if (enclen > 0) {
 181         return rdbWriteRaw(fp,buf,enclen);
 182     } else {
 183         /* Encode as string */
 184         enclen = ll2string((char*)buf,32,value);
 185         redisAssert(enclen < 32);
 186         if ((n = rdbSaveLen(fp,enclen)) == -1) return -1;
 187         nwritten += n;
 188         if ((n = rdbWriteRaw(fp,buf,enclen)) == -1) return -1;
 189         nwritten += n;
 190     }
 191     return nwritten;
 192 }
 193
 194 /* Like rdbSaveStringObjectRaw() but handle encoded objects */
 195 int 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  */
 214 int 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     }
 245     return rdbWriteRaw(fp,buf,len);
 246 }
 247
 248 /* Save a Redis object. */
 249 int rdbSaveObject(FILE *fp, robj *o) {
 250     int n, nwritten = 0;
 251
 252     if (o->type == REDIS_STRING) {
 253         /* Save a string value */
 254         if ((n = rdbSaveStringObject(fp,o)) == -1) return -1;
 255         nwritten += n;
 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
 264             if ((n = rdbSaveLen(fp,ziplistLen(o->ptr))) == -1) return -1;
 265             nwritten += n;
 266
 267             p = ziplistIndex(o->ptr,0);
 268             while(ziplistGet(p,&vstr,&vlen,&vlong)) {
 269                 if (vstr) {
 270                     if ((n = rdbSaveRawString(fp,vstr,vlen)) == -1)
 271                         return -1;
 272                     nwritten += n;
 273                 } else {
 274                     if ((n = rdbSaveLongLongAsStringObject(fp,vlong)) == -1)
 275                         return -1;
 276                     nwritten += n;
 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
 285             if ((n = rdbSaveLen(fp,listLength(list))) == -1) return -1;
 286             nwritten += n;
 287
 288             listRewind(list,&li);
 289             while((ln = listNext(&li))) {
 290                 robj *eleobj = listNodeValue(ln);
 291                 if ((n = rdbSaveStringObject(fp,eleobj)) == -1) return -1;
 292                 nwritten += n;
 293             }
 294         } else {
 295             redisPanic("Unknown list encoding");
 296         }
 297     } else if (o->type == REDIS_SET) {
 298         /* Save a set value */
 299         if (o->encoding == REDIS_ENCODING_HT) {
 300             dict *set = o->ptr;
 301             dictIterator *di = dictGetIterator(set);
 302             dictEntry *de;
 303
 304             if ((n = rdbSaveLen(fp,dictSize(set))) == -1) return -1;
 305             nwritten += n;
 306
 307             while((de = dictNext(di)) != NULL) {
 308                 robj *eleobj = dictGetEntryKey(de);
 309                 if ((n = rdbSaveStringObject(fp,eleobj)) == -1) return -1;
 310                 nwritten += n;
 311             }
 312             dictReleaseIterator(di);
 313         } else if (o->encoding == REDIS_ENCODING_INTSET) {
 314             intset *is = o->ptr;
 315             int64_t llval;
 316             int i = 0;
 317
 318             if ((n = rdbSaveLen(fp,intsetLen(is))) == -1) return -1;
 319             nwritten += n;
 320
 321             while(intsetGet(is,i++,&llval)) {
 322                 if ((n = rdbSaveLongLongAsStringObject(fp,llval)) == -1) return -1;
 323                 nwritten += n;
 324             }
 325         } else {
 326             redisPanic("Unknown set encoding");
 327         }
 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
 334         if ((n = rdbSaveLen(fp,dictSize(zs->dict))) == -1) return -1;
 335         nwritten += n;
 336
 337         while((de = dictNext(di)) != NULL) {
 338             robj *eleobj = dictGetEntryKey(de);
 339             double *score = dictGetEntryVal(de);
 340
 341             if ((n = rdbSaveStringObject(fp,eleobj)) == -1) return -1;
 342             nwritten += n;
 343             if ((n = rdbSaveDoubleValue(fp,*score)) == -1) return -1;
 344             nwritten += n;
 345         }
 346         dictReleaseIterator(di);
 347     } else if (o->type == REDIS_HASH) {
 348         /* Save a hash value */
 349         if (o->encoding == REDIS_ENCODING_ZIPMAP) {
 350             size_t l = zipmapBlobLen((unsigned char*)o->ptr);
 351
 352             if ((n = rdbSaveRawString(fp,o->ptr,l)) == -1) return -1;
 353             nwritten += n;
 354         } else {
 355             dictIterator *di = dictGetIterator(o->ptr);
 356             dictEntry *de;
 357
 358             if ((n = rdbSaveLen(fp,dictSize((dict*)o->ptr))) == -1) return -1;
 359             nwritten += n;
 360
 361             while((de = dictNext(di)) != NULL) {
 362                 robj *key = dictGetEntryKey(de);
 363                 robj *val = dictGetEntryVal(de);
 364
 365                 if ((n = rdbSaveStringObject(fp,key)) == -1) return -1;
 366                 nwritten += n;
 367                 if ((n = rdbSaveStringObject(fp,val)) == -1) return -1;
 368                 nwritten += n;
 369             }
 370             dictReleaseIterator(di);
 371         }
 372     } else {
 373         redisPanic("Unknown object type");
 374     }
 375     return nwritten;
 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. */
 382 off_t rdbSavedObjectLen(robj *o) {
 383     int len = rdbSaveObject(NULL,o);
 384     redisAssert(len != -1);
 385     return len;
 386 }
 387
 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). */
 392 int rdbSaveKeyValuePair(FILE *fp, robj *key, robj *val,
 393                         time_t expiretime, time_t now)
 394 {
 395     int vtype;
 396
 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     }
 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;
 409     /* Save type, key, value */
 410     if (rdbSaveType(fp,vtype) == -1) return -1;
 411     if (rdbSaveStringObject(fp,key) == -1) return -1;
 412     if (rdbSaveObject(fp,val) == -1) return -1;
 413     return 1;
 414 }
 415
 416 /* Save the DB on disk. Return REDIS_ERR on error, REDIS_OK on success */
 417 int 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
 425     if (server.ds_enabled) {
 426         cacheForcePointInTime();
 427         return dsRdbSave(filename);
 428     }
 429
 430     snprintf(tmpfile,256,"temp-%d.rdb", (int) getpid());
 431     fp = fopen(tmpfile,"w");
 432     if (!fp) {
 433         redisLog(REDIS_WARNING, "Failed opening .rdb for saving: %s",
 434             strerror(errno));
 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);
 456             time_t expire;
 457
 458             initStaticStringObject(key,keystr);
 459             expire = getExpire(db,&key);
 460             if (rdbSaveKeyValuePair(fp,&key,o,expire,now) == -1) goto werr;
 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
 484 werr:
 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
 492 int rdbSaveBackground(char *filename) {
 493     pid_t childpid;
 494
 495     if (server.bgsavechildpid != -1 ||
 496         server.bgsavethread != (pthread_t) -1) return REDIS_ERR;
 497
 498     server.dirty_before_bgsave = server.dirty;
 499
 500     if (server.ds_enabled) {
 501         cacheForcePointInTime();
 502         return dsRdbSaveBackground(filename);
 503     }
 504
 505     if ((childpid = fork()) == 0) {
 506         int retval;
 507
 508         /* Child */
 509         if (server.ipfd > 0) close(server.ipfd);
 510         if (server.sofd > 0) close(server.sofd);
 511         retval = rdbSave(filename);
 512         _exit((retval == REDIS_OK) ? 0 : 1);
 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
 528 void rdbRemoveTempFile(pid_t childpid) {
 529     char tmpfile[256];
 530
 531     snprintf(tmpfile,256,"temp-%d.rdb", (int) childpid);
 532     unlink(tmpfile);
 533 }
 534
 535 int rdbLoadType(FILE *fp) {
 536     unsigned char type;
 537     if (fread(&type,1,1,fp) == 0) return -1;
 538     return type;
 539 }
 540
 541 time_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 */
 552 uint32_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. */
 582 robj *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
 609 robj *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);
 622 err:
 623     zfree(c);
 624     sdsfree(val);
 625     return NULL;
 626 }
 627
 628 robj *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
 656 robj *rdbLoadStringObject(FILE *fp) {
 657     return rdbGenericLoadStringObject(fp,0);
 658 }
 659
 660 robj *rdbLoadEncodedStringObject(FILE *fp) {
 661     return rdbGenericLoadStringObject(fp,1);
 662 }
 663
 664 /* For information about double serialization check rdbSaveDoubleValue() */
 665 int 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. */
 684 robj *rdbLoadObject(int type, FILE *fp) {
 685     robj *o, *ele, *dec;
 686     size_t len;
 687     unsigned int i;
 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;
 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
 741         /* Load every single element of the list/set */
 742         for (i = 0; i < len; i++) {
 743             long long llval;
 744             if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
 745             ele = tryObjectEncoding(ele);
 746
 747             if (o->encoding == REDIS_ENCODING_INTSET) {
 748                 /* Fetch integer value from element */
 749                 if (isObjectRepresentableAsLongLong(ele,&llval) == REDIS_OK) {
 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);
 761             } else {
 762                 decrRefCount(ele);
 763             }
 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;
 776             double score;
 777             zskiplistNode *znode;
 778
 779             if ((ele = rdbLoadEncodedStringObject(fp)) == NULL) return NULL;
 780             ele = tryObjectEncoding(ele);
 781             if (rdbLoadDoubleValue(fp,&score) == -1) return NULL;
 782             znode = zslInsert(zs->zsl,score,ele);
 783             dictAdd(zs->dict,ele,&znode->score);
 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         }
 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         /* Convert to real hash if the number of items is too large.
 842          * We don't check the max item size as this requires an O(N)
 843          * scan usually. */
 844         if (zipmapLen(o->ptr) > server.hash_max_zipmap_entries) {
 845             convertToRealHash(o);
 846         }
 847     } else {
 848         redisPanic("Unknown object type");
 849     }
 850     return o;
 851 }
 852
 853 /* Mark that we are loading in the global state and setup the fields
 854  * needed to provide loading stats. */
 855 void startLoading(FILE *fp) {
 856     struct stat sb;
 857
 858     /* Load the DB */
 859     server.loading = 1;
 860     server.loading_start_time = time(NULL);
 861     if (fstat(fileno(fp), &sb) == -1) {
 862         server.loading_total_bytes = 1; /* just to avoid division by zero */
 863     } else {
 864         server.loading_total_bytes = sb.st_size;
 865     }
 866 }
 867
 868 /* Refresh the loading progress info */
 869 void loadingProgress(off_t pos) {
 870     server.loading_loaded_bytes = pos;
 871 }
 872
 873 /* Loading finished */
 874 void stopLoading(void) {
 875     server.loading = 0;
 876 }
 877
 878 int rdbLoad(char *filename) {
 879     FILE *fp;
 880     uint32_t dbid;
 881     int type, retval, rdbver;
 882     redisDb *db = server.db+0;
 883     char buf[1024];
 884     time_t expiretime, now = time(NULL);
 885     long loops = 0;
 886
 887     fp = fopen(filename,"r");
 888     if (!fp) return REDIS_ERR;
 889     if (fread(buf,9,1,fp) == 0) goto eoferr;
 890     buf[9] = '\0';
 891     if (memcmp(buf,"REDIS",5) != 0) {
 892         fclose(fp);
 893         redisLog(REDIS_WARNING,"Wrong signature trying to load DB from file");
 894         return REDIS_ERR;
 895     }
 896     rdbver = atoi(buf+5);
 897     if (rdbver != 1) {
 898         fclose(fp);
 899         redisLog(REDIS_WARNING,"Can't handle RDB format version %d",rdbver);
 900         return REDIS_ERR;
 901     }
 902
 903     startLoading(fp);
 904     while(1) {
 905         robj *key, *val;
 906         expiretime = -1;
 907
 908         /* Serve the clients from time to time */
 909         if (!(loops++ % 1000)) {
 910             loadingProgress(ftello(fp));
 911             aeProcessEvents(server.el, AE_FILE_EVENTS|AE_DONT_WAIT);
 912         }
 913
 914         /* Read type. */
 915         if ((type = rdbLoadType(fp)) == -1) goto eoferr;
 916         if (type == REDIS_EXPIRETIME) {
 917             if ((expiretime = rdbLoadTime(fp)) == -1) goto eoferr;
 918             /* We read the time so we need to read the object type again */
 919             if ((type = rdbLoadType(fp)) == -1) goto eoferr;
 920         }
 921         if (type == REDIS_EOF) break;
 922         /* Handle SELECT DB opcode as a special case */
 923         if (type == REDIS_SELECTDB) {
 924             if ((dbid = rdbLoadLen(fp,NULL)) == REDIS_RDB_LENERR)
 925                 goto eoferr;
 926             if (dbid >= (unsigned)server.dbnum) {
 927                 redisLog(REDIS_WARNING,"FATAL: Data file was created with a Redis server configured to handle more than %d databases. Exiting\n", server.dbnum);
 928                 exit(1);
 929             }
 930             db = server.db+dbid;
 931             continue;
 932         }
 933         /* Read key */
 934         if ((key = rdbLoadStringObject(fp)) == NULL) goto eoferr;
 935         /* Read value */
 936         if ((val = rdbLoadObject(type,fp)) == NULL) goto eoferr;
 937         /* Check if the key already expired */
 938         if (expiretime != -1 && expiretime < now) {
 939             decrRefCount(key);
 940             decrRefCount(val);
 941             continue;
 942         }
 943         /* Add the new object in the hash table */
 944         retval = dbAdd(db,key,val);
 945         if (retval == REDIS_ERR) {
 946             redisLog(REDIS_WARNING,"Loading DB, duplicated key (%s) found! Unrecoverable error, exiting now.", key->ptr);
 947             exit(1);
 948         }
 949         /* Set the expire time if needed */
 950         if (expiretime != -1) setExpire(db,key,expiretime);
 951
 952         decrRefCount(key);
 953     }
 954     fclose(fp);
 955     stopLoading();
 956     return REDIS_OK;
 957
 958 eoferr: /* unexpected end of file is handled here with a fatal exit */
 959     redisLog(REDIS_WARNING,"Short read or OOM loading DB. Unrecoverable error, aborting now.");
 960     exit(1);
 961     return REDIS_ERR; /* Just to avoid warning */
 962 }
 963
 964 /* A background saving child (BGSAVE) terminated its work. Handle this. */
 965 void backgroundSaveDoneHandler(int exitcode, int bysignal) {
 966     if (!bysignal && exitcode == 0) {
 967         redisLog(REDIS_NOTICE,
 968             "Background saving terminated with success");
 969         server.dirty = server.dirty - server.dirty_before_bgsave;
 970         server.lastsave = time(NULL);
 971     } else if (!bysignal && exitcode != 0) {
 972         redisLog(REDIS_WARNING, "Background saving error");
 973     } else {
 974         redisLog(REDIS_WARNING,
 975             "Background saving terminated by signal %d", bysignal);
 976         rdbRemoveTempFile(server.bgsavechildpid);
 977     }
 978     server.bgsavechildpid = -1;
 979     server.bgsavethread = (pthread_t) -1;
 980     server.bgsavethread_state = REDIS_BGSAVE_THREAD_UNACTIVE;
 981     /* Possibly there are slaves waiting for a BGSAVE in order to be served
 982      * (the first stage of SYNC is a bulk transfer of dump.rdb) */
 983     updateSlavesWaitingBgsave(exitcode == 0 ? REDIS_OK : REDIS_ERR);
 984 }
 985
 986 void saveCommand(redisClient *c) {
 987     if (server.bgsavechildpid != -1 || server.bgsavethread != (pthread_t)-1) {
 988         addReplyError(c,"Background save already in progress");
 989         return;
 990     }
 991     if (rdbSave(server.dbfilename) == REDIS_OK) {
 992         addReply(c,shared.ok);
 993     } else {
 994         addReply(c,shared.err);
 995     }
 996 }
 997
 998 void bgsaveCommand(redisClient *c) {
 999     if (server.bgsavechildpid != -1 || server.bgsavethread != (pthread_t)-1) {
1000         addReplyError(c,"Background save already in progress");
1001         return;
1002     }
1003     if (rdbSaveBackground(server.dbfilename) == REDIS_OK) {
1004         addReplyStatus(c,"Background saving started");
1005     } else {
1006         addReply(c,shared.err);
1007     }
1008 }