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