report_generic.c 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * This file contains generic KASAN specific error reporting code.
  4. *
  5. * Copyright (c) 2014 Samsung Electronics Co., Ltd.
  6. * Author: Andrey Ryabinin <[email protected]>
  7. *
  8. * Some code borrowed from https://github.com/xairy/kasan-prototype by
  9. * Andrey Konovalov <[email protected]>
  10. */
  11. #include <linux/bitops.h>
  12. #include <linux/ftrace.h>
  13. #include <linux/init.h>
  14. #include <linux/kernel.h>
  15. #include <linux/mm.h>
  16. #include <linux/printk.h>
  17. #include <linux/sched.h>
  18. #include <linux/sched/task_stack.h>
  19. #include <linux/slab.h>
  20. #include <linux/stackdepot.h>
  21. #include <linux/stacktrace.h>
  22. #include <linux/string.h>
  23. #include <linux/types.h>
  24. #include <linux/kasan.h>
  25. #include <linux/module.h>
  26. #include <asm/sections.h>
  27. #include "kasan.h"
  28. #include "../slab.h"
  29. void *kasan_find_first_bad_addr(void *addr, size_t size)
  30. {
  31. void *p = addr;
  32. if (!addr_has_metadata(p))
  33. return p;
  34. while (p < addr + size && !(*(u8 *)kasan_mem_to_shadow(p)))
  35. p += KASAN_GRANULE_SIZE;
  36. return p;
  37. }
  38. static const char *get_shadow_bug_type(struct kasan_report_info *info)
  39. {
  40. const char *bug_type = "unknown-crash";
  41. u8 *shadow_addr;
  42. shadow_addr = (u8 *)kasan_mem_to_shadow(info->first_bad_addr);
  43. /*
  44. * If shadow byte value is in [0, KASAN_GRANULE_SIZE) we can look
  45. * at the next shadow byte to determine the type of the bad access.
  46. */
  47. if (*shadow_addr > 0 && *shadow_addr <= KASAN_GRANULE_SIZE - 1)
  48. shadow_addr++;
  49. switch (*shadow_addr) {
  50. case 0 ... KASAN_GRANULE_SIZE - 1:
  51. /*
  52. * In theory it's still possible to see these shadow values
  53. * due to a data race in the kernel code.
  54. */
  55. bug_type = "out-of-bounds";
  56. break;
  57. case KASAN_PAGE_REDZONE:
  58. case KASAN_SLAB_REDZONE:
  59. bug_type = "slab-out-of-bounds";
  60. break;
  61. case KASAN_GLOBAL_REDZONE:
  62. bug_type = "global-out-of-bounds";
  63. break;
  64. case KASAN_STACK_LEFT:
  65. case KASAN_STACK_MID:
  66. case KASAN_STACK_RIGHT:
  67. case KASAN_STACK_PARTIAL:
  68. bug_type = "stack-out-of-bounds";
  69. break;
  70. case KASAN_PAGE_FREE:
  71. case KASAN_SLAB_FREE:
  72. case KASAN_SLAB_FREETRACK:
  73. bug_type = "use-after-free";
  74. break;
  75. case KASAN_ALLOCA_LEFT:
  76. case KASAN_ALLOCA_RIGHT:
  77. bug_type = "alloca-out-of-bounds";
  78. break;
  79. case KASAN_VMALLOC_INVALID:
  80. bug_type = "vmalloc-out-of-bounds";
  81. break;
  82. }
  83. return bug_type;
  84. }
  85. static const char *get_wild_bug_type(struct kasan_report_info *info)
  86. {
  87. const char *bug_type = "unknown-crash";
  88. if ((unsigned long)info->access_addr < PAGE_SIZE)
  89. bug_type = "null-ptr-deref";
  90. else if ((unsigned long)info->access_addr < TASK_SIZE)
  91. bug_type = "user-memory-access";
  92. else
  93. bug_type = "wild-memory-access";
  94. return bug_type;
  95. }
  96. static const char *get_bug_type(struct kasan_report_info *info)
  97. {
  98. /*
  99. * If access_size is a negative number, then it has reason to be
  100. * defined as out-of-bounds bug type.
  101. *
  102. * Casting negative numbers to size_t would indeed turn up as
  103. * a large size_t and its value will be larger than ULONG_MAX/2,
  104. * so that this can qualify as out-of-bounds.
  105. */
  106. if (info->access_addr + info->access_size < info->access_addr)
  107. return "out-of-bounds";
  108. if (addr_has_metadata(info->access_addr))
  109. return get_shadow_bug_type(info);
  110. return get_wild_bug_type(info);
  111. }
  112. void kasan_complete_mode_report_info(struct kasan_report_info *info)
  113. {
  114. struct kasan_alloc_meta *alloc_meta;
  115. struct kasan_free_meta *free_meta;
  116. if (!info->bug_type)
  117. info->bug_type = get_bug_type(info);
  118. if (!info->cache || !info->object)
  119. return;
  120. alloc_meta = kasan_get_alloc_meta(info->cache, info->object);
  121. if (alloc_meta)
  122. memcpy(&info->alloc_track, &alloc_meta->alloc_track,
  123. sizeof(info->alloc_track));
  124. if (*(u8 *)kasan_mem_to_shadow(info->object) == KASAN_SLAB_FREETRACK) {
  125. /* Free meta must be present with KASAN_SLAB_FREETRACK. */
  126. free_meta = kasan_get_free_meta(info->cache, info->object);
  127. memcpy(&info->free_track, &free_meta->free_track,
  128. sizeof(info->free_track));
  129. }
  130. }
  131. void kasan_metadata_fetch_row(char *buffer, void *row)
  132. {
  133. memcpy(buffer, kasan_mem_to_shadow(row), META_BYTES_PER_ROW);
  134. }
  135. void kasan_print_aux_stacks(struct kmem_cache *cache, const void *object)
  136. {
  137. struct kasan_alloc_meta *alloc_meta;
  138. alloc_meta = kasan_get_alloc_meta(cache, object);
  139. if (!alloc_meta)
  140. return;
  141. if (alloc_meta->aux_stack[0]) {
  142. pr_err("Last potentially related work creation:\n");
  143. stack_depot_print(alloc_meta->aux_stack[0]);
  144. pr_err("\n");
  145. }
  146. if (alloc_meta->aux_stack[1]) {
  147. pr_err("Second to last potentially related work creation:\n");
  148. stack_depot_print(alloc_meta->aux_stack[1]);
  149. pr_err("\n");
  150. }
  151. }
  152. #ifdef CONFIG_KASAN_STACK
  153. static bool __must_check tokenize_frame_descr(const char **frame_descr,
  154. char *token, size_t max_tok_len,
  155. unsigned long *value)
  156. {
  157. const char *sep = strchr(*frame_descr, ' ');
  158. if (sep == NULL)
  159. sep = *frame_descr + strlen(*frame_descr);
  160. if (token != NULL) {
  161. const size_t tok_len = sep - *frame_descr;
  162. if (tok_len + 1 > max_tok_len) {
  163. pr_err("KASAN internal error: frame description too long: %s\n",
  164. *frame_descr);
  165. return false;
  166. }
  167. /* Copy token (+ 1 byte for '\0'). */
  168. strscpy(token, *frame_descr, tok_len + 1);
  169. }
  170. /* Advance frame_descr past separator. */
  171. *frame_descr = sep + 1;
  172. if (value != NULL && kstrtoul(token, 10, value)) {
  173. pr_err("KASAN internal error: not a valid number: %s\n", token);
  174. return false;
  175. }
  176. return true;
  177. }
  178. static void print_decoded_frame_descr(const char *frame_descr)
  179. {
  180. /*
  181. * We need to parse the following string:
  182. * "n alloc_1 alloc_2 ... alloc_n"
  183. * where alloc_i looks like
  184. * "offset size len name"
  185. * or "offset size len name:line".
  186. */
  187. char token[64];
  188. unsigned long num_objects;
  189. if (!tokenize_frame_descr(&frame_descr, token, sizeof(token),
  190. &num_objects))
  191. return;
  192. pr_err("\n");
  193. pr_err("This frame has %lu %s:\n", num_objects,
  194. num_objects == 1 ? "object" : "objects");
  195. while (num_objects--) {
  196. unsigned long offset;
  197. unsigned long size;
  198. /* access offset */
  199. if (!tokenize_frame_descr(&frame_descr, token, sizeof(token),
  200. &offset))
  201. return;
  202. /* access size */
  203. if (!tokenize_frame_descr(&frame_descr, token, sizeof(token),
  204. &size))
  205. return;
  206. /* name length (unused) */
  207. if (!tokenize_frame_descr(&frame_descr, NULL, 0, NULL))
  208. return;
  209. /* object name */
  210. if (!tokenize_frame_descr(&frame_descr, token, sizeof(token),
  211. NULL))
  212. return;
  213. /* Strip line number; without filename it's not very helpful. */
  214. strreplace(token, ':', '\0');
  215. /* Finally, print object information. */
  216. pr_err(" [%lu, %lu) '%s'", offset, offset + size, token);
  217. }
  218. }
  219. /* Returns true only if the address is on the current task's stack. */
  220. static bool __must_check get_address_stack_frame_info(const void *addr,
  221. unsigned long *offset,
  222. const char **frame_descr,
  223. const void **frame_pc)
  224. {
  225. unsigned long aligned_addr;
  226. unsigned long mem_ptr;
  227. const u8 *shadow_bottom;
  228. const u8 *shadow_ptr;
  229. const unsigned long *frame;
  230. BUILD_BUG_ON(IS_ENABLED(CONFIG_STACK_GROWSUP));
  231. aligned_addr = round_down((unsigned long)addr, sizeof(long));
  232. mem_ptr = round_down(aligned_addr, KASAN_GRANULE_SIZE);
  233. shadow_ptr = kasan_mem_to_shadow((void *)aligned_addr);
  234. shadow_bottom = kasan_mem_to_shadow(end_of_stack(current));
  235. while (shadow_ptr >= shadow_bottom && *shadow_ptr != KASAN_STACK_LEFT) {
  236. shadow_ptr--;
  237. mem_ptr -= KASAN_GRANULE_SIZE;
  238. }
  239. while (shadow_ptr >= shadow_bottom && *shadow_ptr == KASAN_STACK_LEFT) {
  240. shadow_ptr--;
  241. mem_ptr -= KASAN_GRANULE_SIZE;
  242. }
  243. if (shadow_ptr < shadow_bottom)
  244. return false;
  245. frame = (const unsigned long *)(mem_ptr + KASAN_GRANULE_SIZE);
  246. if (frame[0] != KASAN_CURRENT_STACK_FRAME_MAGIC) {
  247. pr_err("KASAN internal error: frame info validation failed; invalid marker: %lu\n",
  248. frame[0]);
  249. return false;
  250. }
  251. *offset = (unsigned long)addr - (unsigned long)frame;
  252. *frame_descr = (const char *)frame[1];
  253. *frame_pc = (void *)frame[2];
  254. return true;
  255. }
  256. void kasan_print_address_stack_frame(const void *addr)
  257. {
  258. unsigned long offset;
  259. const char *frame_descr;
  260. const void *frame_pc;
  261. if (WARN_ON(!object_is_on_stack(addr)))
  262. return;
  263. pr_err("The buggy address belongs to stack of task %s/%d\n",
  264. current->comm, task_pid_nr(current));
  265. if (!get_address_stack_frame_info(addr, &offset, &frame_descr,
  266. &frame_pc))
  267. return;
  268. pr_err(" and is located at offset %lu in frame:\n", offset);
  269. pr_err(" %pS\n", frame_pc);
  270. if (!frame_descr)
  271. return;
  272. print_decoded_frame_descr(frame_descr);
  273. }
  274. #endif /* CONFIG_KASAN_STACK */
  275. #define DEFINE_ASAN_REPORT_LOAD(size) \
  276. void __asan_report_load##size##_noabort(unsigned long addr) \
  277. { \
  278. kasan_report(addr, size, false, _RET_IP_); \
  279. } \
  280. EXPORT_SYMBOL(__asan_report_load##size##_noabort)
  281. #define DEFINE_ASAN_REPORT_STORE(size) \
  282. void __asan_report_store##size##_noabort(unsigned long addr) \
  283. { \
  284. kasan_report(addr, size, true, _RET_IP_); \
  285. } \
  286. EXPORT_SYMBOL(__asan_report_store##size##_noabort)
  287. DEFINE_ASAN_REPORT_LOAD(1);
  288. DEFINE_ASAN_REPORT_LOAD(2);
  289. DEFINE_ASAN_REPORT_LOAD(4);
  290. DEFINE_ASAN_REPORT_LOAD(8);
  291. DEFINE_ASAN_REPORT_LOAD(16);
  292. DEFINE_ASAN_REPORT_STORE(1);
  293. DEFINE_ASAN_REPORT_STORE(2);
  294. DEFINE_ASAN_REPORT_STORE(4);
  295. DEFINE_ASAN_REPORT_STORE(8);
  296. DEFINE_ASAN_REPORT_STORE(16);
  297. void __asan_report_load_n_noabort(unsigned long addr, size_t size)
  298. {
  299. kasan_report(addr, size, false, _RET_IP_);
  300. }
  301. EXPORT_SYMBOL(__asan_report_load_n_noabort);
  302. void __asan_report_store_n_noabort(unsigned long addr, size_t size)
  303. {
  304. kasan_report(addr, size, true, _RET_IP_);
  305. }
  306. EXPORT_SYMBOL(__asan_report_store_n_noabort);