Whamcloud - gitweb
39f866c86e002f2a074822830cfecd19d079d214
[fs/lustre-release.git] / lustre / osc / osc_cl_internal.h
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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2012, Whamcloud, Inc.
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  * This file is part of Lustre, http://www.lustre.org/
38  * Lustre is a trademark of Sun Microsystems, Inc.
39  *
40  * Internal interfaces of OSC layer.
41  *
42  *   Author: Nikita Danilov <nikita.danilov@sun.com>
43  */
44
45 #ifndef OSC_CL_INTERNAL_H
46 #define OSC_CL_INTERNAL_H
47
48 #ifdef __KERNEL__
49 # include <libcfs/libcfs.h>
50 #else
51 # include <liblustre.h>
52 #endif
53
54 #include <obd.h>
55 /* osc_build_res_name() */
56 #include <obd_ost.h>
57 #include <cl_object.h>
58 #include "osc_internal.h"
59
60 /** \defgroup osc osc
61  *  @{
62  */
63
64 /**
65  * State maintained by osc layer for each IO context.
66  */
67 struct osc_io {
68         /** super class */
69         struct cl_io_slice oi_cl;
70         /** true if this io is lockless. */
71         int                oi_lockless;
72
73         struct obdo        oi_oa;
74         struct osc_setattr_cbargs {
75                 int               opc_rc;
76                 cfs_completion_t  opc_sync;
77         } oi_setattr_cbarg;
78 };
79
80 /**
81  * State of transfer for osc.
82  */
83 struct osc_req {
84         struct cl_req_slice    or_cl;
85 };
86
87 /**
88  * State maintained by osc layer for the duration of a system call.
89  */
90 struct osc_session {
91         struct osc_io       os_io;
92 };
93
94 struct osc_thread_info {
95         struct ldlm_res_id      oti_resname;
96         ldlm_policy_data_t      oti_policy;
97         struct cl_lock_descr    oti_descr;
98         struct cl_attr          oti_attr;
99         struct lustre_handle    oti_handle;
100         struct cl_page_list     oti_plist;
101 };
102
103 struct osc_object {
104         struct cl_object   oo_cl;
105         struct lov_oinfo  *oo_oinfo;
106         /**
107          * True if locking against this stripe got -EUSERS.
108          */
109         int                oo_contended;
110         cfs_time_t         oo_contention_time;
111 #ifdef INVARIANT_CHECK
112         /**
113          * IO context used for invariant checks in osc_lock_has_pages().
114          */
115         struct cl_io       oo_debug_io;
116         /** Serialization object for osc_object::oo_debug_io. */
117         cfs_mutex_t        oo_debug_mutex;
118 #endif
119         /**
120          * List of pages in transfer.
121          */
122         cfs_list_t         oo_inflight[CRT_NR];
123         /**
124          * Lock, protecting ccc_object::cob_inflight, because a seat-belt is
125          * locked during take-off and landing.
126          */
127         cfs_spinlock_t     oo_seatbelt;
128 };
129
130 /*
131  * Lock "micro-states" for osc layer.
132  */
133 enum osc_lock_state {
134         OLS_NEW,
135         OLS_ENQUEUED,
136         OLS_UPCALL_RECEIVED,
137         OLS_GRANTED,
138         OLS_RELEASED,
139         OLS_BLOCKED,
140         OLS_CANCELLED
141 };
142
143 /**
144  * osc-private state of cl_lock.
145  *
146  * Interaction with DLM.
147  *
148  * CLIO enqueues all DLM locks through ptlrpcd (that is, in "async" mode).
149  *
150  * Once receive upcall is invoked, osc_lock remembers a handle of DLM lock in
151  * osc_lock::ols_handle and a pointer to that lock in osc_lock::ols_lock.
152  *
153  * This pointer is protected through a reference, acquired by
154  * osc_lock_upcall0(). Also, an additional reference is acquired by
155  * ldlm_lock_addref() call protecting the lock from cancellation, until
156  * osc_lock_unuse() releases it.
157  *
158  * Below is a description of how lock references are acquired and released
159  * inside of DLM.
160  *
161  * - When new lock is created and enqueued to the server (ldlm_cli_enqueue())
162  *      - ldlm_lock_create()
163  *          - ldlm_lock_new(): initializes a lock with 2 references. One for
164  *            the caller (released when reply from the server is received, or on
165  *            error), and another for the hash table.
166  *      - ldlm_lock_addref_internal(): protects the lock from cancellation.
167  *
168  * - When reply is received from the server (osc_enqueue_interpret())
169  *      - ldlm_cli_enqueue_fini()
170  *          - LDLM_LOCK_PUT(): releases caller reference acquired by
171  *            ldlm_lock_new().
172  *          - if (rc != 0)
173  *                ldlm_lock_decref(): error case: matches ldlm_cli_enqueue().
174  *      - ldlm_lock_decref(): for async locks, matches ldlm_cli_enqueue().
175  *
176  * - When lock is being cancelled (ldlm_lock_cancel())
177  *      - ldlm_lock_destroy()
178  *          - LDLM_LOCK_PUT(): releases hash-table reference acquired by
179  *            ldlm_lock_new().
180  *
181  * osc_lock is detached from ldlm_lock by osc_lock_detach() that is called
182  * either when lock is cancelled (osc_lock_blocking()), or when locks is
183  * deleted without cancellation (e.g., from cl_locks_prune()). In the latter
184  * case ldlm lock remains in memory, and can be re-attached to osc_lock in the
185  * future.
186  */
187 struct osc_lock {
188         struct cl_lock_slice     ols_cl;
189         /** underlying DLM lock */
190         struct ldlm_lock        *ols_lock;
191         /** lock value block */
192         struct ost_lvb           ols_lvb;
193         /** DLM flags with which osc_lock::ols_lock was enqueued */
194         int                      ols_flags;
195         /** osc_lock::ols_lock handle */
196         struct lustre_handle     ols_handle;
197         struct ldlm_enqueue_info ols_einfo;
198         enum osc_lock_state      ols_state;
199
200         /**
201          * How many pages are using this lock for io, currently only used by
202          * read-ahead. If non-zero, the underlying dlm lock won't be cancelled
203          * during recovery to avoid deadlock. see bz16774.
204          *
205          * \see osc_page::ops_lock
206          * \see osc_page_addref_lock(), osc_page_putref_lock()
207          */
208         cfs_atomic_t             ols_pageref;
209
210         /**
211          * true, if ldlm_lock_addref() was called against
212          * osc_lock::ols_lock. This is used for sanity checking.
213          *
214          * \see osc_lock::ols_has_ref
215          */
216         unsigned                  ols_hold :1,
217         /**
218          * this is much like osc_lock::ols_hold, except that this bit is
219          * cleared _after_ reference in released in osc_lock_unuse(). This
220          * fine distinction is needed because:
221          *
222          *     - if ldlm lock still has a reference, osc_ast_data_get() needs
223          *       to return associated cl_lock (so that a flag is needed that is
224          *       cleared after ldlm_lock_decref() returned), and
225          *
226          *     - ldlm_lock_decref() can invoke blocking ast (for a
227          *       LDLM_FL_CBPENDING lock), and osc_lock functions like
228          *       osc_lock_cancel() called from there need to know whether to
229          *       release lock reference (so that a flag is needed that is
230          *       cleared before ldlm_lock_decref() is called).
231          */
232                                  ols_has_ref:1,
233         /**
234          * inherit the lockless attribute from top level cl_io.
235          * If true, osc_lock_enqueue is able to tolerate the -EUSERS error.
236          */
237                                  ols_locklessable:1,
238         /**
239          * set by osc_lock_use() to wait until blocking AST enters into
240          * osc_ldlm_blocking_ast0(), so that cl_lock mutex can be used for
241          * further synchronization.
242          */
243                                  ols_ast_wait:1,
244         /**
245          * If the data of this lock has been flushed to server side.
246          */
247                                  ols_flush:1,
248         /**
249          * if set, the osc_lock is a glimpse lock. For glimpse locks, we treat
250          * the EVAVAIL error as torerable, this will make upper logic happy
251          * to wait all glimpse locks to each OSTs to be completed.
252          * Glimpse lock converts to normal lock if the server lock is
253          * granted.
254          * Glimpse lock should be destroyed immediately after use.
255          */
256                                  ols_glimpse:1,
257         /**
258          * For async glimpse lock.
259          */
260                                  ols_agl:1;
261         /**
262          * IO that owns this lock. This field is used for a dead-lock
263          * avoidance by osc_lock_enqueue_wait().
264          *
265          * XXX: unfortunately, the owner of a osc_lock is not unique, 
266          * the lock may have multiple users, if the lock is granted and
267          * then matched.
268          */
269         struct osc_io           *ols_owner;
270 };
271
272
273 /**
274  * Page state private for osc layer.
275  */
276 struct osc_page {
277         struct cl_page_slice  ops_cl;
278         /**
279          * Page queues used by osc to detect when RPC can be formed.
280          */
281         struct osc_async_page ops_oap;
282         /**
283          * An offset within page from which next transfer starts. This is used
284          * by cl_page_clip() to submit partial page transfers.
285          */
286         int                   ops_from;
287         /**
288          * An offset within page at which next transfer ends.
289          *
290          * \see osc_page::ops_from.
291          */
292         int                   ops_to;
293         /**
294          * Boolean, true iff page is under transfer. Used for sanity checking.
295          */
296         unsigned              ops_transfer_pinned:1,
297         /**
298          * True for a `temporary page' created by read-ahead code, probably
299          * outside of any DLM lock.
300          */
301                               ops_temp:1,
302         /**
303          * Set if the page must be transferred with OBD_BRW_SRVLOCK.
304          */
305                               ops_srvlock:1;
306         /**
307          * Linkage into a per-osc_object list of pages in flight. For
308          * debugging.
309          */
310         cfs_list_t            ops_inflight;
311         /**
312          * Thread that submitted this page for transfer. For debugging.
313          */
314         cfs_task_t           *ops_submitter;
315         /**
316          * Submit time - the time when the page is starting RPC. For debugging.
317          */
318         cfs_time_t            ops_submit_time;
319
320         /**
321          * A lock of which we hold a reference covers this page. Only used by
322          * read-ahead: for a readahead page, we hold it's covering lock to
323          * prevent it from being canceled during recovery.
324          *
325          * \see osc_lock::ols_pageref
326          * \see osc_page_addref_lock(), osc_page_putref_lock().
327          */
328         struct cl_lock       *ops_lock;
329 };
330
331 extern cfs_mem_cache_t *osc_page_kmem;
332 extern cfs_mem_cache_t *osc_lock_kmem;
333 extern cfs_mem_cache_t *osc_object_kmem;
334 extern cfs_mem_cache_t *osc_thread_kmem;
335 extern cfs_mem_cache_t *osc_session_kmem;
336 extern cfs_mem_cache_t *osc_req_kmem;
337
338 extern struct lu_device_type osc_device_type;
339 extern struct lu_context_key osc_key;
340 extern struct lu_context_key osc_session_key;
341
342 #define OSC_FLAGS (ASYNC_URGENT|ASYNC_READY)
343
344 int osc_lock_init(const struct lu_env *env,
345                   struct cl_object *obj, struct cl_lock *lock,
346                   const struct cl_io *io);
347 int osc_io_init  (const struct lu_env *env,
348                   struct cl_object *obj, struct cl_io *io);
349 int osc_req_init (const struct lu_env *env, struct cl_device *dev,
350                   struct cl_req *req);
351 struct lu_object *osc_object_alloc(const struct lu_env *env,
352                                    const struct lu_object_header *hdr,
353                                    struct lu_device *dev);
354 struct cl_page   *osc_page_init   (const struct lu_env *env,
355                                    struct cl_object *obj,
356                                    struct cl_page *page, cfs_page_t *vmpage);
357
358 void osc_lock_build_res(const struct lu_env *env, const struct osc_object *obj,
359                         struct ldlm_res_id *resname);
360 void osc_index2policy  (ldlm_policy_data_t *policy, const struct cl_object *obj,
361                         pgoff_t start, pgoff_t end);
362 int  osc_lvb_print     (const struct lu_env *env, void *cookie,
363                         lu_printer_t p, const struct ost_lvb *lvb);
364 void osc_io_submit_page(const struct lu_env *env,
365                         struct osc_io *oio, struct osc_page *opg,
366                         enum cl_req_type crt);
367
368 void osc_object_set_contended  (struct osc_object *obj);
369 void osc_object_clear_contended(struct osc_object *obj);
370 int  osc_object_is_contended   (struct osc_object *obj);
371
372 int  osc_lock_is_lockless      (const struct osc_lock *olck);
373
374 /*****************************************************************************
375  *
376  * Accessors.
377  *
378  */
379
380 static inline struct osc_thread_info *osc_env_info(const struct lu_env *env)
381 {
382         struct osc_thread_info *info;
383
384         info = lu_context_key_get(&env->le_ctx, &osc_key);
385         LASSERT(info != NULL);
386         return info;
387 }
388
389 static inline struct osc_session *osc_env_session(const struct lu_env *env)
390 {
391         struct osc_session *ses;
392
393         ses = lu_context_key_get(env->le_ses, &osc_session_key);
394         LASSERT(ses != NULL);
395         return ses;
396 }
397
398 static inline struct osc_io *osc_env_io(const struct lu_env *env)
399 {
400         return &osc_env_session(env)->os_io;
401 }
402
403 static inline int osc_is_object(const struct lu_object *obj)
404 {
405         return obj->lo_dev->ld_type == &osc_device_type;
406 }
407
408 static inline struct osc_device *lu2osc_dev(const struct lu_device *d)
409 {
410         LINVRNT(d->ld_type == &osc_device_type);
411         return container_of0(d, struct osc_device, od_cl.cd_lu_dev);
412 }
413
414 static inline struct obd_export *osc_export(const struct osc_object *obj)
415 {
416         return lu2osc_dev(obj->oo_cl.co_lu.lo_dev)->od_exp;
417 }
418
419 static inline struct osc_object *cl2osc(const struct cl_object *obj)
420 {
421         LINVRNT(osc_is_object(&obj->co_lu));
422         return container_of0(obj, struct osc_object, oo_cl);
423 }
424
425 static inline ldlm_mode_t osc_cl_lock2ldlm(enum cl_lock_mode mode)
426 {
427         LASSERT(mode == CLM_READ || mode == CLM_WRITE || mode == CLM_GROUP);
428         if (mode == CLM_READ)
429                 return LCK_PR;
430         else if (mode == CLM_WRITE)
431                 return LCK_PW;
432         else
433                 return LCK_GROUP;
434 }
435
436 static inline enum cl_lock_mode osc_ldlm2cl_lock(ldlm_mode_t mode)
437 {
438         LASSERT(mode == LCK_PR || mode == LCK_PW || mode == LCK_GROUP);
439         if (mode == LCK_PR)
440                 return CLM_READ;
441         else if (mode == LCK_PW)
442                 return CLM_WRITE;
443         else
444                 return CLM_GROUP;
445 }
446
447 static inline struct osc_page *cl2osc_page(const struct cl_page_slice *slice)
448 {
449         LINVRNT(osc_is_object(&slice->cpl_obj->co_lu));
450         return container_of0(slice, struct osc_page, ops_cl);
451 }
452
453 static inline struct osc_lock *cl2osc_lock(const struct cl_lock_slice *slice)
454 {
455         LINVRNT(osc_is_object(&slice->cls_obj->co_lu));
456         return container_of0(slice, struct osc_lock, ols_cl);
457 }
458
459 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
460 {
461         return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
462 }
463
464 static inline int osc_io_srvlock(struct osc_io *oio)
465 {
466         return (oio->oi_lockless && !oio->oi_cl.cis_io->ci_no_srvlock);
467 }
468
469 /** @} osc */
470
471 #endif /* OSC_CL_INTERNAL_H */