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