Whamcloud - gitweb
branch: HEAD
[fs/lustre-release.git] / lustre / osc / osc_cl_internal.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
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 /** \addtogroup osc osc @{ */
61
62 /**
63  * State maintained by osc layer for each IO context.
64  */
65 struct osc_io {
66         /** super class */
67         struct cl_io_slice oi_cl;
68         /** true if this io is lockless. */
69         int                oi_lockless;
70
71         struct obdo        oi_oa;
72         struct osc_punch_cbargs {
73                 int               opc_rc;
74                 struct completion opc_sync;
75         } oi_punch_cbarg;
76 };
77
78 /**
79  * State of transfer for osc.
80  */
81 struct osc_req {
82         struct cl_req_slice    or_cl;
83 };
84
85 /**
86  * State maintained by osc layer for the duration of a system call.
87  */
88 struct osc_session {
89         struct osc_io       os_io;
90 };
91
92 struct osc_thread_info {
93         struct ldlm_res_id      oti_resname;
94         ldlm_policy_data_t      oti_policy;
95         struct cl_lock_descr    oti_descr;
96         struct cl_attr          oti_attr;
97         struct lustre_handle    oti_handle;
98         struct cl_lock_closure  oti_closure;
99         struct cl_page_list     oti_plist;
100 };
101
102 struct osc_object {
103         struct cl_object   oo_cl;
104         struct lov_oinfo  *oo_oinfo;
105         /**
106          * True if locking against this stripe got -EUSERS.
107          */
108         int                oo_contended;
109         cfs_time_t         oo_contention_time;
110 #ifdef INVARIANT_CHECK
111         /**
112          * IO context used for invariant checks in osc_lock_has_pages().
113          */
114         struct cl_io       oo_debug_io;
115         /** Serialization object for osc_object::oo_debug_io. */
116         struct mutex       oo_debug_mutex;
117 #endif
118         /**
119          * List of pages in transfer.
120          */
121         struct list_head   oo_inflight[CRT_NR];
122         /**
123          * Lock, protecting ccc_object::cob_inflight, because a seat-belt is
124          * locked during take-off and landing.
125          */
126         spinlock_t         oo_seatbelt;
127 };
128
129 /*
130  * Lock "micro-states" for osc layer.
131  */
132 enum osc_lock_state {
133         OLS_NEW,
134         OLS_ENQUEUED,
135         OLS_UPCALL_RECEIVED,
136         OLS_GRANTED,
137         OLS_RELEASED,
138         OLS_BLOCKED,
139         OLS_CANCELLED
140 };
141
142 /**
143  * osc-private state of cl_lock.
144  *
145  * Interaction with DLM.
146  *
147  * CLIO enqueues all DLM locks through ptlrpcd (that is, in "async" mode).
148  *
149  * Once receive upcall is invoked, osc_lock remembers a handle of DLM lock in
150  * osc_lock::ols_handle and a pointer to that lock in osc_lock::ols_lock.
151  *
152  * This pointer is protected through a reference, acquired by
153  * osc_lock_upcall0(). Also, an additional reference is acquired by
154  * ldlm_lock_addref() call protecting the lock from cancellation, until
155  * osc_lock_unuse() releases it.
156  *
157  * Below is a description of how lock references are acquired and released
158  * inside of DLM.
159  *
160  * - When new lock is created and enqueued to the server (ldlm_cli_enqueue())
161  *      - ldlm_lock_create()
162  *          - ldlm_lock_new(): initializes a lock with 2 references. One for
163  *            the caller (released when reply from the server is received, or on
164  *            error), and another for the hash table.
165  *      - ldlm_lock_addref_internal(): protects the lock from cancellation.
166  *
167  * - When reply is received from the server (osc_enqueue_interpret())
168  *      - ldlm_cli_enqueue_fini()
169  *          - LDLM_LOCK_PUT(): releases caller reference acquired by
170  *            ldlm_lock_new().
171  *          - if (rc != 0)
172  *                ldlm_lock_decref(): error case: matches ldlm_cli_enqueue().
173  *      - ldlm_lock_decref(): for async locks, matches ldlm_cli_enqueue().
174  *
175  * - When lock is being cancelled (ldlm_lock_cancel())
176  *      - ldlm_lock_destroy()
177  *          - LDLM_LOCK_PUT(): releases hash-table reference acquired by
178  *            ldlm_lock_new().
179  *
180  * osc_lock is detached from ldlm_lock by osc_lock_detach() that is called
181  * either when lock is cancelled (osc_lock_blocking()), or when locks is
182  * deleted without cancellation (e.g., from cl_locks_prune()). In the latter
183  * case ldlm lock remains in memory, and can be re-attached to osc_lock in the
184  * future.
185  */
186 struct osc_lock {
187         struct cl_lock_slice     ols_cl;
188         /** underlying DLM lock */
189         struct ldlm_lock        *ols_lock;
190         /** lock value block */
191         struct ost_lvb           ols_lvb;
192         /** DLM flags with which osc_lock::ols_lock was enqueued */
193         int                      ols_flags;
194         /** osc_lock::ols_lock handle */
195         struct lustre_handle     ols_handle;
196         struct ldlm_enqueue_info ols_einfo;
197         enum osc_lock_state      ols_state;
198         /**
199          * true, if ldlm_lock_addref() was called against
200          * osc_lock::ols_lock. This is used for sanity checking.
201          *
202          * \see osc_lock::ols_has_ref
203          */
204         unsigned                  ols_hold :1,
205         /**
206          * this is much like osc_lock::ols_hold, except that this bit is
207          * cleared _after_ reference in released in osc_lock_unuse(). This
208          * fine distinction is needed because:
209          *
210          *     - if ldlm lock still has a reference, osc_ast_data_get() needs
211          *       to return associated cl_lock (so that a flag is needed that is
212          *       cleared after ldlm_lock_decref() returned), and
213          *
214          *     - ldlm_lock_decref() can invoke blocking ast (for a
215          *       LDLM_FL_CBPENDING lock), and osc_lock functions like
216          *       osc_lock_cancel() called from there need to know whether to
217          *       release lock reference (so that a flag is needed that is
218          *       cleared before ldlm_lock_decref() is called).
219          */
220                                  ols_has_ref:1,
221         /**
222          * inherit the lockless attribute from top level cl_io.
223          * If true, osc_lock_enqueue is able to tolerate the -EUSERS error.
224          */
225                                  ols_locklessable:1,
226         /**
227          * set by osc_lock_use() to wait until blocking AST enters into
228          * osc_ldlm_blocking_ast0(), so that cl_lock mutex can be used for
229          * further synchronization.
230          */
231                                  ols_ast_wait:1,
232         /**
233          * If the data of this lock has been flushed to server side.
234          */
235                                  ols_flush:1,
236         /**
237          * if set, the osc_lock is a glimpse lock. For glimpse locks, we treat
238          * the EVAVAIL error as torerable, this will make upper logic happy
239          * to wait all glimpse locks to each OSTs to be completed.
240          * Glimpse lock converts to normal lock if the server lock is
241          * granted.
242          * Glimpse lock should be destroyed immediately after use.
243          */
244                                  ols_glimpse:1;
245         /**
246          * IO that owns this lock. This field is used for a dead-lock
247          * avoidance by osc_lock_enqueue().
248          *
249          * \see osc_deadlock_is_possible()
250          */
251         struct osc_io           *ols_owner;
252 };
253
254
255 /**
256  * Page state private for osc layer.
257  */
258 struct osc_page {
259         struct cl_page_slice  ops_cl;
260         /**
261          * Page queues used by osc to detect when RPC can be formed.
262          */
263         struct osc_async_page ops_oap;
264         /**
265          * An offset within page from which next transfer starts. This is used
266          * by cl_page_clip() to submit partial page transfers.
267          */
268         int                   ops_from;
269         /**
270          * An offset within page at which next transfer ends.
271          *
272          * \see osc_page::ops_from.
273          */
274         int                   ops_to;
275         /**
276          * Boolean, true iff page is under transfer. Used for sanity checking.
277          */
278         unsigned              ops_transfer_pinned:1,
279         /**
280          * True for a `temporary page' created by read-ahead code, probably
281          * outside of any DLM lock.
282          */
283                               ops_temp:1;
284         /**
285          * Linkage into a per-osc_object list of pages in flight. For
286          * debugging.
287          */
288         struct list_head      ops_inflight;
289         /**
290          * Thread that submitted this page for transfer. For debugging.
291          */
292         cfs_task_t           *ops_submitter;
293 };
294
295 extern cfs_mem_cache_t *osc_page_kmem;
296 extern cfs_mem_cache_t *osc_lock_kmem;
297 extern cfs_mem_cache_t *osc_object_kmem;
298 extern cfs_mem_cache_t *osc_thread_kmem;
299 extern cfs_mem_cache_t *osc_session_kmem;
300 extern cfs_mem_cache_t *osc_req_kmem;
301
302 extern struct lu_device_type osc_device_type;
303 extern struct lu_context_key osc_key;
304 extern struct lu_context_key osc_session_key;
305
306 #define OSC_FLAGS (ASYNC_URGENT|ASYNC_READY)
307
308 int osc_lock_init(const struct lu_env *env,
309                   struct cl_object *obj, struct cl_lock *lock,
310                   const struct cl_io *io);
311 int osc_io_init  (const struct lu_env *env,
312                   struct cl_object *obj, struct cl_io *io);
313 int osc_req_init (const struct lu_env *env, struct cl_device *dev,
314                   struct cl_req *req);
315 struct lu_object *osc_object_alloc(const struct lu_env *env,
316                                    const struct lu_object_header *hdr,
317                                    struct lu_device *dev);
318 struct cl_page   *osc_page_init   (const struct lu_env *env,
319                                    struct cl_object *obj,
320                                    struct cl_page *page, cfs_page_t *vmpage);
321
322 void osc_lock_build_res(const struct lu_env *env, const struct osc_object *obj,
323                         struct ldlm_res_id *resname);
324 void osc_index2policy  (ldlm_policy_data_t *policy, const struct cl_object *obj,
325                         pgoff_t start, pgoff_t end);
326 int  osc_lvb_print     (const struct lu_env *env, void *cookie,
327                         lu_printer_t p, const struct ost_lvb *lvb);
328 void osc_io_submit_page(const struct lu_env *env,
329                         struct osc_io *oio, struct osc_page *opg,
330                         enum cl_req_type crt);
331
332 void osc_object_set_contended  (struct osc_object *obj);
333 void osc_object_clear_contended(struct osc_object *obj);
334 int  osc_object_is_contended   (struct osc_object *obj);
335
336 int  osc_lock_is_lockless      (const struct osc_lock *olck);
337
338 /*****************************************************************************
339  *
340  * Accessors.
341  *
342  */
343
344 static inline struct osc_thread_info *osc_env_info(const struct lu_env *env)
345 {
346         struct osc_thread_info *info;
347
348         info = lu_context_key_get(&env->le_ctx, &osc_key);
349         LASSERT(info != NULL);
350         return info;
351 }
352
353 static inline struct osc_session *osc_env_session(const struct lu_env *env)
354 {
355         struct osc_session *ses;
356
357         ses = lu_context_key_get(env->le_ses, &osc_session_key);
358         LASSERT(ses != NULL);
359         return ses;
360 }
361
362 static inline struct osc_io *osc_env_io(const struct lu_env *env)
363 {
364         return &osc_env_session(env)->os_io;
365 }
366
367 static inline int osc_is_object(const struct lu_object *obj)
368 {
369         return obj->lo_dev->ld_type == &osc_device_type;
370 }
371
372 static inline struct osc_device *lu2osc_dev(const struct lu_device *d)
373 {
374         LINVRNT(d->ld_type == &osc_device_type);
375         return container_of0(d, struct osc_device, od_cl.cd_lu_dev);
376 }
377
378 static inline struct obd_export *osc_export(const struct osc_object *obj)
379 {
380         return lu2osc_dev(obj->oo_cl.co_lu.lo_dev)->od_exp;
381 }
382
383 static inline struct osc_object *cl2osc(const struct cl_object *obj)
384 {
385         LINVRNT(osc_is_object(&obj->co_lu));
386         return container_of0(obj, struct osc_object, oo_cl);
387 }
388
389 static inline ldlm_mode_t osc_cl_lock2ldlm(enum cl_lock_mode mode)
390 {
391         LASSERT(mode == CLM_READ || mode == CLM_WRITE || mode == CLM_GROUP);
392         if (mode == CLM_READ)
393                 return LCK_PR;
394         else if (mode == CLM_WRITE)
395                 return LCK_PW;
396         else
397                 return LCK_GROUP;
398 }
399
400 static inline enum cl_lock_mode osc_ldlm2cl_lock(ldlm_mode_t mode)
401 {
402         LASSERT(mode == LCK_PR || mode == LCK_PW || mode == LCK_GROUP);
403         if (mode == LCK_PR)
404                 return CLM_READ;
405         else if (mode == LCK_PW)
406                 return CLM_WRITE;
407         else
408                 return CLM_GROUP;
409 }
410
411 static inline struct osc_page *cl2osc_page(const struct cl_page_slice *slice)
412 {
413         LINVRNT(osc_is_object(&slice->cpl_obj->co_lu));
414         return container_of0(slice, struct osc_page, ops_cl);
415 }
416
417 static inline struct osc_lock *cl2osc_lock(const struct cl_lock_slice *slice)
418 {
419         LINVRNT(osc_is_object(&slice->cls_obj->co_lu));
420         return container_of0(slice, struct osc_lock, ols_cl);
421 }
422
423 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
424 {
425         return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
426 }
427
428 static inline int osc_io_srvlock(struct osc_io *oio)
429 {
430         return (oio->oi_lockless && !oio->oi_cl.cis_io->ci_no_srvlock);
431 }
432
433 /** @} osc */
434
435 #endif /* OSC_CL_INTERNAL_H */