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 debugCommand(redisClient *c) { 256 if (!strcasecmp(c->argv[1]->ptr,"segfault")) { 257 *((char*)-1) = 'x'; 258 } else if (!strcasecmp(c->argv[1]->ptr,"oom")) { 259 void *ptr = zmalloc(ULONG_MAX); /* Should trigger an out of memory. */ 260 zfree(ptr); 261 addReply(c,shared.ok); 262 } else if (!strcasecmp(c->argv[1]->ptr,"assert")) { 263 if (c->argc >= 3) c->argv[2] = tryObjectEncoding(c->argv[2]); 264 redisAssertWithInfo(c,c->argv[0],1 == 2); 265 } else if (!strcasecmp(c->argv[1]->ptr,"reload")) { 266 if (rdbSave(server.rdb_filename) != REDIS_OK) { 267 addReply(c,shared.err); 268 return; 269 } 270 emptyDb(NULL); 271 if (rdbLoad(server.rdb_filename) != REDIS_OK) { 272 addReplyError(c,"Error trying to load the RDB dump"); 273 return; 274 } 275 redisLog(REDIS_WARNING,"DB reloaded by DEBUG RELOAD"); 276 addReply(c,shared.ok); 277 } else if (!strcasecmp(c->argv[1]->ptr,"loadaof")) { 278 emptyDb(NULL); 279 if (loadAppendOnlyFile(server.aof_filename) != REDIS_OK) { 280 addReply(c,shared.err); 281 return; 282 } 283 server.dirty = 0; /* Prevent AOF / replication */ 284 redisLog(REDIS_WARNING,"Append Only File loaded by DEBUG LOADAOF"); 285 addReply(c,shared.ok); 286 } else if (!strcasecmp(c->argv[1]->ptr,"object") && c->argc == 3) { 287 dictEntry *de; 288 robj *val; 289 char *strenc; 290 291 if ((de = dictFind(c->db->dict,c->argv[2]->ptr)) == NULL) { 292 addReply(c,shared.nokeyerr); 293 return; 294 } 295 val = dictGetVal(de); 296 strenc = strEncoding(val->encoding); 297 298 addReplyStatusFormat(c, 299 "Value at:%p refcount:%d " 300 "encoding:%s serializedlength:%lld " 301 "lru:%d lru_seconds_idle:%llu", 302 (void*)val, val->refcount, 303 strenc, (long long) rdbSavedObjectLen(val), 304 val->lru, estimateObjectIdleTime(val)/1000); 305 } else if (!strcasecmp(c->argv[1]->ptr,"sdslen") && c->argc == 3) { 306 dictEntry *de; 307 robj *val; 308 sds key; 309 310 if ((de = dictFind(c->db->dict,c->argv[2]->ptr)) == NULL) { 311 addReply(c,shared.nokeyerr); 312 return; 313 } 314 val = dictGetVal(de); 315 key = dictGetKey(de); 316 317 if (val->type != REDIS_STRING || !sdsEncodedObject(val)) { 318 addReplyError(c,"Not an sds encoded string."); 319 } else { 320 addReplyStatusFormat(c, 321 "key_sds_len:%lld, key_sds_avail:%lld, " 322 "val_sds_len:%lld, val_sds_avail:%lld", 323 (long long) sdslen(key), 324 (long long) sdsavail(key), 325 (long long) sdslen(val->ptr), 326 (long long) sdsavail(val->ptr)); 327 } 328 } else if (!strcasecmp(c->argv[1]->ptr,"populate") && 329 (c->argc == 3 || c->argc == 4)) { 330 long keys, j; 331 robj *key, *val; 332 char buf[128]; 333 334 if (getLongFromObjectOrReply(c, c->argv[2], &keys, NULL) != REDIS_OK) 335 return; 336 dictExpand(c->db->dict,keys); 337 for (j = 0; j < keys; j++) { 338 snprintf(buf,sizeof(buf),"%s:%lu", 339 (c->argc == 3) ? "key" : (char*)c->argv[3]->ptr, j); 340 key = createStringObject(buf,strlen(buf)); 341 if (lookupKeyRead(c->db,key) != NULL) { 342 decrRefCount(key); 343 continue; 344 } 345 snprintf(buf,sizeof(buf),"value:%lu",j); 346 val = createStringObject(buf,strlen(buf)); 347 dbAdd(c->db,key,val); 348 decrRefCount(key); 349 } 350 addReply(c,shared.ok); 351 } else if (!strcasecmp(c->argv[1]->ptr,"digest") && c->argc == 2) { 352 unsigned char digest[20]; 353 sds d = sdsempty(); 354 int j; 355 356 computeDatasetDigest(digest); 357 for (j = 0; j < 20; j++) 358 d = sdscatprintf(d, "%02x",digest[j]); 359 addReplyStatus(c,d); 360 sdsfree(d); 361 } else if (!strcasecmp(c->argv[1]->ptr,"sleep") && c->argc == 3) { 362 double dtime = strtod(c->argv[2]->ptr,NULL); 363 long long utime = dtime*1000000; 364 struct timespec tv; 365 366 tv.tv_sec = utime / 1000000; 367 tv.tv_nsec = (utime % 1000000) * 1000; 368 nanosleep(&tv, NULL); 369 addReply(c,shared.ok); 370 } else if (!strcasecmp(c->argv[1]->ptr,"set-active-expire") && 371 c->argc == 3) 372 { 373 server.active_expire_enabled = atoi(c->argv[2]->ptr); 374 addReply(c,shared.ok); 375 } else if (!strcasecmp(c->argv[1]->ptr,"error") && c->argc == 3) { 376 sds errstr = sdsnewlen("-",1); 377 378 errstr = sdscatsds(errstr,c->argv[2]->ptr); 379 errstr = sdsmapchars(errstr,"\n\r"," ",2); /* no newlines in errors. */ 380 errstr = sdscatlen(errstr,"\r\n",2); 381 addReplySds(c,errstr); 382 } else { 383 addReplyErrorFormat(c, "Unknown DEBUG subcommand or wrong number of arguments for '%s'", 384 (char*)c->argv[1]->ptr); 385 } 386 } 387 388 /* =========================== Crash handling ============================== */ 389 390 void _redisAssert(char *estr, char *file, int line) { 391 bugReportStart(); 392 redisLog(REDIS_WARNING,"=== ASSERTION FAILED ==="); 393 redisLog(REDIS_WARNING,"==> %s:%d '%s' is not true",file,line,estr); 394 #ifdef HAVE_BACKTRACE 395 server.assert_failed = estr; 396 server.assert_file = file; 397 server.assert_line = line; 398 redisLog(REDIS_WARNING,"(forcing SIGSEGV to print the bug report.)"); 399 #endif 400 *((char*)-1) = 'x'; 401 } 402 403 void _redisAssertPrintClientInfo(redisClient *c) { 404 int j; 405 406 bugReportStart(); 407 redisLog(REDIS_WARNING,"=== ASSERTION FAILED CLIENT CONTEXT ==="); 408 redisLog(REDIS_WARNING,"client->flags = %d", c->flags); 409 redisLog(REDIS_WARNING,"client->fd = %d", c->fd); 410 redisLog(REDIS_WARNING,"client->argc = %d", c->argc); 411 for (j=0; j < c->argc; j++) { 412 char buf[128]; 413 char *arg; 414 415 if (c->argv[j]->type == REDIS_STRING && sdsEncodedObject(c->argv[j])) { 416 arg = (char*) c->argv[j]->ptr; 417 } else { 418 snprintf(buf,sizeof(buf),"Object type: %d, encoding: %d", 419 c->argv[j]->type, c->argv[j]->encoding); 420 arg = buf; 421 } 422 redisLog(REDIS_WARNING,"client->argv[%d] = \"%s\" (refcount: %d)", 423 j, arg, c->argv[j]->refcount); 424 } 425 } 426 427 void redisLogObjectDebugInfo(robj *o) { 428 redisLog(REDIS_WARNING,"Object type: %d", o->type); 429 redisLog(REDIS_WARNING,"Object encoding: %d", o->encoding); 430 redisLog(REDIS_WARNING,"Object refcount: %d", o->refcount); 431 if (o->type == REDIS_STRING && sdsEncodedObject(o)) { 432 redisLog(REDIS_WARNING,"Object raw string len: %zu", sdslen(o->ptr)); 433 if (sdslen(o->ptr) < 4096) { 434 sds repr = sdscatrepr(sdsempty(),o->ptr,sdslen(o->ptr)); 435 redisLog(REDIS_WARNING,"Object raw string content: %s", repr); 436 sdsfree(repr); 437 } 438 } else if (o->type == REDIS_LIST) { 439 redisLog(REDIS_WARNING,"List length: %d", (int) listTypeLength(o)); 440 } else if (o->type == REDIS_SET) { 441 redisLog(REDIS_WARNING,"Set size: %d", (int) setTypeSize(o)); 442 } else if (o->type == REDIS_HASH) { 443 redisLog(REDIS_WARNING,"Hash size: %d", (int) hashTypeLength(o)); 444 } else if (o->type == REDIS_ZSET) { 445 redisLog(REDIS_WARNING,"Sorted set size: %d", (int) zsetLength(o)); 446 if (o->encoding == REDIS_ENCODING_SKIPLIST) 447 redisLog(REDIS_WARNING,"Skiplist level: %d", (int) ((zset*)o->ptr)->zsl->level); 448 } 449 } 450 451 void _redisAssertPrintObject(robj *o) { 452 bugReportStart(); 453 redisLog(REDIS_WARNING,"=== ASSERTION FAILED OBJECT CONTEXT ==="); 454 redisLogObjectDebugInfo(o); 455 } 456 457 void _redisAssertWithInfo(redisClient *c, robj *o, char *estr, char *file, int line) { 458 if (c) _redisAssertPrintClientInfo(c); 459 if (o) _redisAssertPrintObject(o); 460 _redisAssert(estr,file,line); 461 } 462 463 void _redisPanic(char *msg, char *file, int line) { 464 bugReportStart(); 465 redisLog(REDIS_WARNING,"------------------------------------------------"); 466 redisLog(REDIS_WARNING,"!!! Software Failure. Press left mouse button to continue"); 467 redisLog(REDIS_WARNING,"Guru Meditation: %s #%s:%d",msg,file,line); 468 #ifdef HAVE_BACKTRACE 469 redisLog(REDIS_WARNING,"(forcing SIGSEGV in order to print the stack trace)"); 470 #endif 471 redisLog(REDIS_WARNING,"------------------------------------------------"); 472 *((char*)-1) = 'x'; 473 } 474 475 void bugReportStart(void) { 476 if (server.bug_report_start == 0) { 477 redisLog(REDIS_WARNING, 478 "\n\n=== REDIS BUG REPORT START: Cut & paste starting from here ==="); 479 server.bug_report_start = 1; 480 } 481 } 482 483 #ifdef HAVE_BACKTRACE 484 static void *getMcontextEip(ucontext_t *uc) { 485 #if defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6) 486 /* OSX < 10.6 */ 487 #if defined(__x86_64__) 488 return (void*) uc->uc_mcontext->__ss.__rip; 489 #elif defined(__i386__) 490 return (void*) uc->uc_mcontext->__ss.__eip; 491 #else 492 return (void*) uc->uc_mcontext->__ss.__srr0; 493 #endif 494 #elif defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6) 495 /* OSX >= 10.6 */ 496 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__) 497 return (void*) uc->uc_mcontext->__ss.__rip; 498 #else 499 return (void*) uc->uc_mcontext->__ss.__eip; 500 #endif 501 #elif defined(__linux__) 502 /* Linux */ 503 #if defined(__i386__) 504 return (void*) uc->uc_mcontext.gregs[14]; /* Linux 32 */ 505 #elif defined(__X86_64__) || defined(__x86_64__) 506 return (void*) uc->uc_mcontext.gregs[16]; /* Linux 64 */ 507 #elif defined(__ia64__) /* Linux IA64 */ 508 return (void*) uc->uc_mcontext.sc_ip; 509 #endif 510 #else 511 return NULL; 512 #endif 513 } 514 515 void logStackContent(void **sp) { 516 int i; 517 for (i = 15; i >= 0; i--) { 518 unsigned long addr = (unsigned long) sp+i; 519 unsigned long val = (unsigned long) sp[i]; 520 521 if (sizeof(long) == 4) 522 redisLog(REDIS_WARNING, "(%08lx) -> %08lx", addr, val); 523 else 524 redisLog(REDIS_WARNING, "(%016lx) -> %016lx", addr, val); 525 } 526 } 527 528 void logRegisters(ucontext_t *uc) { 529 redisLog(REDIS_WARNING, "--- REGISTERS"); 530 531 /* OSX */ 532 #if defined(__APPLE__) && defined(MAC_OS_X_VERSION_10_6) 533 /* OSX AMD64 */ 534 #if defined(_STRUCT_X86_THREAD_STATE64) && !defined(__i386__) 535 redisLog(REDIS_WARNING, 536 "\n" 537 "RAX:%016lx RBX:%016lx\nRCX:%016lx RDX:%016lx\n" 538 "RDI:%016lx RSI:%016lx\nRBP:%016lx RSP:%016lx\n" 539 "R8 :%016lx R9 :%016lx\nR10:%016lx R11:%016lx\n" 540 "R12:%016lx R13:%016lx\nR14:%016lx R15:%016lx\n" 541 "RIP:%016lx EFL:%016lx\nCS :%016lx FS:%016lx GS:%016lx", 542 (unsigned long) uc->uc_mcontext->__ss.__rax, 543 (unsigned long) uc->uc_mcontext->__ss.__rbx, 544 (unsigned long) uc->uc_mcontext->__ss.__rcx, 545 (unsigned long) uc->uc_mcontext->__ss.__rdx, 546 (unsigned long) uc->uc_mcontext->__ss.__rdi, 547 (unsigned long) uc->uc_mcontext->__ss.__rsi, 548 (unsigned long) uc->uc_mcontext->__ss.__rbp, 549 (unsigned long) uc->uc_mcontext->__ss.__rsp, 550 (unsigned long) uc->uc_mcontext->__ss.__r8, 551 (unsigned long) uc->uc_mcontext->__ss.__r9, 552 (unsigned long) uc->uc_mcontext->__ss.__r10, 553 (unsigned long) uc->uc_mcontext->__ss.__r11, 554 (unsigned long) uc->uc_mcontext->__ss.__r12, 555 (unsigned long) uc->uc_mcontext->__ss.__r13, 556 (unsigned long) uc->uc_mcontext->__ss.__r14, 557 (unsigned long) uc->uc_mcontext->__ss.__r15, 558 (unsigned long) uc->uc_mcontext->__ss.__rip, 559 (unsigned long) uc->uc_mcontext->__ss.__rflags, 560 (unsigned long) uc->uc_mcontext->__ss.__cs, 561 (unsigned long) uc->uc_mcontext->__ss.__fs, 562 (unsigned long) uc->uc_mcontext->__ss.__gs 563 ); 564 logStackContent((void**)uc->uc_mcontext->__ss.__rsp); 565 #else 566 /* OSX x86 */ 567 redisLog(REDIS_WARNING, 568 "\n" 569 "EAX:%08lx EBX:%08lx ECX:%08lx EDX:%08lx\n" 570 "EDI:%08lx ESI:%08lx EBP:%08lx ESP:%08lx\n" 571 "SS:%08lx EFL:%08lx EIP:%08lx CS :%08lx\n" 572 "DS:%08lx ES:%08lx FS :%08lx GS :%08lx", 573 (unsigned long) uc->uc_mcontext->__ss.__eax, 574 (unsigned long) uc->uc_mcontext->__ss.__ebx, 575 (unsigned long) uc->uc_mcontext->__ss.__ecx, 576 (unsigned long) uc->uc_mcontext->__ss.__edx, 577 (unsigned long) uc->uc_mcontext->__ss.__edi, 578 (unsigned long) uc->uc_mcontext->__ss.__esi, 579 (unsigned long) uc->uc_mcontext->__ss.__ebp, 580 (unsigned long) uc->uc_mcontext->__ss.__esp, 581 (unsigned long) uc->uc_mcontext->__ss.__ss, 582 (unsigned long) uc->uc_mcontext->__ss.__eflags, 583 (unsigned long) uc->uc_mcontext->__ss.__eip, 584 (unsigned long) uc->uc_mcontext->__ss.__cs, 585 (unsigned long) uc->uc_mcontext->__ss.__ds, 586 (unsigned long) uc->uc_mcontext->__ss.__es, 587 (unsigned long) uc->uc_mcontext->__ss.__fs, 588 (unsigned long) uc->uc_mcontext->__ss.__gs 589 ); 590 logStackContent((void**)uc->uc_mcontext->__ss.__esp); 591 #endif 592 /* Linux */ 593 #elif defined(__linux__) 594 /* Linux x86 */ 595 #if defined(__i386__) 596 redisLog(REDIS_WARNING, 597 "\n" 598 "EAX:%08lx EBX:%08lx ECX:%08lx EDX:%08lx\n" 599 "EDI:%08lx ESI:%08lx EBP:%08lx ESP:%08lx\n" 600 "SS :%08lx EFL:%08lx EIP:%08lx CS:%08lx\n" 601 "DS :%08lx ES :%08lx FS :%08lx GS:%08lx", 602 (unsigned long) uc->uc_mcontext.gregs[11], 603 (unsigned long) uc->uc_mcontext.gregs[8], 604 (unsigned long) uc->uc_mcontext.gregs[10], 605 (unsigned long) uc->uc_mcontext.gregs[9], 606 (unsigned long) uc->uc_mcontext.gregs[4], 607 (unsigned long) uc->uc_mcontext.gregs[5], 608 (unsigned long) uc->uc_mcontext.gregs[6], 609 (unsigned long) uc->uc_mcontext.gregs[7], 610 (unsigned long) uc->uc_mcontext.gregs[18], 611 (unsigned long) uc->uc_mcontext.gregs[17], 612 (unsigned long) uc->uc_mcontext.gregs[14], 613 (unsigned long) uc->uc_mcontext.gregs[15], 614 (unsigned long) uc->uc_mcontext.gregs[3], 615 (unsigned long) uc->uc_mcontext.gregs[2], 616 (unsigned long) uc->uc_mcontext.gregs[1], 617 (unsigned long) uc->uc_mcontext.gregs[0] 618 ); 619 logStackContent((void**)uc->uc_mcontext.gregs[7]); 620 #elif defined(__X86_64__) || defined(__x86_64__) 621 /* Linux AMD64 */ 622 redisLog(REDIS_WARNING, 623 "\n" 624 "RAX:%016lx RBX:%016lx\nRCX:%016lx RDX:%016lx\n" 625 "RDI:%016lx RSI:%016lx\nRBP:%016lx RSP:%016lx\n" 626 "R8 :%016lx R9 :%016lx\nR10:%016lx R11:%016lx\n" 627 "R12:%016lx R13:%016lx\nR14:%016lx R15:%016lx\n" 628 "RIP:%016lx EFL:%016lx\nCSGSFS:%016lx", 629 (unsigned long) uc->uc_mcontext.gregs[13], 630 (unsigned long) uc->uc_mcontext.gregs[11], 631 (unsigned long) uc->uc_mcontext.gregs[14], 632 (unsigned long) uc->uc_mcontext.gregs[12], 633 (unsigned long) uc->uc_mcontext.gregs[8], 634 (unsigned long) uc->uc_mcontext.gregs[9], 635 (unsigned long) uc->uc_mcontext.gregs[10], 636 (unsigned long) uc->uc_mcontext.gregs[15], 637 (unsigned long) uc->uc_mcontext.gregs[0], 638 (unsigned long) uc->uc_mcontext.gregs[1], 639 (unsigned long) uc->uc_mcontext.gregs[2], 640 (unsigned long) uc->uc_mcontext.gregs[3], 641 (unsigned long) uc->uc_mcontext.gregs[4], 642 (unsigned long) uc->uc_mcontext.gregs[5], 643 (unsigned long) uc->uc_mcontext.gregs[6], 644 (unsigned long) uc->uc_mcontext.gregs[7], 645 (unsigned long) uc->uc_mcontext.gregs[16], 646 (unsigned long) uc->uc_mcontext.gregs[17], 647 (unsigned long) uc->uc_mcontext.gregs[18] 648 ); 649 logStackContent((void**)uc->uc_mcontext.gregs[15]); 650 #endif 651 #else 652 redisLog(REDIS_WARNING, 653 " Dumping of registers not supported for this OS/arch"); 654 #endif 655 } 656 657 /* Logs the stack trace using the backtrace() call. This function is designed 658 * to be called from signal handlers safely. */ 659 void logStackTrace(ucontext_t *uc) { 660 void *trace[100]; 661 int trace_size = 0, fd; 662 int log_to_stdout = server.logfile[0] == '\0'; 663 664 /* Open the log file in append mode. */ 665 fd = log_to_stdout ? 666 STDOUT_FILENO : 667 open(server.logfile, O_APPEND|O_CREAT|O_WRONLY, 0644); 668 if (fd == -1) return; 669 670 /* Generate the stack trace */ 671 trace_size = backtrace(trace, 100); 672 673 /* overwrite sigaction with caller's address */ 674 if (getMcontextEip(uc) != NULL) 675 trace[1] = getMcontextEip(uc); 676 677 /* Write symbols to log file */ 678 backtrace_symbols_fd(trace, trace_size, fd); 679 680 /* Cleanup */ 681 if (!log_to_stdout) close(fd); 682 } 683 684 /* Log information about the "current" client, that is, the client that is 685 * currently being served by Redis. May be NULL if Redis is not serving a 686 * client right now. */ 687 void logCurrentClient(void) { 688 if (server.current_client == NULL) return; 689 690 redisClient *cc = server.current_client; 691 sds client; 692 int j; 693 694 redisLog(REDIS_WARNING, "--- CURRENT CLIENT INFO"); 695 client = catClientInfoString(sdsempty(),cc); 696 redisLog(REDIS_WARNING,"client: %s", client); 697 sdsfree(client); 698 for (j = 0; j < cc->argc; j++) { 699 robj *decoded; 700 701 decoded = getDecodedObject(cc->argv[j]); 702 redisLog(REDIS_WARNING,"argv[%d]: '%s'", j, (char*)decoded->ptr); 703 decrRefCount(decoded); 704 } 705 /* Check if the first argument, usually a key, is found inside the 706 * selected DB, and if so print info about the associated object. */ 707 if (cc->argc >= 1) { 708 robj *val, *key; 709 dictEntry *de; 710 711 key = getDecodedObject(cc->argv[1]); 712 de = dictFind(cc->db->dict, key->ptr); 713 if (de) { 714 val = dictGetVal(de); 715 redisLog(REDIS_WARNING,"key '%s' found in DB containing the following object:", (char*)key->ptr); 716 redisLogObjectDebugInfo(val); 717 } 718 decrRefCount(key); 719 } 720 } 721 722 #if defined(HAVE_PROC_MAPS) 723 void memtest_non_destructive_invert(void *addr, size_t size); 724 void memtest_non_destructive_swap(void *addr, size_t size); 725 #define MEMTEST_MAX_REGIONS 128 726 727 int memtest_test_linux_anonymous_maps(void) { 728 FILE *fp = fopen("/proc/self/maps","r"); 729 char line[1024]; 730 size_t start_addr, end_addr, size; 731 size_t start_vect[MEMTEST_MAX_REGIONS]; 732 size_t size_vect[MEMTEST_MAX_REGIONS]; 733 int regions = 0, j; 734 uint64_t crc1 = 0, crc2 = 0, crc3 = 0; 735 736 while(fgets(line,sizeof(line),fp) != NULL) { 737 char *start, *end, *p = line; 738 739 start = p; 740 p = strchr(p,'-'); 741 if (!p) continue; 742 *p++ = '\0'; 743 end = p; 744 p = strchr(p,' '); 745 if (!p) continue; 746 *p++ = '\0'; 747 if (strstr(p,"stack") || 748 strstr(p,"vdso") || 749 strstr(p,"vsyscall")) continue; 750 if (!strstr(p,"00:00")) continue; 751 if (!strstr(p,"rw")) continue; 752 753 start_addr = strtoul(start,NULL,16); 754 end_addr = strtoul(end,NULL,16); 755 size = end_addr-start_addr; 756 757 start_vect[regions] = start_addr; 758 size_vect[regions] = size; 759 printf("Testing %lx %lu\n", (unsigned long) start_vect[regions], 760 (unsigned long) size_vect[regions]); 761 regions++; 762 } 763 764 /* Test all the regions as an unique sequential region. 765 * 1) Take the CRC64 of the memory region. */ 766 for (j = 0; j < regions; j++) { 767 crc1 = crc64(crc1,(void*)start_vect[j],size_vect[j]); 768 } 769 770 /* 2) Invert bits, swap adjacent words, swap again, invert bits. 771 * This is the error amplification step. */ 772 for (j = 0; j < regions; j++) 773 memtest_non_destructive_invert((void*)start_vect[j],size_vect[j]); 774 for (j = 0; j < regions; j++) 775 memtest_non_destructive_swap((void*)start_vect[j],size_vect[j]); 776 for (j = 0; j < regions; j++) 777 memtest_non_destructive_swap((void*)start_vect[j],size_vect[j]); 778 for (j = 0; j < regions; j++) 779 memtest_non_destructive_invert((void*)start_vect[j],size_vect[j]); 780 781 /* 3) Take the CRC64 sum again. */ 782 for (j = 0; j < regions; j++) 783 crc2 = crc64(crc2,(void*)start_vect[j],size_vect[j]); 784 785 /* 4) Swap + Swap again */ 786 for (j = 0; j < regions; j++) 787 memtest_non_destructive_swap((void*)start_vect[j],size_vect[j]); 788 for (j = 0; j < regions; j++) 789 memtest_non_destructive_swap((void*)start_vect[j],size_vect[j]); 790 791 /* 5) Take the CRC64 sum again. */ 792 for (j = 0; j < regions; j++) 793 crc3 = crc64(crc3,(void*)start_vect[j],size_vect[j]); 794 795 /* NOTE: It is very important to close the file descriptor only now 796 * because closing it before may result into unmapping of some memory 797 * region that we are testing. */ 798 fclose(fp); 799 800 /* If the two CRC are not the same, we trapped a memory error. */ 801 return crc1 != crc2 || crc2 != crc3; 802 } 803 #endif 804 805 void sigsegvHandler(int sig, siginfo_t *info, void *secret) { 806 ucontext_t *uc = (ucontext_t*) secret; 807 sds infostring, clients; 808 struct sigaction act; 809 REDIS_NOTUSED(info); 810 811 bugReportStart(); 812 redisLog(REDIS_WARNING, 813 " Redis %s crashed by signal: %d", REDIS_VERSION, sig); 814 redisLog(REDIS_WARNING, 815 " Failed assertion: %s (%s:%d)", server.assert_failed, 816 server.assert_file, server.assert_line); 817 818 /* Log the stack trace */ 819 redisLog(REDIS_WARNING, "--- STACK TRACE"); 820 logStackTrace(uc); 821 822 /* Log INFO and CLIENT LIST */ 823 redisLog(REDIS_WARNING, "--- INFO OUTPUT"); 824 infostring = genRedisInfoString("all"); 825 infostring = sdscatprintf(infostring, "hash_init_value: %u\n", 826 dictGetHashFunctionSeed()); 827 redisLogRaw(REDIS_WARNING, infostring); 828 redisLog(REDIS_WARNING, "--- CLIENT LIST OUTPUT"); 829 clients = getAllClientsInfoString(); 830 redisLogRaw(REDIS_WARNING, clients); 831 sdsfree(infostring); 832 sdsfree(clients); 833 834 /* Log the current client */ 835 logCurrentClient(); 836 837 /* Log dump of processor registers */ 838 logRegisters(uc); 839 840 #if defined(HAVE_PROC_MAPS) 841 /* Test memory */ 842 redisLog(REDIS_WARNING, "--- FAST MEMORY TEST"); 843 bioKillThreads(); 844 if (memtest_test_linux_anonymous_maps()) { 845 redisLog(REDIS_WARNING, 846 "!!! MEMORY ERROR DETECTED! Check your memory ASAP !!!"); 847 } else { 848 redisLog(REDIS_WARNING, 849 "Fast memory test PASSED, however your memory can still be broken. Please run a memory test for several hours if possible."); 850 } 851 #endif 852 853 redisLog(REDIS_WARNING, 854 "\n=== REDIS BUG REPORT END. Make sure to include from START to END. ===\n\n" 855 " Please report the crash by opening an issue on github:\n\n" 856 " http://github.com/antirez/redis/issues\n\n" 857 " Suspect RAM error? Use redis-server --test-memory to verify it.\n\n" 858 ); 859 /* free(messages); Don't call free() with possibly corrupted memory. */ 860 if (server.daemonize) unlink(server.pidfile); 861 862 /* Make sure we exit with the right signal at the end. So for instance 863 * the core will be dumped if enabled. */ 864 sigemptyset (&act.sa_mask); 865 act.sa_flags = SA_NODEFER | SA_ONSTACK | SA_RESETHAND; 866 act.sa_handler = SIG_DFL; 867 sigaction (sig, &act, NULL); 868 kill(getpid(),sig); 869 } 870 #endif /* HAVE_BACKTRACE */ 871 872 /* ==================== Logging functions for debugging ===================== */ 873 874 void redisLogHexDump(int level, char *descr, void *value, size_t len) { 875 char buf[65], *b; 876 unsigned char *v = value; 877 char charset[] = "0123456789abcdef"; 878 879 redisLog(level,"%s (hexdump):", descr); 880 b = buf; 881 while(len) { 882 b[0] = charset[(*v)>>4]; 883 b[1] = charset[(*v)&0xf]; 884 b[2] = '\0'; 885 b += 2; 886 len--; 887 v++; 888 if (b-buf == 64 || len == 0) { 889 redisLogRaw(level|REDIS_LOG_RAW,buf); 890 b = buf; 891 } 892 } 893 redisLogRaw(level|REDIS_LOG_RAW,"\n"); 894 } 895 896 /* =========================== Software Watchdog ============================ */ 897 #include <sys/time.h> 898 899 void watchdogSignalHandler(int sig, siginfo_t *info, void *secret) { 900 #ifdef HAVE_BACKTRACE 901 ucontext_t *uc = (ucontext_t*) secret; 902 #endif 903 REDIS_NOTUSED(info); 904 REDIS_NOTUSED(sig); 905 906 redisLogFromHandler(REDIS_WARNING,"\n--- WATCHDOG TIMER EXPIRED ---"); 907 #ifdef HAVE_BACKTRACE 908 logStackTrace(uc); 909 #else 910 redisLogFromHandler(REDIS_WARNING,"Sorry: no support for backtrace()."); 911 #endif 912 redisLogFromHandler(REDIS_WARNING,"--------\n"); 913 } 914 915 /* Schedule a SIGALRM delivery after the specified period in milliseconds. 916 * If a timer is already scheduled, this function will re-schedule it to the 917 * specified time. If period is 0 the current timer is disabled. */ 918 void watchdogScheduleSignal(int period) { 919 struct itimerval it; 920 921 /* Will stop the timer if period is 0. */ 922 it.it_value.tv_sec = period/1000; 923 it.it_value.tv_usec = (period%1000)*1000; 924 /* Don't automatically restart. */ 925 it.it_interval.tv_sec = 0; 926 it.it_interval.tv_usec = 0; 927 setitimer(ITIMER_REAL, &it, NULL); 928 } 929 930 /* Enable the software watchdog with the specified period in milliseconds. */ 931 void enableWatchdog(int period) { 932 int min_period; 933 934 if (server.watchdog_period == 0) { 935 struct sigaction act; 936 937 /* Watchdog was actually disabled, so we have to setup the signal 938 * handler. */ 939 sigemptyset(&act.sa_mask); 940 act.sa_flags = SA_ONSTACK | SA_SIGINFO; 941 act.sa_sigaction = watchdogSignalHandler; 942 sigaction(SIGALRM, &act, NULL); 943 } 944 /* If the configured period is smaller than twice the timer period, it is 945 * too short for the software watchdog to work reliably. Fix it now 946 * if needed. */ 947 min_period = (1000/server.hz)*2; 948 if (period < min_period) period = min_period; 949 watchdogScheduleSignal(period); /* Adjust the current timer. */ 950 server.watchdog_period = period; 951 } 952 953 /* Disable the software watchdog. */ 954 void disableWatchdog(void) { 955 struct sigaction act; 956 if (server.watchdog_period == 0) return; /* Already disabled. */ 957 watchdogScheduleSignal(0); /* Stop the current timer. */ 958 959 /* Set the signal handler to SIG_IGN, this will also remove pending 960 * signals from the queue. */ 961 sigemptyset(&act.sa_mask); 962 act.sa_flags = 0; 963 act.sa_handler = SIG_IGN; 964 sigaction(SIGALRM, &act, NULL); 965 server.watchdog_period = 0; 966 } 967