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         unpoison_range(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         unpoison_range(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         unpoison_range(base, watermark - base);
  86 }
  87 #endif /* CONFIG_KASAN_STACK */
  88
  89 void __kasan_alloc_pages(struct page *page, unsigned int order)
  90 {
  91         u8 tag;
  92         unsigned long i;
  93
  94         if (unlikely(PageHighMem(page)))
  95                 return;
  96
  97         tag = random_tag();
  98         for (i = 0; i < (1 << order); i++)
  99                 page_kasan_tag_set(page + i, tag);
 100         unpoison_range(page_address(page), PAGE_SIZE << order);
 101 }
 102
 103 void __kasan_free_pages(struct page *page, unsigned int order)
 104 {
 105         if (likely(!PageHighMem(page)))
 106                 poison_range(page_address(page),
 107                                 PAGE_SIZE << order,
 108                                 KASAN_FREE_PAGE);
 109 }
 110
 111 /*
 112  * Adaptive redzone policy taken from the userspace AddressSanitizer runtime.
 113  * For larger allocations larger redzones are used.
 114  */
 115 static inline unsigned int optimal_redzone(unsigned int object_size)
 116 {
 117         if (!IS_ENABLED(CONFIG_KASAN_GENERIC))
 118                 return 0;
 119
 120         return
 121                 object_size <= 64        - 16   ? 16 :
 122                 object_size <= 128       - 32   ? 32 :
 123                 object_size <= 512       - 64   ? 64 :
 124                 object_size <= 4096      - 128  ? 128 :
 125                 object_size <= (1 << 14) - 256  ? 256 :
 126                 object_size <= (1 << 15) - 512  ? 512 :
 127                 object_size <= (1 << 16) - 1024 ? 1024 : 2048;
 128 }
 129
 130 void __kasan_cache_create(struct kmem_cache *cache, unsigned int *size,
 131                           slab_flags_t *flags)
 132 {
 133         unsigned int orig_size = *size;
 134         unsigned int redzone_size;
 135         int redzone_adjust;
 136
 137         if (!kasan_stack_collection_enabled()) {
 138                 *flags |= SLAB_KASAN;
 139                 return;
 140         }
 141
 142         /* Add alloc meta. */
 143         cache->kasan_info.alloc_meta_offset = *size;
 144         *size += sizeof(struct kasan_alloc_meta);
 145
 146         /* Add free meta. */
 147         if (IS_ENABLED(CONFIG_KASAN_GENERIC) &&
 148             (cache->flags & SLAB_TYPESAFE_BY_RCU || cache->ctor ||
 149              cache->object_size < sizeof(struct kasan_free_meta))) {
 150                 cache->kasan_info.free_meta_offset = *size;
 151                 *size += sizeof(struct kasan_free_meta);
 152         }
 153
 154         redzone_size = optimal_redzone(cache->object_size);
 155         redzone_adjust = redzone_size - (*size - cache->object_size);
 156         if (redzone_adjust > 0)
 157                 *size += redzone_adjust;
 158
 159         *size = min_t(unsigned int, KMALLOC_MAX_SIZE,
 160                         max(*size, cache->object_size + redzone_size));
 161
 162         /*
 163          * If the metadata doesn't fit, don't enable KASAN at all.
 164          */
 165         if (*size <= cache->kasan_info.alloc_meta_offset ||
 166                         *size <= cache->kasan_info.free_meta_offset) {
 167                 cache->kasan_info.alloc_meta_offset = 0;
 168                 cache->kasan_info.free_meta_offset = 0;
 169                 *size = orig_size;
 170                 return;
 171         }
 172
 173         *flags |= SLAB_KASAN;
 174 }
 175
 176 size_t __kasan_metadata_size(struct kmem_cache *cache)
 177 {
 178         if (!kasan_stack_collection_enabled())
 179                 return 0;
 180         return (cache->kasan_info.alloc_meta_offset ?
 181                 sizeof(struct kasan_alloc_meta) : 0) +
 182                 (cache->kasan_info.free_meta_offset ?
 183                 sizeof(struct kasan_free_meta) : 0);
 184 }
 185
 186 struct kasan_alloc_meta *kasan_get_alloc_meta(struct kmem_cache *cache,
 187                                               const void *object)
 188 {
 189         return kasan_reset_tag(object) + cache->kasan_info.alloc_meta_offset;
 190 }
 191
 192 struct kasan_free_meta *kasan_get_free_meta(struct kmem_cache *cache,
 193                                             const void *object)
 194 {
 195         BUILD_BUG_ON(sizeof(struct kasan_free_meta) > 32);
 196         return kasan_reset_tag(object) + cache->kasan_info.free_meta_offset;
 197 }
 198
 199 void __kasan_poison_slab(struct page *page)
 200 {
 201         unsigned long i;
 202
 203         for (i = 0; i < compound_nr(page); i++)
 204                 page_kasan_tag_reset(page + i);
 205         poison_range(page_address(page), page_size(page),
 206                      KASAN_KMALLOC_REDZONE);
 207 }
 208
 209 void __kasan_unpoison_object_data(struct kmem_cache *cache, void *object)
 210 {
 211         unpoison_range(object, cache->object_size);
 212 }
 213
 214 void __kasan_poison_object_data(struct kmem_cache *cache, void *object)
 215 {
 216         poison_range(object, cache->object_size, KASAN_KMALLOC_REDZONE);
 217 }
 218
 219 /*
 220  * This function assigns a tag to an object considering the following:
 221  * 1. A cache might have a constructor, which might save a pointer to a slab
 222  *    object somewhere (e.g. in the object itself). We preassign a tag for
 223  *    each object in caches with constructors during slab creation and reuse
 224  *    the same tag each time a particular object is allocated.
 225  * 2. A cache might be SLAB_TYPESAFE_BY_RCU, which means objects can be
 226  *    accessed after being freed. We preassign tags for objects in these
 227  *    caches as well.
 228  * 3. For SLAB allocator we can't preassign tags randomly since the freelist
 229  *    is stored as an array of indexes instead of a linked list. Assign tags
 230  *    based on objects indexes, so that objects that are next to each other
 231  *    get different tags.
 232  */
 233 static u8 assign_tag(struct kmem_cache *cache, const void *object,
 234                         bool init, bool keep_tag)
 235 {
 236         if (IS_ENABLED(CONFIG_KASAN_GENERIC))
 237                 return 0xff;
 238
 239         /*
 240          * 1. When an object is kmalloc()'ed, two hooks are called:
 241          *    kasan_slab_alloc() and kasan_kmalloc(). We assign the
 242          *    tag only in the first one.
 243          * 2. We reuse the same tag for krealloc'ed objects.
 244          */
 245         if (keep_tag)
 246                 return get_tag(object);
 247
 248         /*
 249          * If the cache neither has a constructor nor has SLAB_TYPESAFE_BY_RCU
 250          * set, assign a tag when the object is being allocated (init == false).
 251          */
 252         if (!cache->ctor && !(cache->flags & SLAB_TYPESAFE_BY_RCU))
 253                 return init ? KASAN_TAG_KERNEL : random_tag();
 254
 255         /* For caches that either have a constructor or SLAB_TYPESAFE_BY_RCU: */
 256 #ifdef CONFIG_SLAB
 257         /* For SLAB assign tags based on the object index in the freelist. */
 258         return (u8)obj_to_index(cache, virt_to_page(object), (void *)object);
 259 #else
 260         /*
 261          * For SLUB assign a random tag during slab creation, otherwise reuse
 262          * the already assigned tag.
 263          */
 264         return init ? random_tag() : get_tag(object);
 265 #endif
 266 }
 267
 268 void * __must_check __kasan_init_slab_obj(struct kmem_cache *cache,
 269                                                 const void *object)
 270 {
 271         struct kasan_alloc_meta *alloc_meta;
 272
 273         if (kasan_stack_collection_enabled()) {
 274                 if (!(cache->flags & SLAB_KASAN))
 275                         return (void *)object;
 276
 277                 alloc_meta = kasan_get_alloc_meta(cache, object);
 278                 __memset(alloc_meta, 0, sizeof(*alloc_meta));
 279         }
 280
 281         /* Tag is ignored in set_tag() without CONFIG_KASAN_SW/HW_TAGS */
 282         object = set_tag(object, assign_tag(cache, object, true, false));
 283
 284         return (void *)object;
 285 }
 286
 287 static bool ____kasan_slab_free(struct kmem_cache *cache, void *object,
 288                               unsigned long ip, bool quarantine)
 289 {
 290         u8 tag;
 291         void *tagged_object;
 292
 293         tag = get_tag(object);
 294         tagged_object = object;
 295         object = kasan_reset_tag(object);
 296
 297         if (unlikely(nearest_obj(cache, virt_to_head_page(object), object) !=
 298             object)) {
 299                 kasan_report_invalid_free(tagged_object, ip);
 300                 return true;
 301         }
 302
 303         /* RCU slabs could be legally used after free within the RCU period */
 304         if (unlikely(cache->flags & SLAB_TYPESAFE_BY_RCU))
 305                 return false;
 306
 307         if (check_invalid_free(tagged_object)) {
 308                 kasan_report_invalid_free(tagged_object, ip);
 309                 return true;
 310         }
 311
 312         poison_range(object, cache->object_size, KASAN_KMALLOC_FREE);
 313
 314         if (!kasan_stack_collection_enabled())
 315                 return false;
 316
 317         if ((IS_ENABLED(CONFIG_KASAN_GENERIC) && !quarantine) ||
 318                         unlikely(!(cache->flags & SLAB_KASAN)))
 319                 return false;
 320
 321         kasan_set_free_info(cache, object, tag);
 322
 323         quarantine_put(cache, object);
 324
 325         return IS_ENABLED(CONFIG_KASAN_GENERIC);
 326 }
 327
 328 bool __kasan_slab_free(struct kmem_cache *cache, void *object, unsigned long ip)
 329 {
 330         return ____kasan_slab_free(cache, object, ip, true);
 331 }
 332
 333 void __kasan_slab_free_mempool(void *ptr, unsigned long ip)
 334 {
 335         struct page *page;
 336
 337         page = virt_to_head_page(ptr);
 338
 339         /*
 340          * Even though this function is only called for kmem_cache_alloc and
 341          * kmalloc backed mempool allocations, those allocations can still be
 342          * !PageSlab() when the size provided to kmalloc is larger than
 343          * KMALLOC_MAX_SIZE, and kmalloc falls back onto page_alloc.
 344          */
 345         if (unlikely(!PageSlab(page))) {
 346                 if (ptr != page_address(page)) {
 347                         kasan_report_invalid_free(ptr, ip);
 348                         return;
 349                 }
 350                 poison_range(ptr, page_size(page), KASAN_FREE_PAGE);
 351         } else {
 352                 ____kasan_slab_free(page->slab_cache, ptr, ip, false);
 353         }
 354 }
 355
 356 static void set_alloc_info(struct kmem_cache *cache, void *object, gfp_t flags)
 357 {
 358         kasan_set_track(&kasan_get_alloc_meta(cache, object)->alloc_track, flags);
 359 }
 360
 361 static void *____kasan_kmalloc(struct kmem_cache *cache, const void *object,
 362                                 size_t size, gfp_t flags, bool keep_tag)
 363 {
 364         unsigned long redzone_start;
 365         unsigned long redzone_end;
 366         u8 tag;
 367
 368         if (gfpflags_allow_blocking(flags))
 369                 quarantine_reduce();
 370
 371         if (unlikely(object == NULL))
 372                 return NULL;
 373
 374         redzone_start = round_up((unsigned long)(object + size),
 375                                 KASAN_GRANULE_SIZE);
 376         redzone_end = round_up((unsigned long)object + cache->object_size,
 377                                 KASAN_GRANULE_SIZE);
 378         tag = assign_tag(cache, object, false, keep_tag);
 379
 380         /* Tag is ignored in set_tag without CONFIG_KASAN_SW/HW_TAGS */
 381         unpoison_range(set_tag(object, tag), size);
 382         poison_range((void *)redzone_start, redzone_end - redzone_start,
 383                      KASAN_KMALLOC_REDZONE);
 384
 385         if (kasan_stack_collection_enabled() && (cache->flags & SLAB_KASAN))
 386                 set_alloc_info(cache, (void *)object, flags);
 387
 388         return set_tag(object, tag);
 389 }
 390
 391 void * __must_check __kasan_slab_alloc(struct kmem_cache *cache,
 392                                         void *object, gfp_t flags)
 393 {
 394         return ____kasan_kmalloc(cache, object, cache->object_size, flags, false);
 395 }
 396
 397 void * __must_check __kasan_kmalloc(struct kmem_cache *cache, const void *object,
 398                                         size_t size, gfp_t flags)
 399 {
 400         return ____kasan_kmalloc(cache, object, size, flags, true);
 401 }
 402 EXPORT_SYMBOL(__kasan_kmalloc);
 403
 404 void * __must_check __kasan_kmalloc_large(const void *ptr, size_t size,
 405                                                 gfp_t flags)
 406 {
 407         struct page *page;
 408         unsigned long redzone_start;
 409         unsigned long redzone_end;
 410
 411         if (gfpflags_allow_blocking(flags))
 412                 quarantine_reduce();
 413
 414         if (unlikely(ptr == NULL))
 415                 return NULL;
 416
 417         page = virt_to_page(ptr);
 418         redzone_start = round_up((unsigned long)(ptr + size),
 419                                 KASAN_GRANULE_SIZE);
 420         redzone_end = (unsigned long)ptr + page_size(page);
 421
 422         unpoison_range(ptr, size);
 423         poison_range((void *)redzone_start, redzone_end - redzone_start,
 424                      KASAN_PAGE_REDZONE);
 425
 426         return (void *)ptr;
 427 }
 428
 429 void * __must_check __kasan_krealloc(const void *object, size_t size, gfp_t flags)
 430 {
 431         struct page *page;
 432
 433         if (unlikely(object == ZERO_SIZE_PTR))
 434                 return (void *)object;
 435
 436         page = virt_to_head_page(object);
 437
 438         if (unlikely(!PageSlab(page)))
 439                 return __kasan_kmalloc_large(object, size, flags);
 440         else
 441                 return ____kasan_kmalloc(page->slab_cache, object, size,
 442                                                 flags, true);
 443 }
 444
 445 void __kasan_kfree_large(void *ptr, unsigned long ip)
 446 {
 447         if (ptr != page_address(virt_to_head_page(ptr)))
 448                 kasan_report_invalid_free(ptr, ip);
 449         /* The object will be poisoned by kasan_free_pages(). */
 450 }