Commit | Line | Data |
---|---|---|
d7e09d03 PT |
1 | /* |
2 | * GPL HEADER START | |
3 | * | |
4 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License version 2 only, | |
8 | * as published by the Free Software Foundation. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, but | |
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * General Public License version 2 for more details (a copy is included | |
14 | * in the LICENSE file that accompanied this code). | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * version 2 along with this program; If not, see | |
18 | * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf | |
19 | * | |
20 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, | |
21 | * CA 95054 USA or visit www.sun.com if you need additional information or | |
22 | * have any questions. | |
23 | * | |
24 | * GPL HEADER END | |
25 | */ | |
26 | /* | |
27 | * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved. | |
28 | * Use is subject to license terms. | |
29 | * | |
30 | * Copyright (c) 2011, 2012, Intel Corporation. | |
31 | */ | |
32 | /* | |
33 | * This file is part of Lustre, http://www.lustre.org/ | |
34 | * Lustre is a trademark of Sun Microsystems, Inc. | |
35 | */ | |
36 | ||
37 | #ifndef __LUSTRE_LU_OBJECT_H | |
38 | #define __LUSTRE_LU_OBJECT_H | |
39 | ||
40 | #include <stdarg.h> | |
9fdaf8c0 | 41 | #include "../../include/linux/libcfs/libcfs.h" |
1accaadf GKH |
42 | #include "lustre/lustre_idl.h" |
43 | #include "lu_ref.h" | |
d7e09d03 PT |
44 | |
45 | struct seq_file; | |
d7e09d03 PT |
46 | struct lustre_cfg; |
47 | struct lprocfs_stats; | |
48 | ||
49 | /** \defgroup lu lu | |
50 | * lu_* data-types represent server-side entities shared by data and meta-data | |
51 | * stacks. | |
52 | * | |
53 | * Design goals: | |
54 | * | |
55 | * -# support for layering. | |
56 | * | |
57 | * Server side object is split into layers, one per device in the | |
58 | * corresponding device stack. Individual layer is represented by struct | |
59 | * lu_object. Compound layered object --- by struct lu_object_header. Most | |
60 | * interface functions take lu_object as an argument and operate on the | |
61 | * whole compound object. This decision was made due to the following | |
62 | * reasons: | |
63 | * | |
64 | * - it's envisaged that lu_object will be used much more often than | |
65 | * lu_object_header; | |
66 | * | |
67 | * - we want lower (non-top) layers to be able to initiate operations | |
68 | * on the whole object. | |
69 | * | |
70 | * Generic code supports layering more complex than simple stacking, e.g., | |
71 | * it is possible that at some layer object "spawns" multiple sub-objects | |
72 | * on the lower layer. | |
73 | * | |
74 | * -# fid-based identification. | |
75 | * | |
76 | * Compound object is uniquely identified by its fid. Objects are indexed | |
77 | * by their fids (hash table is used for index). | |
78 | * | |
79 | * -# caching and life-cycle management. | |
80 | * | |
81 | * Object's life-time is controlled by reference counting. When reference | |
82 | * count drops to 0, object is returned to cache. Cached objects still | |
83 | * retain their identity (i.e., fid), and can be recovered from cache. | |
84 | * | |
85 | * Objects are kept in the global LRU list, and lu_site_purge() function | |
86 | * can be used to reclaim given number of unused objects from the tail of | |
87 | * the LRU. | |
88 | * | |
89 | * -# avoiding recursion. | |
90 | * | |
91 | * Generic code tries to replace recursion through layers by iterations | |
92 | * where possible. Additionally to the end of reducing stack consumption, | |
93 | * data, when practically possible, are allocated through lu_context_key | |
94 | * interface rather than on stack. | |
95 | * @{ | |
96 | */ | |
97 | ||
98 | struct lu_site; | |
99 | struct lu_object; | |
100 | struct lu_device; | |
101 | struct lu_object_header; | |
102 | struct lu_context; | |
103 | struct lu_env; | |
104 | ||
105 | /** | |
106 | * Operations common for data and meta-data devices. | |
107 | */ | |
108 | struct lu_device_operations { | |
109 | /** | |
110 | * Allocate object for the given device (without lower-layer | |
111 | * parts). This is called by lu_object_operations::loo_object_init() | |
112 | * from the parent layer, and should setup at least lu_object::lo_dev | |
113 | * and lu_object::lo_ops fields of resulting lu_object. | |
114 | * | |
115 | * Object creation protocol. | |
116 | * | |
117 | * Due to design goal of avoiding recursion, object creation (see | |
118 | * lu_object_alloc()) is somewhat involved: | |
119 | * | |
120 | * - first, lu_device_operations::ldo_object_alloc() method of the | |
121 | * top-level device in the stack is called. It should allocate top | |
122 | * level object (including lu_object_header), but without any | |
123 | * lower-layer sub-object(s). | |
124 | * | |
125 | * - then lu_object_alloc() sets fid in the header of newly created | |
126 | * object. | |
127 | * | |
128 | * - then lu_object_operations::loo_object_init() is called. It has | |
129 | * to allocate lower-layer object(s). To do this, | |
130 | * lu_object_operations::loo_object_init() calls ldo_object_alloc() | |
131 | * of the lower-layer device(s). | |
132 | * | |
133 | * - for all new objects allocated by | |
134 | * lu_object_operations::loo_object_init() (and inserted into object | |
135 | * stack), lu_object_operations::loo_object_init() is called again | |
136 | * repeatedly, until no new objects are created. | |
137 | * | |
138 | * \post ergo(!IS_ERR(result), result->lo_dev == d && | |
139 | * result->lo_ops != NULL); | |
140 | */ | |
141 | struct lu_object *(*ldo_object_alloc)(const struct lu_env *env, | |
142 | const struct lu_object_header *h, | |
143 | struct lu_device *d); | |
144 | /** | |
145 | * process config specific for device. | |
146 | */ | |
147 | int (*ldo_process_config)(const struct lu_env *env, | |
148 | struct lu_device *, struct lustre_cfg *); | |
149 | int (*ldo_recovery_complete)(const struct lu_env *, | |
150 | struct lu_device *); | |
151 | ||
152 | /** | |
153 | * initialize local objects for device. this method called after layer has | |
154 | * been initialized (after LCFG_SETUP stage) and before it starts serving | |
155 | * user requests. | |
156 | */ | |
157 | ||
158 | int (*ldo_prepare)(const struct lu_env *, | |
159 | struct lu_device *parent, | |
160 | struct lu_device *dev); | |
161 | ||
162 | }; | |
163 | ||
164 | /** | |
165 | * For lu_object_conf flags | |
166 | */ | |
167 | typedef enum { | |
168 | /* This is a new object to be allocated, or the file | |
169 | * corresponding to the object does not exists. */ | |
170 | LOC_F_NEW = 0x00000001, | |
171 | } loc_flags_t; | |
172 | ||
173 | /** | |
174 | * Object configuration, describing particulars of object being created. On | |
175 | * server this is not used, as server objects are full identified by fid. On | |
176 | * client configuration contains struct lustre_md. | |
177 | */ | |
178 | struct lu_object_conf { | |
179 | /** | |
180 | * Some hints for obj find and alloc. | |
181 | */ | |
182 | loc_flags_t loc_flags; | |
183 | }; | |
184 | ||
185 | /** | |
186 | * Type of "printer" function used by lu_object_operations::loo_object_print() | |
187 | * method. | |
188 | * | |
189 | * Printer function is needed to provide some flexibility in (semi-)debugging | |
190 | * output: possible implementations: printk, CDEBUG, sysfs/seq_file | |
191 | */ | |
192 | typedef int (*lu_printer_t)(const struct lu_env *env, | |
193 | void *cookie, const char *format, ...) | |
70837c12 | 194 | __printf(3, 4); |
d7e09d03 PT |
195 | |
196 | /** | |
197 | * Operations specific for particular lu_object. | |
198 | */ | |
199 | struct lu_object_operations { | |
200 | ||
201 | /** | |
202 | * Allocate lower-layer parts of the object by calling | |
203 | * lu_device_operations::ldo_object_alloc() of the corresponding | |
204 | * underlying device. | |
205 | * | |
206 | * This method is called once for each object inserted into object | |
207 | * stack. It's responsibility of this method to insert lower-layer | |
208 | * object(s) it create into appropriate places of object stack. | |
209 | */ | |
210 | int (*loo_object_init)(const struct lu_env *env, | |
211 | struct lu_object *o, | |
212 | const struct lu_object_conf *conf); | |
213 | /** | |
214 | * Called (in top-to-bottom order) during object allocation after all | |
215 | * layers were allocated and initialized. Can be used to perform | |
216 | * initialization depending on lower layers. | |
217 | */ | |
218 | int (*loo_object_start)(const struct lu_env *env, | |
219 | struct lu_object *o); | |
220 | /** | |
221 | * Called before lu_object_operations::loo_object_free() to signal | |
222 | * that object is being destroyed. Dual to | |
223 | * lu_object_operations::loo_object_init(). | |
224 | */ | |
225 | void (*loo_object_delete)(const struct lu_env *env, | |
226 | struct lu_object *o); | |
227 | /** | |
228 | * Dual to lu_device_operations::ldo_object_alloc(). Called when | |
229 | * object is removed from memory. | |
230 | */ | |
231 | void (*loo_object_free)(const struct lu_env *env, | |
232 | struct lu_object *o); | |
233 | /** | |
234 | * Called when last active reference to the object is released (and | |
235 | * object returns to the cache). This method is optional. | |
236 | */ | |
237 | void (*loo_object_release)(const struct lu_env *env, | |
238 | struct lu_object *o); | |
239 | /** | |
240 | * Optional debugging helper. Print given object. | |
241 | */ | |
242 | int (*loo_object_print)(const struct lu_env *env, void *cookie, | |
243 | lu_printer_t p, const struct lu_object *o); | |
244 | /** | |
245 | * Optional debugging method. Returns true iff method is internally | |
246 | * consistent. | |
247 | */ | |
248 | int (*loo_object_invariant)(const struct lu_object *o); | |
249 | }; | |
250 | ||
251 | /** | |
252 | * Type of lu_device. | |
253 | */ | |
254 | struct lu_device_type; | |
255 | ||
256 | /** | |
257 | * Device: a layer in the server side abstraction stacking. | |
258 | */ | |
259 | struct lu_device { | |
260 | /** | |
261 | * reference count. This is incremented, in particular, on each object | |
262 | * created at this layer. | |
263 | * | |
264 | * \todo XXX which means that atomic_t is probably too small. | |
265 | */ | |
266 | atomic_t ld_ref; | |
267 | /** | |
268 | * Pointer to device type. Never modified once set. | |
269 | */ | |
270 | struct lu_device_type *ld_type; | |
271 | /** | |
272 | * Operation vector for this device. | |
273 | */ | |
274 | const struct lu_device_operations *ld_ops; | |
275 | /** | |
276 | * Stack this device belongs to. | |
277 | */ | |
278 | struct lu_site *ld_site; | |
d7e09d03 PT |
279 | |
280 | /** \todo XXX: temporary back pointer into obd. */ | |
281 | struct obd_device *ld_obd; | |
282 | /** | |
283 | * A list of references to this object, for debugging. | |
284 | */ | |
285 | struct lu_ref ld_reference; | |
286 | /** | |
287 | * Link the device to the site. | |
288 | **/ | |
289 | struct list_head ld_linkage; | |
290 | }; | |
291 | ||
292 | struct lu_device_type_operations; | |
293 | ||
294 | /** | |
295 | * Tag bits for device type. They are used to distinguish certain groups of | |
296 | * device types. | |
297 | */ | |
298 | enum lu_device_tag { | |
299 | /** this is meta-data device */ | |
300 | LU_DEVICE_MD = (1 << 0), | |
301 | /** this is data device */ | |
302 | LU_DEVICE_DT = (1 << 1), | |
303 | /** data device in the client stack */ | |
304 | LU_DEVICE_CL = (1 << 2) | |
305 | }; | |
306 | ||
307 | /** | |
308 | * Type of device. | |
309 | */ | |
310 | struct lu_device_type { | |
311 | /** | |
312 | * Tag bits. Taken from enum lu_device_tag. Never modified once set. | |
313 | */ | |
314 | __u32 ldt_tags; | |
315 | /** | |
316 | * Name of this class. Unique system-wide. Never modified once set. | |
317 | */ | |
318 | char *ldt_name; | |
319 | /** | |
320 | * Operations for this type. | |
321 | */ | |
322 | const struct lu_device_type_operations *ldt_ops; | |
323 | /** | |
324 | * \todo XXX: temporary pointer to associated obd_type. | |
325 | */ | |
326 | struct obd_type *ldt_obd_type; | |
327 | /** | |
328 | * \todo XXX: temporary: context tags used by obd_*() calls. | |
329 | */ | |
330 | __u32 ldt_ctx_tags; | |
331 | /** | |
332 | * Number of existing device type instances. | |
333 | */ | |
334 | unsigned ldt_device_nr; | |
335 | /** | |
336 | * Linkage into a global list of all device types. | |
337 | * | |
338 | * \see lu_device_types. | |
339 | */ | |
340 | struct list_head ldt_linkage; | |
341 | }; | |
342 | ||
343 | /** | |
344 | * Operations on a device type. | |
345 | */ | |
346 | struct lu_device_type_operations { | |
347 | /** | |
348 | * Allocate new device. | |
349 | */ | |
350 | struct lu_device *(*ldto_device_alloc)(const struct lu_env *env, | |
351 | struct lu_device_type *t, | |
352 | struct lustre_cfg *lcfg); | |
353 | /** | |
354 | * Free device. Dual to | |
355 | * lu_device_type_operations::ldto_device_alloc(). Returns pointer to | |
356 | * the next device in the stack. | |
357 | */ | |
358 | struct lu_device *(*ldto_device_free)(const struct lu_env *, | |
359 | struct lu_device *); | |
360 | ||
361 | /** | |
362 | * Initialize the devices after allocation | |
363 | */ | |
364 | int (*ldto_device_init)(const struct lu_env *env, | |
365 | struct lu_device *, const char *, | |
366 | struct lu_device *); | |
367 | /** | |
368 | * Finalize device. Dual to | |
369 | * lu_device_type_operations::ldto_device_init(). Returns pointer to | |
370 | * the next device in the stack. | |
371 | */ | |
372 | struct lu_device *(*ldto_device_fini)(const struct lu_env *env, | |
373 | struct lu_device *); | |
374 | /** | |
375 | * Initialize device type. This is called on module load. | |
376 | */ | |
377 | int (*ldto_init)(struct lu_device_type *t); | |
378 | /** | |
379 | * Finalize device type. Dual to | |
380 | * lu_device_type_operations::ldto_init(). Called on module unload. | |
381 | */ | |
382 | void (*ldto_fini)(struct lu_device_type *t); | |
383 | /** | |
384 | * Called when the first device is created. | |
385 | */ | |
386 | void (*ldto_start)(struct lu_device_type *t); | |
387 | /** | |
388 | * Called when number of devices drops to 0. | |
389 | */ | |
390 | void (*ldto_stop)(struct lu_device_type *t); | |
391 | }; | |
392 | ||
393 | static inline int lu_device_is_md(const struct lu_device *d) | |
394 | { | |
395 | return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_MD); | |
396 | } | |
397 | ||
d7e09d03 PT |
398 | /** |
399 | * Common object attributes. | |
400 | */ | |
401 | struct lu_attr { | |
402 | /** size in bytes */ | |
403 | __u64 la_size; | |
404 | /** modification time in seconds since Epoch */ | |
21aef7d9 | 405 | s64 la_mtime; |
d7e09d03 | 406 | /** access time in seconds since Epoch */ |
21aef7d9 | 407 | s64 la_atime; |
d7e09d03 | 408 | /** change time in seconds since Epoch */ |
21aef7d9 | 409 | s64 la_ctime; |
d7e09d03 PT |
410 | /** 512-byte blocks allocated to object */ |
411 | __u64 la_blocks; | |
412 | /** permission bits and file type */ | |
413 | __u32 la_mode; | |
414 | /** owner id */ | |
415 | __u32 la_uid; | |
416 | /** group id */ | |
417 | __u32 la_gid; | |
418 | /** object flags */ | |
419 | __u32 la_flags; | |
420 | /** number of persistent references to this object */ | |
421 | __u32 la_nlink; | |
422 | /** blk bits of the object*/ | |
423 | __u32 la_blkbits; | |
424 | /** blk size of the object*/ | |
425 | __u32 la_blksize; | |
426 | /** real device */ | |
427 | __u32 la_rdev; | |
428 | /** | |
429 | * valid bits | |
430 | * | |
431 | * \see enum la_valid | |
432 | */ | |
433 | __u64 la_valid; | |
434 | }; | |
435 | ||
436 | /** Bit-mask of valid attributes */ | |
437 | enum la_valid { | |
438 | LA_ATIME = 1 << 0, | |
439 | LA_MTIME = 1 << 1, | |
440 | LA_CTIME = 1 << 2, | |
441 | LA_SIZE = 1 << 3, | |
442 | LA_MODE = 1 << 4, | |
443 | LA_UID = 1 << 5, | |
444 | LA_GID = 1 << 6, | |
445 | LA_BLOCKS = 1 << 7, | |
446 | LA_TYPE = 1 << 8, | |
447 | LA_FLAGS = 1 << 9, | |
448 | LA_NLINK = 1 << 10, | |
449 | LA_RDEV = 1 << 11, | |
450 | LA_BLKSIZE = 1 << 12, | |
451 | LA_KILL_SUID = 1 << 13, | |
452 | LA_KILL_SGID = 1 << 14, | |
453 | }; | |
454 | ||
455 | /** | |
456 | * Layer in the layered object. | |
457 | */ | |
458 | struct lu_object { | |
459 | /** | |
460 | * Header for this object. | |
461 | */ | |
462 | struct lu_object_header *lo_header; | |
463 | /** | |
464 | * Device for this layer. | |
465 | */ | |
466 | struct lu_device *lo_dev; | |
467 | /** | |
468 | * Operations for this object. | |
469 | */ | |
470 | const struct lu_object_operations *lo_ops; | |
471 | /** | |
472 | * Linkage into list of all layers. | |
473 | */ | |
474 | struct list_head lo_linkage; | |
d7e09d03 PT |
475 | /** |
476 | * Link to the device, for debugging. | |
477 | */ | |
631abc6e | 478 | struct lu_ref_link lo_dev_ref; |
d7e09d03 PT |
479 | }; |
480 | ||
481 | enum lu_object_header_flags { | |
482 | /** | |
483 | * Don't keep this object in cache. Object will be destroyed as soon | |
484 | * as last reference to it is released. This flag cannot be cleared | |
485 | * once set. | |
486 | */ | |
487 | LU_OBJECT_HEARD_BANSHEE = 0, | |
488 | /** | |
489 | * Mark this object has already been taken out of cache. | |
490 | */ | |
491 | LU_OBJECT_UNHASHED = 1 | |
492 | }; | |
493 | ||
494 | enum lu_object_header_attr { | |
495 | LOHA_EXISTS = 1 << 0, | |
496 | LOHA_REMOTE = 1 << 1, | |
497 | /** | |
498 | * UNIX file type is stored in S_IFMT bits. | |
499 | */ | |
500 | LOHA_FT_START = 001 << 12, /**< S_IFIFO */ | |
501 | LOHA_FT_END = 017 << 12, /**< S_IFMT */ | |
502 | }; | |
503 | ||
504 | /** | |
505 | * "Compound" object, consisting of multiple layers. | |
506 | * | |
507 | * Compound object with given fid is unique with given lu_site. | |
508 | * | |
509 | * Note, that object does *not* necessary correspond to the real object in the | |
510 | * persistent storage: object is an anchor for locking and method calling, so | |
511 | * it is created for things like not-yet-existing child created by mkdir or | |
512 | * create calls. lu_object_operations::loo_exists() can be used to check | |
513 | * whether object is backed by persistent storage entity. | |
514 | */ | |
515 | struct lu_object_header { | |
a700f975 AD |
516 | /** |
517 | * Fid, uniquely identifying this object. | |
518 | */ | |
519 | struct lu_fid loh_fid; | |
d7e09d03 PT |
520 | /** |
521 | * Object flags from enum lu_object_header_flags. Set and checked | |
522 | * atomically. | |
523 | */ | |
524 | unsigned long loh_flags; | |
525 | /** | |
526 | * Object reference count. Protected by lu_site::ls_guard. | |
527 | */ | |
528 | atomic_t loh_ref; | |
d7e09d03 PT |
529 | /** |
530 | * Common object attributes, cached for efficiency. From enum | |
531 | * lu_object_header_attr. | |
532 | */ | |
533 | __u32 loh_attr; | |
534 | /** | |
535 | * Linkage into per-site hash table. Protected by lu_site::ls_guard. | |
536 | */ | |
537 | struct hlist_node loh_hash; | |
538 | /** | |
539 | * Linkage into per-site LRU list. Protected by lu_site::ls_guard. | |
540 | */ | |
541 | struct list_head loh_lru; | |
542 | /** | |
543 | * Linkage into list of layers. Never modified once set (except lately | |
544 | * during object destruction). No locking is necessary. | |
545 | */ | |
546 | struct list_head loh_layers; | |
547 | /** | |
548 | * A list of references to this object, for debugging. | |
549 | */ | |
550 | struct lu_ref loh_reference; | |
551 | }; | |
552 | ||
553 | struct fld; | |
554 | ||
555 | struct lu_site_bkt_data { | |
556 | /** | |
6e580ab5 | 557 | * number of object in this bucket on the lsb_lru list. |
d7e09d03 | 558 | */ |
6e580ab5 | 559 | long lsb_lru_len; |
d7e09d03 PT |
560 | /** |
561 | * LRU list, updated on each access to object. Protected by | |
562 | * bucket lock of lu_site::ls_obj_hash. | |
563 | * | |
564 | * "Cold" end of LRU is lu_site::ls_lru.next. Accessed object are | |
565 | * moved to the lu_site::ls_lru.prev (this is due to the non-existence | |
566 | * of list_for_each_entry_safe_reverse()). | |
567 | */ | |
568 | struct list_head lsb_lru; | |
569 | /** | |
570 | * Wait-queue signaled when an object in this site is ultimately | |
571 | * destroyed (lu_object_free()). It is used by lu_object_find() to | |
572 | * wait before re-trying when object in the process of destruction is | |
573 | * found in the hash table. | |
574 | * | |
575 | * \see htable_lookup(). | |
576 | */ | |
577 | wait_queue_head_t lsb_marche_funebre; | |
578 | }; | |
579 | ||
580 | enum { | |
581 | LU_SS_CREATED = 0, | |
582 | LU_SS_CACHE_HIT, | |
583 | LU_SS_CACHE_MISS, | |
584 | LU_SS_CACHE_RACE, | |
585 | LU_SS_CACHE_DEATH_RACE, | |
586 | LU_SS_LRU_PURGED, | |
587 | LU_SS_LAST_STAT | |
588 | }; | |
589 | ||
590 | /** | |
591 | * lu_site is a "compartment" within which objects are unique, and LRU | |
592 | * discipline is maintained. | |
593 | * | |
594 | * lu_site exists so that multiple layered stacks can co-exist in the same | |
595 | * address space. | |
596 | * | |
597 | * lu_site has the same relation to lu_device as lu_object_header to | |
598 | * lu_object. | |
599 | */ | |
600 | struct lu_site { | |
601 | /** | |
602 | * objects hash table | |
603 | */ | |
6da6eabe | 604 | struct cfs_hash *ls_obj_hash; |
d7e09d03 PT |
605 | /** |
606 | * index of bucket on hash table while purging | |
607 | */ | |
608 | int ls_purge_start; | |
609 | /** | |
610 | * Top-level device for this stack. | |
611 | */ | |
612 | struct lu_device *ls_top_dev; | |
613 | /** | |
614 | * Bottom-level device for this stack | |
615 | */ | |
616 | struct lu_device *ls_bottom_dev; | |
617 | /** | |
618 | * Linkage into global list of sites. | |
619 | */ | |
620 | struct list_head ls_linkage; | |
621 | /** | |
622 | * List for lu device for this site, protected | |
623 | * by ls_ld_lock. | |
624 | **/ | |
625 | struct list_head ls_ld_linkage; | |
626 | spinlock_t ls_ld_lock; | |
627 | ||
628 | /** | |
629 | * lu_site stats | |
630 | */ | |
631 | struct lprocfs_stats *ls_stats; | |
632 | /** | |
633 | * XXX: a hack! fld has to find md_site via site, remove when possible | |
634 | */ | |
635 | struct seq_server_site *ld_seq_site; | |
636 | }; | |
637 | ||
638 | static inline struct lu_site_bkt_data * | |
639 | lu_site_bkt_from_fid(struct lu_site *site, struct lu_fid *fid) | |
640 | { | |
6ea510c1 | 641 | struct cfs_hash_bd bd; |
d7e09d03 PT |
642 | |
643 | cfs_hash_bd_get(site->ls_obj_hash, fid, &bd); | |
644 | return cfs_hash_bd_extra_get(site->ls_obj_hash, &bd); | |
645 | } | |
646 | ||
56f4c5a8 LX |
647 | static inline struct seq_server_site *lu_site2seq(const struct lu_site *s) |
648 | { | |
649 | return s->ld_seq_site; | |
650 | } | |
651 | ||
d7e09d03 PT |
652 | /** \name ctors |
653 | * Constructors/destructors. | |
654 | * @{ | |
655 | */ | |
656 | ||
657 | int lu_site_init (struct lu_site *s, struct lu_device *d); | |
658 | void lu_site_fini (struct lu_site *s); | |
659 | int lu_site_init_finish (struct lu_site *s); | |
660 | void lu_stack_fini (const struct lu_env *env, struct lu_device *top); | |
661 | void lu_device_get (struct lu_device *d); | |
662 | void lu_device_put (struct lu_device *d); | |
663 | int lu_device_init (struct lu_device *d, struct lu_device_type *t); | |
664 | void lu_device_fini (struct lu_device *d); | |
665 | int lu_object_header_init(struct lu_object_header *h); | |
666 | void lu_object_header_fini(struct lu_object_header *h); | |
667 | int lu_object_init (struct lu_object *o, | |
668 | struct lu_object_header *h, struct lu_device *d); | |
669 | void lu_object_fini (struct lu_object *o); | |
670 | void lu_object_add_top (struct lu_object_header *h, struct lu_object *o); | |
671 | void lu_object_add (struct lu_object *before, struct lu_object *o); | |
672 | ||
673 | void lu_dev_add_linkage(struct lu_site *s, struct lu_device *d); | |
674 | void lu_dev_del_linkage(struct lu_site *s, struct lu_device *d); | |
675 | ||
676 | /** | |
677 | * Helpers to initialize and finalize device types. | |
678 | */ | |
679 | ||
680 | int lu_device_type_init(struct lu_device_type *ldt); | |
681 | void lu_device_type_fini(struct lu_device_type *ldt); | |
682 | void lu_types_stop(void); | |
683 | ||
684 | /** @} ctors */ | |
685 | ||
686 | /** \name caching | |
687 | * Caching and reference counting. | |
688 | * @{ | |
689 | */ | |
690 | ||
691 | /** | |
692 | * Acquire additional reference to the given object. This function is used to | |
693 | * attain additional reference. To acquire initial reference use | |
694 | * lu_object_find(). | |
695 | */ | |
696 | static inline void lu_object_get(struct lu_object *o) | |
697 | { | |
698 | LASSERT(atomic_read(&o->lo_header->loh_ref) > 0); | |
699 | atomic_inc(&o->lo_header->loh_ref); | |
700 | } | |
701 | ||
702 | /** | |
703 | * Return true of object will not be cached after last reference to it is | |
704 | * released. | |
705 | */ | |
706 | static inline int lu_object_is_dying(const struct lu_object_header *h) | |
707 | { | |
708 | return test_bit(LU_OBJECT_HEARD_BANSHEE, &h->loh_flags); | |
709 | } | |
710 | ||
711 | void lu_object_put(const struct lu_env *env, struct lu_object *o); | |
712 | void lu_object_put_nocache(const struct lu_env *env, struct lu_object *o); | |
713 | void lu_object_unhash(const struct lu_env *env, struct lu_object *o); | |
714 | ||
715 | int lu_site_purge(const struct lu_env *env, struct lu_site *s, int nr); | |
716 | ||
717 | void lu_site_print(const struct lu_env *env, struct lu_site *s, void *cookie, | |
718 | lu_printer_t printer); | |
719 | struct lu_object *lu_object_find(const struct lu_env *env, | |
720 | struct lu_device *dev, const struct lu_fid *f, | |
721 | const struct lu_object_conf *conf); | |
722 | struct lu_object *lu_object_find_at(const struct lu_env *env, | |
723 | struct lu_device *dev, | |
724 | const struct lu_fid *f, | |
725 | const struct lu_object_conf *conf); | |
726 | struct lu_object *lu_object_find_slice(const struct lu_env *env, | |
727 | struct lu_device *dev, | |
728 | const struct lu_fid *f, | |
729 | const struct lu_object_conf *conf); | |
730 | /** @} caching */ | |
731 | ||
732 | /** \name helpers | |
733 | * Helpers. | |
734 | * @{ | |
735 | */ | |
736 | ||
737 | /** | |
738 | * First (topmost) sub-object of given compound object | |
739 | */ | |
740 | static inline struct lu_object *lu_object_top(struct lu_object_header *h) | |
741 | { | |
742 | LASSERT(!list_empty(&h->loh_layers)); | |
743 | return container_of0(h->loh_layers.next, struct lu_object, lo_linkage); | |
744 | } | |
745 | ||
746 | /** | |
747 | * Next sub-object in the layering | |
748 | */ | |
749 | static inline struct lu_object *lu_object_next(const struct lu_object *o) | |
750 | { | |
751 | return container_of0(o->lo_linkage.next, struct lu_object, lo_linkage); | |
752 | } | |
753 | ||
754 | /** | |
755 | * Pointer to the fid of this object. | |
756 | */ | |
757 | static inline const struct lu_fid *lu_object_fid(const struct lu_object *o) | |
758 | { | |
759 | return &o->lo_header->loh_fid; | |
760 | } | |
761 | ||
762 | /** | |
763 | * return device operations vector for this object | |
764 | */ | |
765 | static const inline struct lu_device_operations * | |
766 | lu_object_ops(const struct lu_object *o) | |
767 | { | |
768 | return o->lo_dev->ld_ops; | |
769 | } | |
770 | ||
771 | /** | |
772 | * Given a compound object, find its slice, corresponding to the device type | |
773 | * \a dtype. | |
774 | */ | |
775 | struct lu_object *lu_object_locate(struct lu_object_header *h, | |
776 | const struct lu_device_type *dtype); | |
777 | ||
778 | /** | |
779 | * Printer function emitting messages through libcfs_debug_msg(). | |
780 | */ | |
781 | int lu_cdebug_printer(const struct lu_env *env, | |
782 | void *cookie, const char *format, ...); | |
783 | ||
784 | /** | |
785 | * Print object description followed by a user-supplied message. | |
786 | */ | |
787 | #define LU_OBJECT_DEBUG(mask, env, object, format, ...) \ | |
788 | do { \ | |
789 | LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL); \ | |
790 | \ | |
791 | if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \ | |
792 | lu_object_print(env, &msgdata, lu_cdebug_printer, object);\ | |
b2952d62 | 793 | CDEBUG(mask, format, ## __VA_ARGS__); \ |
d7e09d03 PT |
794 | } \ |
795 | } while (0) | |
796 | ||
797 | /** | |
798 | * Print short object description followed by a user-supplied message. | |
799 | */ | |
800 | #define LU_OBJECT_HEADER(mask, env, object, format, ...) \ | |
801 | do { \ | |
802 | LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL); \ | |
803 | \ | |
804 | if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) { \ | |
805 | lu_object_header_print(env, &msgdata, lu_cdebug_printer,\ | |
806 | (object)->lo_header); \ | |
807 | lu_cdebug_printer(env, &msgdata, "\n"); \ | |
b2952d62 | 808 | CDEBUG(mask, format, ## __VA_ARGS__); \ |
d7e09d03 PT |
809 | } \ |
810 | } while (0) | |
811 | ||
812 | void lu_object_print (const struct lu_env *env, void *cookie, | |
813 | lu_printer_t printer, const struct lu_object *o); | |
814 | void lu_object_header_print(const struct lu_env *env, void *cookie, | |
815 | lu_printer_t printer, | |
816 | const struct lu_object_header *hdr); | |
817 | ||
818 | /** | |
819 | * Check object consistency. | |
820 | */ | |
821 | int lu_object_invariant(const struct lu_object *o); | |
822 | ||
823 | ||
824 | /** | |
825 | * Check whether object exists, no matter on local or remote storage. | |
826 | * Note: LOHA_EXISTS will be set once some one created the object, | |
827 | * and it does not needs to be committed to storage. | |
828 | */ | |
829 | #define lu_object_exists(o) ((o)->lo_header->loh_attr & LOHA_EXISTS) | |
830 | ||
831 | /** | |
832 | * Check whether object on the remote storage. | |
833 | */ | |
834 | #define lu_object_remote(o) unlikely((o)->lo_header->loh_attr & LOHA_REMOTE) | |
835 | ||
836 | static inline int lu_object_assert_exists(const struct lu_object *o) | |
837 | { | |
838 | return lu_object_exists(o); | |
839 | } | |
840 | ||
841 | static inline int lu_object_assert_not_exists(const struct lu_object *o) | |
842 | { | |
843 | return !lu_object_exists(o); | |
844 | } | |
845 | ||
846 | /** | |
847 | * Attr of this object. | |
848 | */ | |
849 | static inline __u32 lu_object_attr(const struct lu_object *o) | |
850 | { | |
851 | LASSERT(lu_object_exists(o) != 0); | |
852 | return o->lo_header->loh_attr; | |
853 | } | |
854 | ||
631abc6e JH |
855 | static inline void lu_object_ref_add(struct lu_object *o, |
856 | const char *scope, | |
857 | const void *source) | |
d7e09d03 | 858 | { |
631abc6e JH |
859 | lu_ref_add(&o->lo_header->loh_reference, scope, source); |
860 | } | |
861 | ||
862 | static inline void lu_object_ref_add_at(struct lu_object *o, | |
863 | struct lu_ref_link *link, | |
864 | const char *scope, | |
865 | const void *source) | |
866 | { | |
867 | lu_ref_add_at(&o->lo_header->loh_reference, link, scope, source); | |
d7e09d03 PT |
868 | } |
869 | ||
870 | static inline void lu_object_ref_del(struct lu_object *o, | |
871 | const char *scope, const void *source) | |
872 | { | |
873 | lu_ref_del(&o->lo_header->loh_reference, scope, source); | |
874 | } | |
875 | ||
876 | static inline void lu_object_ref_del_at(struct lu_object *o, | |
877 | struct lu_ref_link *link, | |
878 | const char *scope, const void *source) | |
879 | { | |
880 | lu_ref_del_at(&o->lo_header->loh_reference, link, scope, source); | |
881 | } | |
882 | ||
883 | /** input params, should be filled out by mdt */ | |
884 | struct lu_rdpg { | |
885 | /** hash */ | |
886 | __u64 rp_hash; | |
887 | /** count in bytes */ | |
888 | unsigned int rp_count; | |
889 | /** number of pages */ | |
890 | unsigned int rp_npages; | |
891 | /** requested attr */ | |
892 | __u32 rp_attrs; | |
893 | /** pointers to pages */ | |
894 | struct page **rp_pages; | |
895 | }; | |
896 | ||
897 | enum lu_xattr_flags { | |
898 | LU_XATTR_REPLACE = (1 << 0), | |
899 | LU_XATTR_CREATE = (1 << 1) | |
900 | }; | |
901 | ||
902 | /** @} helpers */ | |
903 | ||
904 | /** \name lu_context | |
905 | * @{ */ | |
906 | ||
907 | /** For lu_context health-checks */ | |
908 | enum lu_context_state { | |
909 | LCS_INITIALIZED = 1, | |
910 | LCS_ENTERED, | |
911 | LCS_LEFT, | |
912 | LCS_FINALIZED | |
913 | }; | |
914 | ||
915 | /** | |
916 | * lu_context. Execution context for lu_object methods. Currently associated | |
917 | * with thread. | |
918 | * | |
919 | * All lu_object methods, except device and device type methods (called during | |
920 | * system initialization and shutdown) are executed "within" some | |
921 | * lu_context. This means, that pointer to some "current" lu_context is passed | |
922 | * as an argument to all methods. | |
923 | * | |
924 | * All service ptlrpc threads create lu_context as part of their | |
925 | * initialization. It is possible to create "stand-alone" context for other | |
926 | * execution environments (like system calls). | |
927 | * | |
928 | * lu_object methods mainly use lu_context through lu_context_key interface | |
929 | * that allows each layer to associate arbitrary pieces of data with each | |
930 | * context (see pthread_key_create(3) for similar interface). | |
931 | * | |
932 | * On a client, lu_context is bound to a thread, see cl_env_get(). | |
933 | * | |
934 | * \see lu_context_key | |
935 | */ | |
936 | struct lu_context { | |
937 | /** | |
938 | * lu_context is used on the client side too. Yet we don't want to | |
939 | * allocate values of server-side keys for the client contexts and | |
940 | * vice versa. | |
941 | * | |
942 | * To achieve this, set of tags in introduced. Contexts and keys are | |
943 | * marked with tags. Key value are created only for context whose set | |
944 | * of tags has non-empty intersection with one for key. Tags are taken | |
945 | * from enum lu_context_tag. | |
946 | */ | |
947 | __u32 lc_tags; | |
948 | enum lu_context_state lc_state; | |
949 | /** | |
950 | * Pointer to the home service thread. NULL for other execution | |
951 | * contexts. | |
952 | */ | |
953 | struct ptlrpc_thread *lc_thread; | |
954 | /** | |
955 | * Pointer to an array with key values. Internal implementation | |
956 | * detail. | |
957 | */ | |
958 | void **lc_value; | |
959 | /** | |
960 | * Linkage into a list of all remembered contexts. Only | |
961 | * `non-transient' contexts, i.e., ones created for service threads | |
962 | * are placed here. | |
963 | */ | |
964 | struct list_head lc_remember; | |
965 | /** | |
966 | * Version counter used to skip calls to lu_context_refill() when no | |
967 | * keys were registered. | |
968 | */ | |
969 | unsigned lc_version; | |
970 | /** | |
971 | * Debugging cookie. | |
972 | */ | |
973 | unsigned lc_cookie; | |
974 | }; | |
975 | ||
976 | /** | |
977 | * lu_context_key interface. Similar to pthread_key. | |
978 | */ | |
979 | ||
980 | enum lu_context_tag { | |
981 | /** | |
982 | * Thread on md server | |
983 | */ | |
984 | LCT_MD_THREAD = 1 << 0, | |
985 | /** | |
986 | * Thread on dt server | |
987 | */ | |
988 | LCT_DT_THREAD = 1 << 1, | |
989 | /** | |
990 | * Context for transaction handle | |
991 | */ | |
992 | LCT_TX_HANDLE = 1 << 2, | |
993 | /** | |
994 | * Thread on client | |
995 | */ | |
996 | LCT_CL_THREAD = 1 << 3, | |
997 | /** | |
998 | * A per-request session on a server, and a per-system-call session on | |
999 | * a client. | |
1000 | */ | |
1001 | LCT_SESSION = 1 << 4, | |
1002 | /** | |
1003 | * A per-request data on OSP device | |
1004 | */ | |
1005 | LCT_OSP_THREAD = 1 << 5, | |
1006 | /** | |
1007 | * MGS device thread | |
1008 | */ | |
1009 | LCT_MG_THREAD = 1 << 6, | |
1010 | /** | |
1011 | * Context for local operations | |
1012 | */ | |
1013 | LCT_LOCAL = 1 << 7, | |
1014 | /** | |
1015 | * Set when at least one of keys, having values in this context has | |
1016 | * non-NULL lu_context_key::lct_exit() method. This is used to | |
1017 | * optimize lu_context_exit() call. | |
1018 | */ | |
1019 | LCT_HAS_EXIT = 1 << 28, | |
1020 | /** | |
1021 | * Don't add references for modules creating key values in that context. | |
1022 | * This is only for contexts used internally by lu_object framework. | |
1023 | */ | |
1024 | LCT_NOREF = 1 << 29, | |
1025 | /** | |
1026 | * Key is being prepared for retiring, don't create new values for it. | |
1027 | */ | |
1028 | LCT_QUIESCENT = 1 << 30, | |
1029 | /** | |
1030 | * Context should be remembered. | |
1031 | */ | |
1032 | LCT_REMEMBER = 1 << 31, | |
1033 | /** | |
1034 | * Contexts usable in cache shrinker thread. | |
1035 | */ | |
1036 | LCT_SHRINKER = LCT_MD_THREAD|LCT_DT_THREAD|LCT_CL_THREAD|LCT_NOREF | |
1037 | }; | |
1038 | ||
1039 | /** | |
1040 | * Key. Represents per-context value slot. | |
1041 | * | |
1042 | * Keys are usually registered when module owning the key is initialized, and | |
1043 | * de-registered when module is unloaded. Once key is registered, all new | |
1044 | * contexts with matching tags, will get key value. "Old" contexts, already | |
1045 | * initialized at the time of key registration, can be forced to get key value | |
1046 | * by calling lu_context_refill(). | |
1047 | * | |
1048 | * Every key value is counted in lu_context_key::lct_used and acquires a | |
1049 | * reference on an owning module. This means, that all key values have to be | |
1050 | * destroyed before module can be unloaded. This is usually achieved by | |
1051 | * stopping threads started by the module, that created contexts in their | |
1052 | * entry functions. Situation is complicated by the threads shared by multiple | |
1053 | * modules, like ptlrpcd daemon on a client. To work around this problem, | |
1054 | * contexts, created in such threads, are `remembered' (see | |
1055 | * LCT_REMEMBER)---i.e., added into a global list. When module is preparing | |
1056 | * for unloading it does the following: | |
1057 | * | |
1058 | * - marks its keys as `quiescent' (lu_context_tag::LCT_QUIESCENT) | |
1059 | * preventing new key values from being allocated in the new contexts, | |
1060 | * and | |
1061 | * | |
1062 | * - scans a list of remembered contexts, destroying values of module | |
1063 | * keys, thus releasing references to the module. | |
1064 | * | |
1065 | * This is done by lu_context_key_quiesce(). If module is re-activated | |
1066 | * before key has been de-registered, lu_context_key_revive() call clears | |
1067 | * `quiescent' marker. | |
1068 | * | |
1069 | * lu_context code doesn't provide any internal synchronization for these | |
1070 | * activities---it's assumed that startup (including threads start-up) and | |
1071 | * shutdown are serialized by some external means. | |
1072 | * | |
1073 | * \see lu_context | |
1074 | */ | |
1075 | struct lu_context_key { | |
1076 | /** | |
1077 | * Set of tags for which values of this key are to be instantiated. | |
1078 | */ | |
1079 | __u32 lct_tags; | |
1080 | /** | |
1081 | * Value constructor. This is called when new value is created for a | |
1082 | * context. Returns pointer to new value of error pointer. | |
1083 | */ | |
1084 | void *(*lct_init)(const struct lu_context *ctx, | |
1085 | struct lu_context_key *key); | |
1086 | /** | |
1087 | * Value destructor. Called when context with previously allocated | |
1088 | * value of this slot is destroyed. \a data is a value that was returned | |
1089 | * by a matching call to lu_context_key::lct_init(). | |
1090 | */ | |
1091 | void (*lct_fini)(const struct lu_context *ctx, | |
1092 | struct lu_context_key *key, void *data); | |
1093 | /** | |
1094 | * Optional method called on lu_context_exit() for all allocated | |
1095 | * keys. Can be used by debugging code checking that locks are | |
1096 | * released, etc. | |
1097 | */ | |
1098 | void (*lct_exit)(const struct lu_context *ctx, | |
1099 | struct lu_context_key *key, void *data); | |
1100 | /** | |
1101 | * Internal implementation detail: index within lu_context::lc_value[] | |
1102 | * reserved for this key. | |
1103 | */ | |
1104 | int lct_index; | |
1105 | /** | |
1106 | * Internal implementation detail: number of values created for this | |
1107 | * key. | |
1108 | */ | |
1109 | atomic_t lct_used; | |
1110 | /** | |
1111 | * Internal implementation detail: module for this key. | |
1112 | */ | |
c34d9cd8 | 1113 | struct module *lct_owner; |
d7e09d03 PT |
1114 | /** |
1115 | * References to this key. For debugging. | |
1116 | */ | |
1117 | struct lu_ref lct_reference; | |
1118 | }; | |
1119 | ||
1120 | #define LU_KEY_INIT(mod, type) \ | |
9c234f6c | 1121 | static void *mod##_key_init(const struct lu_context *ctx, \ |
d7e09d03 PT |
1122 | struct lu_context_key *key) \ |
1123 | { \ | |
1124 | type *value; \ | |
1125 | \ | |
1126 | CLASSERT(PAGE_CACHE_SIZE >= sizeof (*value)); \ | |
1127 | \ | |
1128 | OBD_ALLOC_PTR(value); \ | |
1129 | if (value == NULL) \ | |
1130 | value = ERR_PTR(-ENOMEM); \ | |
1131 | \ | |
1132 | return value; \ | |
1133 | } \ | |
b2952d62 | 1134 | struct __##mod##__dummy_init {; } /* semicolon catcher */ |
d7e09d03 PT |
1135 | |
1136 | #define LU_KEY_FINI(mod, type) \ | |
1137 | static void mod##_key_fini(const struct lu_context *ctx, \ | |
9c234f6c | 1138 | struct lu_context_key *key, void *data) \ |
d7e09d03 PT |
1139 | { \ |
1140 | type *info = data; \ | |
1141 | \ | |
1142 | OBD_FREE_PTR(info); \ | |
1143 | } \ | |
b2952d62 | 1144 | struct __##mod##__dummy_fini {; } /* semicolon catcher */ |
d7e09d03 PT |
1145 | |
1146 | #define LU_KEY_INIT_FINI(mod, type) \ | |
1d8cb70c GD |
1147 | LU_KEY_INIT(mod, type); \ |
1148 | LU_KEY_FINI(mod, type) | |
d7e09d03 PT |
1149 | |
1150 | #define LU_CONTEXT_KEY_DEFINE(mod, tags) \ | |
1151 | struct lu_context_key mod##_thread_key = { \ | |
1152 | .lct_tags = tags, \ | |
1153 | .lct_init = mod##_key_init, \ | |
1154 | .lct_fini = mod##_key_fini \ | |
1155 | } | |
1156 | ||
1157 | #define LU_CONTEXT_KEY_INIT(key) \ | |
1158 | do { \ | |
1159 | (key)->lct_owner = THIS_MODULE; \ | |
1160 | } while (0) | |
1161 | ||
1162 | int lu_context_key_register(struct lu_context_key *key); | |
1163 | void lu_context_key_degister(struct lu_context_key *key); | |
1164 | void *lu_context_key_get (const struct lu_context *ctx, | |
1165 | const struct lu_context_key *key); | |
1166 | void lu_context_key_quiesce (struct lu_context_key *key); | |
1167 | void lu_context_key_revive (struct lu_context_key *key); | |
1168 | ||
1169 | ||
1170 | /* | |
1171 | * LU_KEY_INIT_GENERIC() has to be a macro to correctly determine an | |
1172 | * owning module. | |
1173 | */ | |
1174 | ||
1175 | #define LU_KEY_INIT_GENERIC(mod) \ | |
1176 | static void mod##_key_init_generic(struct lu_context_key *k, ...) \ | |
1177 | { \ | |
1178 | struct lu_context_key *key = k; \ | |
1179 | va_list args; \ | |
1180 | \ | |
1181 | va_start(args, k); \ | |
1182 | do { \ | |
1183 | LU_CONTEXT_KEY_INIT(key); \ | |
1184 | key = va_arg(args, struct lu_context_key *); \ | |
1185 | } while (key != NULL); \ | |
1186 | va_end(args); \ | |
1187 | } | |
1188 | ||
1189 | #define LU_TYPE_INIT(mod, ...) \ | |
1190 | LU_KEY_INIT_GENERIC(mod) \ | |
1191 | static int mod##_type_init(struct lu_device_type *t) \ | |
1192 | { \ | |
1193 | mod##_key_init_generic(__VA_ARGS__, NULL); \ | |
1194 | return lu_context_key_register_many(__VA_ARGS__, NULL); \ | |
1195 | } \ | |
b2952d62 | 1196 | struct __##mod##_dummy_type_init {; } |
d7e09d03 PT |
1197 | |
1198 | #define LU_TYPE_FINI(mod, ...) \ | |
1199 | static void mod##_type_fini(struct lu_device_type *t) \ | |
1200 | { \ | |
1201 | lu_context_key_degister_many(__VA_ARGS__, NULL); \ | |
1202 | } \ | |
b2952d62 | 1203 | struct __##mod##_dummy_type_fini {; } |
d7e09d03 PT |
1204 | |
1205 | #define LU_TYPE_START(mod, ...) \ | |
1206 | static void mod##_type_start(struct lu_device_type *t) \ | |
1207 | { \ | |
1208 | lu_context_key_revive_many(__VA_ARGS__, NULL); \ | |
1209 | } \ | |
b2952d62 | 1210 | struct __##mod##_dummy_type_start {; } |
d7e09d03 PT |
1211 | |
1212 | #define LU_TYPE_STOP(mod, ...) \ | |
1213 | static void mod##_type_stop(struct lu_device_type *t) \ | |
1214 | { \ | |
1215 | lu_context_key_quiesce_many(__VA_ARGS__, NULL); \ | |
1216 | } \ | |
b2952d62 | 1217 | struct __##mod##_dummy_type_stop {; } |
d7e09d03 PT |
1218 | |
1219 | ||
1220 | ||
1221 | #define LU_TYPE_INIT_FINI(mod, ...) \ | |
1222 | LU_TYPE_INIT(mod, __VA_ARGS__); \ | |
1223 | LU_TYPE_FINI(mod, __VA_ARGS__); \ | |
1224 | LU_TYPE_START(mod, __VA_ARGS__); \ | |
1225 | LU_TYPE_STOP(mod, __VA_ARGS__) | |
1226 | ||
1227 | int lu_context_init (struct lu_context *ctx, __u32 tags); | |
1228 | void lu_context_fini (struct lu_context *ctx); | |
1229 | void lu_context_enter (struct lu_context *ctx); | |
1230 | void lu_context_exit (struct lu_context *ctx); | |
1231 | int lu_context_refill(struct lu_context *ctx); | |
1232 | ||
1233 | /* | |
1234 | * Helper functions to operate on multiple keys. These are used by the default | |
1235 | * device type operations, defined by LU_TYPE_INIT_FINI(). | |
1236 | */ | |
1237 | ||
1238 | int lu_context_key_register_many(struct lu_context_key *k, ...); | |
1239 | void lu_context_key_degister_many(struct lu_context_key *k, ...); | |
1240 | void lu_context_key_revive_many (struct lu_context_key *k, ...); | |
1241 | void lu_context_key_quiesce_many (struct lu_context_key *k, ...); | |
1242 | ||
1243 | /* | |
1244 | * update/clear ctx/ses tags. | |
1245 | */ | |
1246 | void lu_context_tags_update(__u32 tags); | |
1247 | void lu_context_tags_clear(__u32 tags); | |
1248 | void lu_session_tags_update(__u32 tags); | |
1249 | void lu_session_tags_clear(__u32 tags); | |
1250 | ||
1251 | /** | |
1252 | * Environment. | |
1253 | */ | |
1254 | struct lu_env { | |
1255 | /** | |
1256 | * "Local" context, used to store data instead of stack. | |
1257 | */ | |
1258 | struct lu_context le_ctx; | |
1259 | /** | |
1260 | * "Session" context for per-request data. | |
1261 | */ | |
1262 | struct lu_context *le_ses; | |
1263 | }; | |
1264 | ||
1265 | int lu_env_init (struct lu_env *env, __u32 tags); | |
1266 | void lu_env_fini (struct lu_env *env); | |
1267 | int lu_env_refill(struct lu_env *env); | |
1268 | int lu_env_refill_by_tags(struct lu_env *env, __u32 ctags, __u32 stags); | |
1269 | ||
1270 | /** @} lu_context */ | |
1271 | ||
1272 | /** | |
1273 | * Output site statistical counters into a buffer. Suitable for | |
1274 | * ll_rd_*()-style functions. | |
1275 | */ | |
73bb1da6 | 1276 | int lu_site_stats_print(const struct lu_site *s, struct seq_file *m); |
d7e09d03 PT |
1277 | |
1278 | /** | |
1279 | * Common name structure to be passed around for various name related methods. | |
1280 | */ | |
1281 | struct lu_name { | |
1282 | const char *ln_name; | |
1283 | int ln_namelen; | |
1284 | }; | |
1285 | ||
1286 | /** | |
1287 | * Common buffer structure to be passed around for various xattr_{s,g}et() | |
1288 | * methods. | |
1289 | */ | |
1290 | struct lu_buf { | |
1291 | void *lb_buf; | |
1292 | ssize_t lb_len; | |
1293 | }; | |
1294 | ||
1295 | #define DLUBUF "(%p %zu)" | |
1296 | #define PLUBUF(buf) (buf)->lb_buf, (buf)->lb_len | |
1297 | /** | |
1298 | * One-time initializers, called at obdclass module initialization, not | |
1299 | * exported. | |
1300 | */ | |
1301 | ||
1302 | /** | |
1303 | * Initialization of global lu_* data. | |
1304 | */ | |
1305 | int lu_global_init(void); | |
1306 | ||
1307 | /** | |
1308 | * Dual to lu_global_init(). | |
1309 | */ | |
1310 | void lu_global_fini(void); | |
1311 | ||
1312 | struct lu_kmem_descr { | |
1313 | struct kmem_cache **ckd_cache; | |
1314 | const char *ckd_name; | |
1315 | const size_t ckd_size; | |
1316 | }; | |
1317 | ||
1318 | int lu_kmem_init(struct lu_kmem_descr *caches); | |
1319 | void lu_kmem_fini(struct lu_kmem_descr *caches); | |
1320 | ||
1321 | void lu_object_assign_fid(const struct lu_env *env, struct lu_object *o, | |
1322 | const struct lu_fid *fid); | |
1323 | struct lu_object *lu_object_anon(const struct lu_env *env, | |
1324 | struct lu_device *dev, | |
1325 | const struct lu_object_conf *conf); | |
1326 | ||
1327 | /** null buffer */ | |
1328 | extern struct lu_buf LU_BUF_NULL; | |
1329 | ||
1330 | void lu_buf_free(struct lu_buf *buf); | |
1331 | void lu_buf_alloc(struct lu_buf *buf, int size); | |
1332 | void lu_buf_realloc(struct lu_buf *buf, int size); | |
1333 | ||
1334 | int lu_buf_check_and_grow(struct lu_buf *buf, int len); | |
1335 | struct lu_buf *lu_buf_check_and_alloc(struct lu_buf *buf, int len); | |
1336 | ||
1337 | /** @} lu */ | |
1338 | #endif /* __LUSTRE_LU_OBJECT_H */ |