Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 1 | /* |
| 2 | * padata.h - header for the padata parallelization interface |
| 3 | * |
| 4 | * Copyright (C) 2008, 2009 secunet Security Networks AG |
| 5 | * Copyright (C) 2008, 2009 Steffen Klassert <steffen.klassert@secunet.com> |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or modify it |
| 8 | * under the terms and conditions of the GNU General Public License, |
| 9 | * version 2, as published by the Free Software Foundation. |
| 10 | * |
| 11 | * This program is distributed in the hope it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
| 14 | * more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License along with |
| 17 | * this program; if not, write to the Free Software Foundation, Inc., |
| 18 | * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. |
| 19 | */ |
| 20 | |
| 21 | #ifndef PADATA_H |
| 22 | #define PADATA_H |
| 23 | |
| 24 | #include <linux/workqueue.h> |
| 25 | #include <linux/spinlock.h> |
| 26 | #include <linux/list.h> |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 27 | #include <linux/notifier.h> |
Dan Kruchinin | 5e017dc | 2010-07-14 14:33:08 +0400 | [diff] [blame] | 28 | #include <linux/kobject.h> |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 29 | |
| 30 | #define PADATA_CPU_SERIAL 0x01 |
| 31 | #define PADATA_CPU_PARALLEL 0x02 |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 32 | |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 33 | /** |
| 34 | * struct padata_priv - Embedded to the users data structure. |
| 35 | * |
| 36 | * @list: List entry, to attach to the padata lists. |
| 37 | * @pd: Pointer to the internal control structure. |
| 38 | * @cb_cpu: Callback cpu for serializatioon. |
Mathias Krause | 6953f88c | 2017-09-08 20:57:11 +0200 | [diff] [blame] | 39 | * @cpu: Cpu for parallelization. |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 40 | * @seq_nr: Sequence number of the parallelized data object. |
| 41 | * @info: Used to pass information from the parallel to the serial function. |
| 42 | * @parallel: Parallel execution function. |
| 43 | * @serial: Serial complete function. |
| 44 | */ |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 45 | struct padata_priv { |
| 46 | struct list_head list; |
| 47 | struct parallel_data *pd; |
| 48 | int cb_cpu; |
Mathias Krause | 6953f88c | 2017-09-08 20:57:11 +0200 | [diff] [blame] | 49 | int cpu; |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 50 | int info; |
| 51 | void (*parallel)(struct padata_priv *padata); |
| 52 | void (*serial)(struct padata_priv *padata); |
| 53 | }; |
| 54 | |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 55 | /** |
| 56 | * struct padata_list |
| 57 | * |
| 58 | * @list: List head. |
| 59 | * @lock: List lock. |
| 60 | */ |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 61 | struct padata_list { |
| 62 | struct list_head list; |
| 63 | spinlock_t lock; |
| 64 | }; |
| 65 | |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 66 | /** |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 67 | * struct padata_serial_queue - The percpu padata serial queue |
| 68 | * |
| 69 | * @serial: List to wait for serialization after reordering. |
| 70 | * @work: work struct for serialization. |
| 71 | * @pd: Backpointer to the internal control structure. |
| 72 | */ |
| 73 | struct padata_serial_queue { |
| 74 | struct padata_list serial; |
| 75 | struct work_struct work; |
| 76 | struct parallel_data *pd; |
| 77 | }; |
| 78 | |
| 79 | /** |
| 80 | * struct padata_parallel_queue - The percpu padata parallel queue |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 81 | * |
| 82 | * @parallel: List to wait for parallelization. |
| 83 | * @reorder: List to wait for reordering after parallel processing. |
| 84 | * @serial: List to wait for serialization after reordering. |
| 85 | * @pwork: work struct for parallelization. |
| 86 | * @swork: work struct for serialization. |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 87 | * @work: work struct for parallelization. |
| 88 | * @num_obj: Number of objects that are processed by this cpu. |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 89 | * @cpu_index: Index of the cpu. |
| 90 | */ |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 91 | struct padata_parallel_queue { |
| 92 | struct padata_list parallel; |
| 93 | struct padata_list reorder; |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 94 | struct work_struct work; |
| 95 | atomic_t num_obj; |
| 96 | int cpu_index; |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 97 | }; |
| 98 | |
Steffen Klassert | c635696 | 2010-07-27 07:15:50 +0200 | [diff] [blame] | 99 | /** |
| 100 | * struct padata_cpumask - The cpumasks for the parallel/serial workers |
| 101 | * |
| 102 | * @pcpu: cpumask for the parallel workers. |
| 103 | * @cbcpu: cpumask for the serial (callback) workers. |
| 104 | */ |
| 105 | struct padata_cpumask { |
| 106 | cpumask_var_t pcpu; |
| 107 | cpumask_var_t cbcpu; |
| 108 | }; |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 109 | |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 110 | /** |
| 111 | * struct parallel_data - Internal control structure, covers everything |
| 112 | * that depends on the cpumask in use. |
| 113 | * |
| 114 | * @pinst: padata instance. |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 115 | * @pqueue: percpu padata queues used for parallelization. |
| 116 | * @squeue: percpu padata queues used for serialuzation. |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 117 | * @reorder_objects: Number of objects waiting in the reorder queues. |
| 118 | * @refcnt: Number of objects holding a reference on this parallel_data. |
| 119 | * @max_seq_nr: Maximal used sequence number. |
Herbert Xu | f501513 | 2020-05-21 16:48:45 -0400 | [diff] [blame] | 120 | * @cpu: Next CPU to be processed. |
Steffen Klassert | c635696 | 2010-07-27 07:15:50 +0200 | [diff] [blame] | 121 | * @cpumask: The cpumasks in use for parallel and serial workers. |
Herbert Xu | f501513 | 2020-05-21 16:48:45 -0400 | [diff] [blame] | 122 | * @reorder_work: work struct for reordering. |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 123 | * @lock: Reorder lock. |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 124 | */ |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 125 | struct parallel_data { |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 126 | struct padata_instance *pinst; |
Namhyung Kim | 57a2ce5 | 2010-09-03 19:09:46 +0800 | [diff] [blame] | 127 | struct padata_parallel_queue __percpu *pqueue; |
| 128 | struct padata_serial_queue __percpu *squeue; |
Steffen Klassert | c635696 | 2010-07-27 07:15:50 +0200 | [diff] [blame] | 129 | atomic_t reorder_objects; |
| 130 | atomic_t refcnt; |
Mathias Krause | 0b6b098 | 2013-10-25 12:14:15 +0200 | [diff] [blame] | 131 | atomic_t seq_nr; |
Herbert Xu | f501513 | 2020-05-21 16:48:45 -0400 | [diff] [blame] | 132 | int cpu; |
Steffen Klassert | c635696 | 2010-07-27 07:15:50 +0200 | [diff] [blame] | 133 | struct padata_cpumask cpumask; |
Herbert Xu | f501513 | 2020-05-21 16:48:45 -0400 | [diff] [blame] | 134 | struct work_struct reorder_work; |
Steffen Klassert | c635696 | 2010-07-27 07:15:50 +0200 | [diff] [blame] | 135 | spinlock_t lock ____cacheline_aligned; |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 136 | }; |
| 137 | |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 138 | /** |
| 139 | * struct padata_instance - The overall control structure. |
| 140 | * |
| 141 | * @cpu_notifier: cpu hotplug notifier. |
| 142 | * @wq: The workqueue in use. |
| 143 | * @pd: The internal control structure. |
Steffen Klassert | c635696 | 2010-07-27 07:15:50 +0200 | [diff] [blame] | 144 | * @cpumask: User supplied cpumasks for parallel and serial works. |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 145 | * @cpumask_change_notifier: Notifiers chain for user-defined notify |
| 146 | * callbacks that will be called when either @pcpu or @cbcpu |
Dan Kruchinin | 5e017dc | 2010-07-14 14:33:08 +0400 | [diff] [blame] | 147 | * or both cpumasks change. |
| 148 | * @kobj: padata instance kernel object. |
Steffen Klassert | 0198ffd | 2010-05-19 13:44:27 +1000 | [diff] [blame] | 149 | * @lock: padata instance lock. |
| 150 | * @flags: padata flags. |
| 151 | */ |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 152 | struct padata_instance { |
Sebastian Andrzej Siewior | 30e9215 | 2016-09-06 19:04:49 +0200 | [diff] [blame] | 153 | struct hlist_node node; |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 154 | struct workqueue_struct *wq; |
| 155 | struct parallel_data *pd; |
Steffen Klassert | c635696 | 2010-07-27 07:15:50 +0200 | [diff] [blame] | 156 | struct padata_cpumask cpumask; |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 157 | struct blocking_notifier_head cpumask_change_notifier; |
Dan Kruchinin | 5e017dc | 2010-07-14 14:33:08 +0400 | [diff] [blame] | 158 | struct kobject kobj; |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 159 | struct mutex lock; |
| 160 | u8 flags; |
| 161 | #define PADATA_INIT 1 |
| 162 | #define PADATA_RESET 2 |
| 163 | #define PADATA_INVALID 4 |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 164 | }; |
| 165 | |
Steffen Klassert | e6cc117 | 2010-07-27 07:14:28 +0200 | [diff] [blame] | 166 | extern struct padata_instance *padata_alloc_possible( |
| 167 | struct workqueue_struct *wq); |
| 168 | extern struct padata_instance *padata_alloc(struct workqueue_struct *wq, |
| 169 | const struct cpumask *pcpumask, |
| 170 | const struct cpumask *cbcpumask); |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 171 | extern void padata_free(struct padata_instance *pinst); |
| 172 | extern int padata_do_parallel(struct padata_instance *pinst, |
| 173 | struct padata_priv *padata, int cb_cpu); |
| 174 | extern void padata_do_serial(struct padata_priv *padata); |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 175 | extern int padata_set_cpumask(struct padata_instance *pinst, int cpumask_type, |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 176 | cpumask_var_t cpumask); |
Steffen Klassert | 4c87917 | 2010-07-07 15:30:10 +0200 | [diff] [blame] | 177 | extern int padata_start(struct padata_instance *pinst); |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 178 | extern void padata_stop(struct padata_instance *pinst); |
Dan Kruchinin | e15bacb | 2010-07-14 14:31:57 +0400 | [diff] [blame] | 179 | extern int padata_register_cpumask_notifier(struct padata_instance *pinst, |
| 180 | struct notifier_block *nblock); |
| 181 | extern int padata_unregister_cpumask_notifier(struct padata_instance *pinst, |
| 182 | struct notifier_block *nblock); |
Steffen Klassert | 16295be | 2010-01-06 19:47:10 +1100 | [diff] [blame] | 183 | #endif |