mm/kasan/generic.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * This file contains core generic KASAN code.
   4  *
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  * Author: Andrey Ryabinin <ryabinin.a.a@gmail.com>
   7  *
   8  * Some code borrowed from https://github.com/xairy/kasan-prototype by
   9  *        Andrey Konovalov <andreyknvl@gmail.com>
  10  */
  11
  12 #include <linux/export.h>
  13 #include <linux/interrupt.h>
  14 #include <linux/init.h>
  15 #include <linux/kasan.h>
  16 #include <linux/kernel.h>
  17 #include <linux/kfence.h>
  18 #include <linux/kmemleak.h>
  19 #include <linux/linkage.h>
  20 #include <linux/memblock.h>
  21 #include <linux/memory.h>
  22 #include <linux/mm.h>
  23 #include <linux/module.h>
  24 #include <linux/printk.h>
  25 #include <linux/sched.h>
  26 #include <linux/sched/task_stack.h>
  27 #include <linux/slab.h>
  28 #include <linux/spinlock.h>
  29 #include <linux/stackdepot.h>
  30 #include <linux/stacktrace.h>
  31 #include <linux/string.h>
  32 #include <linux/types.h>
  33 #include <linux/vmalloc.h>
  34 #include <linux/bug.h>
  35
  36 #include "kasan.h"
  37 #include "../slab.h"
  38
  39 /*
  40  * All functions below always inlined so compiler could
  41  * perform better optimizations in each of __asan_loadX/__assn_storeX
  42  * depending on memory access size X.
  43  */
  44
  45 static __always_inline bool memory_is_poisoned_1(const void *addr)
  46 {
  47         s8 shadow_value = *(s8 *)kasan_mem_to_shadow(addr);
  48
  49         if (unlikely(shadow_value)) {
  50                 s8 last_accessible_byte = (unsigned long)addr & KASAN_GRANULE_MASK;
  51                 return unlikely(last_accessible_byte >= shadow_value);
  52         }
  53
  54         return false;
  55 }
  56
  57 static __always_inline bool memory_is_poisoned_2_4_8(const void *addr,
  58                                                 unsigned long size)
  59 {
  60         u8 *shadow_addr = (u8 *)kasan_mem_to_shadow(addr);
  61
  62         /*
  63          * Access crosses 8(shadow size)-byte boundary. Such access maps
  64          * into 2 shadow bytes, so we need to check them both.
  65          */
  66         if (unlikely((((unsigned long)addr + size - 1) & KASAN_GRANULE_MASK) < size - 1))
  67                 return *shadow_addr || memory_is_poisoned_1(addr + size - 1);
  68
  69         return memory_is_poisoned_1(addr + size - 1);
  70 }
  71
  72 static __always_inline bool memory_is_poisoned_16(const void *addr)
  73 {
  74         u16 *shadow_addr = (u16 *)kasan_mem_to_shadow(addr);
  75
  76         /* Unaligned 16-bytes access maps into 3 shadow bytes. */
  77         if (unlikely(!IS_ALIGNED((unsigned long)addr, KASAN_GRANULE_SIZE)))
  78                 return *shadow_addr || memory_is_poisoned_1(addr + 15);
  79
  80         return *shadow_addr;
  81 }
  82
  83 static __always_inline unsigned long bytes_is_nonzero(const u8 *start,
  84                                         size_t size)
  85 {
  86         while (size) {
  87                 if (unlikely(*start))
  88                         return (unsigned long)start;
  89                 start++;
  90                 size--;
  91         }
  92
  93         return 0;
  94 }
  95
  96 static __always_inline unsigned long memory_is_nonzero(const void *start,
  97                                                 const void *end)
  98 {
  99         unsigned int words;
 100         unsigned long ret;
 101         unsigned int prefix = (unsigned long)start % 8;
 102
 103         if (end - start <= 16)
 104                 return bytes_is_nonzero(start, end - start);
 105
 106         if (prefix) {
 107                 prefix = 8 - prefix;
 108                 ret = bytes_is_nonzero(start, prefix);
 109                 if (unlikely(ret))
 110                         return ret;
 111                 start += prefix;
 112         }
 113
 114         words = (end - start) / 8;
 115         while (words) {
 116                 if (unlikely(*(u64 *)start))
 117                         return bytes_is_nonzero(start, 8);
 118                 start += 8;
 119                 words--;
 120         }
 121
 122         return bytes_is_nonzero(start, (end - start) % 8);
 123 }
 124
 125 static __always_inline bool memory_is_poisoned_n(const void *addr, size_t size)
 126 {
 127         unsigned long ret;
 128
 129         ret = memory_is_nonzero(kasan_mem_to_shadow(addr),
 130                         kasan_mem_to_shadow(addr + size - 1) + 1);
 131
 132         if (unlikely(ret)) {
 133                 const void *last_byte = addr + size - 1;
 134                 s8 *last_shadow = (s8 *)kasan_mem_to_shadow(last_byte);
 135                 s8 last_accessible_byte = (unsigned long)last_byte & KASAN_GRANULE_MASK;
 136
 137                 if (unlikely(ret != (unsigned long)last_shadow ||
 138                              last_accessible_byte >= *last_shadow))
 139                         return true;
 140         }
 141         return false;
 142 }
 143
 144 static __always_inline bool memory_is_poisoned(const void *addr, size_t size)
 145 {
 146         if (__builtin_constant_p(size)) {
 147                 switch (size) {
 148                 case 1:
 149                         return memory_is_poisoned_1(addr);
 150                 case 2:
 151                 case 4:
 152                 case 8:
 153                         return memory_is_poisoned_2_4_8(addr, size);
 154                 case 16:
 155                         return memory_is_poisoned_16(addr);
 156                 default:
 157                         BUILD_BUG();
 158                 }
 159         }
 160
 161         return memory_is_poisoned_n(addr, size);
 162 }
 163
 164 static __always_inline bool check_region_inline(const void *addr,
 165                                                 size_t size, bool write,
 166                                                 unsigned long ret_ip)
 167 {
 168         if (!kasan_arch_is_ready())
 169                 return true;
 170
 171         if (unlikely(size == 0))
 172                 return true;
 173
 174         if (unlikely(addr + size < addr))
 175                 return !kasan_report(addr, size, write, ret_ip);
 176
 177         if (unlikely(!addr_has_metadata(addr)))
 178                 return !kasan_report(addr, size, write, ret_ip);
 179
 180         if (likely(!memory_is_poisoned(addr, size)))
 181                 return true;
 182
 183         return !kasan_report(addr, size, write, ret_ip);
 184 }
 185
 186 bool kasan_check_range(const void *addr, size_t size, bool write,
 187                                         unsigned long ret_ip)
 188 {
 189         return check_region_inline(addr, size, write, ret_ip);
 190 }
 191
 192 bool kasan_byte_accessible(const void *addr)
 193 {
 194         s8 shadow_byte;
 195
 196         if (!kasan_arch_is_ready())
 197                 return true;
 198
 199         shadow_byte = READ_ONCE(*(s8 *)kasan_mem_to_shadow(addr));
 200
 201         return shadow_byte >= 0 && shadow_byte < KASAN_GRANULE_SIZE;
 202 }
 203
 204 void kasan_cache_shrink(struct kmem_cache *cache)
 205 {
 206         kasan_quarantine_remove_cache(cache);
 207 }
 208
 209 void kasan_cache_shutdown(struct kmem_cache *cache)
 210 {
 211         if (!__kmem_cache_empty(cache))
 212                 kasan_quarantine_remove_cache(cache);
 213 }
 214
 215 static void register_global(struct kasan_global *global)
 216 {
 217         size_t aligned_size = round_up(global->size, KASAN_GRANULE_SIZE);
 218
 219         kasan_unpoison(global->beg, global->size, false);
 220
 221         kasan_poison(global->beg + aligned_size,
 222                      global->size_with_redzone - aligned_size,
 223                      KASAN_GLOBAL_REDZONE, false);
 224 }
 225
 226 void __asan_register_globals(void *ptr, ssize_t size)
 227 {
 228         int i;
 229         struct kasan_global *globals = ptr;
 230
 231         for (i = 0; i < size; i++)
 232                 register_global(&globals[i]);
 233 }
 234 EXPORT_SYMBOL(__asan_register_globals);
 235
 236 void __asan_unregister_globals(void *ptr, ssize_t size)
 237 {
 238 }
 239 EXPORT_SYMBOL(__asan_unregister_globals);
 240
 241 #define DEFINE_ASAN_LOAD_STORE(size)                                    \
 242         void __asan_load##size(void *addr)                              \
 243         {                                                               \
 244                 check_region_inline(addr, size, false, _RET_IP_);       \
 245         }                                                               \
 246         EXPORT_SYMBOL(__asan_load##size);                               \
 247         __alias(__asan_load##size)                                      \
 248         void __asan_load##size##_noabort(void *);                       \
 249         EXPORT_SYMBOL(__asan_load##size##_noabort);                     \
 250         void __asan_store##size(void *addr)                             \
 251         {                                                               \
 252                 check_region_inline(addr, size, true, _RET_IP_);        \
 253         }                                                               \
 254         EXPORT_SYMBOL(__asan_store##size);                              \
 255         __alias(__asan_store##size)                                     \
 256         void __asan_store##size##_noabort(void *);                      \
 257         EXPORT_SYMBOL(__asan_store##size##_noabort)
 258
 259 DEFINE_ASAN_LOAD_STORE(1);
 260 DEFINE_ASAN_LOAD_STORE(2);
 261 DEFINE_ASAN_LOAD_STORE(4);
 262 DEFINE_ASAN_LOAD_STORE(8);
 263 DEFINE_ASAN_LOAD_STORE(16);
 264
 265 void __asan_loadN(void *addr, ssize_t size)
 266 {
 267         kasan_check_range(addr, size, false, _RET_IP_);
 268 }
 269 EXPORT_SYMBOL(__asan_loadN);
 270
 271 __alias(__asan_loadN)
 272 void __asan_loadN_noabort(void *, ssize_t);
 273 EXPORT_SYMBOL(__asan_loadN_noabort);
 274
 275 void __asan_storeN(void *addr, ssize_t size)
 276 {
 277         kasan_check_range(addr, size, true, _RET_IP_);
 278 }
 279 EXPORT_SYMBOL(__asan_storeN);
 280
 281 __alias(__asan_storeN)
 282 void __asan_storeN_noabort(void *, ssize_t);
 283 EXPORT_SYMBOL(__asan_storeN_noabort);
 284
 285 /* to shut up compiler complaints */
 286 void __asan_handle_no_return(void) {}
 287 EXPORT_SYMBOL(__asan_handle_no_return);
 288
 289 /* Emitted by compiler to poison alloca()ed objects. */
 290 void __asan_alloca_poison(void *addr, ssize_t size)
 291 {
 292         size_t rounded_up_size = round_up(size, KASAN_GRANULE_SIZE);
 293         size_t padding_size = round_up(size, KASAN_ALLOCA_REDZONE_SIZE) -
 294                         rounded_up_size;
 295         size_t rounded_down_size = round_down(size, KASAN_GRANULE_SIZE);
 296
 297         const void *left_redzone = (const void *)(addr -
 298                         KASAN_ALLOCA_REDZONE_SIZE);
 299         const void *right_redzone = (const void *)(addr + rounded_up_size);
 300
 301         WARN_ON(!IS_ALIGNED((unsigned long)addr, KASAN_ALLOCA_REDZONE_SIZE));
 302
 303         kasan_unpoison((const void *)(addr + rounded_down_size),
 304                         size - rounded_down_size, false);
 305         kasan_poison(left_redzone, KASAN_ALLOCA_REDZONE_SIZE,
 306                      KASAN_ALLOCA_LEFT, false);
 307         kasan_poison(right_redzone, padding_size + KASAN_ALLOCA_REDZONE_SIZE,
 308                      KASAN_ALLOCA_RIGHT, false);
 309 }
 310 EXPORT_SYMBOL(__asan_alloca_poison);
 311
 312 /* Emitted by compiler to unpoison alloca()ed areas when the stack unwinds. */
 313 void __asan_allocas_unpoison(void *stack_top, ssize_t stack_bottom)
 314 {
 315         if (unlikely(!stack_top || stack_top > (void *)stack_bottom))
 316                 return;
 317
 318         kasan_unpoison(stack_top, (void *)stack_bottom - stack_top, false);
 319 }
 320 EXPORT_SYMBOL(__asan_allocas_unpoison);
 321
 322 /* Emitted by the compiler to [un]poison local variables. */
 323 #define DEFINE_ASAN_SET_SHADOW(byte) \
 324         void __asan_set_shadow_##byte(const void *addr, ssize_t size)   \
 325         {                                                               \
 326                 __memset((void *)addr, 0x##byte, size);                 \
 327         }                                                               \
 328         EXPORT_SYMBOL(__asan_set_shadow_##byte)
 329
 330 DEFINE_ASAN_SET_SHADOW(00);
 331 DEFINE_ASAN_SET_SHADOW(f1);
 332 DEFINE_ASAN_SET_SHADOW(f2);
 333 DEFINE_ASAN_SET_SHADOW(f3);
 334 DEFINE_ASAN_SET_SHADOW(f5);
 335 DEFINE_ASAN_SET_SHADOW(f8);
 336
 337 /* Only allow cache merging when no per-object metadata is present. */
 338 slab_flags_t kasan_never_merge(void)
 339 {
 340         if (!kasan_requires_meta())
 341                 return 0;
 342         return SLAB_KASAN;
 343 }
 344
 345 /*
 346  * Adaptive redzone policy taken from the userspace AddressSanitizer runtime.
 347  * For larger allocations larger redzones are used.
 348  */
 349 static inline unsigned int optimal_redzone(unsigned int object_size)
 350 {
 351         return
 352                 object_size <= 64        - 16   ? 16 :
 353                 object_size <= 128       - 32   ? 32 :
 354                 object_size <= 512       - 64   ? 64 :
 355                 object_size <= 4096      - 128  ? 128 :
 356                 object_size <= (1 << 14) - 256  ? 256 :
 357                 object_size <= (1 << 15) - 512  ? 512 :
 358                 object_size <= (1 << 16) - 1024 ? 1024 : 2048;
 359 }
 360
 361 void kasan_cache_create(struct kmem_cache *cache, unsigned int *size,
 362                           slab_flags_t *flags)
 363 {
 364         unsigned int ok_size;
 365         unsigned int optimal_size;
 366         unsigned int rem_free_meta_size;
 367         unsigned int orig_alloc_meta_offset;
 368
 369         if (!kasan_requires_meta())
 370                 return;
 371
 372         /*
 373          * SLAB_KASAN is used to mark caches that are sanitized by KASAN
 374          * and that thus have per-object metadata.
 375          * Currently this flag is used in two places:
 376          * 1. In slab_ksize() to account for per-object metadata when
 377          *    calculating the size of the accessible memory within the object.
 378          * 2. In slab_common.c via kasan_never_merge() to prevent merging of
 379          *    caches with per-object metadata.
 380          */
 381         *flags |= SLAB_KASAN;
 382
 383         ok_size = *size;
 384
 385         /* Add alloc meta into the redzone. */
 386         cache->kasan_info.alloc_meta_offset = *size;
 387         *size += sizeof(struct kasan_alloc_meta);
 388
 389         /* If alloc meta doesn't fit, don't add it. */
 390         if (*size > KMALLOC_MAX_SIZE) {
 391                 cache->kasan_info.alloc_meta_offset = 0;
 392                 *size = ok_size;
 393                 /* Continue, since free meta might still fit. */
 394         }
 395
 396         ok_size = *size;
 397         orig_alloc_meta_offset = cache->kasan_info.alloc_meta_offset;
 398
 399         /*
 400          * Store free meta in the redzone when it's not possible to store
 401          * it in the object. This is the case when:
 402          * 1. Object is SLAB_TYPESAFE_BY_RCU, which means that it can
 403          *    be touched after it was freed, or
 404          * 2. Object has a constructor, which means it's expected to
 405          *    retain its content until the next allocation.
 406          */
 407         if ((cache->flags & SLAB_TYPESAFE_BY_RCU) || cache->ctor) {
 408                 cache->kasan_info.free_meta_offset = *size;
 409                 *size += sizeof(struct kasan_free_meta);
 410                 goto free_meta_added;
 411         }
 412
 413         /*
 414          * Otherwise, if the object is large enough to contain free meta,
 415          * store it within the object.
 416          */
 417         if (sizeof(struct kasan_free_meta) <= cache->object_size) {
 418                 /* cache->kasan_info.free_meta_offset = 0 is implied. */
 419                 goto free_meta_added;
 420         }
 421
 422         /*
 423          * For smaller objects, store the beginning of free meta within the
 424          * object and the end in the redzone. And thus shift the location of
 425          * alloc meta to free up space for free meta.
 426          * This is only possible when slub_debug is disabled, as otherwise
 427          * the end of free meta will overlap with slub_debug metadata.
 428          */
 429         if (!__slub_debug_enabled()) {
 430                 rem_free_meta_size = sizeof(struct kasan_free_meta) -
 431                                                         cache->object_size;
 432                 *size += rem_free_meta_size;
 433                 if (cache->kasan_info.alloc_meta_offset != 0)
 434                         cache->kasan_info.alloc_meta_offset += rem_free_meta_size;
 435                 goto free_meta_added;
 436         }
 437
 438         /*
 439          * If the object is small and slub_debug is enabled, store free meta
 440          * in the redzone after alloc meta.
 441          */
 442         cache->kasan_info.free_meta_offset = *size;
 443         *size += sizeof(struct kasan_free_meta);
 444
 445 free_meta_added:
 446         /* If free meta doesn't fit, don't add it. */
 447         if (*size > KMALLOC_MAX_SIZE) {
 448                 cache->kasan_info.free_meta_offset = KASAN_NO_FREE_META;
 449                 cache->kasan_info.alloc_meta_offset = orig_alloc_meta_offset;
 450                 *size = ok_size;
 451         }
 452
 453         /* Calculate size with optimal redzone. */
 454         optimal_size = cache->object_size + optimal_redzone(cache->object_size);
 455         /* Limit it with KMALLOC_MAX_SIZE. */
 456         if (optimal_size > KMALLOC_MAX_SIZE)
 457                 optimal_size = KMALLOC_MAX_SIZE;
 458         /* Use optimal size if the size with added metas is not large enough. */
 459         if (*size < optimal_size)
 460                 *size = optimal_size;
 461 }
 462
 463 struct kasan_alloc_meta *kasan_get_alloc_meta(struct kmem_cache *cache,
 464                                               const void *object)
 465 {
 466         if (!cache->kasan_info.alloc_meta_offset)
 467                 return NULL;
 468         return (void *)object + cache->kasan_info.alloc_meta_offset;
 469 }
 470
 471 struct kasan_free_meta *kasan_get_free_meta(struct kmem_cache *cache,
 472                                             const void *object)
 473 {
 474         BUILD_BUG_ON(sizeof(struct kasan_free_meta) > 32);
 475         if (cache->kasan_info.free_meta_offset == KASAN_NO_FREE_META)
 476                 return NULL;
 477         return (void *)object + cache->kasan_info.free_meta_offset;
 478 }
 479
 480 void kasan_init_object_meta(struct kmem_cache *cache, const void *object)
 481 {
 482         struct kasan_alloc_meta *alloc_meta;
 483
 484         alloc_meta = kasan_get_alloc_meta(cache, object);
 485         if (alloc_meta) {
 486                 /* Zero out alloc meta to mark it as invalid. */
 487                 __memset(alloc_meta, 0, sizeof(*alloc_meta));
 488         }
 489
 490         /*
 491          * Explicitly marking free meta as invalid is not required: the shadow
 492          * value for the first 8 bytes of a newly allocated object is not
 493          * KASAN_SLAB_FREE_META.
 494          */
 495 }
 496
 497 static void release_alloc_meta(struct kasan_alloc_meta *meta)
 498 {
 499         /* Zero out alloc meta to mark it as invalid. */
 500         __memset(meta, 0, sizeof(*meta));
 501 }
 502
 503 static void release_free_meta(const void *object, struct kasan_free_meta *meta)
 504 {
 505         if (!kasan_arch_is_ready())
 506                 return;
 507
 508         /* Check if free meta is valid. */
 509         if (*(u8 *)kasan_mem_to_shadow(object) != KASAN_SLAB_FREE_META)
 510                 return;
 511
 512         /* Mark free meta as invalid. */
 513         *(u8 *)kasan_mem_to_shadow(object) = KASAN_SLAB_FREE;
 514 }
 515
 516 size_t kasan_metadata_size(struct kmem_cache *cache, bool in_object)
 517 {
 518         struct kasan_cache *info = &cache->kasan_info;
 519
 520         if (!kasan_requires_meta())
 521                 return 0;
 522
 523         if (in_object)
 524                 return (info->free_meta_offset ?
 525                         0 : sizeof(struct kasan_free_meta));
 526         else
 527                 return (info->alloc_meta_offset ?
 528                         sizeof(struct kasan_alloc_meta) : 0) +
 529                         ((info->free_meta_offset &&
 530                         info->free_meta_offset != KASAN_NO_FREE_META) ?
 531                         sizeof(struct kasan_free_meta) : 0);
 532 }
 533
 534 static void __kasan_record_aux_stack(void *addr, depot_flags_t depot_flags)
 535 {
 536         struct slab *slab = kasan_addr_to_slab(addr);
 537         struct kmem_cache *cache;
 538         struct kasan_alloc_meta *alloc_meta;
 539         void *object;
 540
 541         if (is_kfence_address(addr) || !slab)
 542                 return;
 543
 544         cache = slab->slab_cache;
 545         object = nearest_obj(cache, slab, addr);
 546         alloc_meta = kasan_get_alloc_meta(cache, object);
 547         if (!alloc_meta)
 548                 return;
 549
 550         alloc_meta->aux_stack[1] = alloc_meta->aux_stack[0];
 551         alloc_meta->aux_stack[0] = kasan_save_stack(0, depot_flags);
 552 }
 553
 554 void kasan_record_aux_stack(void *addr)
 555 {
 556         return __kasan_record_aux_stack(addr, STACK_DEPOT_FLAG_CAN_ALLOC);
 557 }
 558
 559 void kasan_record_aux_stack_noalloc(void *addr)
 560 {
 561         return __kasan_record_aux_stack(addr, 0);
 562 }
 563
 564 void kasan_save_alloc_info(struct kmem_cache *cache, void *object, gfp_t flags)
 565 {
 566         struct kasan_alloc_meta *alloc_meta;
 567
 568         alloc_meta = kasan_get_alloc_meta(cache, object);
 569         if (!alloc_meta)
 570                 return;
 571
 572         /* Invalidate previous stack traces (might exist for krealloc or mempool). */
 573         release_alloc_meta(alloc_meta);
 574
 575         kasan_save_track(&alloc_meta->alloc_track, flags);
 576 }
 577
 578 void kasan_save_free_info(struct kmem_cache *cache, void *object)
 579 {
 580         struct kasan_free_meta *free_meta;
 581
 582         free_meta = kasan_get_free_meta(cache, object);
 583         if (!free_meta)
 584                 return;
 585
 586         /* Invalidate previous stack trace (might exist for mempool). */
 587         release_free_meta(object, free_meta);
 588
 589         kasan_save_track(&free_meta->free_track, 0);
 590
 591         /* Mark free meta as valid. */
 592         *(u8 *)kasan_mem_to_shadow(object) = KASAN_SLAB_FREE_META;
 593 }