mm/kasan/common.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * This file contains common 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/init.h>
  14 #include <linux/kasan.h>
  15 #include <linux/kernel.h>
  16 #include <linux/linkage.h>
  17 #include <linux/memblock.h>
  18 #include <linux/memory.h>
  19 #include <linux/mm.h>
  20 #include <linux/module.h>
  21 #include <linux/printk.h>
  22 #include <linux/sched.h>
  23 #include <linux/sched/task_stack.h>
  24 #include <linux/slab.h>
  25 #include <linux/stacktrace.h>
  26 #include <linux/string.h>
  27 #include <linux/types.h>
  28 #include <linux/bug.h>
  29
  30 #include "kasan.h"
  31 #include "../slab.h"
  32
  33 depot_stack_handle_t kasan_save_stack(gfp_t flags)
  34 {
  35         unsigned long entries[KASAN_STACK_DEPTH];
  36         unsigned int nr_entries;
  37
  38         nr_entries = stack_trace_save(entries, ARRAY_SIZE(entries), 0);
  39         nr_entries = filter_irq_stacks(entries, nr_entries);
  40         return stack_depot_save(entries, nr_entries, flags);
  41 }
  42
  43 void kasan_set_track(struct kasan_track *track, gfp_t flags)
  44 {
  45         track->pid = current->pid;
  46         track->stack = kasan_save_stack(flags);
  47 }
  48
  49 #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
  50 void kasan_enable_current(void)
  51 {
  52         current->kasan_depth++;
  53 }
  54
  55 void kasan_disable_current(void)
  56 {
  57         current->kasan_depth--;
  58 }
  59 #endif /* CONFIG_KASAN_GENERIC || CONFIG_KASAN_SW_TAGS */
  60
  61 void __kasan_unpoison_range(const void *address, size_t size)
  62 {
  63         kasan_unpoison(address, size);
  64 }
  65
  66 #if CONFIG_KASAN_STACK
  67 /* Unpoison the entire stack for a task. */
  68 void kasan_unpoison_task_stack(struct task_struct *task)
  69 {
  70         void *base = task_stack_page(task);
  71
  72         kasan_unpoison(base, THREAD_SIZE);
  73 }
  74
  75 /* Unpoison the stack for the current task beyond a watermark sp value. */
  76 asmlinkage void kasan_unpoison_task_stack_below(const void *watermark)
  77 {
  78         /*
  79          * Calculate the task stack base address.  Avoid using 'current'
  80          * because this function is called by early resume code which hasn't
  81          * yet set up the percpu register (%gs).
  82          */
  83         void *base = (void *)((unsigned long)watermark & ~(THREAD_SIZE - 1));
  84
  85         kasan_unpoison(base, watermark - base);
  86 }
  87 #endif /* CONFIG_KASAN_STACK */
  88
  89 /*
  90  * Only allow cache merging when stack collection is disabled and no metadata
  91  * is present.
  92  */
  93 slab_flags_t __kasan_never_merge(void)
  94 {
  95         if (kasan_stack_collection_enabled())
  96                 return SLAB_KASAN;
  97         return 0;
  98 }
  99
 100 void __kasan_alloc_pages(struct page *page, unsigned int order)
 101 {
 102         u8 tag;
 103         unsigned long i;
 104
 105         if (unlikely(PageHighMem(page)))
 106                 return;
 107
 108         tag = kasan_random_tag();
 109         for (i = 0; i < (1 << order); i++)
 110                 page_kasan_tag_set(page + i, tag);
 111         kasan_unpoison(page_address(page), PAGE_SIZE << order);
 112 }
 113
 114 void __kasan_free_pages(struct page *page, unsigned int order)
 115 {
 116         if (likely(!PageHighMem(page)))
 117                 kasan_poison(page_address(page), PAGE_SIZE << order,
 118                              KASAN_FREE_PAGE);
 119 }
 120
 121 /*
 122  * Adaptive redzone policy taken from the userspace AddressSanitizer runtime.
 123  * For larger allocations larger redzones are used.
 124  */
 125 static inline unsigned int optimal_redzone(unsigned int object_size)
 126 {
 127         return
 128                 object_size <= 64        - 16   ? 16 :
 129                 object_size <= 128       - 32   ? 32 :
 130                 object_size <= 512       - 64   ? 64 :
 131                 object_size <= 4096      - 128  ? 128 :
 132                 object_size <= (1 << 14) - 256  ? 256 :
 133                 object_size <= (1 << 15) - 512  ? 512 :
 134                 object_size <= (1 << 16) - 1024 ? 1024 : 2048;
 135 }
 136
 137 void __kasan_cache_create(struct kmem_cache *cache, unsigned int *size,
 138                           slab_flags_t *flags)
 139 {
 140         unsigned int ok_size;
 141         unsigned int optimal_size;
 142
 143         /*
 144          * SLAB_KASAN is used to mark caches as ones that are sanitized by
 145          * KASAN. Currently this flag is used in two places:
 146          * 1. In slab_ksize() when calculating the size of the accessible
 147          *    memory within the object.
 148          * 2. In slab_common.c to prevent merging of sanitized caches.
 149          */
 150         *flags |= SLAB_KASAN;
 151
 152         if (!kasan_stack_collection_enabled())
 153                 return;
 154
 155         ok_size = *size;
 156
 157         /* Add alloc meta into redzone. */
 158         cache->kasan_info.alloc_meta_offset = *size;
 159         *size += sizeof(struct kasan_alloc_meta);
 160
 161         /*
 162          * If alloc meta doesn't fit, don't add it.
 163          * This can only happen with SLAB, as it has KMALLOC_MAX_SIZE equal
 164          * to KMALLOC_MAX_CACHE_SIZE and doesn't fall back to page_alloc for
 165          * larger sizes.
 166          */
 167         if (*size > KMALLOC_MAX_SIZE) {
 168                 cache->kasan_info.alloc_meta_offset = 0;
 169                 *size = ok_size;
 170                 /* Continue, since free meta might still fit. */
 171         }
 172
 173         /* Only the generic mode uses free meta or flexible redzones. */
 174         if (!IS_ENABLED(CONFIG_KASAN_GENERIC)) {
 175                 cache->kasan_info.free_meta_offset = KASAN_NO_FREE_META;
 176                 return;
 177         }
 178
 179         /*
 180          * Add free meta into redzone when it's not possible to store
 181          * it in the object. This is the case when:
 182          * 1. Object is SLAB_TYPESAFE_BY_RCU, which means that it can
 183          *    be touched after it was freed, or
 184          * 2. Object has a constructor, which means it's expected to
 185          *    retain its content until the next allocation, or
 186          * 3. Object is too small.
 187          * Otherwise cache->kasan_info.free_meta_offset = 0 is implied.
 188          */
 189         if ((cache->flags & SLAB_TYPESAFE_BY_RCU) || cache->ctor ||
 190             cache->object_size < sizeof(struct kasan_free_meta)) {
 191                 ok_size = *size;
 192
 193                 cache->kasan_info.free_meta_offset = *size;
 194                 *size += sizeof(struct kasan_free_meta);
 195
 196                 /* If free meta doesn't fit, don't add it. */
 197                 if (*size > KMALLOC_MAX_SIZE) {
 198                         cache->kasan_info.free_meta_offset = KASAN_NO_FREE_META;
 199                         *size = ok_size;
 200                 }
 201         }
 202
 203         /* Calculate size with optimal redzone. */
 204         optimal_size = cache->object_size + optimal_redzone(cache->object_size);
 205         /* Limit it with KMALLOC_MAX_SIZE (relevant for SLAB only). */
 206         if (optimal_size > KMALLOC_MAX_SIZE)
 207                 optimal_size = KMALLOC_MAX_SIZE;
 208         /* Use optimal size if the size with added metas is not large enough. */
 209         if (*size < optimal_size)
 210                 *size = optimal_size;
 211 }
 212
 213 size_t __kasan_metadata_size(struct kmem_cache *cache)
 214 {
 215         if (!kasan_stack_collection_enabled())
 216                 return 0;
 217         return (cache->kasan_info.alloc_meta_offset ?
 218                 sizeof(struct kasan_alloc_meta) : 0) +
 219                 (cache->kasan_info.free_meta_offset ?
 220                 sizeof(struct kasan_free_meta) : 0);
 221 }
 222
 223 struct kasan_alloc_meta *kasan_get_alloc_meta(struct kmem_cache *cache,
 224                                               const void *object)
 225 {
 226         if (!cache->kasan_info.alloc_meta_offset)
 227                 return NULL;
 228         return kasan_reset_tag(object) + cache->kasan_info.alloc_meta_offset;
 229 }
 230
 231 #ifdef CONFIG_KASAN_GENERIC
 232 struct kasan_free_meta *kasan_get_free_meta(struct kmem_cache *cache,
 233                                             const void *object)
 234 {
 235         BUILD_BUG_ON(sizeof(struct kasan_free_meta) > 32);
 236         if (cache->kasan_info.free_meta_offset == KASAN_NO_FREE_META)
 237                 return NULL;
 238         return kasan_reset_tag(object) + cache->kasan_info.free_meta_offset;
 239 }
 240 #endif
 241
 242 void __kasan_poison_slab(struct page *page)
 243 {
 244         unsigned long i;
 245
 246         for (i = 0; i < compound_nr(page); i++)
 247                 page_kasan_tag_reset(page + i);
 248         kasan_poison(page_address(page), page_size(page),
 249                      KASAN_KMALLOC_REDZONE);
 250 }
 251
 252 void __kasan_unpoison_object_data(struct kmem_cache *cache, void *object)
 253 {
 254         kasan_unpoison(object, cache->object_size);
 255 }
 256
 257 void __kasan_poison_object_data(struct kmem_cache *cache, void *object)
 258 {
 259         kasan_poison(object, cache->object_size, KASAN_KMALLOC_REDZONE);
 260 }
 261
 262 /*
 263  * This function assigns a tag to an object considering the following:
 264  * 1. A cache might have a constructor, which might save a pointer to a slab
 265  *    object somewhere (e.g. in the object itself). We preassign a tag for
 266  *    each object in caches with constructors during slab creation and reuse
 267  *    the same tag each time a particular object is allocated.
 268  * 2. A cache might be SLAB_TYPESAFE_BY_RCU, which means objects can be
 269  *    accessed after being freed. We preassign tags for objects in these
 270  *    caches as well.
 271  * 3. For SLAB allocator we can't preassign tags randomly since the freelist
 272  *    is stored as an array of indexes instead of a linked list. Assign tags
 273  *    based on objects indexes, so that objects that are next to each other
 274  *    get different tags.
 275  */
 276 static u8 assign_tag(struct kmem_cache *cache, const void *object,
 277                         bool init, bool keep_tag)
 278 {
 279         if (IS_ENABLED(CONFIG_KASAN_GENERIC))
 280                 return 0xff;
 281
 282         /*
 283          * 1. When an object is kmalloc()'ed, two hooks are called:
 284          *    kasan_slab_alloc() and kasan_kmalloc(). We assign the
 285          *    tag only in the first one.
 286          * 2. We reuse the same tag for krealloc'ed objects.
 287          */
 288         if (keep_tag)
 289                 return get_tag(object);
 290
 291         /*
 292          * If the cache neither has a constructor nor has SLAB_TYPESAFE_BY_RCU
 293          * set, assign a tag when the object is being allocated (init == false).
 294          */
 295         if (!cache->ctor && !(cache->flags & SLAB_TYPESAFE_BY_RCU))
 296                 return init ? KASAN_TAG_KERNEL : kasan_random_tag();
 297
 298         /* For caches that either have a constructor or SLAB_TYPESAFE_BY_RCU: */
 299 #ifdef CONFIG_SLAB
 300         /* For SLAB assign tags based on the object index in the freelist. */
 301         return (u8)obj_to_index(cache, virt_to_page(object), (void *)object);
 302 #else
 303         /*
 304          * For SLUB assign a random tag during slab creation, otherwise reuse
 305          * the already assigned tag.
 306          */
 307         return init ? kasan_random_tag() : get_tag(object);
 308 #endif
 309 }
 310
 311 void * __must_check __kasan_init_slab_obj(struct kmem_cache *cache,
 312                                                 const void *object)
 313 {
 314         struct kasan_alloc_meta *alloc_meta;
 315
 316         if (kasan_stack_collection_enabled()) {
 317                 alloc_meta = kasan_get_alloc_meta(cache, object);
 318                 if (alloc_meta)
 319                         __memset(alloc_meta, 0, sizeof(*alloc_meta));
 320         }
 321
 322         /* Tag is ignored in set_tag() without CONFIG_KASAN_SW/HW_TAGS */
 323         object = set_tag(object, assign_tag(cache, object, true, false));
 324
 325         return (void *)object;
 326 }
 327
 328 static bool ____kasan_slab_free(struct kmem_cache *cache, void *object,
 329                               unsigned long ip, bool quarantine)
 330 {
 331         u8 tag;
 332         void *tagged_object;
 333
 334         tag = get_tag(object);
 335         tagged_object = object;
 336         object = kasan_reset_tag(object);
 337
 338         if (unlikely(nearest_obj(cache, virt_to_head_page(object), object) !=
 339             object)) {
 340                 kasan_report_invalid_free(tagged_object, ip);
 341                 return true;
 342         }
 343
 344         /* RCU slabs could be legally used after free within the RCU period */
 345         if (unlikely(cache->flags & SLAB_TYPESAFE_BY_RCU))
 346                 return false;
 347
 348         if (kasan_check_invalid_free(tagged_object)) {
 349                 kasan_report_invalid_free(tagged_object, ip);
 350                 return true;
 351         }
 352
 353         kasan_poison(object, cache->object_size, KASAN_KMALLOC_FREE);
 354
 355         if (!kasan_stack_collection_enabled())
 356                 return false;
 357
 358         if ((IS_ENABLED(CONFIG_KASAN_GENERIC) && !quarantine))
 359                 return false;
 360
 361         kasan_set_free_info(cache, object, tag);
 362
 363         return kasan_quarantine_put(cache, object);
 364 }
 365
 366 bool __kasan_slab_free(struct kmem_cache *cache, void *object, unsigned long ip)
 367 {
 368         return ____kasan_slab_free(cache, object, ip, true);
 369 }
 370
 371 void __kasan_slab_free_mempool(void *ptr, unsigned long ip)
 372 {
 373         struct page *page;
 374
 375         page = virt_to_head_page(ptr);
 376
 377         /*
 378          * Even though this function is only called for kmem_cache_alloc and
 379          * kmalloc backed mempool allocations, those allocations can still be
 380          * !PageSlab() when the size provided to kmalloc is larger than
 381          * KMALLOC_MAX_SIZE, and kmalloc falls back onto page_alloc.
 382          */
 383         if (unlikely(!PageSlab(page))) {
 384                 if (ptr != page_address(page)) {
 385                         kasan_report_invalid_free(ptr, ip);
 386                         return;
 387                 }
 388                 kasan_poison(ptr, page_size(page), KASAN_FREE_PAGE);
 389         } else {
 390                 ____kasan_slab_free(page->slab_cache, ptr, ip, false);
 391         }
 392 }
 393
 394 static void set_alloc_info(struct kmem_cache *cache, void *object, gfp_t flags)
 395 {
 396         struct kasan_alloc_meta *alloc_meta;
 397
 398         alloc_meta = kasan_get_alloc_meta(cache, object);
 399         if (alloc_meta)
 400                 kasan_set_track(&alloc_meta->alloc_track, flags);
 401 }
 402
 403 static void *____kasan_kmalloc(struct kmem_cache *cache, const void *object,
 404                                 size_t size, gfp_t flags, bool keep_tag)
 405 {
 406         unsigned long redzone_start;
 407         unsigned long redzone_end;
 408         u8 tag;
 409
 410         if (gfpflags_allow_blocking(flags))
 411                 kasan_quarantine_reduce();
 412
 413         if (unlikely(object == NULL))
 414                 return NULL;
 415
 416         redzone_start = round_up((unsigned long)(object + size),
 417                                 KASAN_GRANULE_SIZE);
 418         redzone_end = round_up((unsigned long)object + cache->object_size,
 419                                 KASAN_GRANULE_SIZE);
 420         tag = assign_tag(cache, object, false, keep_tag);
 421
 422         /* Tag is ignored in set_tag without CONFIG_KASAN_SW/HW_TAGS */
 423         kasan_unpoison(set_tag(object, tag), size);
 424         kasan_poison((void *)redzone_start, redzone_end - redzone_start,
 425                            KASAN_KMALLOC_REDZONE);
 426
 427         if (kasan_stack_collection_enabled())
 428                 set_alloc_info(cache, (void *)object, flags);
 429
 430         return set_tag(object, tag);
 431 }
 432
 433 void * __must_check __kasan_slab_alloc(struct kmem_cache *cache,
 434                                         void *object, gfp_t flags)
 435 {
 436         return ____kasan_kmalloc(cache, object, cache->object_size, flags, false);
 437 }
 438
 439 void * __must_check __kasan_kmalloc(struct kmem_cache *cache, const void *object,
 440                                         size_t size, gfp_t flags)
 441 {
 442         return ____kasan_kmalloc(cache, object, size, flags, true);
 443 }
 444 EXPORT_SYMBOL(__kasan_kmalloc);
 445
 446 void * __must_check __kasan_kmalloc_large(const void *ptr, size_t size,
 447                                                 gfp_t flags)
 448 {
 449         struct page *page;
 450         unsigned long redzone_start;
 451         unsigned long redzone_end;
 452
 453         if (gfpflags_allow_blocking(flags))
 454                 kasan_quarantine_reduce();
 455
 456         if (unlikely(ptr == NULL))
 457                 return NULL;
 458
 459         page = virt_to_page(ptr);
 460         redzone_start = round_up((unsigned long)(ptr + size),
 461                                 KASAN_GRANULE_SIZE);
 462         redzone_end = (unsigned long)ptr + page_size(page);
 463
 464         kasan_unpoison(ptr, size);
 465         kasan_poison((void *)redzone_start, redzone_end - redzone_start,
 466                      KASAN_PAGE_REDZONE);
 467
 468         return (void *)ptr;
 469 }
 470
 471 void * __must_check __kasan_krealloc(const void *object, size_t size, gfp_t flags)
 472 {
 473         struct page *page;
 474
 475         if (unlikely(object == ZERO_SIZE_PTR))
 476                 return (void *)object;
 477
 478         page = virt_to_head_page(object);
 479
 480         if (unlikely(!PageSlab(page)))
 481                 return __kasan_kmalloc_large(object, size, flags);
 482         else
 483                 return ____kasan_kmalloc(page->slab_cache, object, size,
 484                                                 flags, true);
 485 }
 486
 487 void __kasan_kfree_large(void *ptr, unsigned long ip)
 488 {
 489         if (ptr != page_address(virt_to_head_page(ptr)))
 490                 kasan_report_invalid_free(ptr, ip);
 491         /* The object will be poisoned by kasan_free_pages(). */
 492 }