SAFE public projects git trees. - safe/jmp/linux-2.6/blob - arch/x86/mm/kmmio.c

   1 /* Support for MMIO probes.
   2  * Benfit many code from kprobes
   3  * (C) 2002 Louis Zhuang <louis.zhuang@intel.com>.
   4  *     2007 Alexander Eichner
   5  *     2008 Pekka Paalanen <pq@iki.fi>
   6  */
   7
   8 #include <linux/list.h>
   9 #include <linux/spinlock.h>
  10 #include <linux/hash.h>
  11 #include <linux/init.h>
  12 #include <linux/module.h>
  13 #include <linux/kernel.h>
  14 #include <linux/uaccess.h>
  15 #include <linux/ptrace.h>
  16 #include <linux/preempt.h>
  17 #include <linux/percpu.h>
  18 #include <linux/kdebug.h>
  19 #include <linux/mutex.h>
  20 #include <linux/io.h>
  21 #include <asm/cacheflush.h>
  22 #include <asm/tlbflush.h>
  23 #include <linux/errno.h>
  24 #include <asm/debugreg.h>
  25 #include <linux/mmiotrace.h>
  26
  27 #define KMMIO_PAGE_HASH_BITS 4
  28 #define KMMIO_PAGE_TABLE_SIZE (1 << KMMIO_PAGE_HASH_BITS)
  29
  30 struct kmmio_fault_page {
  31         struct list_head list;
  32         struct kmmio_fault_page *release_next;
  33         unsigned long page; /* location of the fault page */
  34
  35         /*
  36          * Number of times this page has been registered as a part
  37          * of a probe. If zero, page is disarmed and this may be freed.
  38          * Used only by writers (RCU).
  39          */
  40         int count;
  41 };
  42
  43 struct kmmio_delayed_release {
  44         struct rcu_head rcu;
  45         struct kmmio_fault_page *release_list;
  46 };
  47
  48 struct kmmio_context {
  49         struct kmmio_fault_page *fpage;
  50         struct kmmio_probe *probe;
  51         unsigned long saved_flags;
  52         unsigned long addr;
  53         int active;
  54 };
  55
  56 static DEFINE_SPINLOCK(kmmio_lock);
  57
  58 /* Protected by kmmio_lock */
  59 unsigned int kmmio_count;
  60
  61 /* Read-protected by RCU, write-protected by kmmio_lock. */
  62 static struct list_head kmmio_page_table[KMMIO_PAGE_TABLE_SIZE];
  63 static LIST_HEAD(kmmio_probes);
  64
  65 static struct list_head *kmmio_page_list(unsigned long page)
  66 {
  67         return &kmmio_page_table[hash_long(page, KMMIO_PAGE_HASH_BITS)];
  68 }
  69
  70 /* Accessed per-cpu */
  71 static DEFINE_PER_CPU(struct kmmio_context, kmmio_ctx);
  72
  73 /*
  74  * this is basically a dynamic stabbing problem:
  75  * Could use the existing prio tree code or
  76  * Possible better implementations:
  77  * The Interval Skip List: A Data Structure for Finding All Intervals That
  78  * Overlap a Point (might be simple)
  79  * Space Efficient Dynamic Stabbing with Fast Queries - Mikkel Thorup
  80  */
  81 /* Get the kmmio at this addr (if any). You must be holding RCU read lock. */
  82 static struct kmmio_probe *get_kmmio_probe(unsigned long addr)
  83 {
  84         struct kmmio_probe *p;
  85         list_for_each_entry_rcu(p, &kmmio_probes, list) {
  86                 if (addr >= p->addr && addr <= (p->addr + p->len))
  87                         return p;
  88         }
  89         return NULL;
  90 }
  91
  92 /* You must be holding RCU read lock. */
  93 static struct kmmio_fault_page *get_kmmio_fault_page(unsigned long page)
  94 {
  95         struct list_head *head;
  96         struct kmmio_fault_page *p;
  97
  98         page &= PAGE_MASK;
  99         head = kmmio_page_list(page);
 100         list_for_each_entry_rcu(p, head, list) {
 101                 if (p->page == page)
 102                         return p;
 103         }
 104         return NULL;
 105 }
 106
 107 static void set_page_present(unsigned long addr, bool present, int *pglevel)
 108 {
 109         pteval_t pteval;
 110         pmdval_t pmdval;
 111         int level;
 112         pmd_t *pmd;
 113         pte_t *pte = lookup_address(addr, &level);
 114
 115         if (!pte) {
 116                 pr_err("kmmio: no pte for page 0x%08lx\n", addr);
 117                 return;
 118         }
 119
 120         if (pglevel)
 121                 *pglevel = level;
 122
 123         switch (level) {
 124         case PG_LEVEL_2M:
 125                 pmd = (pmd_t *)pte;
 126                 pmdval = pmd_val(*pmd) & ~_PAGE_PRESENT;
 127                 if (present)
 128                         pmdval |= _PAGE_PRESENT;
 129                 set_pmd(pmd, __pmd(pmdval));
 130                 break;
 131
 132         case PG_LEVEL_4K:
 133                 pteval = pte_val(*pte) & ~_PAGE_PRESENT;
 134                 if (present)
 135                         pteval |= _PAGE_PRESENT;
 136                 set_pte_atomic(pte, __pte(pteval));
 137                 break;
 138
 139         default:
 140                 pr_err("kmmio: unexpected page level 0x%x.\n", level);
 141                 return;
 142         }
 143
 144         __flush_tlb_one(addr);
 145 }
 146
 147 /** Mark the given page as not present. Access to it will trigger a fault. */
 148 static void arm_kmmio_fault_page(unsigned long page, int *page_level)
 149 {
 150         set_page_present(page & PAGE_MASK, false, page_level);
 151 }
 152
 153 /** Mark the given page as present. */
 154 static void disarm_kmmio_fault_page(unsigned long page, int *page_level)
 155 {
 156         set_page_present(page & PAGE_MASK, true, page_level);
 157 }
 158
 159 /*
 160  * This is being called from do_page_fault().
 161  *
 162  * We may be in an interrupt or a critical section. Also prefecthing may
 163  * trigger a page fault. We may be in the middle of process switch.
 164  * We cannot take any locks, because we could be executing especially
 165  * within a kmmio critical section.
 166  *
 167  * Local interrupts are disabled, so preemption cannot happen.
 168  * Do not enable interrupts, do not sleep, and watch out for other CPUs.
 169  */
 170 /*
 171  * Interrupts are disabled on entry as trap3 is an interrupt gate
 172  * and they remain disabled thorough out this function.
 173  */
 174 int kmmio_handler(struct pt_regs *regs, unsigned long addr)
 175 {
 176         struct kmmio_context *ctx;
 177         struct kmmio_fault_page *faultpage;
 178         int ret = 0; /* default to fault not handled */
 179
 180         /*
 181          * Preemption is now disabled to prevent process switch during
 182          * single stepping. We can only handle one active kmmio trace
 183          * per cpu, so ensure that we finish it before something else
 184          * gets to run. We also hold the RCU read lock over single
 185          * stepping to avoid looking up the probe and kmmio_fault_page
 186          * again.
 187          */
 188         preempt_disable();
 189         rcu_read_lock();
 190
 191         faultpage = get_kmmio_fault_page(addr);
 192         if (!faultpage) {
 193                 /*
 194                  * Either this page fault is not caused by kmmio, or
 195                  * another CPU just pulled the kmmio probe from under
 196                  * our feet. The latter case should not be possible.
 197                  */
 198                 goto no_kmmio;
 199         }
 200
 201         ctx = &get_cpu_var(kmmio_ctx);
 202         if (ctx->active) {
 203                 disarm_kmmio_fault_page(faultpage->page, NULL);
 204                 if (addr == ctx->addr) {
 205                         /*
 206                          * On SMP we sometimes get recursive probe hits on the
 207                          * same address. Context is already saved, fall out.
 208                          */
 209                         pr_debug("kmmio: duplicate probe hit on CPU %d, for "
 210                                                 "address 0x%08lx.\n",
 211                                                 smp_processor_id(), addr);
 212                         ret = 1;
 213                         goto no_kmmio_ctx;
 214                 }
 215                 /*
 216                  * Prevent overwriting already in-flight context.
 217                  * This should not happen, let's hope disarming at least
 218                  * prevents a panic.
 219                  */
 220                 pr_emerg("kmmio: recursive probe hit on CPU %d, "
 221                                         "for address 0x%08lx. Ignoring.\n",
 222                                         smp_processor_id(), addr);
 223                 pr_emerg("kmmio: previous hit was at 0x%08lx.\n",
 224                                         ctx->addr);
 225                 goto no_kmmio_ctx;
 226         }
 227         ctx->active++;
 228
 229         ctx->fpage = faultpage;
 230         ctx->probe = get_kmmio_probe(addr);
 231         ctx->saved_flags = (regs->flags & (X86_EFLAGS_TF | X86_EFLAGS_IF));
 232         ctx->addr = addr;
 233
 234         if (ctx->probe && ctx->probe->pre_handler)
 235                 ctx->probe->pre_handler(ctx->probe, regs, addr);
 236
 237         /*
 238          * Enable single-stepping and disable interrupts for the faulting
 239          * context. Local interrupts must not get enabled during stepping.
 240          */
 241         regs->flags |= X86_EFLAGS_TF;
 242         regs->flags &= ~X86_EFLAGS_IF;
 243
 244         /* Now we set present bit in PTE and single step. */
 245         disarm_kmmio_fault_page(ctx->fpage->page, NULL);
 246
 247         /*
 248          * If another cpu accesses the same page while we are stepping,
 249          * the access will not be caught. It will simply succeed and the
 250          * only downside is we lose the event. If this becomes a problem,
 251          * the user should drop to single cpu before tracing.
 252          */
 253
 254         put_cpu_var(kmmio_ctx);
 255         return 1; /* fault handled */
 256
 257 no_kmmio_ctx:
 258         put_cpu_var(kmmio_ctx);
 259 no_kmmio:
 260         rcu_read_unlock();
 261         preempt_enable_no_resched();
 262         return ret;
 263 }
 264
 265 /*
 266  * Interrupts are disabled on entry as trap1 is an interrupt gate
 267  * and they remain disabled thorough out this function.
 268  * This must always get called as the pair to kmmio_handler().
 269  */
 270 static int post_kmmio_handler(unsigned long condition, struct pt_regs *regs)
 271 {
 272         int ret = 0;
 273         struct kmmio_context *ctx = &get_cpu_var(kmmio_ctx);
 274
 275         if (!ctx->active) {
 276                 pr_debug("kmmio: spurious debug trap on CPU %d.\n",
 277                                                         smp_processor_id());
 278                 goto out;
 279         }
 280
 281         if (ctx->probe && ctx->probe->post_handler)
 282                 ctx->probe->post_handler(ctx->probe, condition, regs);
 283
 284         arm_kmmio_fault_page(ctx->fpage->page, NULL);
 285
 286         regs->flags &= ~X86_EFLAGS_TF;
 287         regs->flags |= ctx->saved_flags;
 288
 289         /* These were acquired in kmmio_handler(). */
 290         ctx->active--;
 291         BUG_ON(ctx->active);
 292         rcu_read_unlock();
 293         preempt_enable_no_resched();
 294
 295         /*
 296          * if somebody else is singlestepping across a probe point, flags
 297          * will have TF set, in which case, continue the remaining processing
 298          * of do_debug, as if this is not a probe hit.
 299          */
 300         if (!(regs->flags & X86_EFLAGS_TF))
 301                 ret = 1;
 302 out:
 303         put_cpu_var(kmmio_ctx);
 304         return ret;
 305 }
 306
 307 /* You must be holding kmmio_lock. */
 308 static int add_kmmio_fault_page(unsigned long page)
 309 {
 310         struct kmmio_fault_page *f;
 311
 312         page &= PAGE_MASK;
 313         f = get_kmmio_fault_page(page);
 314         if (f) {
 315                 if (!f->count)
 316                         arm_kmmio_fault_page(f->page, NULL);
 317                 f->count++;
 318                 return 0;
 319         }
 320
 321         f = kmalloc(sizeof(*f), GFP_ATOMIC);
 322         if (!f)
 323                 return -1;
 324
 325         f->count = 1;
 326         f->page = page;
 327         list_add_rcu(&f->list, kmmio_page_list(f->page));
 328
 329         arm_kmmio_fault_page(f->page, NULL);
 330
 331         return 0;
 332 }
 333
 334 /* You must be holding kmmio_lock. */
 335 static void release_kmmio_fault_page(unsigned long page,
 336                                 struct kmmio_fault_page **release_list)
 337 {
 338         struct kmmio_fault_page *f;
 339
 340         page &= PAGE_MASK;
 341         f = get_kmmio_fault_page(page);
 342         if (!f)
 343                 return;
 344
 345         f->count--;
 346         BUG_ON(f->count < 0);
 347         if (!f->count) {
 348                 disarm_kmmio_fault_page(f->page, NULL);
 349                 f->release_next = *release_list;
 350                 *release_list = f;
 351         }
 352 }
 353
 354 /*
 355  * With page-unaligned ioremaps, one or two armed pages may contain
 356  * addresses from outside the intended mapping. Events for these addresses
 357  * are currently silently dropped. The events may result only from programming
 358  * mistakes by accessing addresses before the beginning or past the end of a
 359  * mapping.
 360  */
 361 int register_kmmio_probe(struct kmmio_probe *p)
 362 {
 363         unsigned long flags;
 364         int ret = 0;
 365         unsigned long size = 0;
 366         const unsigned long size_lim = p->len + (p->addr & ~PAGE_MASK);
 367
 368         spin_lock_irqsave(&kmmio_lock, flags);
 369         if (get_kmmio_probe(p->addr)) {
 370                 ret = -EEXIST;
 371                 goto out;
 372         }
 373         kmmio_count++;
 374         list_add_rcu(&p->list, &kmmio_probes);
 375         while (size < size_lim) {
 376                 if (add_kmmio_fault_page(p->addr + size))
 377                         pr_err("kmmio: Unable to set page fault.\n");
 378                 size += PAGE_SIZE;
 379         }
 380 out:
 381         spin_unlock_irqrestore(&kmmio_lock, flags);
 382         /*
 383          * XXX: What should I do here?
 384          * Here was a call to global_flush_tlb(), but it does not exist
 385          * anymore. It seems it's not needed after all.
 386          */
 387         return ret;
 388 }
 389 EXPORT_SYMBOL(register_kmmio_probe);
 390
 391 static void rcu_free_kmmio_fault_pages(struct rcu_head *head)
 392 {
 393         struct kmmio_delayed_release *dr = container_of(
 394                                                 head,
 395                                                 struct kmmio_delayed_release,
 396                                                 rcu);
 397         struct kmmio_fault_page *p = dr->release_list;
 398         while (p) {
 399                 struct kmmio_fault_page *next = p->release_next;
 400                 BUG_ON(p->count);
 401                 kfree(p);
 402                 p = next;
 403         }
 404         kfree(dr);
 405 }
 406
 407 static void remove_kmmio_fault_pages(struct rcu_head *head)
 408 {
 409         struct kmmio_delayed_release *dr = container_of(
 410                                                 head,
 411                                                 struct kmmio_delayed_release,
 412                                                 rcu);
 413         struct kmmio_fault_page *p = dr->release_list;
 414         struct kmmio_fault_page **prevp = &dr->release_list;
 415         unsigned long flags;
 416         spin_lock_irqsave(&kmmio_lock, flags);
 417         while (p) {
 418                 if (!p->count)
 419                         list_del_rcu(&p->list);
 420                 else
 421                         *prevp = p->release_next;
 422                 prevp = &p->release_next;
 423                 p = p->release_next;
 424         }
 425         spin_unlock_irqrestore(&kmmio_lock, flags);
 426         /* This is the real RCU destroy call. */
 427         call_rcu(&dr->rcu, rcu_free_kmmio_fault_pages);
 428 }
 429
 430 /*
 431  * Remove a kmmio probe. You have to synchronize_rcu() before you can be
 432  * sure that the callbacks will not be called anymore. Only after that
 433  * you may actually release your struct kmmio_probe.
 434  *
 435  * Unregistering a kmmio fault page has three steps:
 436  * 1. release_kmmio_fault_page()
 437  *    Disarm the page, wait a grace period to let all faults finish.
 438  * 2. remove_kmmio_fault_pages()
 439  *    Remove the pages from kmmio_page_table.
 440  * 3. rcu_free_kmmio_fault_pages()
 441  *    Actally free the kmmio_fault_page structs as with RCU.
 442  */
 443 void unregister_kmmio_probe(struct kmmio_probe *p)
 444 {
 445         unsigned long flags;
 446         unsigned long size = 0;
 447         const unsigned long size_lim = p->len + (p->addr & ~PAGE_MASK);
 448         struct kmmio_fault_page *release_list = NULL;
 449         struct kmmio_delayed_release *drelease;
 450
 451         spin_lock_irqsave(&kmmio_lock, flags);
 452         while (size < size_lim) {
 453                 release_kmmio_fault_page(p->addr + size, &release_list);
 454                 size += PAGE_SIZE;
 455         }
 456         list_del_rcu(&p->list);
 457         kmmio_count--;
 458         spin_unlock_irqrestore(&kmmio_lock, flags);
 459
 460         drelease = kmalloc(sizeof(*drelease), GFP_ATOMIC);
 461         if (!drelease) {
 462                 pr_crit("kmmio: leaking kmmio_fault_page objects.\n");
 463                 return;
 464         }
 465         drelease->release_list = release_list;
 466
 467         /*
 468          * This is not really RCU here. We have just disarmed a set of
 469          * pages so that they cannot trigger page faults anymore. However,
 470          * we cannot remove the pages from kmmio_page_table,
 471          * because a probe hit might be in flight on another CPU. The
 472          * pages are collected into a list, and they will be removed from
 473          * kmmio_page_table when it is certain that no probe hit related to
 474          * these pages can be in flight. RCU grace period sounds like a
 475          * good choice.
 476          *
 477          * If we removed the pages too early, kmmio page fault handler might
 478          * not find the respective kmmio_fault_page and determine it's not
 479          * a kmmio fault, when it actually is. This would lead to madness.
 480          */
 481         call_rcu(&drelease->rcu, remove_kmmio_fault_pages);
 482 }
 483 EXPORT_SYMBOL(unregister_kmmio_probe);
 484
 485 static int kmmio_die_notifier(struct notifier_block *nb, unsigned long val,
 486                                                                 void *args)
 487 {
 488         struct die_args *arg = args;
 489
 490         if (val == DIE_DEBUG && (arg->err & DR_STEP))
 491                 if (post_kmmio_handler(arg->err, arg->regs) == 1)
 492                         return NOTIFY_STOP;
 493
 494         return NOTIFY_DONE;
 495 }
 496
 497 static struct notifier_block nb_die = {
 498         .notifier_call = kmmio_die_notifier
 499 };
 500
 501 static int __init init_kmmio(void)
 502 {
 503         int i;
 504         for (i = 0; i < KMMIO_PAGE_TABLE_SIZE; i++)
 505                 INIT_LIST_HEAD(&kmmio_page_table[i]);
 506         return register_die_notifier(&nb_die);
 507 }
 508 fs_initcall(init_kmmio); /* should be before device_initcall() */