Loading...
1/*
2 * padata.c - generic interface to process data streams in parallel
3 *
4 * See Documentation/padata.txt for an api documentation.
5 *
6 * Copyright (C) 2008, 2009 secunet Security Networks AG
7 * Copyright (C) 2008, 2009 Steffen Klassert <steffen.klassert@secunet.com>
8 *
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms and conditions of the GNU General Public License,
11 * version 2, as published by the Free Software Foundation.
12 *
13 * This program is distributed in the hope it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * more details.
17 *
18 * You should have received a copy of the GNU General Public License along with
19 * this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 */
22
23#include <linux/export.h>
24#include <linux/cpumask.h>
25#include <linux/err.h>
26#include <linux/cpu.h>
27#include <linux/padata.h>
28#include <linux/mutex.h>
29#include <linux/sched.h>
30#include <linux/slab.h>
31#include <linux/sysfs.h>
32#include <linux/rcupdate.h>
33
34#define MAX_OBJ_NUM 1000
35
36static int padata_index_to_cpu(struct parallel_data *pd, int cpu_index)
37{
38 int cpu, target_cpu;
39
40 target_cpu = cpumask_first(pd->cpumask.pcpu);
41 for (cpu = 0; cpu < cpu_index; cpu++)
42 target_cpu = cpumask_next(target_cpu, pd->cpumask.pcpu);
43
44 return target_cpu;
45}
46
47static int padata_cpu_hash(struct parallel_data *pd)
48{
49 unsigned int seq_nr;
50 int cpu_index;
51
52 /*
53 * Hash the sequence numbers to the cpus by taking
54 * seq_nr mod. number of cpus in use.
55 */
56
57 seq_nr = atomic_inc_return(&pd->seq_nr);
58 cpu_index = seq_nr % cpumask_weight(pd->cpumask.pcpu);
59
60 return padata_index_to_cpu(pd, cpu_index);
61}
62
63static void padata_parallel_worker(struct work_struct *parallel_work)
64{
65 struct padata_parallel_queue *pqueue;
66 struct parallel_data *pd;
67 struct padata_instance *pinst;
68 LIST_HEAD(local_list);
69
70 local_bh_disable();
71 pqueue = container_of(parallel_work,
72 struct padata_parallel_queue, work);
73 pd = pqueue->pd;
74 pinst = pd->pinst;
75
76 spin_lock(&pqueue->parallel.lock);
77 list_replace_init(&pqueue->parallel.list, &local_list);
78 spin_unlock(&pqueue->parallel.lock);
79
80 while (!list_empty(&local_list)) {
81 struct padata_priv *padata;
82
83 padata = list_entry(local_list.next,
84 struct padata_priv, list);
85
86 list_del_init(&padata->list);
87
88 padata->parallel(padata);
89 }
90
91 local_bh_enable();
92}
93
94/**
95 * padata_do_parallel - padata parallelization function
96 *
97 * @pinst: padata instance
98 * @padata: object to be parallelized
99 * @cb_cpu: cpu the serialization callback function will run on,
100 * must be in the serial cpumask of padata(i.e. cpumask.cbcpu).
101 *
102 * The parallelization callback function will run with BHs off.
103 * Note: Every object which is parallelized by padata_do_parallel
104 * must be seen by padata_do_serial.
105 */
106int padata_do_parallel(struct padata_instance *pinst,
107 struct padata_priv *padata, int cb_cpu)
108{
109 int target_cpu, err;
110 struct padata_parallel_queue *queue;
111 struct parallel_data *pd;
112
113 rcu_read_lock_bh();
114
115 pd = rcu_dereference_bh(pinst->pd);
116
117 err = -EINVAL;
118 if (!(pinst->flags & PADATA_INIT) || pinst->flags & PADATA_INVALID)
119 goto out;
120
121 if (!cpumask_test_cpu(cb_cpu, pd->cpumask.cbcpu))
122 goto out;
123
124 err = -EBUSY;
125 if ((pinst->flags & PADATA_RESET))
126 goto out;
127
128 if (atomic_read(&pd->refcnt) >= MAX_OBJ_NUM)
129 goto out;
130
131 err = 0;
132 atomic_inc(&pd->refcnt);
133 padata->pd = pd;
134 padata->cb_cpu = cb_cpu;
135
136 target_cpu = padata_cpu_hash(pd);
137 queue = per_cpu_ptr(pd->pqueue, target_cpu);
138
139 spin_lock(&queue->parallel.lock);
140 list_add_tail(&padata->list, &queue->parallel.list);
141 spin_unlock(&queue->parallel.lock);
142
143 queue_work_on(target_cpu, pinst->wq, &queue->work);
144
145out:
146 rcu_read_unlock_bh();
147
148 return err;
149}
150EXPORT_SYMBOL(padata_do_parallel);
151
152/*
153 * padata_get_next - Get the next object that needs serialization.
154 *
155 * Return values are:
156 *
157 * A pointer to the control struct of the next object that needs
158 * serialization, if present in one of the percpu reorder queues.
159 *
160 * NULL, if all percpu reorder queues are empty.
161 *
162 * -EINPROGRESS, if the next object that needs serialization will
163 * be parallel processed by another cpu and is not yet present in
164 * the cpu's reorder queue.
165 *
166 * -ENODATA, if this cpu has to do the parallel processing for
167 * the next object.
168 */
169static struct padata_priv *padata_get_next(struct parallel_data *pd)
170{
171 int cpu, num_cpus;
172 unsigned int next_nr, next_index;
173 struct padata_parallel_queue *next_queue;
174 struct padata_priv *padata;
175 struct padata_list *reorder;
176
177 num_cpus = cpumask_weight(pd->cpumask.pcpu);
178
179 /*
180 * Calculate the percpu reorder queue and the sequence
181 * number of the next object.
182 */
183 next_nr = pd->processed;
184 next_index = next_nr % num_cpus;
185 cpu = padata_index_to_cpu(pd, next_index);
186 next_queue = per_cpu_ptr(pd->pqueue, cpu);
187
188 padata = NULL;
189
190 reorder = &next_queue->reorder;
191
192 if (!list_empty(&reorder->list)) {
193 padata = list_entry(reorder->list.next,
194 struct padata_priv, list);
195
196 spin_lock(&reorder->lock);
197 list_del_init(&padata->list);
198 atomic_dec(&pd->reorder_objects);
199 spin_unlock(&reorder->lock);
200
201 pd->processed++;
202
203 goto out;
204 }
205
206 if (__this_cpu_read(pd->pqueue->cpu_index) == next_queue->cpu_index) {
207 padata = ERR_PTR(-ENODATA);
208 goto out;
209 }
210
211 padata = ERR_PTR(-EINPROGRESS);
212out:
213 return padata;
214}
215
216static void padata_reorder(struct parallel_data *pd)
217{
218 int cb_cpu;
219 struct padata_priv *padata;
220 struct padata_serial_queue *squeue;
221 struct padata_instance *pinst = pd->pinst;
222
223 /*
224 * We need to ensure that only one cpu can work on dequeueing of
225 * the reorder queue the time. Calculating in which percpu reorder
226 * queue the next object will arrive takes some time. A spinlock
227 * would be highly contended. Also it is not clear in which order
228 * the objects arrive to the reorder queues. So a cpu could wait to
229 * get the lock just to notice that there is nothing to do at the
230 * moment. Therefore we use a trylock and let the holder of the lock
231 * care for all the objects enqueued during the holdtime of the lock.
232 */
233 if (!spin_trylock_bh(&pd->lock))
234 return;
235
236 while (1) {
237 padata = padata_get_next(pd);
238
239 /*
240 * All reorder queues are empty, or the next object that needs
241 * serialization is parallel processed by another cpu and is
242 * still on it's way to the cpu's reorder queue, nothing to
243 * do for now.
244 */
245 if (!padata || PTR_ERR(padata) == -EINPROGRESS)
246 break;
247
248 /*
249 * This cpu has to do the parallel processing of the next
250 * object. It's waiting in the cpu's parallelization queue,
251 * so exit immediately.
252 */
253 if (PTR_ERR(padata) == -ENODATA) {
254 del_timer(&pd->timer);
255 spin_unlock_bh(&pd->lock);
256 return;
257 }
258
259 cb_cpu = padata->cb_cpu;
260 squeue = per_cpu_ptr(pd->squeue, cb_cpu);
261
262 spin_lock(&squeue->serial.lock);
263 list_add_tail(&padata->list, &squeue->serial.list);
264 spin_unlock(&squeue->serial.lock);
265
266 queue_work_on(cb_cpu, pinst->wq, &squeue->work);
267 }
268
269 spin_unlock_bh(&pd->lock);
270
271 /*
272 * The next object that needs serialization might have arrived to
273 * the reorder queues in the meantime, we will be called again
274 * from the timer function if no one else cares for it.
275 */
276 if (atomic_read(&pd->reorder_objects)
277 && !(pinst->flags & PADATA_RESET))
278 mod_timer(&pd->timer, jiffies + HZ);
279 else
280 del_timer(&pd->timer);
281
282 return;
283}
284
285static void padata_reorder_timer(unsigned long arg)
286{
287 struct parallel_data *pd = (struct parallel_data *)arg;
288
289 padata_reorder(pd);
290}
291
292static void padata_serial_worker(struct work_struct *serial_work)
293{
294 struct padata_serial_queue *squeue;
295 struct parallel_data *pd;
296 LIST_HEAD(local_list);
297
298 local_bh_disable();
299 squeue = container_of(serial_work, struct padata_serial_queue, work);
300 pd = squeue->pd;
301
302 spin_lock(&squeue->serial.lock);
303 list_replace_init(&squeue->serial.list, &local_list);
304 spin_unlock(&squeue->serial.lock);
305
306 while (!list_empty(&local_list)) {
307 struct padata_priv *padata;
308
309 padata = list_entry(local_list.next,
310 struct padata_priv, list);
311
312 list_del_init(&padata->list);
313
314 padata->serial(padata);
315 atomic_dec(&pd->refcnt);
316 }
317 local_bh_enable();
318}
319
320/**
321 * padata_do_serial - padata serialization function
322 *
323 * @padata: object to be serialized.
324 *
325 * padata_do_serial must be called for every parallelized object.
326 * The serialization callback function will run with BHs off.
327 */
328void padata_do_serial(struct padata_priv *padata)
329{
330 int cpu;
331 struct padata_parallel_queue *pqueue;
332 struct parallel_data *pd;
333
334 pd = padata->pd;
335
336 cpu = get_cpu();
337 pqueue = per_cpu_ptr(pd->pqueue, cpu);
338
339 spin_lock(&pqueue->reorder.lock);
340 atomic_inc(&pd->reorder_objects);
341 list_add_tail(&padata->list, &pqueue->reorder.list);
342 spin_unlock(&pqueue->reorder.lock);
343
344 put_cpu();
345
346 padata_reorder(pd);
347}
348EXPORT_SYMBOL(padata_do_serial);
349
350static int padata_setup_cpumasks(struct parallel_data *pd,
351 const struct cpumask *pcpumask,
352 const struct cpumask *cbcpumask)
353{
354 if (!alloc_cpumask_var(&pd->cpumask.pcpu, GFP_KERNEL))
355 return -ENOMEM;
356
357 cpumask_and(pd->cpumask.pcpu, pcpumask, cpu_online_mask);
358 if (!alloc_cpumask_var(&pd->cpumask.cbcpu, GFP_KERNEL)) {
359 free_cpumask_var(pd->cpumask.cbcpu);
360 return -ENOMEM;
361 }
362
363 cpumask_and(pd->cpumask.cbcpu, cbcpumask, cpu_online_mask);
364 return 0;
365}
366
367static void __padata_list_init(struct padata_list *pd_list)
368{
369 INIT_LIST_HEAD(&pd_list->list);
370 spin_lock_init(&pd_list->lock);
371}
372
373/* Initialize all percpu queues used by serial workers */
374static void padata_init_squeues(struct parallel_data *pd)
375{
376 int cpu;
377 struct padata_serial_queue *squeue;
378
379 for_each_cpu(cpu, pd->cpumask.cbcpu) {
380 squeue = per_cpu_ptr(pd->squeue, cpu);
381 squeue->pd = pd;
382 __padata_list_init(&squeue->serial);
383 INIT_WORK(&squeue->work, padata_serial_worker);
384 }
385}
386
387/* Initialize all percpu queues used by parallel workers */
388static void padata_init_pqueues(struct parallel_data *pd)
389{
390 int cpu_index, cpu;
391 struct padata_parallel_queue *pqueue;
392
393 cpu_index = 0;
394 for_each_cpu(cpu, pd->cpumask.pcpu) {
395 pqueue = per_cpu_ptr(pd->pqueue, cpu);
396 pqueue->pd = pd;
397 pqueue->cpu_index = cpu_index;
398 cpu_index++;
399
400 __padata_list_init(&pqueue->reorder);
401 __padata_list_init(&pqueue->parallel);
402 INIT_WORK(&pqueue->work, padata_parallel_worker);
403 atomic_set(&pqueue->num_obj, 0);
404 }
405}
406
407/* Allocate and initialize the internal cpumask dependend resources. */
408static struct parallel_data *padata_alloc_pd(struct padata_instance *pinst,
409 const struct cpumask *pcpumask,
410 const struct cpumask *cbcpumask)
411{
412 struct parallel_data *pd;
413
414 pd = kzalloc(sizeof(struct parallel_data), GFP_KERNEL);
415 if (!pd)
416 goto err;
417
418 pd->pqueue = alloc_percpu(struct padata_parallel_queue);
419 if (!pd->pqueue)
420 goto err_free_pd;
421
422 pd->squeue = alloc_percpu(struct padata_serial_queue);
423 if (!pd->squeue)
424 goto err_free_pqueue;
425 if (padata_setup_cpumasks(pd, pcpumask, cbcpumask) < 0)
426 goto err_free_squeue;
427
428 padata_init_pqueues(pd);
429 padata_init_squeues(pd);
430 setup_timer(&pd->timer, padata_reorder_timer, (unsigned long)pd);
431 atomic_set(&pd->seq_nr, -1);
432 atomic_set(&pd->reorder_objects, 0);
433 atomic_set(&pd->refcnt, 0);
434 pd->pinst = pinst;
435 spin_lock_init(&pd->lock);
436
437 return pd;
438
439err_free_squeue:
440 free_percpu(pd->squeue);
441err_free_pqueue:
442 free_percpu(pd->pqueue);
443err_free_pd:
444 kfree(pd);
445err:
446 return NULL;
447}
448
449static void padata_free_pd(struct parallel_data *pd)
450{
451 free_cpumask_var(pd->cpumask.pcpu);
452 free_cpumask_var(pd->cpumask.cbcpu);
453 free_percpu(pd->pqueue);
454 free_percpu(pd->squeue);
455 kfree(pd);
456}
457
458/* Flush all objects out of the padata queues. */
459static void padata_flush_queues(struct parallel_data *pd)
460{
461 int cpu;
462 struct padata_parallel_queue *pqueue;
463 struct padata_serial_queue *squeue;
464
465 for_each_cpu(cpu, pd->cpumask.pcpu) {
466 pqueue = per_cpu_ptr(pd->pqueue, cpu);
467 flush_work(&pqueue->work);
468 }
469
470 del_timer_sync(&pd->timer);
471
472 if (atomic_read(&pd->reorder_objects))
473 padata_reorder(pd);
474
475 for_each_cpu(cpu, pd->cpumask.cbcpu) {
476 squeue = per_cpu_ptr(pd->squeue, cpu);
477 flush_work(&squeue->work);
478 }
479
480 BUG_ON(atomic_read(&pd->refcnt) != 0);
481}
482
483static void __padata_start(struct padata_instance *pinst)
484{
485 pinst->flags |= PADATA_INIT;
486}
487
488static void __padata_stop(struct padata_instance *pinst)
489{
490 if (!(pinst->flags & PADATA_INIT))
491 return;
492
493 pinst->flags &= ~PADATA_INIT;
494
495 synchronize_rcu();
496
497 get_online_cpus();
498 padata_flush_queues(pinst->pd);
499 put_online_cpus();
500}
501
502/* Replace the internal control structure with a new one. */
503static void padata_replace(struct padata_instance *pinst,
504 struct parallel_data *pd_new)
505{
506 struct parallel_data *pd_old = pinst->pd;
507 int notification_mask = 0;
508
509 pinst->flags |= PADATA_RESET;
510
511 rcu_assign_pointer(pinst->pd, pd_new);
512
513 synchronize_rcu();
514
515 if (!cpumask_equal(pd_old->cpumask.pcpu, pd_new->cpumask.pcpu))
516 notification_mask |= PADATA_CPU_PARALLEL;
517 if (!cpumask_equal(pd_old->cpumask.cbcpu, pd_new->cpumask.cbcpu))
518 notification_mask |= PADATA_CPU_SERIAL;
519
520 padata_flush_queues(pd_old);
521 padata_free_pd(pd_old);
522
523 if (notification_mask)
524 blocking_notifier_call_chain(&pinst->cpumask_change_notifier,
525 notification_mask,
526 &pd_new->cpumask);
527
528 pinst->flags &= ~PADATA_RESET;
529}
530
531/**
532 * padata_register_cpumask_notifier - Registers a notifier that will be called
533 * if either pcpu or cbcpu or both cpumasks change.
534 *
535 * @pinst: A poineter to padata instance
536 * @nblock: A pointer to notifier block.
537 */
538int padata_register_cpumask_notifier(struct padata_instance *pinst,
539 struct notifier_block *nblock)
540{
541 return blocking_notifier_chain_register(&pinst->cpumask_change_notifier,
542 nblock);
543}
544EXPORT_SYMBOL(padata_register_cpumask_notifier);
545
546/**
547 * padata_unregister_cpumask_notifier - Unregisters cpumask notifier
548 * registered earlier using padata_register_cpumask_notifier
549 *
550 * @pinst: A pointer to data instance.
551 * @nlock: A pointer to notifier block.
552 */
553int padata_unregister_cpumask_notifier(struct padata_instance *pinst,
554 struct notifier_block *nblock)
555{
556 return blocking_notifier_chain_unregister(
557 &pinst->cpumask_change_notifier,
558 nblock);
559}
560EXPORT_SYMBOL(padata_unregister_cpumask_notifier);
561
562
563/* If cpumask contains no active cpu, we mark the instance as invalid. */
564static bool padata_validate_cpumask(struct padata_instance *pinst,
565 const struct cpumask *cpumask)
566{
567 if (!cpumask_intersects(cpumask, cpu_online_mask)) {
568 pinst->flags |= PADATA_INVALID;
569 return false;
570 }
571
572 pinst->flags &= ~PADATA_INVALID;
573 return true;
574}
575
576static int __padata_set_cpumasks(struct padata_instance *pinst,
577 cpumask_var_t pcpumask,
578 cpumask_var_t cbcpumask)
579{
580 int valid;
581 struct parallel_data *pd;
582
583 valid = padata_validate_cpumask(pinst, pcpumask);
584 if (!valid) {
585 __padata_stop(pinst);
586 goto out_replace;
587 }
588
589 valid = padata_validate_cpumask(pinst, cbcpumask);
590 if (!valid)
591 __padata_stop(pinst);
592
593out_replace:
594 pd = padata_alloc_pd(pinst, pcpumask, cbcpumask);
595 if (!pd)
596 return -ENOMEM;
597
598 cpumask_copy(pinst->cpumask.pcpu, pcpumask);
599 cpumask_copy(pinst->cpumask.cbcpu, cbcpumask);
600
601 padata_replace(pinst, pd);
602
603 if (valid)
604 __padata_start(pinst);
605
606 return 0;
607}
608
609/**
610 * padata_set_cpumasks - Set both parallel and serial cpumasks. The first
611 * one is used by parallel workers and the second one
612 * by the wokers doing serialization.
613 *
614 * @pinst: padata instance
615 * @pcpumask: the cpumask to use for parallel workers
616 * @cbcpumask: the cpumsak to use for serial workers
617 */
618int padata_set_cpumasks(struct padata_instance *pinst, cpumask_var_t pcpumask,
619 cpumask_var_t cbcpumask)
620{
621 int err;
622
623 mutex_lock(&pinst->lock);
624 get_online_cpus();
625
626 err = __padata_set_cpumasks(pinst, pcpumask, cbcpumask);
627
628 put_online_cpus();
629 mutex_unlock(&pinst->lock);
630
631 return err;
632
633}
634EXPORT_SYMBOL(padata_set_cpumasks);
635
636/**
637 * padata_set_cpumask: Sets specified by @cpumask_type cpumask to the value
638 * equivalent to @cpumask.
639 *
640 * @pinst: padata instance
641 * @cpumask_type: PADATA_CPU_SERIAL or PADATA_CPU_PARALLEL corresponding
642 * to parallel and serial cpumasks respectively.
643 * @cpumask: the cpumask to use
644 */
645int padata_set_cpumask(struct padata_instance *pinst, int cpumask_type,
646 cpumask_var_t cpumask)
647{
648 struct cpumask *serial_mask, *parallel_mask;
649 int err = -EINVAL;
650
651 mutex_lock(&pinst->lock);
652 get_online_cpus();
653
654 switch (cpumask_type) {
655 case PADATA_CPU_PARALLEL:
656 serial_mask = pinst->cpumask.cbcpu;
657 parallel_mask = cpumask;
658 break;
659 case PADATA_CPU_SERIAL:
660 parallel_mask = pinst->cpumask.pcpu;
661 serial_mask = cpumask;
662 break;
663 default:
664 goto out;
665 }
666
667 err = __padata_set_cpumasks(pinst, parallel_mask, serial_mask);
668
669out:
670 put_online_cpus();
671 mutex_unlock(&pinst->lock);
672
673 return err;
674}
675EXPORT_SYMBOL(padata_set_cpumask);
676
677static int __padata_add_cpu(struct padata_instance *pinst, int cpu)
678{
679 struct parallel_data *pd;
680
681 if (cpumask_test_cpu(cpu, cpu_online_mask)) {
682 pd = padata_alloc_pd(pinst, pinst->cpumask.pcpu,
683 pinst->cpumask.cbcpu);
684 if (!pd)
685 return -ENOMEM;
686
687 padata_replace(pinst, pd);
688
689 if (padata_validate_cpumask(pinst, pinst->cpumask.pcpu) &&
690 padata_validate_cpumask(pinst, pinst->cpumask.cbcpu))
691 __padata_start(pinst);
692 }
693
694 return 0;
695}
696
697 /**
698 * padata_add_cpu - add a cpu to one or both(parallel and serial)
699 * padata cpumasks.
700 *
701 * @pinst: padata instance
702 * @cpu: cpu to add
703 * @mask: bitmask of flags specifying to which cpumask @cpu shuld be added.
704 * The @mask may be any combination of the following flags:
705 * PADATA_CPU_SERIAL - serial cpumask
706 * PADATA_CPU_PARALLEL - parallel cpumask
707 */
708
709int padata_add_cpu(struct padata_instance *pinst, int cpu, int mask)
710{
711 int err;
712
713 if (!(mask & (PADATA_CPU_SERIAL | PADATA_CPU_PARALLEL)))
714 return -EINVAL;
715
716 mutex_lock(&pinst->lock);
717
718 get_online_cpus();
719 if (mask & PADATA_CPU_SERIAL)
720 cpumask_set_cpu(cpu, pinst->cpumask.cbcpu);
721 if (mask & PADATA_CPU_PARALLEL)
722 cpumask_set_cpu(cpu, pinst->cpumask.pcpu);
723
724 err = __padata_add_cpu(pinst, cpu);
725 put_online_cpus();
726
727 mutex_unlock(&pinst->lock);
728
729 return err;
730}
731EXPORT_SYMBOL(padata_add_cpu);
732
733static int __padata_remove_cpu(struct padata_instance *pinst, int cpu)
734{
735 struct parallel_data *pd = NULL;
736
737 if (cpumask_test_cpu(cpu, cpu_online_mask)) {
738
739 if (!padata_validate_cpumask(pinst, pinst->cpumask.pcpu) ||
740 !padata_validate_cpumask(pinst, pinst->cpumask.cbcpu))
741 __padata_stop(pinst);
742
743 pd = padata_alloc_pd(pinst, pinst->cpumask.pcpu,
744 pinst->cpumask.cbcpu);
745 if (!pd)
746 return -ENOMEM;
747
748 padata_replace(pinst, pd);
749
750 cpumask_clear_cpu(cpu, pd->cpumask.cbcpu);
751 cpumask_clear_cpu(cpu, pd->cpumask.pcpu);
752 }
753
754 return 0;
755}
756
757 /**
758 * padata_remove_cpu - remove a cpu from the one or both(serial and parallel)
759 * padata cpumasks.
760 *
761 * @pinst: padata instance
762 * @cpu: cpu to remove
763 * @mask: bitmask specifying from which cpumask @cpu should be removed
764 * The @mask may be any combination of the following flags:
765 * PADATA_CPU_SERIAL - serial cpumask
766 * PADATA_CPU_PARALLEL - parallel cpumask
767 */
768int padata_remove_cpu(struct padata_instance *pinst, int cpu, int mask)
769{
770 int err;
771
772 if (!(mask & (PADATA_CPU_SERIAL | PADATA_CPU_PARALLEL)))
773 return -EINVAL;
774
775 mutex_lock(&pinst->lock);
776
777 get_online_cpus();
778 if (mask & PADATA_CPU_SERIAL)
779 cpumask_clear_cpu(cpu, pinst->cpumask.cbcpu);
780 if (mask & PADATA_CPU_PARALLEL)
781 cpumask_clear_cpu(cpu, pinst->cpumask.pcpu);
782
783 err = __padata_remove_cpu(pinst, cpu);
784 put_online_cpus();
785
786 mutex_unlock(&pinst->lock);
787
788 return err;
789}
790EXPORT_SYMBOL(padata_remove_cpu);
791
792/**
793 * padata_start - start the parallel processing
794 *
795 * @pinst: padata instance to start
796 */
797int padata_start(struct padata_instance *pinst)
798{
799 int err = 0;
800
801 mutex_lock(&pinst->lock);
802
803 if (pinst->flags & PADATA_INVALID)
804 err =-EINVAL;
805
806 __padata_start(pinst);
807
808 mutex_unlock(&pinst->lock);
809
810 return err;
811}
812EXPORT_SYMBOL(padata_start);
813
814/**
815 * padata_stop - stop the parallel processing
816 *
817 * @pinst: padata instance to stop
818 */
819void padata_stop(struct padata_instance *pinst)
820{
821 mutex_lock(&pinst->lock);
822 __padata_stop(pinst);
823 mutex_unlock(&pinst->lock);
824}
825EXPORT_SYMBOL(padata_stop);
826
827#ifdef CONFIG_HOTPLUG_CPU
828
829static inline int pinst_has_cpu(struct padata_instance *pinst, int cpu)
830{
831 return cpumask_test_cpu(cpu, pinst->cpumask.pcpu) ||
832 cpumask_test_cpu(cpu, pinst->cpumask.cbcpu);
833}
834
835
836static int padata_cpu_callback(struct notifier_block *nfb,
837 unsigned long action, void *hcpu)
838{
839 int err;
840 struct padata_instance *pinst;
841 int cpu = (unsigned long)hcpu;
842
843 pinst = container_of(nfb, struct padata_instance, cpu_notifier);
844
845 switch (action) {
846 case CPU_ONLINE:
847 case CPU_ONLINE_FROZEN:
848 case CPU_DOWN_FAILED:
849 case CPU_DOWN_FAILED_FROZEN:
850 if (!pinst_has_cpu(pinst, cpu))
851 break;
852 mutex_lock(&pinst->lock);
853 err = __padata_add_cpu(pinst, cpu);
854 mutex_unlock(&pinst->lock);
855 if (err)
856 return notifier_from_errno(err);
857 break;
858
859 case CPU_DOWN_PREPARE:
860 case CPU_DOWN_PREPARE_FROZEN:
861 case CPU_UP_CANCELED:
862 case CPU_UP_CANCELED_FROZEN:
863 if (!pinst_has_cpu(pinst, cpu))
864 break;
865 mutex_lock(&pinst->lock);
866 err = __padata_remove_cpu(pinst, cpu);
867 mutex_unlock(&pinst->lock);
868 if (err)
869 return notifier_from_errno(err);
870 break;
871 }
872
873 return NOTIFY_OK;
874}
875#endif
876
877static void __padata_free(struct padata_instance *pinst)
878{
879#ifdef CONFIG_HOTPLUG_CPU
880 unregister_hotcpu_notifier(&pinst->cpu_notifier);
881#endif
882
883 padata_stop(pinst);
884 padata_free_pd(pinst->pd);
885 free_cpumask_var(pinst->cpumask.pcpu);
886 free_cpumask_var(pinst->cpumask.cbcpu);
887 kfree(pinst);
888}
889
890#define kobj2pinst(_kobj) \
891 container_of(_kobj, struct padata_instance, kobj)
892#define attr2pentry(_attr) \
893 container_of(_attr, struct padata_sysfs_entry, attr)
894
895static void padata_sysfs_release(struct kobject *kobj)
896{
897 struct padata_instance *pinst = kobj2pinst(kobj);
898 __padata_free(pinst);
899}
900
901struct padata_sysfs_entry {
902 struct attribute attr;
903 ssize_t (*show)(struct padata_instance *, struct attribute *, char *);
904 ssize_t (*store)(struct padata_instance *, struct attribute *,
905 const char *, size_t);
906};
907
908static ssize_t show_cpumask(struct padata_instance *pinst,
909 struct attribute *attr, char *buf)
910{
911 struct cpumask *cpumask;
912 ssize_t len;
913
914 mutex_lock(&pinst->lock);
915 if (!strcmp(attr->name, "serial_cpumask"))
916 cpumask = pinst->cpumask.cbcpu;
917 else
918 cpumask = pinst->cpumask.pcpu;
919
920 len = bitmap_scnprintf(buf, PAGE_SIZE, cpumask_bits(cpumask),
921 nr_cpu_ids);
922 if (PAGE_SIZE - len < 2)
923 len = -EINVAL;
924 else
925 len += sprintf(buf + len, "\n");
926
927 mutex_unlock(&pinst->lock);
928 return len;
929}
930
931static ssize_t store_cpumask(struct padata_instance *pinst,
932 struct attribute *attr,
933 const char *buf, size_t count)
934{
935 cpumask_var_t new_cpumask;
936 ssize_t ret;
937 int mask_type;
938
939 if (!alloc_cpumask_var(&new_cpumask, GFP_KERNEL))
940 return -ENOMEM;
941
942 ret = bitmap_parse(buf, count, cpumask_bits(new_cpumask),
943 nr_cpumask_bits);
944 if (ret < 0)
945 goto out;
946
947 mask_type = !strcmp(attr->name, "serial_cpumask") ?
948 PADATA_CPU_SERIAL : PADATA_CPU_PARALLEL;
949 ret = padata_set_cpumask(pinst, mask_type, new_cpumask);
950 if (!ret)
951 ret = count;
952
953out:
954 free_cpumask_var(new_cpumask);
955 return ret;
956}
957
958#define PADATA_ATTR_RW(_name, _show_name, _store_name) \
959 static struct padata_sysfs_entry _name##_attr = \
960 __ATTR(_name, 0644, _show_name, _store_name)
961#define PADATA_ATTR_RO(_name, _show_name) \
962 static struct padata_sysfs_entry _name##_attr = \
963 __ATTR(_name, 0400, _show_name, NULL)
964
965PADATA_ATTR_RW(serial_cpumask, show_cpumask, store_cpumask);
966PADATA_ATTR_RW(parallel_cpumask, show_cpumask, store_cpumask);
967
968/*
969 * Padata sysfs provides the following objects:
970 * serial_cpumask [RW] - cpumask for serial workers
971 * parallel_cpumask [RW] - cpumask for parallel workers
972 */
973static struct attribute *padata_default_attrs[] = {
974 &serial_cpumask_attr.attr,
975 ¶llel_cpumask_attr.attr,
976 NULL,
977};
978
979static ssize_t padata_sysfs_show(struct kobject *kobj,
980 struct attribute *attr, char *buf)
981{
982 struct padata_instance *pinst;
983 struct padata_sysfs_entry *pentry;
984 ssize_t ret = -EIO;
985
986 pinst = kobj2pinst(kobj);
987 pentry = attr2pentry(attr);
988 if (pentry->show)
989 ret = pentry->show(pinst, attr, buf);
990
991 return ret;
992}
993
994static ssize_t padata_sysfs_store(struct kobject *kobj, struct attribute *attr,
995 const char *buf, size_t count)
996{
997 struct padata_instance *pinst;
998 struct padata_sysfs_entry *pentry;
999 ssize_t ret = -EIO;
1000
1001 pinst = kobj2pinst(kobj);
1002 pentry = attr2pentry(attr);
1003 if (pentry->show)
1004 ret = pentry->store(pinst, attr, buf, count);
1005
1006 return ret;
1007}
1008
1009static const struct sysfs_ops padata_sysfs_ops = {
1010 .show = padata_sysfs_show,
1011 .store = padata_sysfs_store,
1012};
1013
1014static struct kobj_type padata_attr_type = {
1015 .sysfs_ops = &padata_sysfs_ops,
1016 .default_attrs = padata_default_attrs,
1017 .release = padata_sysfs_release,
1018};
1019
1020/**
1021 * padata_alloc_possible - Allocate and initialize padata instance.
1022 * Use the cpu_possible_mask for serial and
1023 * parallel workers.
1024 *
1025 * @wq: workqueue to use for the allocated padata instance
1026 */
1027struct padata_instance *padata_alloc_possible(struct workqueue_struct *wq)
1028{
1029 return padata_alloc(wq, cpu_possible_mask, cpu_possible_mask);
1030}
1031EXPORT_SYMBOL(padata_alloc_possible);
1032
1033/**
1034 * padata_alloc - allocate and initialize a padata instance and specify
1035 * cpumasks for serial and parallel workers.
1036 *
1037 * @wq: workqueue to use for the allocated padata instance
1038 * @pcpumask: cpumask that will be used for padata parallelization
1039 * @cbcpumask: cpumask that will be used for padata serialization
1040 */
1041struct padata_instance *padata_alloc(struct workqueue_struct *wq,
1042 const struct cpumask *pcpumask,
1043 const struct cpumask *cbcpumask)
1044{
1045 struct padata_instance *pinst;
1046 struct parallel_data *pd = NULL;
1047
1048 pinst = kzalloc(sizeof(struct padata_instance), GFP_KERNEL);
1049 if (!pinst)
1050 goto err;
1051
1052 get_online_cpus();
1053 if (!alloc_cpumask_var(&pinst->cpumask.pcpu, GFP_KERNEL))
1054 goto err_free_inst;
1055 if (!alloc_cpumask_var(&pinst->cpumask.cbcpu, GFP_KERNEL)) {
1056 free_cpumask_var(pinst->cpumask.pcpu);
1057 goto err_free_inst;
1058 }
1059 if (!padata_validate_cpumask(pinst, pcpumask) ||
1060 !padata_validate_cpumask(pinst, cbcpumask))
1061 goto err_free_masks;
1062
1063 pd = padata_alloc_pd(pinst, pcpumask, cbcpumask);
1064 if (!pd)
1065 goto err_free_masks;
1066
1067 rcu_assign_pointer(pinst->pd, pd);
1068
1069 pinst->wq = wq;
1070
1071 cpumask_copy(pinst->cpumask.pcpu, pcpumask);
1072 cpumask_copy(pinst->cpumask.cbcpu, cbcpumask);
1073
1074 pinst->flags = 0;
1075
1076 put_online_cpus();
1077
1078 BLOCKING_INIT_NOTIFIER_HEAD(&pinst->cpumask_change_notifier);
1079 kobject_init(&pinst->kobj, &padata_attr_type);
1080 mutex_init(&pinst->lock);
1081
1082#ifdef CONFIG_HOTPLUG_CPU
1083 pinst->cpu_notifier.notifier_call = padata_cpu_callback;
1084 pinst->cpu_notifier.priority = 0;
1085 register_hotcpu_notifier(&pinst->cpu_notifier);
1086#endif
1087
1088 return pinst;
1089
1090err_free_masks:
1091 free_cpumask_var(pinst->cpumask.pcpu);
1092 free_cpumask_var(pinst->cpumask.cbcpu);
1093err_free_inst:
1094 kfree(pinst);
1095 put_online_cpus();
1096err:
1097 return NULL;
1098}
1099EXPORT_SYMBOL(padata_alloc);
1100
1101/**
1102 * padata_free - free a padata instance
1103 *
1104 * @padata_inst: padata instance to free
1105 */
1106void padata_free(struct padata_instance *pinst)
1107{
1108 kobject_put(&pinst->kobj);
1109}
1110EXPORT_SYMBOL(padata_free);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * padata.c - generic interface to process data streams in parallel
4 *
5 * See Documentation/padata.txt for an api documentation.
6 *
7 * Copyright (C) 2008, 2009 secunet Security Networks AG
8 * Copyright (C) 2008, 2009 Steffen Klassert <steffen.klassert@secunet.com>
9 *
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms and conditions of the GNU General Public License,
12 * version 2, as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 * more details.
18 *
19 * You should have received a copy of the GNU General Public License along with
20 * this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
22 */
23
24#include <linux/export.h>
25#include <linux/cpumask.h>
26#include <linux/err.h>
27#include <linux/cpu.h>
28#include <linux/padata.h>
29#include <linux/mutex.h>
30#include <linux/sched.h>
31#include <linux/slab.h>
32#include <linux/sysfs.h>
33#include <linux/rcupdate.h>
34#include <linux/module.h>
35
36#define MAX_OBJ_NUM 1000
37
38static int padata_index_to_cpu(struct parallel_data *pd, int cpu_index)
39{
40 int cpu, target_cpu;
41
42 target_cpu = cpumask_first(pd->cpumask.pcpu);
43 for (cpu = 0; cpu < cpu_index; cpu++)
44 target_cpu = cpumask_next(target_cpu, pd->cpumask.pcpu);
45
46 return target_cpu;
47}
48
49static int padata_cpu_hash(struct parallel_data *pd)
50{
51 unsigned int seq_nr;
52 int cpu_index;
53
54 /*
55 * Hash the sequence numbers to the cpus by taking
56 * seq_nr mod. number of cpus in use.
57 */
58
59 seq_nr = atomic_inc_return(&pd->seq_nr);
60 cpu_index = seq_nr % cpumask_weight(pd->cpumask.pcpu);
61
62 return padata_index_to_cpu(pd, cpu_index);
63}
64
65static void padata_parallel_worker(struct work_struct *parallel_work)
66{
67 struct padata_parallel_queue *pqueue;
68 LIST_HEAD(local_list);
69
70 local_bh_disable();
71 pqueue = container_of(parallel_work,
72 struct padata_parallel_queue, work);
73
74 spin_lock(&pqueue->parallel.lock);
75 list_replace_init(&pqueue->parallel.list, &local_list);
76 spin_unlock(&pqueue->parallel.lock);
77
78 while (!list_empty(&local_list)) {
79 struct padata_priv *padata;
80
81 padata = list_entry(local_list.next,
82 struct padata_priv, list);
83
84 list_del_init(&padata->list);
85
86 padata->parallel(padata);
87 }
88
89 local_bh_enable();
90}
91
92/**
93 * padata_do_parallel - padata parallelization function
94 *
95 * @pinst: padata instance
96 * @padata: object to be parallelized
97 * @cb_cpu: cpu the serialization callback function will run on,
98 * must be in the serial cpumask of padata(i.e. cpumask.cbcpu).
99 *
100 * The parallelization callback function will run with BHs off.
101 * Note: Every object which is parallelized by padata_do_parallel
102 * must be seen by padata_do_serial.
103 */
104int padata_do_parallel(struct padata_instance *pinst,
105 struct padata_priv *padata, int cb_cpu)
106{
107 int target_cpu, err;
108 struct padata_parallel_queue *queue;
109 struct parallel_data *pd;
110
111 rcu_read_lock_bh();
112
113 pd = rcu_dereference_bh(pinst->pd);
114
115 err = -EINVAL;
116 if (!(pinst->flags & PADATA_INIT) || pinst->flags & PADATA_INVALID)
117 goto out;
118
119 if (!cpumask_test_cpu(cb_cpu, pd->cpumask.cbcpu))
120 goto out;
121
122 err = -EBUSY;
123 if ((pinst->flags & PADATA_RESET))
124 goto out;
125
126 if (atomic_read(&pd->refcnt) >= MAX_OBJ_NUM)
127 goto out;
128
129 err = 0;
130 atomic_inc(&pd->refcnt);
131 padata->pd = pd;
132 padata->cb_cpu = cb_cpu;
133
134 target_cpu = padata_cpu_hash(pd);
135 padata->cpu = target_cpu;
136 queue = per_cpu_ptr(pd->pqueue, target_cpu);
137
138 spin_lock(&queue->parallel.lock);
139 list_add_tail(&padata->list, &queue->parallel.list);
140 spin_unlock(&queue->parallel.lock);
141
142 queue_work_on(target_cpu, pinst->wq, &queue->work);
143
144out:
145 rcu_read_unlock_bh();
146
147 return err;
148}
149EXPORT_SYMBOL(padata_do_parallel);
150
151/*
152 * padata_get_next - Get the next object that needs serialization.
153 *
154 * Return values are:
155 *
156 * A pointer to the control struct of the next object that needs
157 * serialization, if present in one of the percpu reorder queues.
158 *
159 * -EINPROGRESS, if the next object that needs serialization will
160 * be parallel processed by another cpu and is not yet present in
161 * the cpu's reorder queue.
162 *
163 * -ENODATA, if this cpu has to do the parallel processing for
164 * the next object.
165 */
166static struct padata_priv *padata_get_next(struct parallel_data *pd)
167{
168 int cpu, num_cpus;
169 unsigned int next_nr, next_index;
170 struct padata_parallel_queue *next_queue;
171 struct padata_priv *padata;
172 struct padata_list *reorder;
173
174 num_cpus = cpumask_weight(pd->cpumask.pcpu);
175
176 /*
177 * Calculate the percpu reorder queue and the sequence
178 * number of the next object.
179 */
180 next_nr = pd->processed;
181 next_index = next_nr % num_cpus;
182 cpu = padata_index_to_cpu(pd, next_index);
183 next_queue = per_cpu_ptr(pd->pqueue, cpu);
184
185 reorder = &next_queue->reorder;
186
187 spin_lock(&reorder->lock);
188 if (!list_empty(&reorder->list)) {
189 padata = list_entry(reorder->list.next,
190 struct padata_priv, list);
191
192 list_del_init(&padata->list);
193 atomic_dec(&pd->reorder_objects);
194
195 pd->processed++;
196
197 spin_unlock(&reorder->lock);
198 goto out;
199 }
200 spin_unlock(&reorder->lock);
201
202 if (__this_cpu_read(pd->pqueue->cpu_index) == next_queue->cpu_index) {
203 padata = ERR_PTR(-ENODATA);
204 goto out;
205 }
206
207 padata = ERR_PTR(-EINPROGRESS);
208out:
209 return padata;
210}
211
212static void padata_reorder(struct parallel_data *pd)
213{
214 int cb_cpu;
215 struct padata_priv *padata;
216 struct padata_serial_queue *squeue;
217 struct padata_instance *pinst = pd->pinst;
218
219 /*
220 * We need to ensure that only one cpu can work on dequeueing of
221 * the reorder queue the time. Calculating in which percpu reorder
222 * queue the next object will arrive takes some time. A spinlock
223 * would be highly contended. Also it is not clear in which order
224 * the objects arrive to the reorder queues. So a cpu could wait to
225 * get the lock just to notice that there is nothing to do at the
226 * moment. Therefore we use a trylock and let the holder of the lock
227 * care for all the objects enqueued during the holdtime of the lock.
228 */
229 if (!spin_trylock_bh(&pd->lock))
230 return;
231
232 while (1) {
233 padata = padata_get_next(pd);
234
235 /*
236 * If the next object that needs serialization is parallel
237 * processed by another cpu and is still on it's way to the
238 * cpu's reorder queue, nothing to do for now.
239 */
240 if (PTR_ERR(padata) == -EINPROGRESS)
241 break;
242
243 /*
244 * This cpu has to do the parallel processing of the next
245 * object. It's waiting in the cpu's parallelization queue,
246 * so exit immediately.
247 */
248 if (PTR_ERR(padata) == -ENODATA) {
249 del_timer(&pd->timer);
250 spin_unlock_bh(&pd->lock);
251 return;
252 }
253
254 cb_cpu = padata->cb_cpu;
255 squeue = per_cpu_ptr(pd->squeue, cb_cpu);
256
257 spin_lock(&squeue->serial.lock);
258 list_add_tail(&padata->list, &squeue->serial.list);
259 spin_unlock(&squeue->serial.lock);
260
261 queue_work_on(cb_cpu, pinst->wq, &squeue->work);
262 }
263
264 spin_unlock_bh(&pd->lock);
265
266 /*
267 * The next object that needs serialization might have arrived to
268 * the reorder queues in the meantime, we will be called again
269 * from the timer function if no one else cares for it.
270 */
271 if (atomic_read(&pd->reorder_objects)
272 && !(pinst->flags & PADATA_RESET))
273 mod_timer(&pd->timer, jiffies + HZ);
274 else
275 del_timer(&pd->timer);
276
277 return;
278}
279
280static void invoke_padata_reorder(struct work_struct *work)
281{
282 struct padata_parallel_queue *pqueue;
283 struct parallel_data *pd;
284
285 local_bh_disable();
286 pqueue = container_of(work, struct padata_parallel_queue, reorder_work);
287 pd = pqueue->pd;
288 padata_reorder(pd);
289 local_bh_enable();
290}
291
292static void padata_reorder_timer(struct timer_list *t)
293{
294 struct parallel_data *pd = from_timer(pd, t, timer);
295 unsigned int weight;
296 int target_cpu, cpu;
297
298 cpu = get_cpu();
299
300 /* We don't lock pd here to not interfere with parallel processing
301 * padata_reorder() calls on other CPUs. We just need any CPU out of
302 * the cpumask.pcpu set. It would be nice if it's the right one but
303 * it doesn't matter if we're off to the next one by using an outdated
304 * pd->processed value.
305 */
306 weight = cpumask_weight(pd->cpumask.pcpu);
307 target_cpu = padata_index_to_cpu(pd, pd->processed % weight);
308
309 /* ensure to call the reorder callback on the correct CPU */
310 if (cpu != target_cpu) {
311 struct padata_parallel_queue *pqueue;
312 struct padata_instance *pinst;
313
314 /* The timer function is serialized wrt itself -- no locking
315 * needed.
316 */
317 pinst = pd->pinst;
318 pqueue = per_cpu_ptr(pd->pqueue, target_cpu);
319 queue_work_on(target_cpu, pinst->wq, &pqueue->reorder_work);
320 } else {
321 padata_reorder(pd);
322 }
323
324 put_cpu();
325}
326
327static void padata_serial_worker(struct work_struct *serial_work)
328{
329 struct padata_serial_queue *squeue;
330 struct parallel_data *pd;
331 LIST_HEAD(local_list);
332
333 local_bh_disable();
334 squeue = container_of(serial_work, struct padata_serial_queue, work);
335 pd = squeue->pd;
336
337 spin_lock(&squeue->serial.lock);
338 list_replace_init(&squeue->serial.list, &local_list);
339 spin_unlock(&squeue->serial.lock);
340
341 while (!list_empty(&local_list)) {
342 struct padata_priv *padata;
343
344 padata = list_entry(local_list.next,
345 struct padata_priv, list);
346
347 list_del_init(&padata->list);
348
349 padata->serial(padata);
350 atomic_dec(&pd->refcnt);
351 }
352 local_bh_enable();
353}
354
355/**
356 * padata_do_serial - padata serialization function
357 *
358 * @padata: object to be serialized.
359 *
360 * padata_do_serial must be called for every parallelized object.
361 * The serialization callback function will run with BHs off.
362 */
363void padata_do_serial(struct padata_priv *padata)
364{
365 int cpu;
366 struct padata_parallel_queue *pqueue;
367 struct parallel_data *pd;
368 int reorder_via_wq = 0;
369
370 pd = padata->pd;
371
372 cpu = get_cpu();
373
374 /* We need to run on the same CPU padata_do_parallel(.., padata, ..)
375 * was called on -- or, at least, enqueue the padata object into the
376 * correct per-cpu queue.
377 */
378 if (cpu != padata->cpu) {
379 reorder_via_wq = 1;
380 cpu = padata->cpu;
381 }
382
383 pqueue = per_cpu_ptr(pd->pqueue, cpu);
384
385 spin_lock(&pqueue->reorder.lock);
386 atomic_inc(&pd->reorder_objects);
387 list_add_tail(&padata->list, &pqueue->reorder.list);
388 spin_unlock(&pqueue->reorder.lock);
389
390 put_cpu();
391
392 /* If we're running on the wrong CPU, call padata_reorder() via a
393 * kernel worker.
394 */
395 if (reorder_via_wq)
396 queue_work_on(cpu, pd->pinst->wq, &pqueue->reorder_work);
397 else
398 padata_reorder(pd);
399}
400EXPORT_SYMBOL(padata_do_serial);
401
402static int padata_setup_cpumasks(struct parallel_data *pd,
403 const struct cpumask *pcpumask,
404 const struct cpumask *cbcpumask)
405{
406 if (!alloc_cpumask_var(&pd->cpumask.pcpu, GFP_KERNEL))
407 return -ENOMEM;
408
409 cpumask_and(pd->cpumask.pcpu, pcpumask, cpu_online_mask);
410 if (!alloc_cpumask_var(&pd->cpumask.cbcpu, GFP_KERNEL)) {
411 free_cpumask_var(pd->cpumask.pcpu);
412 return -ENOMEM;
413 }
414
415 cpumask_and(pd->cpumask.cbcpu, cbcpumask, cpu_online_mask);
416 return 0;
417}
418
419static void __padata_list_init(struct padata_list *pd_list)
420{
421 INIT_LIST_HEAD(&pd_list->list);
422 spin_lock_init(&pd_list->lock);
423}
424
425/* Initialize all percpu queues used by serial workers */
426static void padata_init_squeues(struct parallel_data *pd)
427{
428 int cpu;
429 struct padata_serial_queue *squeue;
430
431 for_each_cpu(cpu, pd->cpumask.cbcpu) {
432 squeue = per_cpu_ptr(pd->squeue, cpu);
433 squeue->pd = pd;
434 __padata_list_init(&squeue->serial);
435 INIT_WORK(&squeue->work, padata_serial_worker);
436 }
437}
438
439/* Initialize all percpu queues used by parallel workers */
440static void padata_init_pqueues(struct parallel_data *pd)
441{
442 int cpu_index, cpu;
443 struct padata_parallel_queue *pqueue;
444
445 cpu_index = 0;
446 for_each_possible_cpu(cpu) {
447 pqueue = per_cpu_ptr(pd->pqueue, cpu);
448
449 if (!cpumask_test_cpu(cpu, pd->cpumask.pcpu)) {
450 pqueue->cpu_index = -1;
451 continue;
452 }
453
454 pqueue->pd = pd;
455 pqueue->cpu_index = cpu_index;
456 cpu_index++;
457
458 __padata_list_init(&pqueue->reorder);
459 __padata_list_init(&pqueue->parallel);
460 INIT_WORK(&pqueue->work, padata_parallel_worker);
461 INIT_WORK(&pqueue->reorder_work, invoke_padata_reorder);
462 atomic_set(&pqueue->num_obj, 0);
463 }
464}
465
466/* Allocate and initialize the internal cpumask dependend resources. */
467static struct parallel_data *padata_alloc_pd(struct padata_instance *pinst,
468 const struct cpumask *pcpumask,
469 const struct cpumask *cbcpumask)
470{
471 struct parallel_data *pd;
472
473 pd = kzalloc(sizeof(struct parallel_data), GFP_KERNEL);
474 if (!pd)
475 goto err;
476
477 pd->pqueue = alloc_percpu(struct padata_parallel_queue);
478 if (!pd->pqueue)
479 goto err_free_pd;
480
481 pd->squeue = alloc_percpu(struct padata_serial_queue);
482 if (!pd->squeue)
483 goto err_free_pqueue;
484 if (padata_setup_cpumasks(pd, pcpumask, cbcpumask) < 0)
485 goto err_free_squeue;
486
487 padata_init_pqueues(pd);
488 padata_init_squeues(pd);
489 timer_setup(&pd->timer, padata_reorder_timer, 0);
490 atomic_set(&pd->seq_nr, -1);
491 atomic_set(&pd->reorder_objects, 0);
492 atomic_set(&pd->refcnt, 0);
493 pd->pinst = pinst;
494 spin_lock_init(&pd->lock);
495
496 return pd;
497
498err_free_squeue:
499 free_percpu(pd->squeue);
500err_free_pqueue:
501 free_percpu(pd->pqueue);
502err_free_pd:
503 kfree(pd);
504err:
505 return NULL;
506}
507
508static void padata_free_pd(struct parallel_data *pd)
509{
510 free_cpumask_var(pd->cpumask.pcpu);
511 free_cpumask_var(pd->cpumask.cbcpu);
512 free_percpu(pd->pqueue);
513 free_percpu(pd->squeue);
514 kfree(pd);
515}
516
517/* Flush all objects out of the padata queues. */
518static void padata_flush_queues(struct parallel_data *pd)
519{
520 int cpu;
521 struct padata_parallel_queue *pqueue;
522 struct padata_serial_queue *squeue;
523
524 for_each_cpu(cpu, pd->cpumask.pcpu) {
525 pqueue = per_cpu_ptr(pd->pqueue, cpu);
526 flush_work(&pqueue->work);
527 }
528
529 del_timer_sync(&pd->timer);
530
531 if (atomic_read(&pd->reorder_objects))
532 padata_reorder(pd);
533
534 for_each_cpu(cpu, pd->cpumask.cbcpu) {
535 squeue = per_cpu_ptr(pd->squeue, cpu);
536 flush_work(&squeue->work);
537 }
538
539 BUG_ON(atomic_read(&pd->refcnt) != 0);
540}
541
542static void __padata_start(struct padata_instance *pinst)
543{
544 pinst->flags |= PADATA_INIT;
545}
546
547static void __padata_stop(struct padata_instance *pinst)
548{
549 if (!(pinst->flags & PADATA_INIT))
550 return;
551
552 pinst->flags &= ~PADATA_INIT;
553
554 synchronize_rcu();
555
556 get_online_cpus();
557 padata_flush_queues(pinst->pd);
558 put_online_cpus();
559}
560
561/* Replace the internal control structure with a new one. */
562static void padata_replace(struct padata_instance *pinst,
563 struct parallel_data *pd_new)
564{
565 struct parallel_data *pd_old = pinst->pd;
566 int notification_mask = 0;
567
568 pinst->flags |= PADATA_RESET;
569
570 rcu_assign_pointer(pinst->pd, pd_new);
571
572 synchronize_rcu();
573
574 if (!cpumask_equal(pd_old->cpumask.pcpu, pd_new->cpumask.pcpu))
575 notification_mask |= PADATA_CPU_PARALLEL;
576 if (!cpumask_equal(pd_old->cpumask.cbcpu, pd_new->cpumask.cbcpu))
577 notification_mask |= PADATA_CPU_SERIAL;
578
579 padata_flush_queues(pd_old);
580 padata_free_pd(pd_old);
581
582 if (notification_mask)
583 blocking_notifier_call_chain(&pinst->cpumask_change_notifier,
584 notification_mask,
585 &pd_new->cpumask);
586
587 pinst->flags &= ~PADATA_RESET;
588}
589
590/**
591 * padata_register_cpumask_notifier - Registers a notifier that will be called
592 * if either pcpu or cbcpu or both cpumasks change.
593 *
594 * @pinst: A poineter to padata instance
595 * @nblock: A pointer to notifier block.
596 */
597int padata_register_cpumask_notifier(struct padata_instance *pinst,
598 struct notifier_block *nblock)
599{
600 return blocking_notifier_chain_register(&pinst->cpumask_change_notifier,
601 nblock);
602}
603EXPORT_SYMBOL(padata_register_cpumask_notifier);
604
605/**
606 * padata_unregister_cpumask_notifier - Unregisters cpumask notifier
607 * registered earlier using padata_register_cpumask_notifier
608 *
609 * @pinst: A pointer to data instance.
610 * @nlock: A pointer to notifier block.
611 */
612int padata_unregister_cpumask_notifier(struct padata_instance *pinst,
613 struct notifier_block *nblock)
614{
615 return blocking_notifier_chain_unregister(
616 &pinst->cpumask_change_notifier,
617 nblock);
618}
619EXPORT_SYMBOL(padata_unregister_cpumask_notifier);
620
621
622/* If cpumask contains no active cpu, we mark the instance as invalid. */
623static bool padata_validate_cpumask(struct padata_instance *pinst,
624 const struct cpumask *cpumask)
625{
626 if (!cpumask_intersects(cpumask, cpu_online_mask)) {
627 pinst->flags |= PADATA_INVALID;
628 return false;
629 }
630
631 pinst->flags &= ~PADATA_INVALID;
632 return true;
633}
634
635static int __padata_set_cpumasks(struct padata_instance *pinst,
636 cpumask_var_t pcpumask,
637 cpumask_var_t cbcpumask)
638{
639 int valid;
640 struct parallel_data *pd;
641
642 valid = padata_validate_cpumask(pinst, pcpumask);
643 if (!valid) {
644 __padata_stop(pinst);
645 goto out_replace;
646 }
647
648 valid = padata_validate_cpumask(pinst, cbcpumask);
649 if (!valid)
650 __padata_stop(pinst);
651
652out_replace:
653 pd = padata_alloc_pd(pinst, pcpumask, cbcpumask);
654 if (!pd)
655 return -ENOMEM;
656
657 cpumask_copy(pinst->cpumask.pcpu, pcpumask);
658 cpumask_copy(pinst->cpumask.cbcpu, cbcpumask);
659
660 padata_replace(pinst, pd);
661
662 if (valid)
663 __padata_start(pinst);
664
665 return 0;
666}
667
668/**
669 * padata_set_cpumask: Sets specified by @cpumask_type cpumask to the value
670 * equivalent to @cpumask.
671 *
672 * @pinst: padata instance
673 * @cpumask_type: PADATA_CPU_SERIAL or PADATA_CPU_PARALLEL corresponding
674 * to parallel and serial cpumasks respectively.
675 * @cpumask: the cpumask to use
676 */
677int padata_set_cpumask(struct padata_instance *pinst, int cpumask_type,
678 cpumask_var_t cpumask)
679{
680 struct cpumask *serial_mask, *parallel_mask;
681 int err = -EINVAL;
682
683 mutex_lock(&pinst->lock);
684 get_online_cpus();
685
686 switch (cpumask_type) {
687 case PADATA_CPU_PARALLEL:
688 serial_mask = pinst->cpumask.cbcpu;
689 parallel_mask = cpumask;
690 break;
691 case PADATA_CPU_SERIAL:
692 parallel_mask = pinst->cpumask.pcpu;
693 serial_mask = cpumask;
694 break;
695 default:
696 goto out;
697 }
698
699 err = __padata_set_cpumasks(pinst, parallel_mask, serial_mask);
700
701out:
702 put_online_cpus();
703 mutex_unlock(&pinst->lock);
704
705 return err;
706}
707EXPORT_SYMBOL(padata_set_cpumask);
708
709/**
710 * padata_start - start the parallel processing
711 *
712 * @pinst: padata instance to start
713 */
714int padata_start(struct padata_instance *pinst)
715{
716 int err = 0;
717
718 mutex_lock(&pinst->lock);
719
720 if (pinst->flags & PADATA_INVALID)
721 err = -EINVAL;
722
723 __padata_start(pinst);
724
725 mutex_unlock(&pinst->lock);
726
727 return err;
728}
729EXPORT_SYMBOL(padata_start);
730
731/**
732 * padata_stop - stop the parallel processing
733 *
734 * @pinst: padata instance to stop
735 */
736void padata_stop(struct padata_instance *pinst)
737{
738 mutex_lock(&pinst->lock);
739 __padata_stop(pinst);
740 mutex_unlock(&pinst->lock);
741}
742EXPORT_SYMBOL(padata_stop);
743
744#ifdef CONFIG_HOTPLUG_CPU
745
746static int __padata_add_cpu(struct padata_instance *pinst, int cpu)
747{
748 struct parallel_data *pd;
749
750 if (cpumask_test_cpu(cpu, cpu_online_mask)) {
751 pd = padata_alloc_pd(pinst, pinst->cpumask.pcpu,
752 pinst->cpumask.cbcpu);
753 if (!pd)
754 return -ENOMEM;
755
756 padata_replace(pinst, pd);
757
758 if (padata_validate_cpumask(pinst, pinst->cpumask.pcpu) &&
759 padata_validate_cpumask(pinst, pinst->cpumask.cbcpu))
760 __padata_start(pinst);
761 }
762
763 return 0;
764}
765
766static int __padata_remove_cpu(struct padata_instance *pinst, int cpu)
767{
768 struct parallel_data *pd = NULL;
769
770 if (cpumask_test_cpu(cpu, cpu_online_mask)) {
771
772 if (!padata_validate_cpumask(pinst, pinst->cpumask.pcpu) ||
773 !padata_validate_cpumask(pinst, pinst->cpumask.cbcpu))
774 __padata_stop(pinst);
775
776 pd = padata_alloc_pd(pinst, pinst->cpumask.pcpu,
777 pinst->cpumask.cbcpu);
778 if (!pd)
779 return -ENOMEM;
780
781 padata_replace(pinst, pd);
782
783 cpumask_clear_cpu(cpu, pd->cpumask.cbcpu);
784 cpumask_clear_cpu(cpu, pd->cpumask.pcpu);
785 }
786
787 return 0;
788}
789
790 /**
791 * padata_remove_cpu - remove a cpu from the one or both(serial and parallel)
792 * padata cpumasks.
793 *
794 * @pinst: padata instance
795 * @cpu: cpu to remove
796 * @mask: bitmask specifying from which cpumask @cpu should be removed
797 * The @mask may be any combination of the following flags:
798 * PADATA_CPU_SERIAL - serial cpumask
799 * PADATA_CPU_PARALLEL - parallel cpumask
800 */
801int padata_remove_cpu(struct padata_instance *pinst, int cpu, int mask)
802{
803 int err;
804
805 if (!(mask & (PADATA_CPU_SERIAL | PADATA_CPU_PARALLEL)))
806 return -EINVAL;
807
808 mutex_lock(&pinst->lock);
809
810 get_online_cpus();
811 if (mask & PADATA_CPU_SERIAL)
812 cpumask_clear_cpu(cpu, pinst->cpumask.cbcpu);
813 if (mask & PADATA_CPU_PARALLEL)
814 cpumask_clear_cpu(cpu, pinst->cpumask.pcpu);
815
816 err = __padata_remove_cpu(pinst, cpu);
817 put_online_cpus();
818
819 mutex_unlock(&pinst->lock);
820
821 return err;
822}
823EXPORT_SYMBOL(padata_remove_cpu);
824
825static inline int pinst_has_cpu(struct padata_instance *pinst, int cpu)
826{
827 return cpumask_test_cpu(cpu, pinst->cpumask.pcpu) ||
828 cpumask_test_cpu(cpu, pinst->cpumask.cbcpu);
829}
830
831static int padata_cpu_online(unsigned int cpu, struct hlist_node *node)
832{
833 struct padata_instance *pinst;
834 int ret;
835
836 pinst = hlist_entry_safe(node, struct padata_instance, node);
837 if (!pinst_has_cpu(pinst, cpu))
838 return 0;
839
840 mutex_lock(&pinst->lock);
841 ret = __padata_add_cpu(pinst, cpu);
842 mutex_unlock(&pinst->lock);
843 return ret;
844}
845
846static int padata_cpu_prep_down(unsigned int cpu, struct hlist_node *node)
847{
848 struct padata_instance *pinst;
849 int ret;
850
851 pinst = hlist_entry_safe(node, struct padata_instance, node);
852 if (!pinst_has_cpu(pinst, cpu))
853 return 0;
854
855 mutex_lock(&pinst->lock);
856 ret = __padata_remove_cpu(pinst, cpu);
857 mutex_unlock(&pinst->lock);
858 return ret;
859}
860
861static enum cpuhp_state hp_online;
862#endif
863
864static void __padata_free(struct padata_instance *pinst)
865{
866#ifdef CONFIG_HOTPLUG_CPU
867 cpuhp_state_remove_instance_nocalls(hp_online, &pinst->node);
868#endif
869
870 padata_stop(pinst);
871 padata_free_pd(pinst->pd);
872 free_cpumask_var(pinst->cpumask.pcpu);
873 free_cpumask_var(pinst->cpumask.cbcpu);
874 kfree(pinst);
875}
876
877#define kobj2pinst(_kobj) \
878 container_of(_kobj, struct padata_instance, kobj)
879#define attr2pentry(_attr) \
880 container_of(_attr, struct padata_sysfs_entry, attr)
881
882static void padata_sysfs_release(struct kobject *kobj)
883{
884 struct padata_instance *pinst = kobj2pinst(kobj);
885 __padata_free(pinst);
886}
887
888struct padata_sysfs_entry {
889 struct attribute attr;
890 ssize_t (*show)(struct padata_instance *, struct attribute *, char *);
891 ssize_t (*store)(struct padata_instance *, struct attribute *,
892 const char *, size_t);
893};
894
895static ssize_t show_cpumask(struct padata_instance *pinst,
896 struct attribute *attr, char *buf)
897{
898 struct cpumask *cpumask;
899 ssize_t len;
900
901 mutex_lock(&pinst->lock);
902 if (!strcmp(attr->name, "serial_cpumask"))
903 cpumask = pinst->cpumask.cbcpu;
904 else
905 cpumask = pinst->cpumask.pcpu;
906
907 len = snprintf(buf, PAGE_SIZE, "%*pb\n",
908 nr_cpu_ids, cpumask_bits(cpumask));
909 mutex_unlock(&pinst->lock);
910 return len < PAGE_SIZE ? len : -EINVAL;
911}
912
913static ssize_t store_cpumask(struct padata_instance *pinst,
914 struct attribute *attr,
915 const char *buf, size_t count)
916{
917 cpumask_var_t new_cpumask;
918 ssize_t ret;
919 int mask_type;
920
921 if (!alloc_cpumask_var(&new_cpumask, GFP_KERNEL))
922 return -ENOMEM;
923
924 ret = bitmap_parse(buf, count, cpumask_bits(new_cpumask),
925 nr_cpumask_bits);
926 if (ret < 0)
927 goto out;
928
929 mask_type = !strcmp(attr->name, "serial_cpumask") ?
930 PADATA_CPU_SERIAL : PADATA_CPU_PARALLEL;
931 ret = padata_set_cpumask(pinst, mask_type, new_cpumask);
932 if (!ret)
933 ret = count;
934
935out:
936 free_cpumask_var(new_cpumask);
937 return ret;
938}
939
940#define PADATA_ATTR_RW(_name, _show_name, _store_name) \
941 static struct padata_sysfs_entry _name##_attr = \
942 __ATTR(_name, 0644, _show_name, _store_name)
943#define PADATA_ATTR_RO(_name, _show_name) \
944 static struct padata_sysfs_entry _name##_attr = \
945 __ATTR(_name, 0400, _show_name, NULL)
946
947PADATA_ATTR_RW(serial_cpumask, show_cpumask, store_cpumask);
948PADATA_ATTR_RW(parallel_cpumask, show_cpumask, store_cpumask);
949
950/*
951 * Padata sysfs provides the following objects:
952 * serial_cpumask [RW] - cpumask for serial workers
953 * parallel_cpumask [RW] - cpumask for parallel workers
954 */
955static struct attribute *padata_default_attrs[] = {
956 &serial_cpumask_attr.attr,
957 ¶llel_cpumask_attr.attr,
958 NULL,
959};
960
961static ssize_t padata_sysfs_show(struct kobject *kobj,
962 struct attribute *attr, char *buf)
963{
964 struct padata_instance *pinst;
965 struct padata_sysfs_entry *pentry;
966 ssize_t ret = -EIO;
967
968 pinst = kobj2pinst(kobj);
969 pentry = attr2pentry(attr);
970 if (pentry->show)
971 ret = pentry->show(pinst, attr, buf);
972
973 return ret;
974}
975
976static ssize_t padata_sysfs_store(struct kobject *kobj, struct attribute *attr,
977 const char *buf, size_t count)
978{
979 struct padata_instance *pinst;
980 struct padata_sysfs_entry *pentry;
981 ssize_t ret = -EIO;
982
983 pinst = kobj2pinst(kobj);
984 pentry = attr2pentry(attr);
985 if (pentry->show)
986 ret = pentry->store(pinst, attr, buf, count);
987
988 return ret;
989}
990
991static const struct sysfs_ops padata_sysfs_ops = {
992 .show = padata_sysfs_show,
993 .store = padata_sysfs_store,
994};
995
996static struct kobj_type padata_attr_type = {
997 .sysfs_ops = &padata_sysfs_ops,
998 .default_attrs = padata_default_attrs,
999 .release = padata_sysfs_release,
1000};
1001
1002/**
1003 * padata_alloc - allocate and initialize a padata instance and specify
1004 * cpumasks for serial and parallel workers.
1005 *
1006 * @wq: workqueue to use for the allocated padata instance
1007 * @pcpumask: cpumask that will be used for padata parallelization
1008 * @cbcpumask: cpumask that will be used for padata serialization
1009 *
1010 * Must be called from a cpus_read_lock() protected region
1011 */
1012static struct padata_instance *padata_alloc(struct workqueue_struct *wq,
1013 const struct cpumask *pcpumask,
1014 const struct cpumask *cbcpumask)
1015{
1016 struct padata_instance *pinst;
1017 struct parallel_data *pd = NULL;
1018
1019 pinst = kzalloc(sizeof(struct padata_instance), GFP_KERNEL);
1020 if (!pinst)
1021 goto err;
1022
1023 if (!alloc_cpumask_var(&pinst->cpumask.pcpu, GFP_KERNEL))
1024 goto err_free_inst;
1025 if (!alloc_cpumask_var(&pinst->cpumask.cbcpu, GFP_KERNEL)) {
1026 free_cpumask_var(pinst->cpumask.pcpu);
1027 goto err_free_inst;
1028 }
1029 if (!padata_validate_cpumask(pinst, pcpumask) ||
1030 !padata_validate_cpumask(pinst, cbcpumask))
1031 goto err_free_masks;
1032
1033 pd = padata_alloc_pd(pinst, pcpumask, cbcpumask);
1034 if (!pd)
1035 goto err_free_masks;
1036
1037 rcu_assign_pointer(pinst->pd, pd);
1038
1039 pinst->wq = wq;
1040
1041 cpumask_copy(pinst->cpumask.pcpu, pcpumask);
1042 cpumask_copy(pinst->cpumask.cbcpu, cbcpumask);
1043
1044 pinst->flags = 0;
1045
1046 BLOCKING_INIT_NOTIFIER_HEAD(&pinst->cpumask_change_notifier);
1047 kobject_init(&pinst->kobj, &padata_attr_type);
1048 mutex_init(&pinst->lock);
1049
1050#ifdef CONFIG_HOTPLUG_CPU
1051 cpuhp_state_add_instance_nocalls_cpuslocked(hp_online, &pinst->node);
1052#endif
1053 return pinst;
1054
1055err_free_masks:
1056 free_cpumask_var(pinst->cpumask.pcpu);
1057 free_cpumask_var(pinst->cpumask.cbcpu);
1058err_free_inst:
1059 kfree(pinst);
1060err:
1061 return NULL;
1062}
1063
1064/**
1065 * padata_alloc_possible - Allocate and initialize padata instance.
1066 * Use the cpu_possible_mask for serial and
1067 * parallel workers.
1068 *
1069 * @wq: workqueue to use for the allocated padata instance
1070 *
1071 * Must be called from a cpus_read_lock() protected region
1072 */
1073struct padata_instance *padata_alloc_possible(struct workqueue_struct *wq)
1074{
1075 lockdep_assert_cpus_held();
1076 return padata_alloc(wq, cpu_possible_mask, cpu_possible_mask);
1077}
1078EXPORT_SYMBOL(padata_alloc_possible);
1079
1080/**
1081 * padata_free - free a padata instance
1082 *
1083 * @padata_inst: padata instance to free
1084 */
1085void padata_free(struct padata_instance *pinst)
1086{
1087 kobject_put(&pinst->kobj);
1088}
1089EXPORT_SYMBOL(padata_free);
1090
1091#ifdef CONFIG_HOTPLUG_CPU
1092
1093static __init int padata_driver_init(void)
1094{
1095 int ret;
1096
1097 ret = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "padata:online",
1098 padata_cpu_online,
1099 padata_cpu_prep_down);
1100 if (ret < 0)
1101 return ret;
1102 hp_online = ret;
1103 return 0;
1104}
1105module_init(padata_driver_init);
1106
1107static __exit void padata_driver_exit(void)
1108{
1109 cpuhp_remove_multi_state(hp_online);
1110}
1111module_exit(padata_driver_exit);
1112#endif