1 /* 2 * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * * Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * * Neither the name of Redis nor the names of its contributors may be used 14 * to endorse or promote products derived from this software without 15 * specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 21 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 27 * POSSIBILITY OF SUCH DAMAGE. 28 */ 29 30 #include "redis.h" 31 #include "sha1.h" /* SHA1 is used for DEBUG DIGEST */ 32 #include "crc64.h" 33 34 #include <arpa/inet.h> 35 #include <signal.h> 36 37 #ifdef HAVE_BACKTRACE 38 #include <execinfo.h> 39 #include <ucontext.h> 40 #include <fcntl.h> 41 #include "bio.h" 42 #endif /* HAVE_BACKTRACE */ 43 44 #ifdef __CYGWIN__ 45 #ifndef SA_ONSTACK 46 #define SA_ONSTACK 0x08000000 47 #endif 48 #endif 49 50 /* ================================= Debugging ============================== */ 51 52 /* Compute the sha1 of string at 's' with 'len' bytes long. 53 * The SHA1 is then xored against the string pointed by digest. 54 * Since xor is commutative, this operation is used in order to 55 * "add" digests relative to unordered elements. 56 * 57 * So digest(a,b,c,d) will be the same of digest(b,a,c,d) */ 58 void xorDigest(unsigned char *digest, void *ptr, size_t len) { 59 SHA1_CTX ctx; 60 unsigned char hash[20], *s = ptr; 61 int j; 62 63 SHA1Init(&ctx); 64 SHA1Update(&ctx,s,len); 65 SHA1Final(hash,&ctx); 66 67 for (j = 0; j < 20; j++) 68 digest[j] ^= hash[j]; 69 } 70 71 void xorObjectDigest(unsigned char *digest, robj *o) { 72 o = getDecodedObject(o); 73 xorDigest(digest,o->ptr,sdslen(o->ptr)); 74 decrRefCount(o); 75 } 76 77 /* This function instead of just computing the SHA1 and xoring it 78 * against digest, also perform the digest of "digest" itself and 79 * replace the old value with the new one. 80 * 81 * So the final digest will be: 82 * 83 * digest = SHA1(digest xor SHA1(data)) 84 * 85 * This function is used every time we want to preserve the order so 86 * that digest(a,b,c,d) will be different than digest(b,c,d,a) 87 * 88 * Also note that mixdigest("foo") followed by mixdigest("bar") 89 * will lead to a different digest compared to "fo", "obar". 90 */ 91 void mixDigest(unsigned char *digest, void *ptr, size_t len) { 92 SHA1_CTX ctx; 93 char *s = ptr; 94 95 xorDigest(digest,s,len); 96 SHA1Init(&ctx); 97 SHA1Update(&ctx,digest,20); 98 SHA1Final(digest,&ctx); 99 } 100 101 void mixObjectDigest(unsigned char *digest, robj *o) { 102 o = getDecodedObject(o); 103 mixDigest(digest,o->ptr,sdslen(o->ptr)); 104 decrRefCount(o); 105 } 106 107 /* Compute the dataset digest. Since keys, sets elements, hashes elements 108 * are not ordered, we use a trick: every aggregate digest is the xor 109 * of the digests of their elements. This way the order will not change 110 * the result. For list instead we use a feedback entering the output digest 111 * as input in order to ensure that a different ordered list will result in 112 * a different digest. */ 113 void computeDatasetDigest(unsigned char *final) { 114 unsigned char digest[20]; 115 char buf[128]; 116 dictIterator *di = NULL; 117 dictEntry *de; 118 int j; 119 uint32_t aux; 120 121 memset(final,0,20); /* Start with a clean result */ 122 123 for (j = 0; j < server.dbnum; j++) { 124 redisDb *db = server.db+j; 125 126 if (dictSize(db->dict) == 0) continue; 127 di = dictGetIterator(db->dict); 128 129 /* hash the DB id, so the same dataset moved in a different 130 * DB will lead to a different digest */ 131 aux = htonl(j); 132 mixDigest(final,&aux,sizeof(aux)); 133 134 /* Iterate this DB writing every entry */ 135 while((de = dictNext(di)) != NULL) { 136 sds key; 137 robj *keyobj, *o; 138 long long expiretime; 139 140 memset(digest,0,20); /* This key-val digest */ 141 key = dictGetKey(de); 142 keyobj = createStringObject(key,sdslen(key)); 143 144 mixDigest(digest,key,sdslen(key)); 145 146 o = dictGetVal(de); 147 148 aux = htonl(o->type); 149 mixDigest(digest,&aux,sizeof(aux)); 150 expiretime = getExpire(db,keyobj); 151 152 /* Save the key and associated value */ 153 if (o->type == REDIS_STRING) { 154 mixObjectDigest(digest,o); 155 } else if (o->type == REDIS_LIST) { 156 listTypeIterator *li = listTypeInitIterator(o,0,REDIS_TAIL); 157 listTypeEntry entry; 158 while(listTypeNext(li,&entry)) { 159 robj *eleobj = listTypeGet(&entry); 160 mixObjectDigest(digest,eleobj); 161 decrRefCount(eleobj); 162 } 163 listTypeReleaseIterator(li); 164 } else if (o->type == REDIS_SET) { 165 setTypeIterator *si = setTypeInitIterator(o); 166 robj *ele; 167 while((ele = setTypeNextObject(si)) != NULL) { 168 xorObjectDigest(digest,ele); 169 decrRefCount(ele); 170 } 171 setTypeReleaseIterator(si); 172 } else if (o->type == REDIS_ZSET) { 173 unsigned char eledigest[20]; 174 175 if (o->encoding == REDIS_ENCODING_ZIPLIST) { 176 unsigned char *zl = o->ptr; 177 unsigned char *eptr, *sptr; 178 unsigned char *vstr; 179 unsigned int vlen; 180 long long vll; 181 double score; 182 183 eptr = ziplistIndex(zl,0); 184 redisAssert(eptr != NULL); 185 sptr = ziplistNext(zl,eptr); 186 redisAssert(sptr != NULL); 187 188 while (eptr != NULL) { 189 redisAssert(ziplistGet(eptr,&vstr,&vlen,&vll)); 190 score = zzlGetScore(sptr); 191 192 memset(eledigest,0,20); 193 if (vstr != NULL) { 194 mixDigest(eledigest,vstr,vlen); 195 } else { 196 ll2string(buf,sizeof(buf),vll); 197 mixDigest(eledigest,buf,strlen(buf)); 198 } 199 200 snprintf(buf,sizeof(buf),"%.17g",score); 201 mixDigest(eledigest,buf,strlen(buf)); 202 xorDigest(digest,eledigest,20); 203 zzlNext(zl,&eptr,&sptr); 204 } 205 } else if (o->encoding == REDIS_ENCODING_SKIPLIST) { 206 zset *zs = o->ptr; 207 dictIterator *di = dictGetIterator(zs->dict); 208 dictEntry *de; 209 210 while((de = dictNext(di)) != NULL) { 211 robj *eleobj = dictGetKey(de); 212 double *score = dictGetVal(de); 213 214 snprintf(buf,sizeof(buf),"%.17g",*score); 215 memset(eledigest,0,20); 216 mixObjectDigest(eledigest,eleobj); 217 mixDigest(eledigest,buf,strlen(buf)); 218 xorDigest(digest,eledigest,20); 219 } 220 dictReleaseIterator(di); 221 } else { 222 redisPanic("Unknown sorted set encoding"); 223 } 224 } else if (o->type == REDIS_HASH) { 225 hashTypeIterator *hi; 226 robj *obj; 227 228 hi = hashTypeInitIterator(o); 229 while (hashTypeNext(hi) != REDIS_ERR) { 230 unsigned char eledigest[20]; 231 232 memset(eledigest,0,20); 233 obj = hashTypeCurrentObject(hi,REDIS_HASH_KEY); 234 mixObjectDigest(eledigest,obj); 235 decrRefCount(obj); 236 obj = hashTypeCurrentObject(hi,REDIS_HASH_VALUE); 237 mixObjectDigest(eledigest,obj); 238 decrRefCount(obj); 239 xorDigest(digest,eledigest,20); 240 } 241 hashTypeReleaseIterator(hi); 242 } else { 243 redisPanic("Unknown object type"); 244 } 245 /* If the key has an expire, add it to the mix */ 246 if (expiretime != -1) xorDigest(digest,"!!expire!!",10); 247 /* We can finally xor the key-val digest to the final digest */ 248 xorDigest(final,digest,20); 249 decrRefCount(keyobj); 250 } 251 dictReleaseIterator(di); 252 } 253 } 254 255 void inputCatSds(void *result, const char *str) { 256 /* result is actually a (sds *), so re-cast it here */ 257 sds *info = (sds *)result; 258 *info = sdscat(*info, str); 259 } 260 261 void debugCommand(redisClient *c) { 262 if (!strcasecmp(c->argv[1]->ptr,"segfault")) { 263 *((char*)-1) = 'x'; 264 } else if (!strcasecmp(c->argv[1]->ptr,"oom")) { 265 void *ptr = zmalloc(ULONG_MAX); /* Should trigger an out of memory. */ 266 zfree(ptr); 267 addReply(c,shared.ok); 268 } else if (!strcasecmp(c->argv[1]->ptr,"assert")) { 269 if (c->argc >= 3) c->argv[2] = tryObjectEncoding(c->argv[2]); 270 redisAssertWithInfo(c,c->argv[0],1 == 2); 271 } else if (!strcasecmp(c->argv[1]->ptr,"reload")) { 272 if (rdbSave(server.rdb_filename) != REDIS_OK) { 273 addReply(c,shared.err); 274 return; 275 } 276 emptyDb(NULL); 277 if (rdbLoad(server.rdb_filename) != REDIS_OK) { 278 addReplyError(c,"Error trying to load the RDB dump"); 279 return; 280 } 281 redisLog(REDIS_WARNING,"DB reloaded by DEBUG RELOAD"); 282 addReply(c,shared.ok); 283 } else if (!strcasecmp(c->argv[1]->ptr,"loadaof")) { 284 emptyDb(NULL); 285 if (loadAppendOnlyFile(server.aof_filename) != REDIS_OK) { 286 addReply(c,shared.err); 287 return; 288 } 289 server.dirty = 0; /* Prevent AOF / replication */ 290 redisLog(REDIS_WARNING,"Append Only File loaded by DEBUG LOADAOF"); 291 addReply(c,shared.ok); 292 } else if (!strcasecmp(c->argv[1]->ptr,"object") && c->argc == 3) { 293 dictEntry *de; 294 robj *val; 295 char *strenc; 296 297 if ((de = dictFind(c->db->dict,c->argv[2]->ptr)) == NULL) { 298 addReply(c,shared.nokeyerr); 299 return; 300 } 301 val = dictGetVal(de); 302 strenc = strEncoding(val->encoding); 303 304 char extra[128] = {0}; 305 if (val->encoding == REDIS_ENCODING_QUICKLIST) { 306 char *nextra = extra; 307 int remaining = sizeof(extra); 308 quicklist *ql = val->ptr; 309 /* Add number of quicklist nodes */ 310 int used = snprintf(nextra, remaining, " ql_nodes:%u", ql->len); 311 nextra += used; 312 remaining -= used; 313 /* Add average quicklist fill factor */ 314 double avg = (double)ql->count/ql->len; 315 used = snprintf(nextra, remaining, " ql_avg_node:%.2f", avg); 316 nextra += used; 317 remaining -= used; 318 /* Add quicklist fill level / max ziplist size */ 319 used = snprintf(nextra, remaining, " ql_ziplist_max:%d", ql->fill); 320 nextra += used; 321 remaining -= used; 322 /* Add isCompressed? */ 323 int compressed = ql->compress != 0; 324 used = snprintf(nextra, remaining, " ql_compressed:%d", compressed); 325 nextra += used; 326 remaining -= used; 327 /* Add total uncompressed size */ 328 unsigned long sz = 0; 329 for (quicklistNode *node = ql->head; node; node = node->next) { 330 sz += node->sz; 331 } 332 used = snprintf(nextra, remaining, " ql_uncompressed_size:%lu", sz); 333 nextra += used; 334 remaining -= used; 335 } 336 337 addReplyStatusFormat(c, 338 "Value at:%p refcount:%d " 339 "encoding:%s serializedlength:%zu " 340 "lru:%d lru_seconds_idle:%llu%s", 341 (void*)val, val->refcount, 342 strenc, rdbSavedObjectLen(val), 343 val->lru, estimateObjectIdleTime(val)/1000, extra); 344 } else if (!strcasecmp(c->argv[1]->ptr,"sdslen") && c->argc == 3) { 345 dictEntry *de; 346 robj *val; 347 sds key; 348 349 if ((de = dictFind(c->db->dict,c->argv[2]->ptr)) == NULL) { 350 addReply(c,shared.nokeyerr); 351 return; 352 } 353 val = dictGetVal(de); 354 key = dictGetKey(de); 355 356 if (val->type != REDIS_STRING || !sdsEncodedObject(val)) { 357 addReplyError(c,"Not an sds encoded string."); 358 } else { 359 addReplyStatusFormat(c, 360 "key_sds_len:%lld, key_sds_avail:%lld, " 361 "val_sds_len:%lld, val_sds_avail:%lld", 362 (long long) sdslen(key), 363 (long long) sdsavail(key), 364 (long long) sdslen(val->ptr), 365 (long long) sdsavail(val->ptr)); 366 } 367 } else if (!strcasecmp(c->argv[1]->ptr,"populate") && 368 (c->argc == 3 || c->argc == 4)) { 369 long keys, j; 370 robj *key, *val; 371 char buf[128]; 372 373 if (getLongFromObjectOrReply(c, c->argv[2], &keys, NULL) != REDIS_OK) 374 return; 375 dictExpand(c->db->dict,keys); 376 for (j = 0; j < keys; j++) { 377 snprintf(buf,sizeof(buf),"%s:%lu", 378 (c->argc == 3) ? "key" : (char*)c->argv[3]->ptr, j); 379 key = createStringObject(buf,strlen(buf)); 380 if (lookupKeyWrite(c->db,key) != NULL) { 381 decrRefCount(key); 382 continue; 383 } 384 snprintf(buf,sizeof(buf),"value:%lu",j); 385 val = createStringObject(buf,strlen(buf)); 386 dbAdd(c->db,key,val); 387 decrRefCount(key); 388 } 389 addReply(c,shared.ok); 390 } else if (!strcasecmp(c->argv[1]->ptr,"digest") && c->argc == 2) { 391 unsigned char digest[20]; 392 sds d = sdsempty(); 393 int j; 394 395 computeDatasetDigest(digest); 396 for (j = 0; j < 20; j++) 397 d = sdscatprintf(d, "%02x",digest[j]); 398 addReplyStatus(c,d); 399 sdsfree(d); 400 } else if (!strcasecmp(c->argv[1]->ptr,"sleep") && c->argc == 3) { 401 double dtime = strtod(c->argv[2]->ptr,NULL); 402 long long utime = dtime*1000000; 403 struct timespec tv; 404 405 tv.tv_sec = utime / 1000000; 406 tv.tv_nsec = (utime % 1000000) * 1000; 407 nanosleep(&tv, NULL); 408 addReply(c,shared.ok); 409 } else if (!strcasecmp(c->argv[1]->ptr,"set-active-expire") && 410 c->argc == 3) 411 { 412 server.active_expire_enabled = atoi(c->argv[2]->ptr); 413 addReply(c,shared.ok); 414 } else if (!strcasecmp(c->argv[1]->ptr,"error") && c->argc == 3) { 415 sds errstr = sdsnewlen("-",1); 416 417 errstr = sdscatsds(errstr,c->argv[2]->ptr); 418 errstr = sdsmapchars(errstr,"\n\r"," ",2); /* no newlines in errors. */ 419 errstr = sdscatlen(errstr,"\r\n",2); 420 addReplySds(c,errstr); 421 } else if (!strcasecmp(c->argv[1]->ptr,"structsize") && c->argc == 2) { 422 sds sizes = sdsempty(); 423 sizes = sdscatprintf(sizes,"bits:%d ",(sizeof(void*) == 8)?64:32); 424 sizes = sdscatprintf(sizes,"robj:%d ",(int)sizeof(robj)); 425 sizes = sdscatprintf(sizes,"dictentry:%d ",(int)sizeof(dictEntry)); 426 sizes = sdscatprintf(sizes,"sdshdr5:%d ",(int)sizeof(struct sdshdr5)); 427 sizes = sdscatprintf(sizes,"sdshdr8:%d ",(int)sizeof(struct sdshdr8)); 428 sizes = sdscatprintf(sizes,"sdshdr16:%d ",(int)sizeof(struct sdshdr16)); 429 sizes = sdscatprintf(sizes,"sdshdr32:%d ",(int)sizeof(struct sdshdr32)); 430 sizes = sdscatprintf(sizes,"sdshdr64:%d ",(int)sizeof(struct sdshdr64)); 431 addReplyBulkSds(c,sizes); 432 } else if (!strcasecmp(c->argv[1]->ptr,"htstats") && c->argc == 3) { 433 long dbid; 434 sds stats = sdsempty(); 435 char buf[4096]; 436 437 if (getLongFromObjectOrReply(c, c->argv[2], &dbid, NULL) != REDIS_OK) 438 return; 439 if (dbid < 0 || dbid >= server.dbnum) { 440 addReplyError(c,"Out of range database"); 441 return; 442 } 443 444 stats = sdscatprintf(stats,"[Dictionary HT]\n"); 445 dictGetStats(buf,sizeof(buf),server.db[dbid].dict); 446 stats = sdscat(stats,buf); 447 448 stats = sdscatprintf(stats,"[Expires HT]\n"); 449 dictGetStats(buf,sizeof(buf),server.db[dbid].expires); 450 stats = sdscat(stats,buf); 451 452 addReplyBulkSds(c,stats); 453 } else if (!strcasecmp(c->argv[1]->ptr,"jemalloc") && c->argc == 3) { 454 #if defined(USE_JEMALLOC) 455 if (!strcasecmp(c->argv[2]->ptr, "info")) { 456 sds info = sdsempty(); 457 je_malloc_stats_print(inputCatSds, &info, NULL); 458 addReplyBulkSds(c, info); 459 } else { 460 addReplyErrorFormat(c, "Valid jemalloc debug fields: info"); 461 } 462 #else 463 addReplyErrorFormat(c, "jemalloc support not available"); 464 #endif 465 } else { 466 addReplyErrorFormat(c, "Unknown DEBUG subcommand or wrong number of arguments for '%s'", 467 (char*)c->argv[1]->ptr); 468 } 469 } 470 471 /* =========================== Crash handling ============================== */ 472 473 void _redisAssert(char *estr, char *file, int line) { 474 bugReportStart(); 475 redisLog(REDIS_WARNING,"=== ASSERTION FAILED ==="); 476 redisLog(REDIS_WARNING,"==> %s:%d '%s' is not true",file,line,estr); 477 #ifdef HAVE_BACKTRACE 478 server.assert_failed = estr; 479 server.assert_file = file; 480 server.assert_line = line; 481 redisLog(REDIS_WARNING,"(forcing SIGSEGV to print the bug report.)"); 482 #endif 483 *((char*)-1) = 'x'; 484 } 485 486 void _redisAssertPrintClientInfo(redisClient *c) { 487 int j; 488 489 bugReportStart(); 490 redisLog(REDIS_WARNING,"=== ASSERTION FAILED CLIENT CONTEXT ==="); 491 redisLog(REDIS_WARNING,"client->flags = %d", c->flags); 492 redisLog(REDIS_WARNING,"client->fd = %d", c->fd); 493 redisLog(REDIS_WARNING,"client->argc = %d", c->argc); 494 for (j=0; j < c->argc; j++) { 495 char buf[128]; 496 char *arg; 497 498 if (c->argv[j]->type == REDIS_STRING && sdsEncodedObject(c->argv[j])) { 499 arg = (char*) c->argv[j]->ptr; 500 } else { 501 snprintf(buf,sizeof(buf),"Object type: %d, encoding: %d", 502 c->argv[j]->type, c->argv[j]->encoding); 503 arg = buf; 504 } 505 redisLog(REDIS_WARNING,"client->argv[%d] = \"%s\" (refcount: %d)", 506 j, arg, c->argv[j]->refcount); 507 } 508 } 509 510 void redisLogObjectDebugInfo(robj *o) { 511 redisLog(REDIS_WARNING,"Object type: %d", o->type); 512 redisLog(REDIS_WARNING,"Object encoding: %d", o->encoding); 513 redisLog(REDIS_WARNING,"Object refcount: %d", o->refcount); 514 if (o->type == REDIS_STRING && sdsEncodedObject(o)) { 515 redisLog(REDIS_WARNING,"Object raw string len: %zu", sdslen(o->ptr)); 516 if (sdslen(o->ptr) < 4096) { 517 sds repr = sdscatrepr(sdsempty(),o->ptr,sdslen(o->ptr)); 518 redisLog(REDIS_WARNING,"Object raw string content: %s", repr); 519 sdsfree(repr); 520 } 521 } else if (o->type == REDIS_LIST) { 522 redisLog(REDIS_WARNING,"List length: %d", (int) listTypeLength(o)); 523 } else if (o->type == REDIS_SET) { 524 redisLog(REDIS_WARNING,"Set size: %d", (int) setTypeSize(o)); 525 } else if (o->type == REDIS_HASH) { 526 redisLog(REDIS_WARNING,"Hash size: %d", (int) hashTypeLength(o)); 527 } else if (o->type == REDIS_ZSET) { 528 redisLog(REDIS_WARNING,"Sorted set size: %d", (int) zsetLength(o)); 529 if (o->encoding == REDIS_ENCODING_SKIPLIST) 530 redisLog(REDIS_WARNING,"Skiplist level: %d", (int) ((zset*)o->ptr)->zsl->level); 531 } 532 } 533 534 void _redisAssertPrintObject(robj *o) { 535 bugReportStart(); 536 redisLog(REDIS_WARNING,"=== ASSERTION FAILED OBJECT CONTEXT ==="); 537 redisLogObjectDebugInfo(o); 538 } 539 540 void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line) { 541 if (c) _redisAssertPrintClientInfo(c); 542 if (o) _redisAssertPrintObject(o); 543 _redisAssert(estr,file,line); 544 } 545 546 void _redisPanic(char *msg, char *file, int line) { 547 bugReportStart(); 548 redisLog(REDIS_WARNING,"------------------------------------------------"); 549 redisLog(REDIS_WARNING,"!!! Software Failure. Press left mouse button to continue"); 550 redisLog(REDIS_WARNING,"Guru Meditation: %s #%s:%d",msg,file,line); 551 #ifdef HAVE_BACKTRACE 552 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)"); 553 #endif 554 redisLog(REDIS_WARNING,"------------------------------------------------"); 555 *((char*)-1) = 'x'; 556 } 557 558 void bugReportStart(void) { 559 if (server.bug_report_start == 0) { 560 redisLog(REDIS_WARNING, 561 "\n\n=== REDIS BUG REPORT START: Cut & paste starting from here ==="); 562 server.bug_report_start = 1; 563 } 564 } 565 566 #ifdef HAVE_BACKTRACE 567 static void *getMcontextEip(ucontext_t *uc) { 568 #if defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6) 569 /* OSX < 10.6 */ 570 #if defined(__x86_64__) 571 return (void*) uc->uc_mcontext->__ss.__rip; 572 #elif defined(__i386__) 573 return (void*) uc->uc_mcontext->__ss.__eip; 574 #else 575 return (void*) uc->uc_mcontext->__ss.__srr0; 576 #endif 577 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6) 578 /* OSX >= 10.6 */ 579 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__) 580 return (void*) uc->uc_mcontext->__ss.__rip; 581 #else 582 return (void*) uc->uc_mcontext->__ss.__eip; 583 #endif 584 #elif defined(__linux__) 585 /* Linux */ 586 #if defined(__i386__) 587 return (void*) uc->uc_mcontext.gregs[14]; /* Linux 32 */ 588 #elif defined(__X86_64__) || defined(__x86_64__) 589 return (void*) uc->uc_mcontext.gregs[16]; /* Linux 64 */ 590 #elif defined(__ia64__) /* Linux IA64 */ 591 return (void*) uc->uc_mcontext.sc_ip; 592 #endif 593 #else 594 return NULL; 595 #endif 596 } 597 598 void logStackContent(void **sp) { 599 int i; 600 for (i = 15; i >= 0; i--) { 601 unsigned long addr = (unsigned long) sp+i; 602 unsigned long val = (unsigned long) sp[i]; 603 604 if (sizeof(long) == 4) 605 redisLog(REDIS_WARNING, "(%08lx) -> %08lx", addr, val); 606 else 607 redisLog(REDIS_WARNING, "(%016lx) -> %016lx", addr, val); 608 } 609 } 610 611 void logRegisters(ucontext_t *uc) { 612 redisLog(REDIS_WARNING, "--- REGISTERS"); 613 614 /* OSX */ 615 #if defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6) 616 /* OSX AMD64 */ 617 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__) 618 redisLog(REDIS_WARNING, 619 "\n" 620 "RAX:%016lx RBX:%016lx\nRCX:%016lx RDX:%016lx\n" 621 "RDI:%016lx RSI:%016lx\nRBP:%016lx RSP:%016lx\n" 622 "R8 :%016lx R9 :%016lx\nR10:%016lx R11:%016lx\n" 623 "R12:%016lx R13:%016lx\nR14:%016lx R15:%016lx\n" 624 "RIP:%016lx EFL:%016lx\nCS :%016lx FS:%016lx GS:%016lx", 625 (unsigned long) uc->uc_mcontext->__ss.__rax, 626 (unsigned long) uc->uc_mcontext->__ss.__rbx, 627 (unsigned long) uc->uc_mcontext->__ss.__rcx, 628 (unsigned long) uc->uc_mcontext->__ss.__rdx, 629 (unsigned long) uc->uc_mcontext->__ss.__rdi, 630 (unsigned long) uc->uc_mcontext->__ss.__rsi, 631 (unsigned long) uc->uc_mcontext->__ss.__rbp, 632 (unsigned long) uc->uc_mcontext->__ss.__rsp, 633 (unsigned long) uc->uc_mcontext->__ss.__r8, 634 (unsigned long) uc->uc_mcontext->__ss.__r9, 635 (unsigned long) uc->uc_mcontext->__ss.__r10, 636 (unsigned long) uc->uc_mcontext->__ss.__r11, 637 (unsigned long) uc->uc_mcontext->__ss.__r12, 638 (unsigned long) uc->uc_mcontext->__ss.__r13, 639 (unsigned long) uc->uc_mcontext->__ss.__r14, 640 (unsigned long) uc->uc_mcontext->__ss.__r15, 641 (unsigned long) uc->uc_mcontext->__ss.__rip, 642 (unsigned long) uc->uc_mcontext->__ss.__rflags, 643 (unsigned long) uc->uc_mcontext->__ss.__cs, 644 (unsigned long) uc->uc_mcontext->__ss.__fs, 645 (unsigned long) uc->uc_mcontext->__ss.__gs 646 ); 647 logStackContent((void**)uc->uc_mcontext->__ss.__rsp); 648 #else 649 /* OSX x86 */ 650 redisLog(REDIS_WARNING, 651 "\n" 652 "EAX:%08lx EBX:%08lx ECX:%08lx EDX:%08lx\n" 653 "EDI:%08lx ESI:%08lx EBP:%08lx ESP:%08lx\n" 654 "SS:%08lx EFL:%08lx EIP:%08lx CS :%08lx\n" 655 "DS:%08lx ES:%08lx FS :%08lx GS :%08lx", 656 (unsigned long) uc->uc_mcontext->__ss.__eax, 657 (unsigned long) uc->uc_mcontext->__ss.__ebx, 658 (unsigned long) uc->uc_mcontext->__ss.__ecx, 659 (unsigned long) uc->uc_mcontext->__ss.__edx, 660 (unsigned long) uc->uc_mcontext->__ss.__edi, 661 (unsigned long) uc->uc_mcontext->__ss.__esi, 662 (unsigned long) uc->uc_mcontext->__ss.__ebp, 663 (unsigned long) uc->uc_mcontext->__ss.__esp, 664 (unsigned long) uc->uc_mcontext->__ss.__ss, 665 (unsigned long) uc->uc_mcontext->__ss.__eflags, 666 (unsigned long) uc->uc_mcontext->__ss.__eip, 667 (unsigned long) uc->uc_mcontext->__ss.__cs, 668 (unsigned long) uc->uc_mcontext->__ss.__ds, 669 (unsigned long) uc->uc_mcontext->__ss.__es, 670 (unsigned long) uc->uc_mcontext->__ss.__fs, 671 (unsigned long) uc->uc_mcontext->__ss.__gs 672 ); 673 logStackContent((void**)uc->uc_mcontext->__ss.__esp); 674 #endif 675 /* Linux */ 676 #elif defined(__linux__) 677 /* Linux x86 */ 678 #if defined(__i386__) 679 redisLog(REDIS_WARNING, 680 "\n" 681 "EAX:%08lx EBX:%08lx ECX:%08lx EDX:%08lx\n" 682 "EDI:%08lx ESI:%08lx EBP:%08lx ESP:%08lx\n" 683 "SS :%08lx EFL:%08lx EIP:%08lx CS:%08lx\n" 684 "DS :%08lx ES :%08lx FS :%08lx GS:%08lx", 685 (unsigned long) uc->uc_mcontext.gregs[11], 686 (unsigned long) uc->uc_mcontext.gregs[8], 687 (unsigned long) uc->uc_mcontext.gregs[10], 688 (unsigned long) uc->uc_mcontext.gregs[9], 689 (unsigned long) uc->uc_mcontext.gregs[4], 690 (unsigned long) uc->uc_mcontext.gregs[5], 691 (unsigned long) uc->uc_mcontext.gregs[6], 692 (unsigned long) uc->uc_mcontext.gregs[7], 693 (unsigned long) uc->uc_mcontext.gregs[18], 694 (unsigned long) uc->uc_mcontext.gregs[17], 695 (unsigned long) uc->uc_mcontext.gregs[14], 696 (unsigned long) uc->uc_mcontext.gregs[15], 697 (unsigned long) uc->uc_mcontext.gregs[3], 698 (unsigned long) uc->uc_mcontext.gregs[2], 699 (unsigned long) uc->uc_mcontext.gregs[1], 700 (unsigned long) uc->uc_mcontext.gregs[0] 701 ); 702 logStackContent((void**)uc->uc_mcontext.gregs[7]); 703 #elif defined(__X86_64__) || defined(__x86_64__) 704 /* Linux AMD64 */ 705 redisLog(REDIS_WARNING, 706 "\n" 707 "RAX:%016lx RBX:%016lx\nRCX:%016lx RDX:%016lx\n" 708 "RDI:%016lx RSI:%016lx\nRBP:%016lx RSP:%016lx\n" 709 "R8 :%016lx R9 :%016lx\nR10:%016lx R11:%016lx\n" 710 "R12:%016lx R13:%016lx\nR14:%016lx R15:%016lx\n" 711 "RIP:%016lx EFL:%016lx\nCSGSFS:%016lx", 712 (unsigned long) uc->uc_mcontext.gregs[13], 713 (unsigned long) uc->uc_mcontext.gregs[11], 714 (unsigned long) uc->uc_mcontext.gregs[14], 715 (unsigned long) uc->uc_mcontext.gregs[12], 716 (unsigned long) uc->uc_mcontext.gregs[8], 717 (unsigned long) uc->uc_mcontext.gregs[9], 718 (unsigned long) uc->uc_mcontext.gregs[10], 719 (unsigned long) uc->uc_mcontext.gregs[15], 720 (unsigned long) uc->uc_mcontext.gregs[0], 721 (unsigned long) uc->uc_mcontext.gregs[1], 722 (unsigned long) uc->uc_mcontext.gregs[2], 723 (unsigned long) uc->uc_mcontext.gregs[3], 724 (unsigned long) uc->uc_mcontext.gregs[4], 725 (unsigned long) uc->uc_mcontext.gregs[5], 726 (unsigned long) uc->uc_mcontext.gregs[6], 727 (unsigned long) uc->uc_mcontext.gregs[7], 728 (unsigned long) uc->uc_mcontext.gregs[16], 729 (unsigned long) uc->uc_mcontext.gregs[17], 730 (unsigned long) uc->uc_mcontext.gregs[18] 731 ); 732 logStackContent((void**)uc->uc_mcontext.gregs[15]); 733 #endif 734 #else 735 redisLog(REDIS_WARNING, 736 " Dumping of registers not supported for this OS/arch"); 737 #endif 738 } 739 740 /* Logs the stack trace using the backtrace() call. This function is designed 741 * to be called from signal handlers safely. */ 742 void logStackTrace(ucontext_t *uc) { 743 void *trace[100]; 744 int trace_size = 0, fd; 745 int log_to_stdout = server.logfile[0] == '\0'; 746 747 /* Open the log file in append mode. */ 748 fd = log_to_stdout ? 749 STDOUT_FILENO : 750 open(server.logfile, O_APPEND|O_CREAT|O_WRONLY, 0644); 751 if (fd == -1) return; 752 753 /* Generate the stack trace */ 754 trace_size = backtrace(trace, 100); 755 756 /* overwrite sigaction with caller's address */ 757 if (getMcontextEip(uc) != NULL) 758 trace[1] = getMcontextEip(uc); 759 760 /* Write symbols to log file */ 761 backtrace_symbols_fd(trace, trace_size, fd); 762 763 /* Cleanup */ 764 if (!log_to_stdout) close(fd); 765 } 766 767 /* Log information about the "current" client, that is, the client that is 768 * currently being served by Redis. May be NULL if Redis is not serving a 769 * client right now. */ 770 void logCurrentClient(void) { 771 if (server.current_client == NULL) return; 772 773 redisClient *cc = server.current_client; 774 sds client; 775 int j; 776 777 redisLog(REDIS_WARNING, "--- CURRENT CLIENT INFO"); 778 client = catClientInfoString(sdsempty(),cc); 779 redisLog(REDIS_WARNING,"client: %s", client); 780 sdsfree(client); 781 for (j = 0; j < cc->argc; j++) { 782 robj *decoded; 783 784 decoded = getDecodedObject(cc->argv[j]); 785 redisLog(REDIS_WARNING,"argv[%d]: '%s'", j, (char*)decoded->ptr); 786 decrRefCount(decoded); 787 } 788 /* Check if the first argument, usually a key, is found inside the 789 * selected DB, and if so print info about the associated object. */ 790 if (cc->argc >= 1) { 791 robj *val, *key; 792 dictEntry *de; 793 794 key = getDecodedObject(cc->argv[1]); 795 de = dictFind(cc->db->dict, key->ptr); 796 if (de) { 797 val = dictGetVal(de); 798 redisLog(REDIS_WARNING,"key '%s' found in DB containing the following object:", (char*)key->ptr); 799 redisLogObjectDebugInfo(val); 800 } 801 decrRefCount(key); 802 } 803 } 804 805 #if defined(HAVE_PROC_MAPS) 806 void memtest_non_destructive_invert(void *addr, size_t size); 807 void memtest_non_destructive_swap(void *addr, size_t size); 808 #define MEMTEST_MAX_REGIONS 128 809 810 int memtest_test_linux_anonymous_maps(void) { 811 FILE *fp = fopen("/proc/self/maps","r"); 812 char line[1024]; 813 size_t start_addr, end_addr, size; 814 size_t start_vect[MEMTEST_MAX_REGIONS]; 815 size_t size_vect[MEMTEST_MAX_REGIONS]; 816 int regions = 0, j; 817 uint64_t crc1 = 0, crc2 = 0, crc3 = 0; 818 819 while(fgets(line,sizeof(line),fp) != NULL) { 820 char *start, *end, *p = line; 821 822 start = p; 823 p = strchr(p,'-'); 824 if (!p) continue; 825 *p++ = '\0'; 826 end = p; 827 p = strchr(p,' '); 828 if (!p) continue; 829 *p++ = '\0'; 830 if (strstr(p,"stack") || 831 strstr(p,"vdso") || 832 strstr(p,"vsyscall")) continue; 833 if (!strstr(p,"00:00")) continue; 834 if (!strstr(p,"rw")) continue; 835 836 start_addr = strtoul(start,NULL,16); 837 end_addr = strtoul(end,NULL,16); 838 size = end_addr-start_addr; 839 840 start_vect[regions] = start_addr; 841 size_vect[regions] = size; 842 printf("Testing %lx %lu\n", (unsigned long) start_vect[regions], 843 (unsigned long) size_vect[regions]); 844 regions++; 845 } 846 847 /* Test all the regions as an unique sequential region. 848 * 1) Take the CRC64 of the memory region. */ 849 for (j = 0; j < regions; j++) { 850 crc1 = crc64(crc1,(void*)start_vect[j],size_vect[j]); 851 } 852 853 /* 2) Invert bits, swap adjacent words, swap again, invert bits. 854 * This is the error amplification step. */ 855 for (j = 0; j < regions; j++) 856 memtest_non_destructive_invert((void*)start_vect[j],size_vect[j]); 857 for (j = 0; j < regions; j++) 858 memtest_non_destructive_swap((void*)start_vect[j],size_vect[j]); 859 for (j = 0; j < regions; j++) 860 memtest_non_destructive_swap((void*)start_vect[j],size_vect[j]); 861 for (j = 0; j < regions; j++) 862 memtest_non_destructive_invert((void*)start_vect[j],size_vect[j]); 863 864 /* 3) Take the CRC64 sum again. */ 865 for (j = 0; j < regions; j++) 866 crc2 = crc64(crc2,(void*)start_vect[j],size_vect[j]); 867 868 /* 4) Swap + Swap again */ 869 for (j = 0; j < regions; j++) 870 memtest_non_destructive_swap((void*)start_vect[j],size_vect[j]); 871 for (j = 0; j < regions; j++) 872 memtest_non_destructive_swap((void*)start_vect[j],size_vect[j]); 873 874 /* 5) Take the CRC64 sum again. */ 875 for (j = 0; j < regions; j++) 876 crc3 = crc64(crc3,(void*)start_vect[j],size_vect[j]); 877 878 /* NOTE: It is very important to close the file descriptor only now 879 * because closing it before may result into unmapping of some memory 880 * region that we are testing. */ 881 fclose(fp); 882 883 /* If the two CRC are not the same, we trapped a memory error. */ 884 return crc1 != crc2 || crc2 != crc3; 885 } 886 #endif 887 888 void sigsegvHandler(int sig, siginfo_t *info, void *secret) { 889 ucontext_t *uc = (ucontext_t*) secret; 890 sds infostring, clients; 891 struct sigaction act; 892 REDIS_NOTUSED(info); 893 894 bugReportStart(); 895 redisLog(REDIS_WARNING, 896 " Redis %s crashed by signal: %d", REDIS_VERSION, sig); 897 redisLog(REDIS_WARNING, 898 " Failed assertion: %s (%s:%d)", server.assert_failed, 899 server.assert_file, server.assert_line); 900 901 /* Log the stack trace */ 902 redisLog(REDIS_WARNING, "--- STACK TRACE"); 903 logStackTrace(uc); 904 905 /* Log INFO and CLIENT LIST */ 906 redisLog(REDIS_WARNING, "--- INFO OUTPUT"); 907 infostring = genRedisInfoString("all"); 908 infostring = sdscatprintf(infostring, "hash_init_value: %u\n", 909 dictGetHashFunctionSeed()); 910 redisLogRaw(REDIS_WARNING, infostring); 911 redisLog(REDIS_WARNING, "--- CLIENT LIST OUTPUT"); 912 clients = getAllClientsInfoString(); 913 redisLogRaw(REDIS_WARNING, clients); 914 sdsfree(infostring); 915 sdsfree(clients); 916 917 /* Log the current client */ 918 logCurrentClient(); 919 920 /* Log dump of processor registers */ 921 logRegisters(uc); 922 923 #if defined(HAVE_PROC_MAPS) 924 /* Test memory */ 925 redisLog(REDIS_WARNING, "--- FAST MEMORY TEST"); 926 bioKillThreads(); 927 if (memtest_test_linux_anonymous_maps()) { 928 redisLog(REDIS_WARNING, 929 "!!! MEMORY ERROR DETECTED! Check your memory ASAP !!!"); 930 } else { 931 redisLog(REDIS_WARNING, 932 "Fast memory test PASSED, however your memory can still be broken. Please run a memory test for several hours if possible."); 933 } 934 #endif 935 936 redisLog(REDIS_WARNING, 937 "\n=== REDIS BUG REPORT END. Make sure to include from START to END. ===\n\n" 938 " Please report the crash by opening an issue on github:\n\n" 939 " http://github.com/antirez/redis/issues\n\n" 940 " Suspect RAM error? Use redis-server --test-memory to verify it.\n\n" 941 ); 942 /* free(messages); Don't call free() with possibly corrupted memory. */ 943 if (server.daemonize && server.supervised == 0) unlink(server.pidfile); 944 945 /* Make sure we exit with the right signal at the end. So for instance 946 * the core will be dumped if enabled. */ 947 sigemptyset (&act.sa_mask); 948 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND; 949 act.sa_handler = SIG_DFL; 950 sigaction (sig, &act, NULL); 951 kill(getpid(),sig); 952 } 953 #endif /* HAVE_BACKTRACE */ 954 955 /* ==================== Logging functions for debugging ===================== */ 956 957 void redisLogHexDump(int level, char *descr, void *value, size_t len) { 958 char buf[65], *b; 959 unsigned char *v = value; 960 char charset[] = "0123456789abcdef"; 961 962 redisLog(level,"%s (hexdump):", descr); 963 b = buf; 964 while(len) { 965 b[0] = charset[(*v)>>4]; 966 b[1] = charset[(*v)&0xf]; 967 b[2] = '\0'; 968 b += 2; 969 len--; 970 v++; 971 if (b-buf == 64 || len == 0) { 972 redisLogRaw(level|REDIS_LOG_RAW,buf); 973 b = buf; 974 } 975 } 976 redisLogRaw(level|REDIS_LOG_RAW,"\n"); 977 } 978 979 /* =========================== Software Watchdog ============================ */ 980 #include <sys/time.h> 981 982 void watchdogSignalHandler(int sig, siginfo_t *info, void *secret) { 983 #ifdef HAVE_BACKTRACE 984 ucontext_t *uc = (ucontext_t*) secret; 985 #endif 986 REDIS_NOTUSED(info); 987 REDIS_NOTUSED(sig); 988 989 redisLogFromHandler(REDIS_WARNING,"\n--- WATCHDOG TIMER EXPIRED ---"); 990 #ifdef HAVE_BACKTRACE 991 logStackTrace(uc); 992 #else 993 redisLogFromHandler(REDIS_WARNING,"Sorry: no support for backtrace()."); 994 #endif 995 redisLogFromHandler(REDIS_WARNING,"--------\n"); 996 } 997 998 /* Schedule a SIGALRM delivery after the specified period in milliseconds. 999 * If a timer is already scheduled, this function will re-schedule it to the 1000 * specified time. If period is 0 the current timer is disabled. */ 1001 void watchdogScheduleSignal(int period) { 1002 struct itimerval it; 1003 1004 /* Will stop the timer if period is 0. */ 1005 it.it_value.tv_sec = period/1000; 1006 it.it_value.tv_usec = (period%1000)*1000; 1007 /* Don't automatically restart. */ 1008 it.it_interval.tv_sec = 0; 1009 it.it_interval.tv_usec = 0; 1010 setitimer(ITIMER_REAL, &it, NULL); 1011 } 1012 1013 /* Enable the software watchdog with the specified period in milliseconds. */ 1014 void enableWatchdog(int period) { 1015 int min_period; 1016 1017 if (server.watchdog_period == 0) { 1018 struct sigaction act; 1019 1020 /* Watchdog was actually disabled, so we have to setup the signal 1021 * handler. */ 1022 sigemptyset(&act.sa_mask); 1023 act.sa_flags = SA_ONSTACK | SA_SIGINFO; 1024 act.sa_sigaction = watchdogSignalHandler; 1025 sigaction(SIGALRM, &act, NULL); 1026 } 1027 /* If the configured period is smaller than twice the timer period, it is 1028 * too short for the software watchdog to work reliably. Fix it now 1029 * if needed. */ 1030 min_period = (1000/server.hz)*2; 1031 if (period < min_period) period = min_period; 1032 watchdogScheduleSignal(period); /* Adjust the current timer. */ 1033 server.watchdog_period = period; 1034 } 1035 1036 /* Disable the software watchdog. */ 1037 void disableWatchdog(void) { 1038 struct sigaction act; 1039 if (server.watchdog_period == 0) return; /* Already disabled. */ 1040 watchdogScheduleSignal(0); /* Stop the current timer. */ 1041 1042 /* Set the signal handler to SIG_IGN, this will also remove pending 1043 * signals from the queue. */ 1044 sigemptyset(&act.sa_mask); 1045 act.sa_flags = 0; 1046 act.sa_handler = SIG_IGN; 1047 sigaction(SIGALRM, &act, NULL); 1048 server.watchdog_period = 0; 1049 } 1050