Commit | Line | Data |
---|---|---|
16295bec SK |
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> | |
d46a5ac7 | 27 | #include <linux/timer.h> |
e15bacbe | 28 | #include <linux/notifier.h> |
5e017dc3 | 29 | #include <linux/kobject.h> |
e15bacbe DK |
30 | |
31 | #define PADATA_CPU_SERIAL 0x01 | |
32 | #define PADATA_CPU_PARALLEL 0x02 | |
16295bec | 33 | |
0198ffd1 SK |
34 | /** |
35 | * struct padata_priv - Embedded to the users data structure. | |
36 | * | |
37 | * @list: List entry, to attach to the padata lists. | |
38 | * @pd: Pointer to the internal control structure. | |
39 | * @cb_cpu: Callback cpu for serializatioon. | |
350ef88e | 40 | * @cpu: Cpu for parallelization. |
0198ffd1 SK |
41 | * @seq_nr: Sequence number of the parallelized data object. |
42 | * @info: Used to pass information from the parallel to the serial function. | |
43 | * @parallel: Parallel execution function. | |
44 | * @serial: Serial complete function. | |
45 | */ | |
16295bec SK |
46 | struct padata_priv { |
47 | struct list_head list; | |
48 | struct parallel_data *pd; | |
49 | int cb_cpu; | |
350ef88e | 50 | int cpu; |
16295bec SK |
51 | int info; |
52 | void (*parallel)(struct padata_priv *padata); | |
53 | void (*serial)(struct padata_priv *padata); | |
54 | }; | |
55 | ||
0198ffd1 SK |
56 | /** |
57 | * struct padata_list | |
58 | * | |
59 | * @list: List head. | |
60 | * @lock: List lock. | |
61 | */ | |
16295bec SK |
62 | struct padata_list { |
63 | struct list_head list; | |
64 | spinlock_t lock; | |
65 | }; | |
66 | ||
0198ffd1 | 67 | /** |
e15bacbe DK |
68 | * struct padata_serial_queue - The percpu padata serial queue |
69 | * | |
70 | * @serial: List to wait for serialization after reordering. | |
71 | * @work: work struct for serialization. | |
72 | * @pd: Backpointer to the internal control structure. | |
73 | */ | |
74 | struct padata_serial_queue { | |
75 | struct padata_list serial; | |
76 | struct work_struct work; | |
77 | struct parallel_data *pd; | |
78 | }; | |
79 | ||
80 | /** | |
81 | * struct padata_parallel_queue - The percpu padata parallel queue | |
0198ffd1 SK |
82 | * |
83 | * @parallel: List to wait for parallelization. | |
84 | * @reorder: List to wait for reordering after parallel processing. | |
85 | * @serial: List to wait for serialization after reordering. | |
86 | * @pwork: work struct for parallelization. | |
87 | * @swork: work struct for serialization. | |
88 | * @pd: Backpointer to the internal control structure. | |
e15bacbe | 89 | * @work: work struct for parallelization. |
cf5868c8 | 90 | * @reorder_work: work struct for reordering. |
e15bacbe | 91 | * @num_obj: Number of objects that are processed by this cpu. |
0198ffd1 SK |
92 | * @cpu_index: Index of the cpu. |
93 | */ | |
e15bacbe DK |
94 | struct padata_parallel_queue { |
95 | struct padata_list parallel; | |
96 | struct padata_list reorder; | |
97 | struct parallel_data *pd; | |
98 | struct work_struct work; | |
cf5868c8 | 99 | struct work_struct reorder_work; |
e15bacbe DK |
100 | atomic_t num_obj; |
101 | int cpu_index; | |
16295bec SK |
102 | }; |
103 | ||
c635696c SK |
104 | /** |
105 | * struct padata_cpumask - The cpumasks for the parallel/serial workers | |
106 | * | |
107 | * @pcpu: cpumask for the parallel workers. | |
108 | * @cbcpu: cpumask for the serial (callback) workers. | |
109 | */ | |
110 | struct padata_cpumask { | |
111 | cpumask_var_t pcpu; | |
112 | cpumask_var_t cbcpu; | |
113 | }; | |
e15bacbe | 114 | |
0198ffd1 SK |
115 | /** |
116 | * struct parallel_data - Internal control structure, covers everything | |
117 | * that depends on the cpumask in use. | |
118 | * | |
119 | * @pinst: padata instance. | |
e15bacbe DK |
120 | * @pqueue: percpu padata queues used for parallelization. |
121 | * @squeue: percpu padata queues used for serialuzation. | |
0198ffd1 SK |
122 | * @reorder_objects: Number of objects waiting in the reorder queues. |
123 | * @refcnt: Number of objects holding a reference on this parallel_data. | |
124 | * @max_seq_nr: Maximal used sequence number. | |
c635696c | 125 | * @cpumask: The cpumasks in use for parallel and serial workers. |
0198ffd1 | 126 | * @lock: Reorder lock. |
5f1a8c1b | 127 | * @processed: Number of already processed objects. |
0198ffd1 SK |
128 | * @timer: Reorder timer. |
129 | */ | |
16295bec | 130 | struct parallel_data { |
e15bacbe | 131 | struct padata_instance *pinst; |
57a2ce5f NK |
132 | struct padata_parallel_queue __percpu *pqueue; |
133 | struct padata_serial_queue __percpu *squeue; | |
c635696c SK |
134 | atomic_t reorder_objects; |
135 | atomic_t refcnt; | |
0b6b098e | 136 | atomic_t seq_nr; |
c635696c SK |
137 | struct padata_cpumask cpumask; |
138 | spinlock_t lock ____cacheline_aligned; | |
139 | unsigned int processed; | |
140 | struct timer_list timer; | |
16295bec SK |
141 | }; |
142 | ||
0198ffd1 SK |
143 | /** |
144 | * struct padata_instance - The overall control structure. | |
145 | * | |
146 | * @cpu_notifier: cpu hotplug notifier. | |
147 | * @wq: The workqueue in use. | |
148 | * @pd: The internal control structure. | |
c635696c | 149 | * @cpumask: User supplied cpumasks for parallel and serial works. |
e15bacbe DK |
150 | * @cpumask_change_notifier: Notifiers chain for user-defined notify |
151 | * callbacks that will be called when either @pcpu or @cbcpu | |
5e017dc3 DK |
152 | * or both cpumasks change. |
153 | * @kobj: padata instance kernel object. | |
0198ffd1 SK |
154 | * @lock: padata instance lock. |
155 | * @flags: padata flags. | |
156 | */ | |
16295bec | 157 | struct padata_instance { |
30e92153 | 158 | struct hlist_node node; |
e15bacbe DK |
159 | struct workqueue_struct *wq; |
160 | struct parallel_data *pd; | |
c635696c | 161 | struct padata_cpumask cpumask; |
e15bacbe | 162 | struct blocking_notifier_head cpumask_change_notifier; |
5e017dc3 | 163 | struct kobject kobj; |
e15bacbe DK |
164 | struct mutex lock; |
165 | u8 flags; | |
166 | #define PADATA_INIT 1 | |
167 | #define PADATA_RESET 2 | |
168 | #define PADATA_INVALID 4 | |
16295bec SK |
169 | }; |
170 | ||
e6cc1170 SK |
171 | extern struct padata_instance *padata_alloc_possible( |
172 | struct workqueue_struct *wq); | |
16295bec SK |
173 | extern void padata_free(struct padata_instance *pinst); |
174 | extern int padata_do_parallel(struct padata_instance *pinst, | |
175 | struct padata_priv *padata, int cb_cpu); | |
176 | extern void padata_do_serial(struct padata_priv *padata); | |
e15bacbe | 177 | extern int padata_set_cpumask(struct padata_instance *pinst, int cpumask_type, |
16295bec | 178 | cpumask_var_t cpumask); |
4c879170 | 179 | extern int padata_start(struct padata_instance *pinst); |
16295bec | 180 | extern void padata_stop(struct padata_instance *pinst); |
e15bacbe DK |
181 | extern int padata_register_cpumask_notifier(struct padata_instance *pinst, |
182 | struct notifier_block *nblock); | |
183 | extern int padata_unregister_cpumask_notifier(struct padata_instance *pinst, | |
184 | struct notifier_block *nblock); | |
16295bec | 185 | #endif |