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         /* Add alloc meta. */
 138         cache->kasan_info.alloc_meta_offset = *size;
 139         *size += sizeof(struct kasan_alloc_meta);
 140
 141         /* Add free meta. */
 142         if (IS_ENABLED(CONFIG_KASAN_GENERIC) &&
 143             (cache->flags & SLAB_TYPESAFE_BY_RCU || cache->ctor ||
 144              cache->object_size < sizeof(struct kasan_free_meta))) {
 145                 cache->kasan_info.free_meta_offset = *size;
 146                 *size += sizeof(struct kasan_free_meta);
 147         }
 148
 149         redzone_size = optimal_redzone(cache->object_size);
 150         redzone_adjust = redzone_size - (*size - cache->object_size);
 151         if (redzone_adjust > 0)
 152                 *size += redzone_adjust;
 153
 154         *size = min_t(unsigned int, KMALLOC_MAX_SIZE,
 155                         max(*size, cache->object_size + redzone_size));
 156
 157         /*
 158          * If the metadata doesn't fit, don't enable KASAN at all.
 159          */
 160         if (*size <= cache->kasan_info.alloc_meta_offset ||
 161                         *size <= cache->kasan_info.free_meta_offset) {
 162                 cache->kasan_info.alloc_meta_offset = 0;
 163                 cache->kasan_info.free_meta_offset = 0;
 164                 *size = orig_size;
 165                 return;
 166         }
 167
 168         *flags |= SLAB_KASAN;
 169 }
 170
 171 size_t kasan_metadata_size(struct kmem_cache *cache)
 172 {
 173         return (cache->kasan_info.alloc_meta_offset ?
 174                 sizeof(struct kasan_alloc_meta) : 0) +
 175                 (cache->kasan_info.free_meta_offset ?
 176                 sizeof(struct kasan_free_meta) : 0);
 177 }
 178
 179 struct kasan_alloc_meta *kasan_get_alloc_meta(struct kmem_cache *cache,
 180                                               const void *object)
 181 {
 182         return (void *)reset_tag(object) + cache->kasan_info.alloc_meta_offset;
 183 }
 184
 185 struct kasan_free_meta *kasan_get_free_meta(struct kmem_cache *cache,
 186                                             const void *object)
 187 {
 188         BUILD_BUG_ON(sizeof(struct kasan_free_meta) > 32);
 189         return (void *)reset_tag(object) + cache->kasan_info.free_meta_offset;
 190 }
 191
 192 void kasan_poison_slab(struct page *page)
 193 {
 194         unsigned long i;
 195
 196         for (i = 0; i < compound_nr(page); i++)
 197                 page_kasan_tag_reset(page + i);
 198         poison_range(page_address(page), page_size(page),
 199                      KASAN_KMALLOC_REDZONE);
 200 }
 201
 202 void kasan_unpoison_object_data(struct kmem_cache *cache, void *object)
 203 {
 204         unpoison_range(object, cache->object_size);
 205 }
 206
 207 void kasan_poison_object_data(struct kmem_cache *cache, void *object)
 208 {
 209         poison_range(object,
 210                         round_up(cache->object_size, KASAN_GRANULE_SIZE),
 211                         KASAN_KMALLOC_REDZONE);
 212 }
 213
 214 /*
 215  * This function assigns a tag to an object considering the following:
 216  * 1. A cache might have a constructor, which might save a pointer to a slab
 217  *    object somewhere (e.g. in the object itself). We preassign a tag for
 218  *    each object in caches with constructors during slab creation and reuse
 219  *    the same tag each time a particular object is allocated.
 220  * 2. A cache might be SLAB_TYPESAFE_BY_RCU, which means objects can be
 221  *    accessed after being freed. We preassign tags for objects in these
 222  *    caches as well.
 223  * 3. For SLAB allocator we can't preassign tags randomly since the freelist
 224  *    is stored as an array of indexes instead of a linked list. Assign tags
 225  *    based on objects indexes, so that objects that are next to each other
 226  *    get different tags.
 227  */
 228 static u8 assign_tag(struct kmem_cache *cache, const void *object,
 229                         bool init, bool keep_tag)
 230 {
 231         /*
 232          * 1. When an object is kmalloc()'ed, two hooks are called:
 233          *    kasan_slab_alloc() and kasan_kmalloc(). We assign the
 234          *    tag only in the first one.
 235          * 2. We reuse the same tag for krealloc'ed objects.
 236          */
 237         if (keep_tag)
 238                 return get_tag(object);
 239
 240         /*
 241          * If the cache neither has a constructor nor has SLAB_TYPESAFE_BY_RCU
 242          * set, assign a tag when the object is being allocated (init == false).
 243          */
 244         if (!cache->ctor && !(cache->flags & SLAB_TYPESAFE_BY_RCU))
 245                 return init ? KASAN_TAG_KERNEL : random_tag();
 246
 247         /* For caches that either have a constructor or SLAB_TYPESAFE_BY_RCU: */
 248 #ifdef CONFIG_SLAB
 249         /* For SLAB assign tags based on the object index in the freelist. */
 250         return (u8)obj_to_index(cache, virt_to_page(object), (void *)object);
 251 #else
 252         /*
 253          * For SLUB assign a random tag during slab creation, otherwise reuse
 254          * the already assigned tag.
 255          */
 256         return init ? random_tag() : get_tag(object);
 257 #endif
 258 }
 259
 260 void * __must_check kasan_init_slab_obj(struct kmem_cache *cache,
 261                                                 const void *object)
 262 {
 263         struct kasan_alloc_meta *alloc_meta;
 264
 265         if (!(cache->flags & SLAB_KASAN))
 266                 return (void *)object;
 267
 268         alloc_meta = kasan_get_alloc_meta(cache, object);
 269         __memset(alloc_meta, 0, sizeof(*alloc_meta));
 270
 271         if (IS_ENABLED(CONFIG_KASAN_SW_TAGS) || IS_ENABLED(CONFIG_KASAN_HW_TAGS))
 272                 object = set_tag(object, assign_tag(cache, object, true, false));
 273
 274         return (void *)object;
 275 }
 276
 277 static bool __kasan_slab_free(struct kmem_cache *cache, void *object,
 278                               unsigned long ip, bool quarantine)
 279 {
 280         u8 tag;
 281         void *tagged_object;
 282         unsigned long rounded_up_size;
 283
 284         tag = get_tag(object);
 285         tagged_object = object;
 286         object = reset_tag(object);
 287
 288         if (unlikely(nearest_obj(cache, virt_to_head_page(object), object) !=
 289             object)) {
 290                 kasan_report_invalid_free(tagged_object, ip);
 291                 return true;
 292         }
 293
 294         /* RCU slabs could be legally used after free within the RCU period */
 295         if (unlikely(cache->flags & SLAB_TYPESAFE_BY_RCU))
 296                 return false;
 297
 298         if (check_invalid_free(tagged_object)) {
 299                 kasan_report_invalid_free(tagged_object, ip);
 300                 return true;
 301         }
 302
 303         rounded_up_size = round_up(cache->object_size, KASAN_GRANULE_SIZE);
 304         poison_range(object, rounded_up_size, KASAN_KMALLOC_FREE);
 305
 306         if ((IS_ENABLED(CONFIG_KASAN_GENERIC) && !quarantine) ||
 307                         unlikely(!(cache->flags & SLAB_KASAN)))
 308                 return false;
 309
 310         kasan_set_free_info(cache, object, tag);
 311
 312         quarantine_put(cache, object);
 313
 314         return IS_ENABLED(CONFIG_KASAN_GENERIC);
 315 }
 316
 317 bool kasan_slab_free(struct kmem_cache *cache, void *object, unsigned long ip)
 318 {
 319         return __kasan_slab_free(cache, object, ip, true);
 320 }
 321
 322 static void set_alloc_info(struct kmem_cache *cache, void *object, gfp_t flags)
 323 {
 324         kasan_set_track(&kasan_get_alloc_meta(cache, object)->alloc_track, flags);
 325 }
 326
 327 static void *__kasan_kmalloc(struct kmem_cache *cache, const void *object,
 328                                 size_t size, gfp_t flags, bool keep_tag)
 329 {
 330         unsigned long redzone_start;
 331         unsigned long redzone_end;
 332         u8 tag = 0xff;
 333
 334         if (gfpflags_allow_blocking(flags))
 335                 quarantine_reduce();
 336
 337         if (unlikely(object == NULL))
 338                 return NULL;
 339
 340         redzone_start = round_up((unsigned long)(object + size),
 341                                 KASAN_GRANULE_SIZE);
 342         redzone_end = round_up((unsigned long)object + cache->object_size,
 343                                 KASAN_GRANULE_SIZE);
 344
 345         if (IS_ENABLED(CONFIG_KASAN_SW_TAGS) || IS_ENABLED(CONFIG_KASAN_HW_TAGS))
 346                 tag = assign_tag(cache, object, false, keep_tag);
 347
 348         /* Tag is ignored in set_tag without CONFIG_KASAN_SW/HW_TAGS */
 349         unpoison_range(set_tag(object, tag), size);
 350         poison_range((void *)redzone_start, redzone_end - redzone_start,
 351                      KASAN_KMALLOC_REDZONE);
 352
 353         if (cache->flags & SLAB_KASAN)
 354                 set_alloc_info(cache, (void *)object, flags);
 355
 356         return set_tag(object, tag);
 357 }
 358
 359 void * __must_check kasan_slab_alloc(struct kmem_cache *cache, void *object,
 360                                         gfp_t flags)
 361 {
 362         return __kasan_kmalloc(cache, object, cache->object_size, flags, false);
 363 }
 364
 365 void * __must_check kasan_kmalloc(struct kmem_cache *cache, const void *object,
 366                                 size_t size, gfp_t flags)
 367 {
 368         return __kasan_kmalloc(cache, object, size, flags, true);
 369 }
 370 EXPORT_SYMBOL(kasan_kmalloc);
 371
 372 void * __must_check kasan_kmalloc_large(const void *ptr, size_t size,
 373                                                 gfp_t flags)
 374 {
 375         struct page *page;
 376         unsigned long redzone_start;
 377         unsigned long redzone_end;
 378
 379         if (gfpflags_allow_blocking(flags))
 380                 quarantine_reduce();
 381
 382         if (unlikely(ptr == NULL))
 383                 return NULL;
 384
 385         page = virt_to_page(ptr);
 386         redzone_start = round_up((unsigned long)(ptr + size),
 387                                 KASAN_GRANULE_SIZE);
 388         redzone_end = (unsigned long)ptr + page_size(page);
 389
 390         unpoison_range(ptr, size);
 391         poison_range((void *)redzone_start, redzone_end - redzone_start,
 392                      KASAN_PAGE_REDZONE);
 393
 394         return (void *)ptr;
 395 }
 396
 397 void * __must_check kasan_krealloc(const void *object, size_t size, gfp_t flags)
 398 {
 399         struct page *page;
 400
 401         if (unlikely(object == ZERO_SIZE_PTR))
 402                 return (void *)object;
 403
 404         page = virt_to_head_page(object);
 405
 406         if (unlikely(!PageSlab(page)))
 407                 return kasan_kmalloc_large(object, size, flags);
 408         else
 409                 return __kasan_kmalloc(page->slab_cache, object, size,
 410                                                 flags, true);
 411 }
 412
 413 void kasan_poison_kfree(void *ptr, unsigned long ip)
 414 {
 415         struct page *page;
 416
 417         page = virt_to_head_page(ptr);
 418
 419         if (unlikely(!PageSlab(page))) {
 420                 if (ptr != page_address(page)) {
 421                         kasan_report_invalid_free(ptr, ip);
 422                         return;
 423                 }
 424                 poison_range(ptr, page_size(page), KASAN_FREE_PAGE);
 425         } else {
 426                 __kasan_slab_free(page->slab_cache, ptr, ip, false);
 427         }
 428 }
 429
 430 void kasan_kfree_large(void *ptr, unsigned long ip)
 431 {
 432         if (ptr != page_address(virt_to_head_page(ptr)))
 433                 kasan_report_invalid_free(ptr, ip);
 434         /* The object will be poisoned by page_alloc. */
 435 }