kernel/padata.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * padata.c - generic interface to process data streams in parallel
   4  *
   5  * See Documentation/core-api/padata.rst for more information.
   6  *
   7  * Copyright (C) 2008, 2009 secunet Security Networks AG
   8  * Copyright (C) 2008, 2009 Steffen Klassert <steffen.klassert@secunet.com>
   9  *
  10  * Copyright (c) 2020 Oracle and/or its affiliates.
  11  * Author: Daniel Jordan <daniel.m.jordan@oracle.com>
  12  */
  13
  14 #include <linux/completion.h>
  15 #include <linux/export.h>
  16 #include <linux/cpumask.h>
  17 #include <linux/err.h>
  18 #include <linux/cpu.h>
  19 #include <linux/padata.h>
  20 #include <linux/mutex.h>
  21 #include <linux/sched.h>
  22 #include <linux/slab.h>
  23 #include <linux/sysfs.h>
  24 #include <linux/rcupdate.h>
  25
  26 #define PADATA_WORK_ONSTACK     1       /* Work's memory is on stack */
  27
  28 struct padata_work {
  29         struct work_struct      pw_work;
  30         struct list_head        pw_list;  /* padata_free_works linkage */
  31         void                    *pw_data;
  32 };
  33
  34 static DEFINE_SPINLOCK(padata_works_lock);
  35 static struct padata_work *padata_works;
  36 static LIST_HEAD(padata_free_works);
  37
  38 struct padata_mt_job_state {
  39         spinlock_t              lock;
  40         struct completion       completion;
  41         struct padata_mt_job    *job;
  42         int                     nworks;
  43         int                     nworks_fini;
  44         unsigned long           chunk_size;
  45 };
  46
  47 static void padata_free_pd(struct parallel_data *pd);
  48 static void __init padata_mt_helper(struct work_struct *work);
  49
  50 static int padata_index_to_cpu(struct parallel_data *pd, int cpu_index)
  51 {
  52         int cpu, target_cpu;
  53
  54         target_cpu = cpumask_first(pd->cpumask.pcpu);
  55         for (cpu = 0; cpu < cpu_index; cpu++)
  56                 target_cpu = cpumask_next(target_cpu, pd->cpumask.pcpu);
  57
  58         return target_cpu;
  59 }
  60
  61 static int padata_cpu_hash(struct parallel_data *pd, unsigned int seq_nr)
  62 {
  63         /*
  64          * Hash the sequence numbers to the cpus by taking
  65          * seq_nr mod. number of cpus in use.
  66          */
  67         int cpu_index = seq_nr % cpumask_weight(pd->cpumask.pcpu);
  68
  69         return padata_index_to_cpu(pd, cpu_index);
  70 }
  71
  72 static struct padata_work *padata_work_alloc(void)
  73 {
  74         struct padata_work *pw;
  75
  76         lockdep_assert_held(&padata_works_lock);
  77
  78         if (list_empty(&padata_free_works))
  79                 return NULL;    /* No more work items allowed to be queued. */
  80
  81         pw = list_first_entry(&padata_free_works, struct padata_work, pw_list);
  82         list_del(&pw->pw_list);
  83         return pw;
  84 }
  85
  86 static void padata_work_init(struct padata_work *pw, work_func_t work_fn,
  87                              void *data, int flags)
  88 {
  89         if (flags & PADATA_WORK_ONSTACK)
  90                 INIT_WORK_ONSTACK(&pw->pw_work, work_fn);
  91         else
  92                 INIT_WORK(&pw->pw_work, work_fn);
  93         pw->pw_data = data;
  94 }
  95
  96 static int __init padata_work_alloc_mt(int nworks, void *data,
  97                                        struct list_head *head)
  98 {
  99         int i;
 100
 101         spin_lock(&padata_works_lock);
 102         /* Start at 1 because the current task participates in the job. */
 103         for (i = 1; i < nworks; ++i) {
 104                 struct padata_work *pw = padata_work_alloc();
 105
 106                 if (!pw)
 107                         break;
 108                 padata_work_init(pw, padata_mt_helper, data, 0);
 109                 list_add(&pw->pw_list, head);
 110         }
 111         spin_unlock(&padata_works_lock);
 112
 113         return i;
 114 }
 115
 116 static void padata_work_free(struct padata_work *pw)
 117 {
 118         lockdep_assert_held(&padata_works_lock);
 119         list_add(&pw->pw_list, &padata_free_works);
 120 }
 121
 122 static void __init padata_works_free(struct list_head *works)
 123 {
 124         struct padata_work *cur, *next;
 125
 126         if (list_empty(works))
 127                 return;
 128
 129         spin_lock(&padata_works_lock);
 130         list_for_each_entry_safe(cur, next, works, pw_list) {
 131                 list_del(&cur->pw_list);
 132                 padata_work_free(cur);
 133         }
 134         spin_unlock(&padata_works_lock);
 135 }
 136
 137 static void padata_parallel_worker(struct work_struct *parallel_work)
 138 {
 139         struct padata_work *pw = container_of(parallel_work, struct padata_work,
 140                                               pw_work);
 141         struct padata_priv *padata = pw->pw_data;
 142
 143         local_bh_disable();
 144         padata->parallel(padata);
 145         spin_lock(&padata_works_lock);
 146         padata_work_free(pw);
 147         spin_unlock(&padata_works_lock);
 148         local_bh_enable();
 149 }
 150
 151 /**
 152  * padata_do_parallel - padata parallelization function
 153  *
 154  * @ps: padatashell
 155  * @padata: object to be parallelized
 156  * @cb_cpu: pointer to the CPU that the serialization callback function should
 157  *          run on.  If it's not in the serial cpumask of @pinst
 158  *          (i.e. cpumask.cbcpu), this function selects a fallback CPU and if
 159  *          none found, returns -EINVAL.
 160  *
 161  * The parallelization callback function will run with BHs off.
 162  * Note: Every object which is parallelized by padata_do_parallel
 163  * must be seen by padata_do_serial.
 164  *
 165  * Return: 0 on success or else negative error code.
 166  */
 167 int padata_do_parallel(struct padata_shell *ps,
 168                        struct padata_priv *padata, int *cb_cpu)
 169 {
 170         struct padata_instance *pinst = ps->pinst;
 171         int i, cpu, cpu_index, err;
 172         struct parallel_data *pd;
 173         struct padata_work *pw;
 174
 175         rcu_read_lock_bh();
 176
 177         pd = rcu_dereference_bh(ps->pd);
 178
 179         err = -EINVAL;
 180         if (!(pinst->flags & PADATA_INIT) || pinst->flags & PADATA_INVALID)
 181                 goto out;
 182
 183         if (!cpumask_test_cpu(*cb_cpu, pd->cpumask.cbcpu)) {
 184                 if (!cpumask_weight(pd->cpumask.cbcpu))
 185                         goto out;
 186
 187                 /* Select an alternate fallback CPU and notify the caller. */
 188                 cpu_index = *cb_cpu % cpumask_weight(pd->cpumask.cbcpu);
 189
 190                 cpu = cpumask_first(pd->cpumask.cbcpu);
 191                 for (i = 0; i < cpu_index; i++)
 192                         cpu = cpumask_next(cpu, pd->cpumask.cbcpu);
 193
 194                 *cb_cpu = cpu;
 195         }
 196
 197         err =  -EBUSY;
 198         if ((pinst->flags & PADATA_RESET))
 199                 goto out;
 200
 201         refcount_inc(&pd->refcnt);
 202         padata->pd = pd;
 203         padata->cb_cpu = *cb_cpu;
 204
 205         spin_lock(&padata_works_lock);
 206         padata->seq_nr = ++pd->seq_nr;
 207         pw = padata_work_alloc();
 208         spin_unlock(&padata_works_lock);
 209
 210         if (!pw) {
 211                 /* Maximum works limit exceeded, run in the current task. */
 212                 padata->parallel(padata);
 213         }
 214
 215         rcu_read_unlock_bh();
 216
 217         if (pw) {
 218                 padata_work_init(pw, padata_parallel_worker, padata, 0);
 219                 queue_work(pinst->parallel_wq, &pw->pw_work);
 220         }
 221
 222         return 0;
 223 out:
 224         rcu_read_unlock_bh();
 225
 226         return err;
 227 }
 228 EXPORT_SYMBOL(padata_do_parallel);
 229
 230 /*
 231  * padata_find_next - Find the next object that needs serialization.
 232  *
 233  * Return:
 234  * * A pointer to the control struct of the next object that needs
 235  *   serialization, if present in one of the percpu reorder queues.
 236  * * NULL, if the next object that needs serialization will
 237  *   be parallel processed by another cpu and is not yet present in
 238  *   the cpu's reorder queue.
 239  */
 240 static struct padata_priv *padata_find_next(struct parallel_data *pd,
 241                                             bool remove_object)
 242 {
 243         struct padata_priv *padata;
 244         struct padata_list *reorder;
 245         int cpu = pd->cpu;
 246
 247         reorder = per_cpu_ptr(pd->reorder_list, cpu);
 248
 249         spin_lock(&reorder->lock);
 250         if (list_empty(&reorder->list)) {
 251                 spin_unlock(&reorder->lock);
 252                 return NULL;
 253         }
 254
 255         padata = list_entry(reorder->list.next, struct padata_priv, list);
 256
 257         /*
 258          * Checks the rare case where two or more parallel jobs have hashed to
 259          * the same CPU and one of the later ones finishes first.
 260          */
 261         if (padata->seq_nr != pd->processed) {
 262                 spin_unlock(&reorder->lock);
 263                 return NULL;
 264         }
 265
 266         if (remove_object) {
 267                 list_del_init(&padata->list);
 268                 ++pd->processed;
 269                 pd->cpu = cpumask_next_wrap(cpu, pd->cpumask.pcpu, -1, false);
 270         }
 271
 272         spin_unlock(&reorder->lock);
 273         return padata;
 274 }
 275
 276 static void padata_reorder(struct parallel_data *pd)
 277 {
 278         struct padata_instance *pinst = pd->ps->pinst;
 279         int cb_cpu;
 280         struct padata_priv *padata;
 281         struct padata_serial_queue *squeue;
 282         struct padata_list *reorder;
 283
 284         /*
 285          * We need to ensure that only one cpu can work on dequeueing of
 286          * the reorder queue the time. Calculating in which percpu reorder
 287          * queue the next object will arrive takes some time. A spinlock
 288          * would be highly contended. Also it is not clear in which order
 289          * the objects arrive to the reorder queues. So a cpu could wait to
 290          * get the lock just to notice that there is nothing to do at the
 291          * moment. Therefore we use a trylock and let the holder of the lock
 292          * care for all the objects enqueued during the holdtime of the lock.
 293          */
 294         if (!spin_trylock_bh(&pd->lock))
 295                 return;
 296
 297         while (1) {
 298                 padata = padata_find_next(pd, true);
 299
 300                 /*
 301                  * If the next object that needs serialization is parallel
 302                  * processed by another cpu and is still on it's way to the
 303                  * cpu's reorder queue, nothing to do for now.
 304                  */
 305                 if (!padata)
 306                         break;
 307
 308                 cb_cpu = padata->cb_cpu;
 309                 squeue = per_cpu_ptr(pd->squeue, cb_cpu);
 310
 311                 spin_lock(&squeue->serial.lock);
 312                 list_add_tail(&padata->list, &squeue->serial.list);
 313                 spin_unlock(&squeue->serial.lock);
 314
 315                 queue_work_on(cb_cpu, pinst->serial_wq, &squeue->work);
 316         }
 317
 318         spin_unlock_bh(&pd->lock);
 319
 320         /*
 321          * The next object that needs serialization might have arrived to
 322          * the reorder queues in the meantime.
 323          *
 324          * Ensure reorder queue is read after pd->lock is dropped so we see
 325          * new objects from another task in padata_do_serial.  Pairs with
 326          * smp_mb in padata_do_serial.
 327          */
 328         smp_mb();
 329
 330         reorder = per_cpu_ptr(pd->reorder_list, pd->cpu);
 331         if (!list_empty(&reorder->list) && padata_find_next(pd, false))
 332                 queue_work(pinst->serial_wq, &pd->reorder_work);
 333 }
 334
 335 static void invoke_padata_reorder(struct work_struct *work)
 336 {
 337         struct parallel_data *pd;
 338
 339         local_bh_disable();
 340         pd = container_of(work, struct parallel_data, reorder_work);
 341         padata_reorder(pd);
 342         local_bh_enable();
 343 }
 344
 345 static void padata_serial_worker(struct work_struct *serial_work)
 346 {
 347         struct padata_serial_queue *squeue;
 348         struct parallel_data *pd;
 349         LIST_HEAD(local_list);
 350         int cnt;
 351
 352         local_bh_disable();
 353         squeue = container_of(serial_work, struct padata_serial_queue, work);
 354         pd = squeue->pd;
 355
 356         spin_lock(&squeue->serial.lock);
 357         list_replace_init(&squeue->serial.list, &local_list);
 358         spin_unlock(&squeue->serial.lock);
 359
 360         cnt = 0;
 361
 362         while (!list_empty(&local_list)) {
 363                 struct padata_priv *padata;
 364
 365                 padata = list_entry(local_list.next,
 366                                     struct padata_priv, list);
 367
 368                 list_del_init(&padata->list);
 369
 370                 padata->serial(padata);
 371                 cnt++;
 372         }
 373         local_bh_enable();
 374
 375         if (refcount_sub_and_test(cnt, &pd->refcnt))
 376                 padata_free_pd(pd);
 377 }
 378
 379 /**
 380  * padata_do_serial - padata serialization function
 381  *
 382  * @padata: object to be serialized.
 383  *
 384  * padata_do_serial must be called for every parallelized object.
 385  * The serialization callback function will run with BHs off.
 386  */
 387 void padata_do_serial(struct padata_priv *padata)
 388 {
 389         struct parallel_data *pd = padata->pd;
 390         int hashed_cpu = padata_cpu_hash(pd, padata->seq_nr);
 391         struct padata_list *reorder = per_cpu_ptr(pd->reorder_list, hashed_cpu);
 392         struct padata_priv *cur;
 393
 394         spin_lock(&reorder->lock);
 395         /* Sort in ascending order of sequence number. */
 396         list_for_each_entry_reverse(cur, &reorder->list, list)
 397                 if (cur->seq_nr < padata->seq_nr)
 398                         break;
 399         list_add(&padata->list, &cur->list);
 400         spin_unlock(&reorder->lock);
 401
 402         /*
 403          * Ensure the addition to the reorder list is ordered correctly
 404          * with the trylock of pd->lock in padata_reorder.  Pairs with smp_mb
 405          * in padata_reorder.
 406          */
 407         smp_mb();
 408
 409         padata_reorder(pd);
 410 }
 411 EXPORT_SYMBOL(padata_do_serial);
 412
 413 static int padata_setup_cpumasks(struct padata_instance *pinst)
 414 {
 415         struct workqueue_attrs *attrs;
 416         int err;
 417
 418         attrs = alloc_workqueue_attrs();
 419         if (!attrs)
 420                 return -ENOMEM;
 421
 422         /* Restrict parallel_wq workers to pd->cpumask.pcpu. */
 423         cpumask_copy(attrs->cpumask, pinst->cpumask.pcpu);
 424         err = apply_workqueue_attrs(pinst->parallel_wq, attrs);
 425         free_workqueue_attrs(attrs);
 426
 427         return err;
 428 }
 429
 430 static void __init padata_mt_helper(struct work_struct *w)
 431 {
 432         struct padata_work *pw = container_of(w, struct padata_work, pw_work);
 433         struct padata_mt_job_state *ps = pw->pw_data;
 434         struct padata_mt_job *job = ps->job;
 435         bool done;
 436
 437         spin_lock(&ps->lock);
 438
 439         while (job->size > 0) {
 440                 unsigned long start, size, end;
 441
 442                 start = job->start;
 443                 /* So end is chunk size aligned if enough work remains. */
 444                 size = roundup(start + 1, ps->chunk_size) - start;
 445                 size = min(size, job->size);
 446                 end = start + size;
 447
 448                 job->start = end;
 449                 job->size -= size;
 450
 451                 spin_unlock(&ps->lock);
 452                 job->thread_fn(start, end, job->fn_arg);
 453                 spin_lock(&ps->lock);
 454         }
 455
 456         ++ps->nworks_fini;
 457         done = (ps->nworks_fini == ps->nworks);
 458         spin_unlock(&ps->lock);
 459
 460         if (done)
 461                 complete(&ps->completion);
 462 }
 463
 464 /**
 465  * padata_do_multithreaded - run a multithreaded job
 466  * @job: Description of the job.
 467  *
 468  * See the definition of struct padata_mt_job for more details.
 469  */
 470 void __init padata_do_multithreaded(struct padata_mt_job *job)
 471 {
 472         /* In case threads finish at different times. */
 473         static const unsigned long load_balance_factor = 4;
 474         struct padata_work my_work, *pw;
 475         struct padata_mt_job_state ps;
 476         LIST_HEAD(works);
 477         int nworks;
 478
 479         if (job->size == 0)
 480                 return;
 481
 482         /* Ensure at least one thread when size < min_chunk. */
 483         nworks = max(job->size / job->min_chunk, 1ul);
 484         nworks = min(nworks, job->max_threads);
 485
 486         if (nworks == 1) {
 487                 /* Single thread, no coordination needed, cut to the chase. */
 488                 job->thread_fn(job->start, job->start + job->size, job->fn_arg);
 489                 return;
 490         }
 491
 492         spin_lock_init(&ps.lock);
 493         init_completion(&ps.completion);
 494         ps.job         = job;
 495         ps.nworks      = padata_work_alloc_mt(nworks, &ps, &works);
 496         ps.nworks_fini = 0;
 497
 498         /*
 499          * Chunk size is the amount of work a helper does per call to the
 500          * thread function.  Load balance large jobs between threads by
 501          * increasing the number of chunks, guarantee at least the minimum
 502          * chunk size from the caller, and honor the caller's alignment.
 503          */
 504         ps.chunk_size = job->size / (ps.nworks * load_balance_factor);
 505         ps.chunk_size = max(ps.chunk_size, job->min_chunk);
 506         ps.chunk_size = roundup(ps.chunk_size, job->align);
 507
 508         list_for_each_entry(pw, &works, pw_list)
 509                 queue_work(system_unbound_wq, &pw->pw_work);
 510
 511         /* Use the current thread, which saves starting a workqueue worker. */
 512         padata_work_init(&my_work, padata_mt_helper, &ps, PADATA_WORK_ONSTACK);
 513         padata_mt_helper(&my_work.pw_work);
 514
 515         /* Wait for all the helpers to finish. */
 516         wait_for_completion(&ps.completion);
 517
 518         destroy_work_on_stack(&my_work.pw_work);
 519         padata_works_free(&works);
 520 }
 521
 522 static void __padata_list_init(struct padata_list *pd_list)
 523 {
 524         INIT_LIST_HEAD(&pd_list->list);
 525         spin_lock_init(&pd_list->lock);
 526 }
 527
 528 /* Initialize all percpu queues used by serial workers */
 529 static void padata_init_squeues(struct parallel_data *pd)
 530 {
 531         int cpu;
 532         struct padata_serial_queue *squeue;
 533
 534         for_each_cpu(cpu, pd->cpumask.cbcpu) {
 535                 squeue = per_cpu_ptr(pd->squeue, cpu);
 536                 squeue->pd = pd;
 537                 __padata_list_init(&squeue->serial);
 538                 INIT_WORK(&squeue->work, padata_serial_worker);
 539         }
 540 }
 541
 542 /* Initialize per-CPU reorder lists */
 543 static void padata_init_reorder_list(struct parallel_data *pd)
 544 {
 545         int cpu;
 546         struct padata_list *list;
 547
 548         for_each_cpu(cpu, pd->cpumask.pcpu) {
 549                 list = per_cpu_ptr(pd->reorder_list, cpu);
 550                 __padata_list_init(list);
 551         }
 552 }
 553
 554 /* Allocate and initialize the internal cpumask dependend resources. */
 555 static struct parallel_data *padata_alloc_pd(struct padata_shell *ps)
 556 {
 557         struct padata_instance *pinst = ps->pinst;
 558         struct parallel_data *pd;
 559
 560         pd = kzalloc(sizeof(struct parallel_data), GFP_KERNEL);
 561         if (!pd)
 562                 goto err;
 563
 564         pd->reorder_list = alloc_percpu(struct padata_list);
 565         if (!pd->reorder_list)
 566                 goto err_free_pd;
 567
 568         pd->squeue = alloc_percpu(struct padata_serial_queue);
 569         if (!pd->squeue)
 570                 goto err_free_reorder_list;
 571
 572         pd->ps = ps;
 573
 574         if (!alloc_cpumask_var(&pd->cpumask.pcpu, GFP_KERNEL))
 575                 goto err_free_squeue;
 576         if (!alloc_cpumask_var(&pd->cpumask.cbcpu, GFP_KERNEL))
 577                 goto err_free_pcpu;
 578
 579         cpumask_and(pd->cpumask.pcpu, pinst->cpumask.pcpu, cpu_online_mask);
 580         cpumask_and(pd->cpumask.cbcpu, pinst->cpumask.cbcpu, cpu_online_mask);
 581
 582         padata_init_reorder_list(pd);
 583         padata_init_squeues(pd);
 584         pd->seq_nr = -1;
 585         refcount_set(&pd->refcnt, 1);
 586         spin_lock_init(&pd->lock);
 587         pd->cpu = cpumask_first(pd->cpumask.pcpu);
 588         INIT_WORK(&pd->reorder_work, invoke_padata_reorder);
 589
 590         return pd;
 591
 592 err_free_pcpu:
 593         free_cpumask_var(pd->cpumask.pcpu);
 594 err_free_squeue:
 595         free_percpu(pd->squeue);
 596 err_free_reorder_list:
 597         free_percpu(pd->reorder_list);
 598 err_free_pd:
 599         kfree(pd);
 600 err:
 601         return NULL;
 602 }
 603
 604 static void padata_free_pd(struct parallel_data *pd)
 605 {
 606         free_cpumask_var(pd->cpumask.pcpu);
 607         free_cpumask_var(pd->cpumask.cbcpu);
 608         free_percpu(pd->reorder_list);
 609         free_percpu(pd->squeue);
 610         kfree(pd);
 611 }
 612
 613 static void __padata_start(struct padata_instance *pinst)
 614 {
 615         pinst->flags |= PADATA_INIT;
 616 }
 617
 618 static void __padata_stop(struct padata_instance *pinst)
 619 {
 620         if (!(pinst->flags & PADATA_INIT))
 621                 return;
 622
 623         pinst->flags &= ~PADATA_INIT;
 624
 625         synchronize_rcu();
 626 }
 627
 628 /* Replace the internal control structure with a new one. */
 629 static int padata_replace_one(struct padata_shell *ps)
 630 {
 631         struct parallel_data *pd_new;
 632
 633         pd_new = padata_alloc_pd(ps);
 634         if (!pd_new)
 635                 return -ENOMEM;
 636
 637         ps->opd = rcu_dereference_protected(ps->pd, 1);
 638         rcu_assign_pointer(ps->pd, pd_new);
 639
 640         return 0;
 641 }
 642
 643 static int padata_replace(struct padata_instance *pinst)
 644 {
 645         struct padata_shell *ps;
 646         int err = 0;
 647
 648         pinst->flags |= PADATA_RESET;
 649
 650         list_for_each_entry(ps, &pinst->pslist, list) {
 651                 err = padata_replace_one(ps);
 652                 if (err)
 653                         break;
 654         }
 655
 656         synchronize_rcu();
 657
 658         list_for_each_entry_continue_reverse(ps, &pinst->pslist, list)
 659                 if (refcount_dec_and_test(&ps->opd->refcnt))
 660                         padata_free_pd(ps->opd);
 661
 662         pinst->flags &= ~PADATA_RESET;
 663
 664         return err;
 665 }
 666
 667 /* If cpumask contains no active cpu, we mark the instance as invalid. */
 668 static bool padata_validate_cpumask(struct padata_instance *pinst,
 669                                     const struct cpumask *cpumask)
 670 {
 671         if (!cpumask_intersects(cpumask, cpu_online_mask)) {
 672                 pinst->flags |= PADATA_INVALID;
 673                 return false;
 674         }
 675
 676         pinst->flags &= ~PADATA_INVALID;
 677         return true;
 678 }
 679
 680 static int __padata_set_cpumasks(struct padata_instance *pinst,
 681                                  cpumask_var_t pcpumask,
 682                                  cpumask_var_t cbcpumask)
 683 {
 684         int valid;
 685         int err;
 686
 687         valid = padata_validate_cpumask(pinst, pcpumask);
 688         if (!valid) {
 689                 __padata_stop(pinst);
 690                 goto out_replace;
 691         }
 692
 693         valid = padata_validate_cpumask(pinst, cbcpumask);
 694         if (!valid)
 695                 __padata_stop(pinst);
 696
 697 out_replace:
 698         cpumask_copy(pinst->cpumask.pcpu, pcpumask);
 699         cpumask_copy(pinst->cpumask.cbcpu, cbcpumask);
 700
 701         err = padata_setup_cpumasks(pinst) ?: padata_replace(pinst);
 702
 703         if (valid)
 704                 __padata_start(pinst);
 705
 706         return err;
 707 }
 708
 709 /**
 710  * padata_set_cpumask - Sets specified by @cpumask_type cpumask to the value
 711  *                      equivalent to @cpumask.
 712  * @pinst: padata instance
 713  * @cpumask_type: PADATA_CPU_SERIAL or PADATA_CPU_PARALLEL corresponding
 714  *                to parallel and serial cpumasks respectively.
 715  * @cpumask: the cpumask to use
 716  *
 717  * Return: 0 on success or negative error code
 718  */
 719 int padata_set_cpumask(struct padata_instance *pinst, int cpumask_type,
 720                        cpumask_var_t cpumask)
 721 {
 722         struct cpumask *serial_mask, *parallel_mask;
 723         int err = -EINVAL;
 724
 725         cpus_read_lock();
 726         mutex_lock(&pinst->lock);
 727
 728         switch (cpumask_type) {
 729         case PADATA_CPU_PARALLEL:
 730                 serial_mask = pinst->cpumask.cbcpu;
 731                 parallel_mask = cpumask;
 732                 break;
 733         case PADATA_CPU_SERIAL:
 734                 parallel_mask = pinst->cpumask.pcpu;
 735                 serial_mask = cpumask;
 736                 break;
 737         default:
 738                  goto out;
 739         }
 740
 741         err =  __padata_set_cpumasks(pinst, parallel_mask, serial_mask);
 742
 743 out:
 744         mutex_unlock(&pinst->lock);
 745         cpus_read_unlock();
 746
 747         return err;
 748 }
 749 EXPORT_SYMBOL(padata_set_cpumask);
 750
 751 #ifdef CONFIG_HOTPLUG_CPU
 752
 753 static int __padata_add_cpu(struct padata_instance *pinst, int cpu)
 754 {
 755         int err = 0;
 756
 757         if (cpumask_test_cpu(cpu, cpu_online_mask)) {
 758                 err = padata_replace(pinst);
 759
 760                 if (padata_validate_cpumask(pinst, pinst->cpumask.pcpu) &&
 761                     padata_validate_cpumask(pinst, pinst->cpumask.cbcpu))
 762                         __padata_start(pinst);
 763         }
 764
 765         return err;
 766 }
 767
 768 static int __padata_remove_cpu(struct padata_instance *pinst, int cpu)
 769 {
 770         int err = 0;
 771
 772         if (!cpumask_test_cpu(cpu, cpu_online_mask)) {
 773                 if (!padata_validate_cpumask(pinst, pinst->cpumask.pcpu) ||
 774                     !padata_validate_cpumask(pinst, pinst->cpumask.cbcpu))
 775                         __padata_stop(pinst);
 776
 777                 err = padata_replace(pinst);
 778         }
 779
 780         return err;
 781 }
 782
 783 static inline int pinst_has_cpu(struct padata_instance *pinst, int cpu)
 784 {
 785         return cpumask_test_cpu(cpu, pinst->cpumask.pcpu) ||
 786                 cpumask_test_cpu(cpu, pinst->cpumask.cbcpu);
 787 }
 788
 789 static int padata_cpu_online(unsigned int cpu, struct hlist_node *node)
 790 {
 791         struct padata_instance *pinst;
 792         int ret;
 793
 794         pinst = hlist_entry_safe(node, struct padata_instance, cpu_online_node);
 795         if (!pinst_has_cpu(pinst, cpu))
 796                 return 0;
 797
 798         mutex_lock(&pinst->lock);
 799         ret = __padata_add_cpu(pinst, cpu);
 800         mutex_unlock(&pinst->lock);
 801         return ret;
 802 }
 803
 804 static int padata_cpu_dead(unsigned int cpu, struct hlist_node *node)
 805 {
 806         struct padata_instance *pinst;
 807         int ret;
 808
 809         pinst = hlist_entry_safe(node, struct padata_instance, cpu_dead_node);
 810         if (!pinst_has_cpu(pinst, cpu))
 811                 return 0;
 812
 813         mutex_lock(&pinst->lock);
 814         ret = __padata_remove_cpu(pinst, cpu);
 815         mutex_unlock(&pinst->lock);
 816         return ret;
 817 }
 818
 819 static enum cpuhp_state hp_online;
 820 #endif
 821
 822 static void __padata_free(struct padata_instance *pinst)
 823 {
 824 #ifdef CONFIG_HOTPLUG_CPU
 825         cpuhp_state_remove_instance_nocalls(CPUHP_PADATA_DEAD,
 826                                             &pinst->cpu_dead_node);
 827         cpuhp_state_remove_instance_nocalls(hp_online, &pinst->cpu_online_node);
 828 #endif
 829
 830         WARN_ON(!list_empty(&pinst->pslist));
 831
 832         free_cpumask_var(pinst->cpumask.pcpu);
 833         free_cpumask_var(pinst->cpumask.cbcpu);
 834         destroy_workqueue(pinst->serial_wq);
 835         destroy_workqueue(pinst->parallel_wq);
 836         kfree(pinst);
 837 }
 838
 839 #define kobj2pinst(_kobj)                                       \
 840         container_of(_kobj, struct padata_instance, kobj)
 841 #define attr2pentry(_attr)                                      \
 842         container_of(_attr, struct padata_sysfs_entry, attr)
 843
 844 static void padata_sysfs_release(struct kobject *kobj)
 845 {
 846         struct padata_instance *pinst = kobj2pinst(kobj);
 847         __padata_free(pinst);
 848 }
 849
 850 struct padata_sysfs_entry {
 851         struct attribute attr;
 852         ssize_t (*show)(struct padata_instance *, struct attribute *, char *);
 853         ssize_t (*store)(struct padata_instance *, struct attribute *,
 854                          const char *, size_t);
 855 };
 856
 857 static ssize_t show_cpumask(struct padata_instance *pinst,
 858                             struct attribute *attr,  char *buf)
 859 {
 860         struct cpumask *cpumask;
 861         ssize_t len;
 862
 863         mutex_lock(&pinst->lock);
 864         if (!strcmp(attr->name, "serial_cpumask"))
 865                 cpumask = pinst->cpumask.cbcpu;
 866         else
 867                 cpumask = pinst->cpumask.pcpu;
 868
 869         len = snprintf(buf, PAGE_SIZE, "%*pb\n",
 870                        nr_cpu_ids, cpumask_bits(cpumask));
 871         mutex_unlock(&pinst->lock);
 872         return len < PAGE_SIZE ? len : -EINVAL;
 873 }
 874
 875 static ssize_t store_cpumask(struct padata_instance *pinst,
 876                              struct attribute *attr,
 877                              const char *buf, size_t count)
 878 {
 879         cpumask_var_t new_cpumask;
 880         ssize_t ret;
 881         int mask_type;
 882
 883         if (!alloc_cpumask_var(&new_cpumask, GFP_KERNEL))
 884                 return -ENOMEM;
 885
 886         ret = bitmap_parse(buf, count, cpumask_bits(new_cpumask),
 887                            nr_cpumask_bits);
 888         if (ret < 0)
 889                 goto out;
 890
 891         mask_type = !strcmp(attr->name, "serial_cpumask") ?
 892                 PADATA_CPU_SERIAL : PADATA_CPU_PARALLEL;
 893         ret = padata_set_cpumask(pinst, mask_type, new_cpumask);
 894         if (!ret)
 895                 ret = count;
 896
 897 out:
 898         free_cpumask_var(new_cpumask);
 899         return ret;
 900 }
 901
 902 #define PADATA_ATTR_RW(_name, _show_name, _store_name)          \
 903         static struct padata_sysfs_entry _name##_attr =         \
 904                 __ATTR(_name, 0644, _show_name, _store_name)
 905 #define PADATA_ATTR_RO(_name, _show_name)               \
 906         static struct padata_sysfs_entry _name##_attr = \
 907                 __ATTR(_name, 0400, _show_name, NULL)
 908
 909 PADATA_ATTR_RW(serial_cpumask, show_cpumask, store_cpumask);
 910 PADATA_ATTR_RW(parallel_cpumask, show_cpumask, store_cpumask);
 911
 912 /*
 913  * Padata sysfs provides the following objects:
 914  * serial_cpumask   [RW] - cpumask for serial workers
 915  * parallel_cpumask [RW] - cpumask for parallel workers
 916  */
 917 static struct attribute *padata_default_attrs[] = {
 918         &serial_cpumask_attr.attr,
 919         &parallel_cpumask_attr.attr,
 920         NULL,
 921 };
 922 ATTRIBUTE_GROUPS(padata_default);
 923
 924 static ssize_t padata_sysfs_show(struct kobject *kobj,
 925                                  struct attribute *attr, char *buf)
 926 {
 927         struct padata_instance *pinst;
 928         struct padata_sysfs_entry *pentry;
 929         ssize_t ret = -EIO;
 930
 931         pinst = kobj2pinst(kobj);
 932         pentry = attr2pentry(attr);
 933         if (pentry->show)
 934                 ret = pentry->show(pinst, attr, buf);
 935
 936         return ret;
 937 }
 938
 939 static ssize_t padata_sysfs_store(struct kobject *kobj, struct attribute *attr,
 940                                   const char *buf, size_t count)
 941 {
 942         struct padata_instance *pinst;
 943         struct padata_sysfs_entry *pentry;
 944         ssize_t ret = -EIO;
 945
 946         pinst = kobj2pinst(kobj);
 947         pentry = attr2pentry(attr);
 948         if (pentry->show)
 949                 ret = pentry->store(pinst, attr, buf, count);
 950
 951         return ret;
 952 }
 953
 954 static const struct sysfs_ops padata_sysfs_ops = {
 955         .show = padata_sysfs_show,
 956         .store = padata_sysfs_store,
 957 };
 958
 959 static struct kobj_type padata_attr_type = {
 960         .sysfs_ops = &padata_sysfs_ops,
 961         .default_groups = padata_default_groups,
 962         .release = padata_sysfs_release,
 963 };
 964
 965 /**
 966  * padata_alloc - allocate and initialize a padata instance
 967  * @name: used to identify the instance
 968  *
 969  * Return: new instance on success, NULL on error
 970  */
 971 struct padata_instance *padata_alloc(const char *name)
 972 {
 973         struct padata_instance *pinst;
 974
 975         pinst = kzalloc(sizeof(struct padata_instance), GFP_KERNEL);
 976         if (!pinst)
 977                 goto err;
 978
 979         pinst->parallel_wq = alloc_workqueue("%s_parallel", WQ_UNBOUND, 0,
 980                                              name);
 981         if (!pinst->parallel_wq)
 982                 goto err_free_inst;
 983
 984         cpus_read_lock();
 985
 986         pinst->serial_wq = alloc_workqueue("%s_serial", WQ_MEM_RECLAIM |
 987                                            WQ_CPU_INTENSIVE, 1, name);
 988         if (!pinst->serial_wq)
 989                 goto err_put_cpus;
 990
 991         if (!alloc_cpumask_var(&pinst->cpumask.pcpu, GFP_KERNEL))
 992                 goto err_free_serial_wq;
 993         if (!alloc_cpumask_var(&pinst->cpumask.cbcpu, GFP_KERNEL)) {
 994                 free_cpumask_var(pinst->cpumask.pcpu);
 995                 goto err_free_serial_wq;
 996         }
 997
 998         INIT_LIST_HEAD(&pinst->pslist);
 999
1000         cpumask_copy(pinst->cpumask.pcpu, cpu_possible_mask);
1001         cpumask_copy(pinst->cpumask.cbcpu, cpu_possible_mask);
1002
1003         if (padata_setup_cpumasks(pinst))
1004                 goto err_free_masks;
1005
1006         __padata_start(pinst);
1007
1008         kobject_init(&pinst->kobj, &padata_attr_type);
1009         mutex_init(&pinst->lock);
1010
1011 #ifdef CONFIG_HOTPLUG_CPU
1012         cpuhp_state_add_instance_nocalls_cpuslocked(hp_online,
1013                                                     &pinst->cpu_online_node);
1014         cpuhp_state_add_instance_nocalls_cpuslocked(CPUHP_PADATA_DEAD,
1015                                                     &pinst->cpu_dead_node);
1016 #endif
1017
1018         cpus_read_unlock();
1019
1020         return pinst;
1021
1022 err_free_masks:
1023         free_cpumask_var(pinst->cpumask.pcpu);
1024         free_cpumask_var(pinst->cpumask.cbcpu);
1025 err_free_serial_wq:
1026         destroy_workqueue(pinst->serial_wq);
1027 err_put_cpus:
1028         cpus_read_unlock();
1029         destroy_workqueue(pinst->parallel_wq);
1030 err_free_inst:
1031         kfree(pinst);
1032 err:
1033         return NULL;
1034 }
1035 EXPORT_SYMBOL(padata_alloc);
1036
1037 /**
1038  * padata_free - free a padata instance
1039  *
1040  * @pinst: padata instance to free
1041  */
1042 void padata_free(struct padata_instance *pinst)
1043 {
1044         kobject_put(&pinst->kobj);
1045 }
1046 EXPORT_SYMBOL(padata_free);
1047
1048 /**
1049  * padata_alloc_shell - Allocate and initialize padata shell.
1050  *
1051  * @pinst: Parent padata_instance object.
1052  *
1053  * Return: new shell on success, NULL on error
1054  */
1055 struct padata_shell *padata_alloc_shell(struct padata_instance *pinst)
1056 {
1057         struct parallel_data *pd;
1058         struct padata_shell *ps;
1059
1060         ps = kzalloc(sizeof(*ps), GFP_KERNEL);
1061         if (!ps)
1062                 goto out;
1063
1064         ps->pinst = pinst;
1065
1066         cpus_read_lock();
1067         pd = padata_alloc_pd(ps);
1068         cpus_read_unlock();
1069
1070         if (!pd)
1071                 goto out_free_ps;
1072
1073         mutex_lock(&pinst->lock);
1074         RCU_INIT_POINTER(ps->pd, pd);
1075         list_add(&ps->list, &pinst->pslist);
1076         mutex_unlock(&pinst->lock);
1077
1078         return ps;
1079
1080 out_free_ps:
1081         kfree(ps);
1082 out:
1083         return NULL;
1084 }
1085 EXPORT_SYMBOL(padata_alloc_shell);
1086
1087 /**
1088  * padata_free_shell - free a padata shell
1089  *
1090  * @ps: padata shell to free
1091  */
1092 void padata_free_shell(struct padata_shell *ps)
1093 {
1094         if (!ps)
1095                 return;
1096
1097         mutex_lock(&ps->pinst->lock);
1098         list_del(&ps->list);
1099         padata_free_pd(rcu_dereference_protected(ps->pd, 1));
1100         mutex_unlock(&ps->pinst->lock);
1101
1102         kfree(ps);
1103 }
1104 EXPORT_SYMBOL(padata_free_shell);
1105
1106 void __init padata_init(void)
1107 {
1108         unsigned int i, possible_cpus;
1109 #ifdef CONFIG_HOTPLUG_CPU
1110         int ret;
1111
1112         ret = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "padata:online",
1113                                       padata_cpu_online, NULL);
1114         if (ret < 0)
1115                 goto err;
1116         hp_online = ret;
1117
1118         ret = cpuhp_setup_state_multi(CPUHP_PADATA_DEAD, "padata:dead",
1119                                       NULL, padata_cpu_dead);
1120         if (ret < 0)
1121                 goto remove_online_state;
1122 #endif
1123
1124         possible_cpus = num_possible_cpus();
1125         padata_works = kmalloc_array(possible_cpus, sizeof(struct padata_work),
1126                                      GFP_KERNEL);
1127         if (!padata_works)
1128                 goto remove_dead_state;
1129
1130         for (i = 0; i < possible_cpus; ++i)
1131                 list_add(&padata_works[i].pw_list, &padata_free_works);
1132
1133         return;
1134
1135 remove_dead_state:
1136 #ifdef CONFIG_HOTPLUG_CPU
1137         cpuhp_remove_multi_state(CPUHP_PADATA_DEAD);
1138 remove_online_state:
1139         cpuhp_remove_multi_state(hp_online);
1140 err:
1141 #endif
1142         pr_warn("padata: initialization failed\n");
1143 }