kernel/smp.c

   1 /*
   2  * Generic helpers for smp ipi calls
   3  *
   4  * (C) Jens Axboe <jens.axboe@oracle.com> 2008
   5  */
   6 #include <linux/rcupdate.h>
   7 #include <linux/rculist.h>
   8 #include <linux/kernel.h>
   9 #include <linux/module.h>
  10 #include <linux/percpu.h>
  11 #include <linux/init.h>
  12 #include <linux/gfp.h>
  13 #include <linux/smp.h>
  14 #include <linux/cpu.h>
  15
  16 #ifdef CONFIG_USE_GENERIC_SMP_HELPERS
  17 static struct {
  18         struct list_head        queue;
  19         raw_spinlock_t          lock;
  20 } call_function __cacheline_aligned_in_smp =
  21         {
  22                 .queue          = LIST_HEAD_INIT(call_function.queue),
  23                 .lock           = __RAW_SPIN_LOCK_UNLOCKED(call_function.lock),
  24         };
  25
  26 enum {
  27         CSD_FLAG_LOCK           = 0x01,
  28 };
  29
  30 struct call_function_data {
  31         struct call_single_data csd;
  32         atomic_t                refs;
  33         cpumask_var_t           cpumask;
  34 };
  35
  36 static DEFINE_PER_CPU_SHARED_ALIGNED(struct call_function_data, cfd_data);
  37
  38 struct call_single_queue {
  39         struct list_head        list;
  40         raw_spinlock_t          lock;
  41 };
  42
  43 static DEFINE_PER_CPU_SHARED_ALIGNED(struct call_single_queue, call_single_queue);
  44
  45 static int
  46 hotplug_cfd(struct notifier_block *nfb, unsigned long action, void *hcpu)
  47 {
  48         long cpu = (long)hcpu;
  49         struct call_function_data *cfd = &per_cpu(cfd_data, cpu);
  50
  51         switch (action) {
  52         case CPU_UP_PREPARE:
  53         case CPU_UP_PREPARE_FROZEN:
  54                 if (!zalloc_cpumask_var_node(&cfd->cpumask, GFP_KERNEL,
  55                                 cpu_to_node(cpu)))
  56                         return notifier_from_errno(-ENOMEM);
  57                 break;
  58
  59 #ifdef CONFIG_HOTPLUG_CPU
  60         case CPU_UP_CANCELED:
  61         case CPU_UP_CANCELED_FROZEN:
  62
  63         case CPU_DEAD:
  64         case CPU_DEAD_FROZEN:
  65                 free_cpumask_var(cfd->cpumask);
  66                 break;
  67 #endif
  68         };
  69
  70         return NOTIFY_OK;
  71 }
  72
  73 static struct notifier_block __cpuinitdata hotplug_cfd_notifier = {
  74         .notifier_call          = hotplug_cfd,
  75 };
  76
  77 static int __cpuinit init_call_single_data(void)
  78 {
  79         void *cpu = (void *)(long)smp_processor_id();
  80         int i;
  81
  82         for_each_possible_cpu(i) {
  83                 struct call_single_queue *q = &per_cpu(call_single_queue, i);
  84
  85                 raw_spin_lock_init(&q->lock);
  86                 INIT_LIST_HEAD(&q->list);
  87         }
  88
  89         hotplug_cfd(&hotplug_cfd_notifier, CPU_UP_PREPARE, cpu);
  90         register_cpu_notifier(&hotplug_cfd_notifier);
  91
  92         return 0;
  93 }
  94 early_initcall(init_call_single_data);
  95
  96 /*
  97  * csd_lock/csd_unlock used to serialize access to per-cpu csd resources
  98  *
  99  * For non-synchronous ipi calls the csd can still be in use by the
 100  * previous function call. For multi-cpu calls its even more interesting
 101  * as we'll have to ensure no other cpu is observing our csd.
 102  */
 103 static void csd_lock_wait(struct call_single_data *data)
 104 {
 105         while (data->flags & CSD_FLAG_LOCK)
 106                 cpu_relax();
 107 }
 108
 109 static void csd_lock(struct call_single_data *data)
 110 {
 111         csd_lock_wait(data);
 112         data->flags = CSD_FLAG_LOCK;
 113
 114         /*
 115          * prevent CPU from reordering the above assignment
 116          * to ->flags with any subsequent assignments to other
 117          * fields of the specified call_single_data structure:
 118          */
 119         smp_mb();
 120 }
 121
 122 static void csd_unlock(struct call_single_data *data)
 123 {
 124         WARN_ON(!(data->flags & CSD_FLAG_LOCK));
 125
 126         /*
 127          * ensure we're all done before releasing data:
 128          */
 129         smp_mb();
 130
 131         data->flags &= ~CSD_FLAG_LOCK;
 132 }
 133
 134 /*
 135  * Insert a previously allocated call_single_data element
 136  * for execution on the given CPU. data must already have
 137  * ->func, ->info, and ->flags set.
 138  */
 139 static
 140 void generic_exec_single(int cpu, struct call_single_data *data, int wait)
 141 {
 142         struct call_single_queue *dst = &per_cpu(call_single_queue, cpu);
 143         unsigned long flags;
 144         int ipi;
 145
 146         raw_spin_lock_irqsave(&dst->lock, flags);
 147         ipi = list_empty(&dst->list);
 148         list_add_tail(&data->list, &dst->list);
 149         raw_spin_unlock_irqrestore(&dst->lock, flags);
 150
 151         /*
 152          * The list addition should be visible before sending the IPI
 153          * handler locks the list to pull the entry off it because of
 154          * normal cache coherency rules implied by spinlocks.
 155          *
 156          * If IPIs can go out of order to the cache coherency protocol
 157          * in an architecture, sufficient synchronisation should be added
 158          * to arch code to make it appear to obey cache coherency WRT
 159          * locking and barrier primitives. Generic code isn't really
 160          * equipped to do the right thing...
 161          */
 162         if (ipi)
 163                 arch_send_call_function_single_ipi(cpu);
 164
 165         if (wait)
 166                 csd_lock_wait(data);
 167 }
 168
 169 /*
 170  * Invoked by arch to handle an IPI for call function. Must be called with
 171  * interrupts disabled.
 172  */
 173 void generic_smp_call_function_interrupt(void)
 174 {
 175         struct call_function_data *data;
 176         int cpu = smp_processor_id();
 177
 178         /*
 179          * Shouldn't receive this interrupt on a cpu that is not yet online.
 180          */
 181         WARN_ON_ONCE(!cpu_online(cpu));
 182
 183         /*
 184          * Ensure entry is visible on call_function_queue after we have
 185          * entered the IPI. See comment in smp_call_function_many.
 186          * If we don't have this, then we may miss an entry on the list
 187          * and never get another IPI to process it.
 188          */
 189         smp_mb();
 190
 191         /*
 192          * It's ok to use list_for_each_rcu() here even though we may
 193          * delete 'pos', since list_del_rcu() doesn't clear ->next
 194          */
 195         list_for_each_entry_rcu(data, &call_function.queue, csd.list) {
 196                 int refs;
 197
 198                 /*
 199                  * Since we walk the list without any locks, we might
 200                  * see an entry that was completed, removed from the
 201                  * list and is in the process of being reused.
 202                  *
 203                  * We must check that the cpu is in the cpumask before
 204                  * checking the refs, and both must be set before
 205                  * executing the callback on this cpu.
 206                  */
 207
 208                 if (!cpumask_test_cpu(cpu, data->cpumask))
 209                         continue;
 210
 211                 smp_rmb();
 212
 213                 if (atomic_read(&data->refs) == 0)
 214                         continue;
 215
 216                 if (!cpumask_test_and_clear_cpu(cpu, data->cpumask))
 217                         continue;
 218
 219                 data->csd.func(data->csd.info);
 220
 221                 refs = atomic_dec_return(&data->refs);
 222                 WARN_ON(refs < 0);
 223                 if (!refs) {
 224                         WARN_ON(!cpumask_empty(data->cpumask));
 225
 226                         raw_spin_lock(&call_function.lock);
 227                         list_del_rcu(&data->csd.list);
 228                         raw_spin_unlock(&call_function.lock);
 229                 }
 230
 231                 if (refs)
 232                         continue;
 233
 234                 csd_unlock(&data->csd);
 235         }
 236
 237 }
 238
 239 /*
 240  * Invoked by arch to handle an IPI for call function single. Must be
 241  * called from the arch with interrupts disabled.
 242  */
 243 void generic_smp_call_function_single_interrupt(void)
 244 {
 245         struct call_single_queue *q = &__get_cpu_var(call_single_queue);
 246         unsigned int data_flags;
 247         LIST_HEAD(list);
 248
 249         /*
 250          * Shouldn't receive this interrupt on a cpu that is not yet online.
 251          */
 252         WARN_ON_ONCE(!cpu_online(smp_processor_id()));
 253
 254         raw_spin_lock(&q->lock);
 255         list_replace_init(&q->list, &list);
 256         raw_spin_unlock(&q->lock);
 257
 258         while (!list_empty(&list)) {
 259                 struct call_single_data *data;
 260
 261                 data = list_entry(list.next, struct call_single_data, list);
 262                 list_del(&data->list);
 263
 264                 /*
 265                  * 'data' can be invalid after this call if flags == 0
 266                  * (when called through generic_exec_single()),
 267                  * so save them away before making the call:
 268                  */
 269                 data_flags = data->flags;
 270
 271                 data->func(data->info);
 272
 273                 /*
 274                  * Unlocked CSDs are valid through generic_exec_single():
 275                  */
 276                 if (data_flags & CSD_FLAG_LOCK)
 277                         csd_unlock(data);
 278         }
 279 }
 280
 281 static DEFINE_PER_CPU_SHARED_ALIGNED(struct call_single_data, csd_data);
 282
 283 /*
 284  * smp_call_function_single - Run a function on a specific CPU
 285  * @func: The function to run. This must be fast and non-blocking.
 286  * @info: An arbitrary pointer to pass to the function.
 287  * @wait: If true, wait until function has completed on other CPUs.
 288  *
 289  * Returns 0 on success, else a negative status code.
 290  */
 291 int smp_call_function_single(int cpu, smp_call_func_t func, void *info,
 292                              int wait)
 293 {
 294         struct call_single_data d = {
 295                 .flags = 0,
 296         };
 297         unsigned long flags;
 298         int this_cpu;
 299         int err = 0;
 300
 301         /*
 302          * prevent preemption and reschedule on another processor,
 303          * as well as CPU removal
 304          */
 305         this_cpu = get_cpu();
 306
 307         /*
 308          * Can deadlock when called with interrupts disabled.
 309          * We allow cpu's that are not yet online though, as no one else can
 310          * send smp call function interrupt to this cpu and as such deadlocks
 311          * can't happen.
 312          */
 313         WARN_ON_ONCE(cpu_online(this_cpu) && irqs_disabled()
 314                      && !oops_in_progress);
 315
 316         if (cpu == this_cpu) {
 317                 local_irq_save(flags);
 318                 func(info);
 319                 local_irq_restore(flags);
 320         } else {
 321                 if ((unsigned)cpu < nr_cpu_ids && cpu_online(cpu)) {
 322                         struct call_single_data *data = &d;
 323
 324                         if (!wait)
 325                                 data = &__get_cpu_var(csd_data);
 326
 327                         csd_lock(data);
 328
 329                         data->func = func;
 330                         data->info = info;
 331                         generic_exec_single(cpu, data, wait);
 332                 } else {
 333                         err = -ENXIO;   /* CPU not online */
 334                 }
 335         }
 336
 337         put_cpu();
 338
 339         return err;
 340 }
 341 EXPORT_SYMBOL(smp_call_function_single);
 342
 343 /*
 344  * smp_call_function_any - Run a function on any of the given cpus
 345  * @mask: The mask of cpus it can run on.
 346  * @func: The function to run. This must be fast and non-blocking.
 347  * @info: An arbitrary pointer to pass to the function.
 348  * @wait: If true, wait until function has completed.
 349  *
 350  * Returns 0 on success, else a negative status code (if no cpus were online).
 351  * Note that @wait will be implicitly turned on in case of allocation failures,
 352  * since we fall back to on-stack allocation.
 353  *
 354  * Selection preference:
 355  *      1) current cpu if in @mask
 356  *      2) any cpu of current node if in @mask
 357  *      3) any other online cpu in @mask
 358  */
 359 int smp_call_function_any(const struct cpumask *mask,
 360                           smp_call_func_t func, void *info, int wait)
 361 {
 362         unsigned int cpu;
 363         const struct cpumask *nodemask;
 364         int ret;
 365
 366         /* Try for same CPU (cheapest) */
 367         cpu = get_cpu();
 368         if (cpumask_test_cpu(cpu, mask))
 369                 goto call;
 370
 371         /* Try for same node. */
 372         nodemask = cpumask_of_node(cpu_to_node(cpu));
 373         for (cpu = cpumask_first_and(nodemask, mask); cpu < nr_cpu_ids;
 374              cpu = cpumask_next_and(cpu, nodemask, mask)) {
 375                 if (cpu_online(cpu))
 376                         goto call;
 377         }
 378
 379         /* Any online will do: smp_call_function_single handles nr_cpu_ids. */
 380         cpu = cpumask_any_and(mask, cpu_online_mask);
 381 call:
 382         ret = smp_call_function_single(cpu, func, info, wait);
 383         put_cpu();
 384         return ret;
 385 }
 386 EXPORT_SYMBOL_GPL(smp_call_function_any);
 387
 388 /**
 389  * __smp_call_function_single(): Run a function on a specific CPU
 390  * @cpu: The CPU to run on.
 391  * @data: Pre-allocated and setup data structure
 392  * @wait: If true, wait until function has completed on specified CPU.
 393  *
 394  * Like smp_call_function_single(), but allow caller to pass in a
 395  * pre-allocated data structure. Useful for embedding @data inside
 396  * other structures, for instance.
 397  */
 398 void __smp_call_function_single(int cpu, struct call_single_data *data,
 399                                 int wait)
 400 {
 401         unsigned int this_cpu;
 402         unsigned long flags;
 403
 404         this_cpu = get_cpu();
 405         /*
 406          * Can deadlock when called with interrupts disabled.
 407          * We allow cpu's that are not yet online though, as no one else can
 408          * send smp call function interrupt to this cpu and as such deadlocks
 409          * can't happen.
 410          */
 411         WARN_ON_ONCE(cpu_online(smp_processor_id()) && wait && irqs_disabled()
 412                      && !oops_in_progress);
 413
 414         if (cpu == this_cpu) {
 415                 local_irq_save(flags);
 416                 data->func(data->info);
 417                 local_irq_restore(flags);
 418         } else {
 419                 csd_lock(data);
 420                 generic_exec_single(cpu, data, wait);
 421         }
 422         put_cpu();
 423 }
 424
 425 /**
 426  * smp_call_function_many(): Run a function on a set of other CPUs.
 427  * @mask: The set of cpus to run on (only runs on online subset).
 428  * @func: The function to run. This must be fast and non-blocking.
 429  * @info: An arbitrary pointer to pass to the function.
 430  * @wait: If true, wait (atomically) until function has completed
 431  *        on other CPUs.
 432  *
 433  * If @wait is true, then returns once @func has returned.
 434  *
 435  * You must not call this function with disabled interrupts or from a
 436  * hardware interrupt handler or from a bottom half handler. Preemption
 437  * must be disabled when calling this function.
 438  */
 439 void smp_call_function_many(const struct cpumask *mask,
 440                             smp_call_func_t func, void *info, bool wait)
 441 {
 442         struct call_function_data *data;
 443         unsigned long flags;
 444         int cpu, next_cpu, this_cpu = smp_processor_id();
 445
 446         /*
 447          * Can deadlock when called with interrupts disabled.
 448          * We allow cpu's that are not yet online though, as no one else can
 449          * send smp call function interrupt to this cpu and as such deadlocks
 450          * can't happen.
 451          */
 452         WARN_ON_ONCE(cpu_online(this_cpu) && irqs_disabled()
 453                      && !oops_in_progress);
 454
 455         /* So, what's a CPU they want? Ignoring this one. */
 456         cpu = cpumask_first_and(mask, cpu_online_mask);
 457         if (cpu == this_cpu)
 458                 cpu = cpumask_next_and(cpu, mask, cpu_online_mask);
 459
 460         /* No online cpus?  We're done. */
 461         if (cpu >= nr_cpu_ids)
 462                 return;
 463
 464         /* Do we have another CPU which isn't us? */
 465         next_cpu = cpumask_next_and(cpu, mask, cpu_online_mask);
 466         if (next_cpu == this_cpu)
 467                 next_cpu = cpumask_next_and(next_cpu, mask, cpu_online_mask);
 468
 469         /* Fastpath: do that cpu by itself. */
 470         if (next_cpu >= nr_cpu_ids) {
 471                 smp_call_function_single(cpu, func, info, wait);
 472                 return;
 473         }
 474
 475         data = &__get_cpu_var(cfd_data);
 476         csd_lock(&data->csd);
 477         BUG_ON(atomic_read(&data->refs) || !cpumask_empty(data->cpumask));
 478
 479         data->csd.func = func;
 480         data->csd.info = info;
 481         cpumask_and(data->cpumask, mask, cpu_online_mask);
 482         cpumask_clear_cpu(this_cpu, data->cpumask);
 483
 484         /*
 485          * To ensure the interrupt handler gets an complete view
 486          * we order the cpumask and refs writes and order the read
 487          * of them in the interrupt handler.  In addition we may
 488          * only clear our own cpu bit from the mask.
 489          */
 490         smp_wmb();
 491
 492         atomic_set(&data->refs, cpumask_weight(data->cpumask));
 493
 494         raw_spin_lock_irqsave(&call_function.lock, flags);
 495         /*
 496          * Place entry at the _HEAD_ of the list, so that any cpu still
 497          * observing the entry in generic_smp_call_function_interrupt()
 498          * will not miss any other list entries:
 499          */
 500         list_add_rcu(&data->csd.list, &call_function.queue);
 501         raw_spin_unlock_irqrestore(&call_function.lock, flags);
 502
 503         /*
 504          * Make the list addition visible before sending the ipi.
 505          * (IPIs must obey or appear to obey normal Linux cache
 506          * coherency rules -- see comment in generic_exec_single).
 507          */
 508         smp_mb();
 509
 510         /* Send a message to all CPUs in the map */
 511         arch_send_call_function_ipi_mask(data->cpumask);
 512
 513         /* Optionally wait for the CPUs to complete */
 514         if (wait)
 515                 csd_lock_wait(&data->csd);
 516 }
 517 EXPORT_SYMBOL(smp_call_function_many);
 518
 519 /**
 520  * smp_call_function(): Run a function on all other CPUs.
 521  * @func: The function to run. This must be fast and non-blocking.
 522  * @info: An arbitrary pointer to pass to the function.
 523  * @wait: If true, wait (atomically) until function has completed
 524  *        on other CPUs.
 525  *
 526  * Returns 0.
 527  *
 528  * If @wait is true, then returns once @func has returned; otherwise
 529  * it returns just before the target cpu calls @func.
 530  *
 531  * You must not call this function with disabled interrupts or from a
 532  * hardware interrupt handler or from a bottom half handler.
 533  */
 534 int smp_call_function(smp_call_func_t func, void *info, int wait)
 535 {
 536         preempt_disable();
 537         smp_call_function_many(cpu_online_mask, func, info, wait);
 538         preempt_enable();
 539
 540         return 0;
 541 }
 542 EXPORT_SYMBOL(smp_call_function);
 543
 544 void ipi_call_lock(void)
 545 {
 546         raw_spin_lock(&call_function.lock);
 547 }
 548
 549 void ipi_call_unlock(void)
 550 {
 551         raw_spin_unlock(&call_function.lock);
 552 }
 553
 554 void ipi_call_lock_irq(void)
 555 {
 556         raw_spin_lock_irq(&call_function.lock);
 557 }
 558
 559 void ipi_call_unlock_irq(void)
 560 {
 561         raw_spin_unlock_irq(&call_function.lock);
 562 }
 563 #endif /* USE_GENERIC_SMP_HELPERS */
 564
 565 /*
 566  * Call a function on all processors
 567  */
 568 int on_each_cpu(void (*func) (void *info), void *info, int wait)
 569 {
 570         int ret = 0;
 571
 572         preempt_disable();
 573         ret = smp_call_function(func, info, wait);
 574         local_irq_disable();
 575         func(info);
 576         local_irq_enable();
 577         preempt_enable();
 578         return ret;
 579 }
 580 EXPORT_SYMBOL(on_each_cpu);