contrib/compiler-rt/lib/interception/interception_win.cc

   1 //===-- interception_linux.cc -----------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file is a part of AddressSanitizer, an address sanity checker.
  11 //
  12 // Windows-specific interception methods.
  13 //
  14 // This file is implementing several hooking techniques to intercept calls
  15 // to functions. The hooks are dynamically installed by modifying the assembly
  16 // code.
  17 //
  18 // The hooking techniques are making assumptions on the way the code is
  19 // generated and are safe under these assumptions.
  20 //
  21 // On 64-bit architecture, there is no direct 64-bit jump instruction. To allow
  22 // arbitrary branching on the whole memory space, the notion of trampoline
  23 // region is used. A trampoline region is a memory space withing 2G boundary
  24 // where it is safe to add custom assembly code to build 64-bit jumps.
  25 //
  26 // Hooking techniques
  27 // ==================
  28 //
  29 // 1) Detour
  30 //
  31 //    The Detour hooking technique is assuming the presence of an header with
  32 //    padding and an overridable 2-bytes nop instruction (mov edi, edi). The
  33 //    nop instruction can safely be replaced by a 2-bytes jump without any need
  34 //    to save the instruction. A jump to the target is encoded in the function
  35 //    header and the nop instruction is replaced by a short jump to the header.
  36 //
  37 //        head:  5 x nop                 head:  jmp <hook>
  38 //        func:  mov edi, edi    -->     func:  jmp short <head>
  39 //               [...]                   real:  [...]
  40 //
  41 //    This technique is only implemented on 32-bit architecture.
  42 //    Most of the time, Windows API are hookable with the detour technique.
  43 //
  44 // 2) Redirect Jump
  45 //
  46 //    The redirect jump is applicable when the first instruction is a direct
  47 //    jump. The instruction is replaced by jump to the hook.
  48 //
  49 //        func:  jmp <label>     -->     func:  jmp <hook>
  50 //
  51 //    On an 64-bit architecture, a trampoline is inserted.
  52 //
  53 //        func:  jmp <label>     -->     func:  jmp <tramp>
  54 //                                              [...]
  55 //
  56 //                                   [trampoline]
  57 //                                      tramp:  jmp QWORD [addr]
  58 //                                       addr:  .bytes <hook>
  59 //
  60 //    Note: <real> is equilavent to <label>.
  61 //
  62 // 3) HotPatch
  63 //
  64 //    The HotPatch hooking is assuming the presence of an header with padding
  65 //    and a first instruction with at least 2-bytes.
  66 //
  67 //    The reason to enforce the 2-bytes limitation is to provide the minimal
  68 //    space to encode a short jump. HotPatch technique is only rewriting one
  69 //    instruction to avoid breaking a sequence of instructions containing a
  70 //    branching target.
  71 //
  72 //    Assumptions are enforced by MSVC compiler by using the /HOTPATCH flag.
  73 //      see: https://msdn.microsoft.com/en-us/library/ms173507.aspx
  74 //    Default padding length is 5 bytes in 32-bits and 6 bytes in 64-bits.
  75 //
  76 //        head:   5 x nop                head:  jmp <hook>
  77 //        func:   <instr>        -->     func:  jmp short <head>
  78 //                [...]                  body:  [...]
  79 //
  80 //                                   [trampoline]
  81 //                                       real:  <instr>
  82 //                                              jmp <body>
  83 //
  84 //    On an 64-bit architecture:
  85 //
  86 //        head:   6 x nop                head:  jmp QWORD [addr1]
  87 //        func:   <instr>        -->     func:  jmp short <head>
  88 //                [...]                  body:  [...]
  89 //
  90 //                                   [trampoline]
  91 //                                      addr1:  .bytes <hook>
  92 //                                       real:  <instr>
  93 //                                              jmp QWORD [addr2]
  94 //                                      addr2:  .bytes <body>
  95 //
  96 // 4) Trampoline
  97 //
  98 //    The Trampoline hooking technique is the most aggressive one. It is
  99 //    assuming that there is a sequence of instructions that can be safely
 100 //    replaced by a jump (enough room and no incoming branches).
 101 //
 102 //    Unfortunately, these assumptions can't be safely presumed and code may
 103 //    be broken after hooking.
 104 //
 105 //        func:   <instr>        -->     func:  jmp <hook>
 106 //                <instr>
 107 //                [...]                  body:  [...]
 108 //
 109 //                                   [trampoline]
 110 //                                       real:  <instr>
 111 //                                              <instr>
 112 //                                              jmp <body>
 113 //
 114 //    On an 64-bit architecture:
 115 //
 116 //        func:   <instr>        -->     func:  jmp QWORD [addr1]
 117 //                <instr>
 118 //                [...]                  body:  [...]
 119 //
 120 //                                   [trampoline]
 121 //                                      addr1:  .bytes <hook>
 122 //                                       real:  <instr>
 123 //                                              <instr>
 124 //                                              jmp QWORD [addr2]
 125 //                                      addr2:  .bytes <body>
 126 //===----------------------------------------------------------------------===//
 127
 128 #ifdef _WIN32
 129
 130 #include "interception.h"
 131 #include "sanitizer_common/sanitizer_platform.h"
 132 #define WIN32_LEAN_AND_MEAN
 133 #include <windows.h>
 134
 135 namespace __interception {
 136
 137 static const int kAddressLength = FIRST_32_SECOND_64(4, 8);
 138 static const int kJumpInstructionLength = 5;
 139 static const int kShortJumpInstructionLength = 2;
 140 static const int kIndirectJumpInstructionLength = 6;
 141 static const int kBranchLength =
 142     FIRST_32_SECOND_64(kJumpInstructionLength, kIndirectJumpInstructionLength);
 143 static const int kDirectBranchLength = kBranchLength + kAddressLength;
 144
 145 static void InterceptionFailed() {
 146   // Do we have a good way to abort with an error message here?
 147   __debugbreak();
 148 }
 149
 150 static bool DistanceIsWithin2Gig(uptr from, uptr target) {
 151 #if SANITIZER_WINDOWS64
 152   if (from < target)
 153     return target - from <= (uptr)0x7FFFFFFFU;
 154   else
 155     return from - target <= (uptr)0x80000000U;
 156 #else
 157   // In a 32-bit address space, the address calculation will wrap, so this check
 158   // is unnecessary.
 159   return true;
 160 #endif
 161 }
 162
 163 static uptr GetMmapGranularity() {
 164   SYSTEM_INFO si;
 165   GetSystemInfo(&si);
 166   return si.dwAllocationGranularity;
 167 }
 168
 169 static uptr RoundUpTo(uptr size, uptr boundary) {
 170   return (size + boundary - 1) & ~(boundary - 1);
 171 }
 172
 173 // FIXME: internal_str* and internal_mem* functions should be moved from the
 174 // ASan sources into interception/.
 175
 176 static size_t _strlen(const char *str) {
 177   const char* p = str;
 178   while (*p != '\0') ++p;
 179   return p - str;
 180 }
 181
 182 static char* _strchr(char* str, char c) {
 183   while (*str) {
 184     if (*str == c)
 185       return str;
 186     ++str;
 187   }
 188   return nullptr;
 189 }
 190
 191 static void _memset(void *p, int value, size_t sz) {
 192   for (size_t i = 0; i < sz; ++i)
 193     ((char*)p)[i] = (char)value;
 194 }
 195
 196 static void _memcpy(void *dst, void *src, size_t sz) {
 197   char *dst_c = (char*)dst,
 198        *src_c = (char*)src;
 199   for (size_t i = 0; i < sz; ++i)
 200     dst_c[i] = src_c[i];
 201 }
 202
 203 static bool ChangeMemoryProtection(
 204     uptr address, uptr size, DWORD *old_protection) {
 205   return ::VirtualProtect((void*)address, size,
 206                           PAGE_EXECUTE_READWRITE,
 207                           old_protection) != FALSE;
 208 }
 209
 210 static bool RestoreMemoryProtection(
 211     uptr address, uptr size, DWORD old_protection) {
 212   DWORD unused;
 213   return ::VirtualProtect((void*)address, size,
 214                           old_protection,
 215                           &unused) != FALSE;
 216 }
 217
 218 static bool IsMemoryPadding(uptr address, uptr size) {
 219   u8* function = (u8*)address;
 220   for (size_t i = 0; i < size; ++i)
 221     if (function[i] != 0x90 && function[i] != 0xCC)
 222       return false;
 223   return true;
 224 }
 225
 226 static const u8 kHintNop10Bytes[] = {
 227   0x66, 0x66, 0x0F, 0x1F, 0x84,
 228   0x00, 0x00, 0x00, 0x00, 0x00
 229 };
 230
 231 template<class T>
 232 static bool FunctionHasPrefix(uptr address, const T &pattern) {
 233   u8* function = (u8*)address - sizeof(pattern);
 234   for (size_t i = 0; i < sizeof(pattern); ++i)
 235     if (function[i] != pattern[i])
 236       return false;
 237   return true;
 238 }
 239
 240 static bool FunctionHasPadding(uptr address, uptr size) {
 241   if (IsMemoryPadding(address - size, size))
 242     return true;
 243   if (size <= sizeof(kHintNop10Bytes) &&
 244       FunctionHasPrefix(address, kHintNop10Bytes))
 245     return true;
 246   return false;
 247 }
 248
 249 static void WritePadding(uptr from, uptr size) {
 250   _memset((void*)from, 0xCC, (size_t)size);
 251 }
 252
 253 static void WriteJumpInstruction(uptr from, uptr target) {
 254   if (!DistanceIsWithin2Gig(from + kJumpInstructionLength, target))
 255     InterceptionFailed();
 256   ptrdiff_t offset = target - from - kJumpInstructionLength;
 257   *(u8*)from = 0xE9;
 258   *(u32*)(from + 1) = offset;
 259 }
 260
 261 static void WriteShortJumpInstruction(uptr from, uptr target) {
 262   sptr offset = target - from - kShortJumpInstructionLength;
 263   if (offset < -128 || offset > 127)
 264     InterceptionFailed();
 265   *(u8*)from = 0xEB;
 266   *(u8*)(from + 1) = (u8)offset;
 267 }
 268
 269 #if SANITIZER_WINDOWS64
 270 static void WriteIndirectJumpInstruction(uptr from, uptr indirect_target) {
 271   // jmp [rip + <offset>] = FF 25 <offset> where <offset> is a relative
 272   // offset.
 273   // The offset is the distance from then end of the jump instruction to the
 274   // memory location containing the targeted address. The displacement is still
 275   // 32-bit in x64, so indirect_target must be located within +/- 2GB range.
 276   int offset = indirect_target - from - kIndirectJumpInstructionLength;
 277   if (!DistanceIsWithin2Gig(from + kIndirectJumpInstructionLength,
 278                             indirect_target)) {
 279     InterceptionFailed();
 280   }
 281   *(u16*)from = 0x25FF;
 282   *(u32*)(from + 2) = offset;
 283 }
 284 #endif
 285
 286 static void WriteBranch(
 287     uptr from, uptr indirect_target, uptr target) {
 288 #if SANITIZER_WINDOWS64
 289   WriteIndirectJumpInstruction(from, indirect_target);
 290   *(u64*)indirect_target = target;
 291 #else
 292   (void)indirect_target;
 293   WriteJumpInstruction(from, target);
 294 #endif
 295 }
 296
 297 static void WriteDirectBranch(uptr from, uptr target) {
 298 #if SANITIZER_WINDOWS64
 299   // Emit an indirect jump through immediately following bytes:
 300   //   jmp [rip + kBranchLength]
 301   //   .quad <target>
 302   WriteBranch(from, from + kBranchLength, target);
 303 #else
 304   WriteJumpInstruction(from, target);
 305 #endif
 306 }
 307
 308 struct TrampolineMemoryRegion {
 309   uptr content;
 310   uptr allocated_size;
 311   uptr max_size;
 312 };
 313
 314 static const uptr kTrampolineScanLimitRange = 1 << 31;  // 2 gig
 315 static const int kMaxTrampolineRegion = 1024;
 316 static TrampolineMemoryRegion TrampolineRegions[kMaxTrampolineRegion];
 317
 318 static void *AllocateTrampolineRegion(uptr image_address, size_t granularity) {
 319 #if SANITIZER_WINDOWS64
 320   uptr address = image_address;
 321   uptr scanned = 0;
 322   while (scanned < kTrampolineScanLimitRange) {
 323     MEMORY_BASIC_INFORMATION info;
 324     if (!::VirtualQuery((void*)address, &info, sizeof(info)))
 325       return nullptr;
 326
 327     // Check whether a region can be allocated at |address|.
 328     if (info.State == MEM_FREE && info.RegionSize >= granularity) {
 329       void *page = ::VirtualAlloc((void*)RoundUpTo(address, granularity),
 330                                   granularity,
 331                                   MEM_RESERVE | MEM_COMMIT,
 332                                   PAGE_EXECUTE_READWRITE);
 333       return page;
 334     }
 335
 336     // Move to the next region.
 337     address = (uptr)info.BaseAddress + info.RegionSize;
 338     scanned += info.RegionSize;
 339   }
 340   return nullptr;
 341 #else
 342   return ::VirtualAlloc(nullptr,
 343                         granularity,
 344                         MEM_RESERVE | MEM_COMMIT,
 345                         PAGE_EXECUTE_READWRITE);
 346 #endif
 347 }
 348
 349 // Used by unittests to release mapped memory space.
 350 void TestOnlyReleaseTrampolineRegions() {
 351   for (size_t bucket = 0; bucket < kMaxTrampolineRegion; ++bucket) {
 352     TrampolineMemoryRegion *current = &TrampolineRegions[bucket];
 353     if (current->content == 0)
 354       return;
 355     ::VirtualFree((void*)current->content, 0, MEM_RELEASE);
 356     current->content = 0;
 357   }
 358 }
 359
 360 static uptr AllocateMemoryForTrampoline(uptr image_address, size_t size) {
 361   // Find a region within 2G with enough space to allocate |size| bytes.
 362   TrampolineMemoryRegion *region = nullptr;
 363   for (size_t bucket = 0; bucket < kMaxTrampolineRegion; ++bucket) {
 364     TrampolineMemoryRegion* current = &TrampolineRegions[bucket];
 365     if (current->content == 0) {
 366       // No valid region found, allocate a new region.
 367       size_t bucket_size = GetMmapGranularity();
 368       void *content = AllocateTrampolineRegion(image_address, bucket_size);
 369       if (content == nullptr)
 370         return 0U;
 371
 372       current->content = (uptr)content;
 373       current->allocated_size = 0;
 374       current->max_size = bucket_size;
 375       region = current;
 376       break;
 377     } else if (current->max_size - current->allocated_size > size) {
 378 #if SANITIZER_WINDOWS64
 379         // In 64-bits, the memory space must be allocated within 2G boundary.
 380         uptr next_address = current->content + current->allocated_size;
 381         if (next_address < image_address ||
 382             next_address - image_address >= 0x7FFF0000)
 383           continue;
 384 #endif
 385       // The space can be allocated in the current region.
 386       region = current;
 387       break;
 388     }
 389   }
 390
 391   // Failed to find a region.
 392   if (region == nullptr)
 393     return 0U;
 394
 395   // Allocate the space in the current region.
 396   uptr allocated_space = region->content + region->allocated_size;
 397   region->allocated_size += size;
 398   WritePadding(allocated_space, size);
 399
 400   return allocated_space;
 401 }
 402
 403 // Returns 0 on error.
 404 static size_t GetInstructionSize(uptr address, size_t* rel_offset = nullptr) {
 405   switch (*(u64*)address) {
 406     case 0x90909090909006EB:  // stub: jmp over 6 x nop.
 407       return 8;
 408   }
 409
 410   switch (*(u8*)address) {
 411     case 0x90:  // 90 : nop
 412       return 1;
 413
 414     case 0x50:  // push eax / rax
 415     case 0x51:  // push ecx / rcx
 416     case 0x52:  // push edx / rdx
 417     case 0x53:  // push ebx / rbx
 418     case 0x54:  // push esp / rsp
 419     case 0x55:  // push ebp / rbp
 420     case 0x56:  // push esi / rsi
 421     case 0x57:  // push edi / rdi
 422     case 0x5D:  // pop ebp / rbp
 423       return 1;
 424
 425     case 0x6A:  // 6A XX = push XX
 426       return 2;
 427
 428     case 0xb8:  // b8 XX XX XX XX : mov eax, XX XX XX XX
 429     case 0xB9:  // b9 XX XX XX XX : mov ecx, XX XX XX XX
 430       return 5;
 431
 432     // Cannot overwrite control-instruction. Return 0 to indicate failure.
 433     case 0xE9:  // E9 XX XX XX XX : jmp <label>
 434     case 0xE8:  // E8 XX XX XX XX : call <func>
 435     case 0xC3:  // C3 : ret
 436     case 0xEB:  // EB XX : jmp XX (short jump)
 437     case 0x70:  // 7Y YY : jy XX (short conditional jump)
 438     case 0x71:
 439     case 0x72:
 440     case 0x73:
 441     case 0x74:
 442     case 0x75:
 443     case 0x76:
 444     case 0x77:
 445     case 0x78:
 446     case 0x79:
 447     case 0x7A:
 448     case 0x7B:
 449     case 0x7C:
 450     case 0x7D:
 451     case 0x7E:
 452     case 0x7F:
 453       return 0;
 454   }
 455
 456   switch (*(u16*)(address)) {
 457     case 0xFF8B:  // 8B FF : mov edi, edi
 458     case 0xEC8B:  // 8B EC : mov ebp, esp
 459     case 0xc889:  // 89 C8 : mov eax, ecx
 460     case 0xC18B:  // 8B C1 : mov eax, ecx
 461     case 0xC033:  // 33 C0 : xor eax, eax
 462     case 0xC933:  // 33 C9 : xor ecx, ecx
 463     case 0xD233:  // 33 D2 : xor edx, edx
 464       return 2;
 465
 466     // Cannot overwrite control-instruction. Return 0 to indicate failure.
 467     case 0x25FF:  // FF 25 XX XX XX XX : jmp [XXXXXXXX]
 468       return 0;
 469   }
 470
 471   switch (0x00FFFFFF & *(u32*)address) {
 472     case 0x24A48D:  // 8D A4 24 XX XX XX XX : lea esp, [esp + XX XX XX XX]
 473       return 7;
 474   }
 475
 476 #if SANITIZER_WINDOWS64
 477   switch (*(u8*)address) {
 478     case 0xA1:  // A1 XX XX XX XX XX XX XX XX :
 479                 //   movabs eax, dword ptr ds:[XXXXXXXX]
 480       return 9;
 481   }
 482
 483   switch (*(u16*)address) {
 484     case 0x5040:  // push rax
 485     case 0x5140:  // push rcx
 486     case 0x5240:  // push rdx
 487     case 0x5340:  // push rbx
 488     case 0x5440:  // push rsp
 489     case 0x5540:  // push rbp
 490     case 0x5640:  // push rsi
 491     case 0x5740:  // push rdi
 492     case 0x5441:  // push r12
 493     case 0x5541:  // push r13
 494     case 0x5641:  // push r14
 495     case 0x5741:  // push r15
 496     case 0x9066:  // Two-byte NOP
 497       return 2;
 498
 499     case 0x058B:  // 8B 05 XX XX XX XX : mov eax, dword ptr [XX XX XX XX]
 500       if (rel_offset)
 501         *rel_offset = 2;
 502       return 6;
 503   }
 504
 505   switch (0x00FFFFFF & *(u32*)address) {
 506     case 0xe58948:    // 48 8b c4 : mov rbp, rsp
 507     case 0xc18b48:    // 48 8b c1 : mov rax, rcx
 508     case 0xc48b48:    // 48 8b c4 : mov rax, rsp
 509     case 0xd9f748:    // 48 f7 d9 : neg rcx
 510     case 0xd12b48:    // 48 2b d1 : sub rdx, rcx
 511     case 0x07c1f6:    // f6 c1 07 : test cl, 0x7
 512     case 0xc98548:    // 48 85 C9 : test rcx, rcx
 513     case 0xc0854d:    // 4d 85 c0 : test r8, r8
 514     case 0xc2b60f:    // 0f b6 c2 : movzx eax, dl
 515     case 0xc03345:    // 45 33 c0 : xor r8d, r8d
 516     case 0xdb3345:    // 45 33 DB : xor r11d, r11d
 517     case 0xd98b4c:    // 4c 8b d9 : mov r11, rcx
 518     case 0xd28b4c:    // 4c 8b d2 : mov r10, rdx
 519     case 0xc98b4c:    // 4C 8B C9 : mov r9, rcx
 520     case 0xd2b60f:    // 0f b6 d2 : movzx edx, dl
 521     case 0xca2b48:    // 48 2b ca : sub rcx, rdx
 522     case 0x10b70f:    // 0f b7 10 : movzx edx, WORD PTR [rax]
 523     case 0xc00b4d:    // 3d 0b c0 : or r8, r8
 524     case 0xd18b48:    // 48 8b d1 : mov rdx, rcx
 525     case 0xdc8b4c:    // 4c 8b dc : mov r11, rsp
 526     case 0xd18b4c:    // 4c 8b d1 : mov r10, rcx
 527       return 3;
 528
 529     case 0xec8348:    // 48 83 ec XX : sub rsp, XX
 530     case 0xf88349:    // 49 83 f8 XX : cmp r8, XX
 531     case 0x588948:    // 48 89 58 XX : mov QWORD PTR[rax + XX], rbx
 532       return 4;
 533
 534     case 0xec8148:    // 48 81 EC XX XX XX XX : sub rsp, XXXXXXXX
 535       return 7;
 536
 537     case 0x058b48:    // 48 8b 05 XX XX XX XX :
 538                       //   mov rax, QWORD PTR [rip + XXXXXXXX]
 539     case 0x25ff48:    // 48 ff 25 XX XX XX XX :
 540                       //   rex.W jmp QWORD PTR [rip + XXXXXXXX]
 541
 542       // Instructions having offset relative to 'rip' need offset adjustment.
 543       if (rel_offset)
 544         *rel_offset = 3;
 545       return 7;
 546
 547     case 0x2444c7:    // C7 44 24 XX YY YY YY YY
 548                       //   mov dword ptr [rsp + XX], YYYYYYYY
 549       return 8;
 550   }
 551
 552   switch (*(u32*)(address)) {
 553     case 0x24448b48:  // 48 8b 44 24 XX : mov rax, QWORD ptr [rsp + XX]
 554     case 0x246c8948:  // 48 89 6C 24 XX : mov QWORD ptr [rsp + XX], rbp
 555     case 0x245c8948:  // 48 89 5c 24 XX : mov QWORD PTR [rsp + XX], rbx
 556     case 0x24748948:  // 48 89 74 24 XX : mov QWORD PTR [rsp + XX], rsi
 557       return 5;
 558   }
 559
 560 #else
 561
 562   switch (*(u8*)address) {
 563     case 0xA1:  // A1 XX XX XX XX :  mov eax, dword ptr ds:[XXXXXXXX]
 564       return 5;
 565   }
 566   switch (*(u16*)address) {
 567     case 0x458B:  // 8B 45 XX : mov eax, dword ptr [ebp + XX]
 568     case 0x5D8B:  // 8B 5D XX : mov ebx, dword ptr [ebp + XX]
 569     case 0x7D8B:  // 8B 7D XX : mov edi, dword ptr [ebp + XX]
 570     case 0xEC83:  // 83 EC XX : sub esp, XX
 571     case 0x75FF:  // FF 75 XX : push dword ptr [ebp + XX]
 572       return 3;
 573     case 0xC1F7:  // F7 C1 XX YY ZZ WW : test ecx, WWZZYYXX
 574     case 0x25FF:  // FF 25 XX YY ZZ WW : jmp dword ptr ds:[WWZZYYXX]
 575       return 6;
 576     case 0x3D83:  // 83 3D XX YY ZZ WW TT : cmp TT, WWZZYYXX
 577       return 7;
 578     case 0x7D83:  // 83 7D XX YY : cmp dword ptr [ebp + XX], YY
 579       return 4;
 580   }
 581
 582   switch (0x00FFFFFF & *(u32*)address) {
 583     case 0x24448A:  // 8A 44 24 XX : mov eal, dword ptr [esp + XX]
 584     case 0x24448B:  // 8B 44 24 XX : mov eax, dword ptr [esp + XX]
 585     case 0x244C8B:  // 8B 4C 24 XX : mov ecx, dword ptr [esp + XX]
 586     case 0x24548B:  // 8B 54 24 XX : mov edx, dword ptr [esp + XX]
 587     case 0x24748B:  // 8B 74 24 XX : mov esi, dword ptr [esp + XX]
 588     case 0x247C8B:  // 8B 7C 24 XX : mov edi, dword ptr [esp + XX]
 589       return 4;
 590   }
 591
 592   switch (*(u32*)address) {
 593     case 0x2444B60F:  // 0F B6 44 24 XX : movzx eax, byte ptr [esp + XX]
 594       return 5;
 595   }
 596 #endif
 597
 598   // Unknown instruction!
 599   // FIXME: Unknown instruction failures might happen when we add a new
 600   // interceptor or a new compiler version. In either case, they should result
 601   // in visible and readable error messages. However, merely calling abort()
 602   // leads to an infinite recursion in CheckFailed.
 603   InterceptionFailed();
 604   return 0;
 605 }
 606
 607 // Returns 0 on error.
 608 static size_t RoundUpToInstrBoundary(size_t size, uptr address) {
 609   size_t cursor = 0;
 610   while (cursor < size) {
 611     size_t instruction_size = GetInstructionSize(address + cursor);
 612     if (!instruction_size)
 613       return 0;
 614     cursor += instruction_size;
 615   }
 616   return cursor;
 617 }
 618
 619 static bool CopyInstructions(uptr to, uptr from, size_t size) {
 620   size_t cursor = 0;
 621   while (cursor != size) {
 622     size_t rel_offset = 0;
 623     size_t instruction_size = GetInstructionSize(from + cursor, &rel_offset);
 624     _memcpy((void*)(to + cursor), (void*)(from + cursor),
 625             (size_t)instruction_size);
 626     if (rel_offset) {
 627       uptr delta = to - from;
 628       uptr relocated_offset = *(u32*)(to + cursor + rel_offset) - delta;
 629 #if SANITIZER_WINDOWS64
 630       if (relocated_offset + 0x80000000U >= 0xFFFFFFFFU)
 631         return false;
 632 #endif
 633       *(u32*)(to + cursor + rel_offset) = relocated_offset;
 634     }
 635     cursor += instruction_size;
 636   }
 637   return true;
 638 }
 639
 640
 641 #if !SANITIZER_WINDOWS64
 642 bool OverrideFunctionWithDetour(
 643     uptr old_func, uptr new_func, uptr *orig_old_func) {
 644   const int kDetourHeaderLen = 5;
 645   const u16 kDetourInstruction = 0xFF8B;
 646
 647   uptr header = (uptr)old_func - kDetourHeaderLen;
 648   uptr patch_length = kDetourHeaderLen + kShortJumpInstructionLength;
 649
 650   // Validate that the function is hookable.
 651   if (*(u16*)old_func != kDetourInstruction ||
 652       !IsMemoryPadding(header, kDetourHeaderLen))
 653     return false;
 654
 655   // Change memory protection to writable.
 656   DWORD protection = 0;
 657   if (!ChangeMemoryProtection(header, patch_length, &protection))
 658     return false;
 659
 660   // Write a relative jump to the redirected function.
 661   WriteJumpInstruction(header, new_func);
 662
 663   // Write the short jump to the function prefix.
 664   WriteShortJumpInstruction(old_func, header);
 665
 666   // Restore previous memory protection.
 667   if (!RestoreMemoryProtection(header, patch_length, protection))
 668     return false;
 669
 670   if (orig_old_func)
 671     *orig_old_func = old_func + kShortJumpInstructionLength;
 672
 673   return true;
 674 }
 675 #endif
 676
 677 bool OverrideFunctionWithRedirectJump(
 678     uptr old_func, uptr new_func, uptr *orig_old_func) {
 679   // Check whether the first instruction is a relative jump.
 680   if (*(u8*)old_func != 0xE9)
 681     return false;
 682
 683   if (orig_old_func) {
 684     uptr relative_offset = *(u32*)(old_func + 1);
 685     uptr absolute_target = old_func + relative_offset + kJumpInstructionLength;
 686     *orig_old_func = absolute_target;
 687   }
 688
 689 #if SANITIZER_WINDOWS64
 690   // If needed, get memory space for a trampoline jump.
 691   uptr trampoline = AllocateMemoryForTrampoline(old_func, kDirectBranchLength);
 692   if (!trampoline)
 693     return false;
 694   WriteDirectBranch(trampoline, new_func);
 695 #endif
 696
 697   // Change memory protection to writable.
 698   DWORD protection = 0;
 699   if (!ChangeMemoryProtection(old_func, kJumpInstructionLength, &protection))
 700     return false;
 701
 702   // Write a relative jump to the redirected function.
 703   WriteJumpInstruction(old_func, FIRST_32_SECOND_64(new_func, trampoline));
 704
 705   // Restore previous memory protection.
 706   if (!RestoreMemoryProtection(old_func, kJumpInstructionLength, protection))
 707     return false;
 708
 709   return true;
 710 }
 711
 712 bool OverrideFunctionWithHotPatch(
 713     uptr old_func, uptr new_func, uptr *orig_old_func) {
 714   const int kHotPatchHeaderLen = kBranchLength;
 715
 716   uptr header = (uptr)old_func - kHotPatchHeaderLen;
 717   uptr patch_length = kHotPatchHeaderLen + kShortJumpInstructionLength;
 718
 719   // Validate that the function is hot patchable.
 720   size_t instruction_size = GetInstructionSize(old_func);
 721   if (instruction_size < kShortJumpInstructionLength ||
 722       !FunctionHasPadding(old_func, kHotPatchHeaderLen))
 723     return false;
 724
 725   if (orig_old_func) {
 726     // Put the needed instructions into the trampoline bytes.
 727     uptr trampoline_length = instruction_size + kDirectBranchLength;
 728     uptr trampoline = AllocateMemoryForTrampoline(old_func, trampoline_length);
 729     if (!trampoline)
 730       return false;
 731     if (!CopyInstructions(trampoline, old_func, instruction_size))
 732       return false;
 733     WriteDirectBranch(trampoline + instruction_size,
 734                       old_func + instruction_size);
 735     *orig_old_func = trampoline;
 736   }
 737
 738   // If needed, get memory space for indirect address.
 739   uptr indirect_address = 0;
 740 #if SANITIZER_WINDOWS64
 741   indirect_address = AllocateMemoryForTrampoline(old_func, kAddressLength);
 742   if (!indirect_address)
 743     return false;
 744 #endif
 745
 746   // Change memory protection to writable.
 747   DWORD protection = 0;
 748   if (!ChangeMemoryProtection(header, patch_length, &protection))
 749     return false;
 750
 751   // Write jumps to the redirected function.
 752   WriteBranch(header, indirect_address, new_func);
 753   WriteShortJumpInstruction(old_func, header);
 754
 755   // Restore previous memory protection.
 756   if (!RestoreMemoryProtection(header, patch_length, protection))
 757     return false;
 758
 759   return true;
 760 }
 761
 762 bool OverrideFunctionWithTrampoline(
 763     uptr old_func, uptr new_func, uptr *orig_old_func) {
 764
 765   size_t instructions_length = kBranchLength;
 766   size_t padding_length = 0;
 767   uptr indirect_address = 0;
 768
 769   if (orig_old_func) {
 770     // Find out the number of bytes of the instructions we need to copy
 771     // to the trampoline.
 772     instructions_length = RoundUpToInstrBoundary(kBranchLength, old_func);
 773     if (!instructions_length)
 774       return false;
 775
 776     // Put the needed instructions into the trampoline bytes.
 777     uptr trampoline_length = instructions_length + kDirectBranchLength;
 778     uptr trampoline = AllocateMemoryForTrampoline(old_func, trampoline_length);
 779     if (!trampoline)
 780       return false;
 781     if (!CopyInstructions(trampoline, old_func, instructions_length))
 782       return false;
 783     WriteDirectBranch(trampoline + instructions_length,
 784                       old_func + instructions_length);
 785     *orig_old_func = trampoline;
 786   }
 787
 788 #if SANITIZER_WINDOWS64
 789   // Check if the targeted address can be encoded in the function padding.
 790   // Otherwise, allocate it in the trampoline region.
 791   if (IsMemoryPadding(old_func - kAddressLength, kAddressLength)) {
 792     indirect_address = old_func - kAddressLength;
 793     padding_length = kAddressLength;
 794   } else {
 795     indirect_address = AllocateMemoryForTrampoline(old_func, kAddressLength);
 796     if (!indirect_address)
 797       return false;
 798   }
 799 #endif
 800
 801   // Change memory protection to writable.
 802   uptr patch_address = old_func - padding_length;
 803   uptr patch_length = instructions_length + padding_length;
 804   DWORD protection = 0;
 805   if (!ChangeMemoryProtection(patch_address, patch_length, &protection))
 806     return false;
 807
 808   // Patch the original function.
 809   WriteBranch(old_func, indirect_address, new_func);
 810
 811   // Restore previous memory protection.
 812   if (!RestoreMemoryProtection(patch_address, patch_length, protection))
 813     return false;
 814
 815   return true;
 816 }
 817
 818 bool OverrideFunction(
 819     uptr old_func, uptr new_func, uptr *orig_old_func) {
 820 #if !SANITIZER_WINDOWS64
 821   if (OverrideFunctionWithDetour(old_func, new_func, orig_old_func))
 822     return true;
 823 #endif
 824   if (OverrideFunctionWithRedirectJump(old_func, new_func, orig_old_func))
 825     return true;
 826   if (OverrideFunctionWithHotPatch(old_func, new_func, orig_old_func))
 827     return true;
 828   if (OverrideFunctionWithTrampoline(old_func, new_func, orig_old_func))
 829     return true;
 830   return false;
 831 }
 832
 833 static void **InterestingDLLsAvailable() {
 834   static const char *InterestingDLLs[] = {
 835       "kernel32.dll",
 836       "msvcr110.dll",      // VS2012
 837       "msvcr120.dll",      // VS2013
 838       "vcruntime140.dll",  // VS2015
 839       "ucrtbase.dll",      // Universal CRT
 840       // NTDLL should go last as it exports some functions that we should
 841       // override in the CRT [presumably only used internally].
 842       "ntdll.dll", NULL};
 843   static void *result[ARRAY_SIZE(InterestingDLLs)] = { 0 };
 844   if (!result[0]) {
 845     for (size_t i = 0, j = 0; InterestingDLLs[i]; ++i) {
 846       if (HMODULE h = GetModuleHandleA(InterestingDLLs[i]))
 847         result[j++] = (void *)h;
 848     }
 849   }
 850   return &result[0];
 851 }
 852
 853 namespace {
 854 // Utility for reading loaded PE images.
 855 template <typename T> class RVAPtr {
 856  public:
 857   RVAPtr(void *module, uptr rva)
 858       : ptr_(reinterpret_cast<T *>(reinterpret_cast<char *>(module) + rva)) {}
 859   operator T *() { return ptr_; }
 860   T *operator->() { return ptr_; }
 861   T *operator++() { return ++ptr_; }
 862
 863  private:
 864   T *ptr_;
 865 };
 866 } // namespace
 867
 868 // Internal implementation of GetProcAddress. At least since Windows 8,
 869 // GetProcAddress appears to initialize DLLs before returning function pointers
 870 // into them. This is problematic for the sanitizers, because they typically
 871 // want to intercept malloc *before* MSVCRT initializes. Our internal
 872 // implementation walks the export list manually without doing initialization.
 873 uptr InternalGetProcAddress(void *module, const char *func_name) {
 874   // Check that the module header is full and present.
 875   RVAPtr<IMAGE_DOS_HEADER> dos_stub(module, 0);
 876   RVAPtr<IMAGE_NT_HEADERS> headers(module, dos_stub->e_lfanew);
 877   if (!module || dos_stub->e_magic != IMAGE_DOS_SIGNATURE || // "MZ"
 878       headers->Signature != IMAGE_NT_SIGNATURE ||           // "PE\0\0"
 879       headers->FileHeader.SizeOfOptionalHeader <
 880           sizeof(IMAGE_OPTIONAL_HEADER)) {
 881     return 0;
 882   }
 883
 884   IMAGE_DATA_DIRECTORY *export_directory =
 885       &headers->OptionalHeader.DataDirectory[IMAGE_DIRECTORY_ENTRY_EXPORT];
 886   if (export_directory->Size == 0)
 887     return 0;
 888   RVAPtr<IMAGE_EXPORT_DIRECTORY> exports(module,
 889                                          export_directory->VirtualAddress);
 890   RVAPtr<DWORD> functions(module, exports->AddressOfFunctions);
 891   RVAPtr<DWORD> names(module, exports->AddressOfNames);
 892   RVAPtr<WORD> ordinals(module, exports->AddressOfNameOrdinals);
 893
 894   for (DWORD i = 0; i < exports->NumberOfNames; i++) {
 895     RVAPtr<char> name(module, names[i]);
 896     if (!strcmp(func_name, name)) {
 897       DWORD index = ordinals[i];
 898       RVAPtr<char> func(module, functions[index]);
 899
 900       // Handle forwarded functions.
 901       DWORD offset = functions[index];
 902       if (offset >= export_directory->VirtualAddress &&
 903           offset < export_directory->VirtualAddress + export_directory->Size) {
 904         // An entry for a forwarded function is a string with the following
 905         // format: "<module> . <function_name>" that is stored into the
 906         // exported directory.
 907         char function_name[256];
 908         size_t funtion_name_length = _strlen(func);
 909         if (funtion_name_length >= sizeof(function_name) - 1)
 910           InterceptionFailed();
 911
 912         _memcpy(function_name, func, funtion_name_length);
 913         function_name[funtion_name_length] = '\0';
 914         char* separator = _strchr(function_name, '.');
 915         if (!separator)
 916           InterceptionFailed();
 917         *separator = '\0';
 918
 919         void* redirected_module = GetModuleHandleA(function_name);
 920         if (!redirected_module)
 921           InterceptionFailed();
 922         return InternalGetProcAddress(redirected_module, separator + 1);
 923       }
 924
 925       return (uptr)(char *)func;
 926     }
 927   }
 928
 929   return 0;
 930 }
 931
 932 bool OverrideFunction(
 933     const char *func_name, uptr new_func, uptr *orig_old_func) {
 934   bool hooked = false;
 935   void **DLLs = InterestingDLLsAvailable();
 936   for (size_t i = 0; DLLs[i]; ++i) {
 937     uptr func_addr = InternalGetProcAddress(DLLs[i], func_name);
 938     if (func_addr &&
 939         OverrideFunction(func_addr, new_func, orig_old_func)) {
 940       hooked = true;
 941     }
 942   }
 943   return hooked;
 944 }
 945
 946 bool OverrideImportedFunction(const char *module_to_patch,
 947                               const char *imported_module,
 948                               const char *function_name, uptr new_function,
 949                               uptr *orig_old_func) {
 950   HMODULE module = GetModuleHandleA(module_to_patch);
 951   if (!module)
 952     return false;
 953
 954   // Check that the module header is full and present.
 955   RVAPtr<IMAGE_DOS_HEADER> dos_stub(module, 0);
 956   RVAPtr<IMAGE_NT_HEADERS> headers(module, dos_stub->e_lfanew);
 957   if (!module || dos_stub->e_magic != IMAGE_DOS_SIGNATURE || // "MZ"
 958       headers->Signature != IMAGE_NT_SIGNATURE ||            // "PE\0\0"
 959       headers->FileHeader.SizeOfOptionalHeader <
 960           sizeof(IMAGE_OPTIONAL_HEADER)) {
 961     return false;
 962   }
 963
 964   IMAGE_DATA_DIRECTORY *import_directory =
 965       &headers->OptionalHeader.DataDirectory[IMAGE_DIRECTORY_ENTRY_IMPORT];
 966
 967   // Iterate the list of imported DLLs. FirstThunk will be null for the last
 968   // entry.
 969   RVAPtr<IMAGE_IMPORT_DESCRIPTOR> imports(module,
 970                                           import_directory->VirtualAddress);
 971   for (; imports->FirstThunk != 0; ++imports) {
 972     RVAPtr<const char> modname(module, imports->Name);
 973     if (_stricmp(&*modname, imported_module) == 0)
 974       break;
 975   }
 976   if (imports->FirstThunk == 0)
 977     return false;
 978
 979   // We have two parallel arrays: the import address table (IAT) and the table
 980   // of names. They start out containing the same data, but the loader rewrites
 981   // the IAT to hold imported addresses and leaves the name table in
 982   // OriginalFirstThunk alone.
 983   RVAPtr<IMAGE_THUNK_DATA> name_table(module, imports->OriginalFirstThunk);
 984   RVAPtr<IMAGE_THUNK_DATA> iat(module, imports->FirstThunk);
 985   for (; name_table->u1.Ordinal != 0; ++name_table, ++iat) {
 986     if (!IMAGE_SNAP_BY_ORDINAL(name_table->u1.Ordinal)) {
 987       RVAPtr<IMAGE_IMPORT_BY_NAME> import_by_name(
 988           module, name_table->u1.ForwarderString);
 989       const char *funcname = &import_by_name->Name[0];
 990       if (strcmp(funcname, function_name) == 0)
 991         break;
 992     }
 993   }
 994   if (name_table->u1.Ordinal == 0)
 995     return false;
 996
 997   // Now we have the correct IAT entry. Do the swap. We have to make the page
 998   // read/write first.
 999   if (orig_old_func)
1000     *orig_old_func = iat->u1.AddressOfData;
1001   DWORD old_prot, unused_prot;
1002   if (!VirtualProtect(&iat->u1.AddressOfData, 4, PAGE_EXECUTE_READWRITE,
1003                       &old_prot))
1004     return false;
1005   iat->u1.AddressOfData = new_function;
1006   if (!VirtualProtect(&iat->u1.AddressOfData, 4, old_prot, &unused_prot))
1007     return false;  // Not clear if this failure bothers us.
1008   return true;
1009 }
1010
1011 }  // namespace __interception
1012
1013 #endif  // _WIN32