Whamcloud - gitweb
LU-14487 modules: remove references to Sun Trademark.
[fs/lustre-release.git] / lustre / osp / osp_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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * lustre/osp/osp_internal.h
32  *
33  * Author: Alex Zhuravlev <alexey.zhuravlev@intel.com>
34  */
35
36 #ifndef _OSP_INTERNAL_H
37 #define _OSP_INTERNAL_H
38
39 #include <obd.h>
40 #include <obd_class.h>
41 #include <dt_object.h>
42 #include <md_object.h>
43 #include <lustre_fid.h>
44 #include <lustre_update.h>
45 #include <lu_target.h>
46
47 /*
48  * Infrastructure to support tracking of last committed llog record
49  */
50 struct osp_id_tracker {
51         spinlock_t               otr_lock;
52         __u64                    otr_next_id;
53         __u64                    otr_committed_id;
54         /* callback is register once per diskfs -- that's the whole point */
55         struct dt_txn_callback   otr_tx_cb;
56         /* single node can run many clusters */
57         struct list_head         otr_wakeup_list;
58         struct list_head         otr_list;
59         /* underlying shared device */
60         struct dt_device        *otr_dev;
61         /* how many users of this tracker */
62         atomic_t                 otr_refcount;
63 };
64
65 struct osp_precreate {
66         /*
67          * Precreation pool
68          */
69
70         /* last fid to assign in creation */
71         struct lu_fid                    osp_pre_used_fid;
72         /* last created id OST reported, next-created - available id's */
73         struct lu_fid                    osp_pre_last_created_fid;
74         /* how many ids are reserved in declare, we shouldn't block in create */
75         __u64                            osp_pre_reserved;
76         /* consumers (who needs new ids) wait here */
77         wait_queue_head_t                osp_pre_user_waitq;
78         /* current precreation status: working, failed, stopping? */
79         int                              osp_pre_status;
80         /* how many objects to precreate next time */
81         int                              osp_pre_create_count;
82         int                              osp_pre_min_create_count;
83         int                              osp_pre_max_create_count;
84         /* whether to increase precreation window next time or not */
85         int                              osp_pre_create_slow;
86         /* cleaning up orphans or recreating missing objects */
87         int                              osp_pre_recovering;
88 };
89
90 struct osp_update_request_sub {
91         struct object_update_request    *ours_req; /* may be vmalloc'd */
92         size_t                          ours_req_size;
93         /* Linked to osp_update_request->our_req_list */
94         struct list_head                ours_list;
95 };
96
97 struct osp_update_request {
98         int                             our_flags;
99         /* update request result */
100         int                             our_rc;
101
102         /* List of osp_update_request_sub */
103         struct list_head                our_req_list;
104         int                             our_req_nr;
105         int                             our_update_nr;
106
107         struct list_head                our_cb_items;
108         struct list_head                our_invalidate_cb_list;
109
110         /* points to thandle if this update request belongs to one */
111         struct osp_thandle              *our_th;
112
113         __u64                           our_version;
114         __u64                           our_generation;
115         /* protect our_list and flag */
116         spinlock_t                      our_list_lock;
117         /* linked to the list(ou_list) in osp_updates */
118         struct list_head                our_list;
119         __u32                           our_batchid;
120         __u32                           our_req_ready:1;
121
122 };
123
124 struct osp_updates {
125         struct list_head        ou_list;
126         spinlock_t              ou_lock;
127         wait_queue_head_t       ou_waitq;
128
129         /* The next rpc version which supposed to be sent in
130          * osp_send_update_thread().*/
131         __u64                   ou_rpc_version;
132
133         /* The rpc version assigned to the osp thandle during (osp_md_write()),
134          * which will be sent by this order. Note: the osp_thandle has be sent
135          * by this order to make sure the remote update log will follow the
136          * llog format rule. XXX: these probably should be removed once we
137          * invent new llog format */
138         __u64                   ou_version;
139
140         /* The generation of current osp update RPC, which is used to make sure
141          * those stale RPC(with older generation) will not be sent, otherwise it
142          * will cause update lllog corruption */
143         __u64                   ou_generation;
144
145         /* dedicate update thread */
146         struct task_struct      *ou_update_task;
147         struct lu_env           ou_env;
148 };
149
150 struct osp_rpc_lock {
151         /** Lock protecting in-flight RPC concurrency. */
152         struct mutex            rpcl_mutex;
153         /** Used for MDS/RPC load testing purposes. */
154         unsigned int            rpcl_fakes;
155 };
156
157 struct osp_device {
158         struct dt_device                 opd_dt_dev;
159         /* corresponded OST index */
160         int                              opd_index;
161
162         /* corrsponded MDT index, which will be used when connecting to OST
163          * for validating the connection (see ofd_parse_connect_data) */
164         int                              opd_group;
165         /* device used to store persistent state (llogs, last ids) */
166         struct obd_export               *opd_storage_exp;
167         struct dt_device                *opd_storage;
168         struct dt_object                *opd_last_used_oid_file;
169         struct dt_object                *opd_last_used_seq_file;
170
171         /* stored persistently in LE format, updated directly to/from disk
172          * and required le64_to_cpu() conversion before use.
173          * Protected by opd_pre_lock */
174         struct lu_fid                   opd_last_used_fid;
175         /* on disk copy last_used_fid.f_oid or idif */
176         u64                             opd_last_id;
177         struct lu_fid                   opd_gap_start_fid;
178         int                              opd_gap_count;
179         /* connection to OST */
180         struct osp_rpc_lock              opd_rpc_lock;
181         struct obd_device               *opd_obd;
182         struct obd_export               *opd_exp;
183         struct obd_connect_data         *opd_connect_data;
184         int                              opd_connects;
185         /* connection status. */
186         unsigned int                     opd_new_connection:1,
187                                          opd_got_disconnected:1,
188                                          opd_imp_connected:1,
189                                          opd_imp_active:1,
190                                          opd_imp_seen_connected:1,
191                                          opd_connect_mdt:1;
192
193         /* whether local recovery is completed:
194          * reported via ->ldo_recovery_complete() */
195         int                              opd_recovery_completed;
196
197         /* precreate structure for OSP */
198         struct osp_precreate            *opd_pre;
199         /* dedicate precreate thread */
200         struct task_struct              *opd_pre_task;
201         spinlock_t                       opd_pre_lock;
202         /* thread waits for signals about pool going empty */
203         wait_queue_head_t                opd_pre_waitq;
204
205         /* send update thread */
206         struct osp_updates              *opd_update;
207
208         /*
209          * OST synchronization thread
210          */
211         spinlock_t                       opd_sync_lock;
212         /* unique generation, to recognize start of new records in the llog */
213         struct llog_gen                  opd_sync_generation;
214         /* number of changes to sync, used to wake up sync thread */
215         atomic_t                         opd_sync_changes;
216         /* processing of changes from previous mount is done? */
217         int                              opd_sync_prev_done;
218         /* found records */
219         struct task_struct              *opd_sync_task;
220         wait_queue_head_t                opd_sync_waitq;
221         /* list of in flight rpcs */
222         struct list_head                 opd_sync_in_flight_list;
223         /* list of remotely committed rpc */
224         struct list_head                 opd_sync_committed_there;
225         /* number of RPCs in flight - flow control */
226         atomic_t                         opd_sync_rpcs_in_flight;
227         int                              opd_sync_max_rpcs_in_flight;
228         /* number of RPC in processing (including non-committed by OST) */
229         atomic_t                         opd_sync_rpcs_in_progress;
230         int                              opd_sync_max_rpcs_in_progress;
231         /* osd api's commit cb control structure */
232         struct dt_txn_callback           opd_sync_txn_cb;
233         /* last used change number -- semantically similar to transno */
234         unsigned long                    opd_sync_last_used_id;
235         /* last committed change number -- semantically similar to
236          * last_committed */
237         __u64                            opd_sync_last_committed_id;
238         /* last processed catalog index */
239         int                              opd_sync_last_catalog_idx;
240         /* number of processed records */
241         atomic64_t                       opd_sync_processed_recs;
242         /* stop processing new requests until barrier=0 */
243         atomic_t                         opd_sync_barrier;
244         wait_queue_head_t                opd_sync_barrier_waitq;
245         /* last generated id */
246         ktime_t                          opd_sync_next_commit_cb;
247         atomic_t                         opd_commits_registered;
248
249         /*
250          * statfs related fields: OSP maintains it on its own
251          */
252         struct obd_statfs                opd_statfs;
253         ktime_t                          opd_statfs_fresh_till;
254         struct timer_list                opd_statfs_timer;
255         int                              opd_statfs_update_in_progress;
256         /* how often to update statfs data */
257         time64_t                         opd_statfs_maxage;
258
259         struct dentry                   *opd_debugfs;
260
261         /* If the caller wants to do some idempotent async operations on
262          * remote server, it can append the async remote requests on the
263          * osp_device::opd_async_requests via declare() functions, these
264          * requests can be packed together and sent to the remote server
265          * via single OUT RPC later. */
266         struct osp_update_request       *opd_async_requests;
267         /* Protect current operations on opd_async_requests. */
268         struct mutex                     opd_async_requests_mutex;
269         struct list_head                 opd_async_updates;
270         struct rw_semaphore              opd_async_updates_rwsem;
271         atomic_t                         opd_async_updates_count;
272
273         /*
274          * Limit the object allocation using ENOSPC for opd_pre_status
275          */
276         int                             opd_reserved_mb_high;
277         int                             opd_reserved_mb_low;
278 };
279
280 #define opd_pre_used_fid                opd_pre->osp_pre_used_fid
281 #define opd_pre_last_created_fid        opd_pre->osp_pre_last_created_fid
282 #define opd_pre_reserved                opd_pre->osp_pre_reserved
283 #define opd_pre_user_waitq              opd_pre->osp_pre_user_waitq
284 #define opd_pre_status                  opd_pre->osp_pre_status
285 #define opd_pre_create_count            opd_pre->osp_pre_create_count
286 #define opd_pre_min_create_count        opd_pre->osp_pre_min_create_count
287 #define opd_pre_max_create_count        opd_pre->osp_pre_max_create_count
288 #define opd_pre_create_slow             opd_pre->osp_pre_create_slow
289 #define opd_pre_recovering              opd_pre->osp_pre_recovering
290
291 extern struct kmem_cache *osp_object_kmem;
292
293 /* The first part of oxe_buf is xattr name, and is '\0' terminated.
294  * The left part is for value, binary mode. */
295 struct osp_xattr_entry {
296         struct list_head         oxe_list;
297         atomic_t                 oxe_ref;
298         void                    *oxe_value;
299         size_t                   oxe_buflen;
300         size_t                   oxe_namelen;
301         size_t                   oxe_vallen;
302         unsigned int             oxe_exist:1,
303                                  oxe_ready:1;
304         char                     oxe_buf[0];
305 };
306
307 /* this is a top object */
308 struct osp_object {
309         struct lu_object_header opo_header;
310         struct dt_object        opo_obj;
311         unsigned int            opo_reserved:1,
312                                 opo_non_exist:1,
313                                 opo_stale:1;
314
315         /* read/write lock for md osp object */
316         struct rw_semaphore     opo_sem;
317         const struct lu_env     *opo_owner;
318         struct lu_attr          opo_attr;
319         struct list_head        opo_xattr_list;
320         struct list_head        opo_invalidate_cb_list;
321         /* Protect opo_ooa. */
322         spinlock_t              opo_lock;
323         /* to implement in-flight invalidation */
324         atomic_t                opo_invalidate_seq;
325         struct rw_semaphore     opo_invalidate_sem;
326 };
327
328 extern const struct lu_object_operations osp_lu_obj_ops;
329 extern const struct dt_object_operations osp_md_obj_ops;
330 extern const struct dt_body_operations osp_md_body_ops;
331
332 struct osp_thread_info {
333         struct lu_buf            osi_lb;
334         struct lu_buf            osi_lb2;
335         struct lu_fid            osi_fid;
336         struct lu_attr           osi_attr;
337         struct ost_id            osi_oi;
338         struct ost_id            osi_oi2;
339         loff_t                   osi_off;
340         union {
341                 struct llog_rec_hdr             osi_hdr;
342                 struct llog_unlink64_rec        osi_unlink;
343                 struct llog_setattr64_rec_v2    osi_setattr;
344                 struct llog_gen_rec             osi_gen;
345         };
346         struct llog_cookie       osi_cookie;
347         struct llog_catid        osi_cid;
348         struct lu_seq_range      osi_seq;
349         struct ldlm_res_id       osi_resid;
350         struct obdo              osi_obdo;
351 };
352
353 /* Iterator for OSP */
354 struct osp_it {
355         __u32                     ooi_pos_page;
356         __u32                     ooi_pos_lu_page;
357         __u32                     ooi_attr;
358         __u32                     ooi_rec_size;
359         int                       ooi_pos_ent;
360         int                       ooi_total_npages;
361         int                       ooi_valid_npages;
362         unsigned int              ooi_swab:1;
363         __u64                     ooi_next;
364         struct dt_object         *ooi_obj;
365         void                     *ooi_ent;
366         struct page              *ooi_cur_page;
367         struct lu_idxpage        *ooi_cur_idxpage;
368         struct page              **ooi_pages;
369 };
370
371 #define OSP_THANDLE_MAGIC       0x20141214
372 struct osp_thandle {
373         struct thandle           ot_super;
374
375         /* OSP will use this thandle to update last oid*/
376         struct thandle          *ot_storage_th;
377         __u32                    ot_magic;
378         struct list_head         ot_commit_dcb_list;
379         struct list_head         ot_stop_dcb_list;
380         struct osp_update_request *ot_our;
381         atomic_t                 ot_refcount;
382 };
383
384 static inline struct osp_thandle *
385 thandle_to_osp_thandle(struct thandle *th)
386 {
387         return container_of(th, struct osp_thandle, ot_super);
388 }
389
390 static inline struct osp_update_request *
391 thandle_to_osp_update_request(struct thandle *th)
392 {
393         struct osp_thandle *oth;
394
395         oth = thandle_to_osp_thandle(th);
396         return oth->ot_our;
397 }
398
399 /* The transaction only include the updates on the remote node, and
400  * no local updates at all */
401 static inline bool is_only_remote_trans(struct thandle *th)
402 {
403         return th->th_top == NULL;
404 }
405
406 static inline void osp_objid_buf_prep(struct lu_buf *buf, loff_t *off,
407                                       __u64 *id, int index)
408 {
409         /* Note: through id is only 32 bits, it will also write 64 bits
410          * for oid to keep compatibility with the previous version. */
411         buf->lb_buf = (void *)id;
412         buf->lb_len = sizeof(u64);
413         *off = sizeof(u64) * index;
414 }
415
416 static inline void osp_objseq_buf_prep(struct lu_buf *buf, loff_t *off,
417                                        __u64 *seq, int index)
418 {
419         buf->lb_buf = (void *)seq;
420         buf->lb_len = sizeof(u64);
421         *off = sizeof(u64) * index;
422 }
423
424 static inline void osp_buf_prep(struct lu_buf *lb, void *buf, int buf_len)
425 {
426         lb->lb_buf = buf;
427         lb->lb_len = buf_len;
428 }
429
430 extern struct lu_context_key osp_thread_key;
431
432 static inline struct osp_thread_info *osp_env_info(const struct lu_env *env)
433 {
434         return lu_env_info(env, &osp_thread_key);
435 }
436
437 struct osp_txn_info {
438         __u64   oti_current_id;
439 };
440
441 extern struct lu_context_key osp_txn_key;
442
443 static inline struct osp_txn_info *osp_txn_info(struct lu_context *ctx)
444 {
445         struct osp_txn_info *info;
446
447         info = lu_context_key_get(ctx, &osp_txn_key);
448         return info;
449 }
450
451 extern const struct lu_device_operations osp_lu_ops;
452
453 static inline int lu_device_is_osp(struct lu_device *d)
454 {
455         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osp_lu_ops);
456 }
457
458 static inline struct osp_device *lu2osp_dev(struct lu_device *d)
459 {
460         LASSERT(lu_device_is_osp(d));
461         return container_of_safe(d, struct osp_device, opd_dt_dev.dd_lu_dev);
462 }
463
464 static inline struct lu_device *osp2lu_dev(struct osp_device *d)
465 {
466         return &d->opd_dt_dev.dd_lu_dev;
467 }
468
469 static inline struct osp_device *dt2osp_dev(struct dt_device *d)
470 {
471         LASSERT(lu_device_is_osp(&d->dd_lu_dev));
472         return container_of_safe(d, struct osp_device, opd_dt_dev);
473 }
474
475 static inline struct osp_object *lu2osp_obj(struct lu_object *o)
476 {
477         LASSERT(ergo(o != NULL, lu_device_is_osp(o->lo_dev)));
478         return container_of_safe(o, struct osp_object, opo_obj.do_lu);
479 }
480
481 static inline struct lu_object *osp2lu_obj(struct osp_object *obj)
482 {
483         return &obj->opo_obj.do_lu;
484 }
485
486 static inline struct osp_object *osp_obj(const struct lu_object *o)
487 {
488         LASSERT(lu_device_is_osp(o->lo_dev));
489         return container_of_safe(o, struct osp_object, opo_obj.do_lu);
490 }
491
492 static inline struct osp_object *dt2osp_obj(const struct dt_object *d)
493 {
494         return osp_obj(&d->do_lu);
495 }
496
497 static inline struct dt_object *osp_object_child(struct osp_object *o)
498 {
499         return container_of(lu_object_next(osp2lu_obj(o)),
500                             struct dt_object, do_lu);
501 }
502
503 static inline struct seq_server_site *osp_seq_site(struct osp_device *osp)
504 {
505         return osp->opd_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
506 }
507
508 /**
509  * Serializes in-flight MDT-modifying RPC requests to preserve idempotency.
510  *
511  * This mutex is used to implement execute-once semantics on the MDT.
512  * The MDT stores the last transaction ID and result for every client in
513  * its last_rcvd file. If the client doesn't get a reply, it can safely
514  * resend the request and the MDT will reconstruct the reply being aware
515  * that the request has already been executed. Without this lock,
516  * execution status of concurrent in-flight requests would be
517  * overwritten.
518  *
519  * This imlpementation limits the extent to which we can keep a full pipeline
520  * of in-flight requests from a single client.  This limitation can be
521  * overcome by allowing multiple slots per client in the last_rcvd file,
522  * see LU-6864.
523  */
524 #define OSP_FAKE_RPCL_IT ((void *)0x2c0012bfUL)
525
526 static inline void osp_init_rpc_lock(struct osp_device *osp)
527 {
528         struct osp_rpc_lock *lck = &osp->opd_rpc_lock;
529
530         mutex_init(&lck->rpcl_mutex);
531         lck->rpcl_fakes = 0;
532 }
533
534 static inline void osp_get_rpc_lock(struct osp_device *osp)
535 {
536         struct osp_rpc_lock *lck = &osp->opd_rpc_lock;
537
538         /* This would normally block until the existing request finishes.
539          * If fail_loc is set it will block until the regular request is
540          * done, then increment rpcl_fakes.  Once that is non-zero it
541          * will only be cleared when all fake requests are finished.
542          * Only when all fake requests are finished can normal requests
543          * be sent, to ensure they are recoverable again.
544          */
545  again:
546         mutex_lock(&lck->rpcl_mutex);
547
548         if (CFS_FAIL_CHECK_QUIET(OBD_FAIL_MDC_RPCS_SEM) ||
549             CFS_FAIL_CHECK_QUIET(OBD_FAIL_OSP_RPCS_SEM)) {
550                 lck->rpcl_fakes++;
551                 mutex_unlock(&lck->rpcl_mutex);
552
553                 return;
554         }
555
556         /* This will only happen when the CFS_FAIL_CHECK() was just turned
557          * off but there are still requests in progress.  Wait until they
558          * finish.  It doesn't need to be efficient in this extremely rare
559          * case, just have low overhead in the common case when it isn't true.
560          */
561         if (unlikely(lck->rpcl_fakes)) {
562                 mutex_unlock(&lck->rpcl_mutex);
563                 schedule_timeout_uninterruptible(cfs_time_seconds(1) / 4);
564
565                 goto again;
566         }
567 }
568
569 static inline void osp_put_rpc_lock(struct osp_device *osp)
570 {
571         struct osp_rpc_lock *lck = &osp->opd_rpc_lock;
572
573         if (lck->rpcl_fakes) { /* OBD_FAIL_OSP_RPCS_SEM */
574                 mutex_lock(&lck->rpcl_mutex);
575
576                 if (lck->rpcl_fakes) /* check again under lock */
577                         lck->rpcl_fakes--;
578         }
579
580         mutex_unlock(&lck->rpcl_mutex);
581 }
582
583 static inline int osp_fid_diff(const struct lu_fid *fid1,
584                                const struct lu_fid *fid2)
585 {
586         /* In 2.6+ ost_idx is packed into IDIF FID, while in 2.4 and 2.5 IDIF
587          * is always FID_SEQ_IDIF(0x100000000ULL), which does not include OST
588          * index in the seq. So we can not compare IDIF FID seq here */
589         if (fid_is_idif(fid1) && fid_is_idif(fid2)) {
590                 __u32 ost_idx1 = fid_idif_ost_idx(fid1);
591                 __u32 ost_idx2 = fid_idif_ost_idx(fid2);
592
593                 LASSERTF(ost_idx1 == 0 || ost_idx2 == 0 || ost_idx1 == ost_idx2,
594                          "fid1: "DFID", fid2: "DFID"\n", PFID(fid1),
595                          PFID(fid2));
596
597                 return fid_idif_id(fid1->f_seq, fid1->f_oid, 0) -
598                        fid_idif_id(fid2->f_seq, fid2->f_oid, 0);
599         }
600
601         LASSERTF(fid_seq(fid1) == fid_seq(fid2), "fid1:"DFID", fid2:"DFID"\n",
602                  PFID(fid1), PFID(fid2));
603
604         return fid_oid(fid1) - fid_oid(fid2);
605 }
606
607 static inline void osp_fid_to_obdid(struct lu_fid *last_fid, u64 *osi_id)
608 {
609         if (fid_is_idif((last_fid)))
610                 *osi_id = fid_idif_id(fid_seq(last_fid), fid_oid(last_fid),
611                                       fid_ver(last_fid));
612         else
613                 *osi_id = fid_oid(last_fid);
614 }
615
616 static inline void osp_update_last_fid(struct osp_device *d, struct lu_fid *fid)
617 {
618         int diff = osp_fid_diff(fid, &d->opd_last_used_fid);
619         struct lu_fid *gap_start = &d->opd_gap_start_fid;
620
621         /*
622          * we might have lost precreated objects due to VBR and precreate
623          * orphans, the gap in objid can be calculated properly only here
624          */
625         if (diff > 0) {
626                 if (diff > 1) {
627                         d->opd_gap_start_fid = d->opd_last_used_fid;
628                         if (fid_oid(gap_start) == LUSTRE_DATA_SEQ_MAX_WIDTH) {
629                                 gap_start->f_seq++;
630                                 gap_start->f_oid = fid_is_idif(gap_start) ?
631                                                                0 : 1;
632                         } else {
633                                 gap_start->f_oid++;
634                         }
635                         d->opd_gap_count = diff - 1;
636                         CDEBUG(D_HA, "Gap in objids: start="DFID", count =%d\n",
637                                PFID(&d->opd_gap_start_fid), d->opd_gap_count);
638                 }
639                 d->opd_last_used_fid = *fid;
640                 osp_fid_to_obdid(fid, &d->opd_last_id);
641         }
642 }
643
644 static int osp_fid_end_seq(const struct lu_env *env, struct lu_fid *fid)
645 {
646         if (fid_is_idif(fid)) {
647                 struct osp_thread_info *info = osp_env_info(env);
648                 struct ost_id *oi = &info->osi_oi;
649
650                 fid_to_ostid(fid, oi);
651                 return ostid_id(oi) == IDIF_MAX_OID;
652         } else {
653                 return fid_oid(fid) == LUSTRE_DATA_SEQ_MAX_WIDTH;
654         }
655 }
656
657 static inline int osp_precreate_end_seq_nolock(const struct lu_env *env,
658                                                struct osp_device *osp)
659 {
660         struct lu_fid *fid = &osp->opd_pre_last_created_fid;
661
662         return osp_fid_end_seq(env, fid);
663 }
664
665 static inline int osp_precreate_end_seq(const struct lu_env *env,
666                                         struct osp_device *osp)
667 {
668         int rc;
669
670         spin_lock(&osp->opd_pre_lock);
671         rc = osp_precreate_end_seq_nolock(env, osp);
672         spin_unlock(&osp->opd_pre_lock);
673         return rc;
674 }
675
676 static inline int osp_is_fid_client(struct osp_device *osp)
677 {
678         struct obd_import *imp = osp->opd_obd->u.cli.cl_import;
679
680         return imp->imp_connect_data.ocd_connect_flags & OBD_CONNECT_FID;
681 }
682
683 struct object_update *
684 update_buffer_get_update(struct object_update_request *request,
685                          unsigned int index);
686
687 int osp_extend_update_buffer(const struct lu_env *env,
688                              struct osp_update_request *our);
689
690 struct osp_update_request_sub *
691 osp_current_object_update_request(struct osp_update_request *our);
692
693 int osp_object_update_request_create(struct osp_update_request *our,
694                                      size_t size);
695
696 #define OSP_UPDATE_RPC_PACK(env, out_something_pack, our, ...)          \
697 ({                                                                      \
698         struct object_update *object_update;                            \
699         size_t max_update_length;                                       \
700         struct osp_update_request_sub *ours;                            \
701         int ret;                                                        \
702                                                                         \
703         while (1) {                                                     \
704                 ours = osp_current_object_update_request(our);          \
705                 LASSERT(ours != NULL);                                  \
706                 max_update_length = ours->ours_req_size -               \
707                             object_update_request_size(ours->ours_req); \
708                                                                         \
709                 object_update = update_buffer_get_update(ours->ours_req,\
710                                          ours->ours_req->ourq_count);   \
711                 ret = out_something_pack(env, object_update,            \
712                                          &max_update_length,            \
713                                          __VA_ARGS__);                  \
714                 if (ret == -E2BIG) {                                    \
715                         int rc1;                                        \
716                         /* Create new object update request */          \
717                         rc1 = osp_object_update_request_create(our,     \
718                                 max_update_length  +                    \
719                                 offsetof(struct object_update_request,  \
720                                          ourq_updates[0]) + 1);         \
721                         if (rc1 != 0) {                                 \
722                                 ret = rc1;                              \
723                                 break;                                  \
724                         }                                               \
725                         continue;                                       \
726                 } else {                                                \
727                         if (ret == 0) {                                 \
728                                 ours->ours_req->ourq_count++;           \
729                                 (our)->our_update_nr++;                 \
730                                 object_update->ou_batchid =             \
731                                                      (our)->our_batchid;\
732                                 object_update->ou_flags |=              \
733                                                      (our)->our_flags;  \
734                         }                                               \
735                         break;                                          \
736                 }                                                       \
737         }                                                               \
738         ret;                                                            \
739 })
740
741 typedef int (*osp_update_interpreter_t)(const struct lu_env *env,
742                                         struct object_update_reply *rep,
743                                         struct ptlrpc_request *req,
744                                         struct osp_object *obj,
745                                         void *data, int index, int rc);
746
747 /* osp_dev.c */
748 void osp_update_last_id(struct osp_device *d, u64 objid);
749
750 /* osp_trans.c */
751 int osp_insert_async_request(const struct lu_env *env, enum update_type op,
752                              struct osp_object *obj, int count, __u16 *lens,
753                              const void **bufs, void *data, __u32 repsize,
754                              osp_update_interpreter_t interpreter);
755
756 int osp_unplug_async_request(const struct lu_env *env,
757                              struct osp_device *osp,
758                              struct osp_update_request *update);
759 int osp_trans_update_request_create(struct thandle *th);
760 struct thandle *osp_trans_create(const struct lu_env *env,
761                                  struct dt_device *d);
762 int osp_trans_start(const struct lu_env *env, struct dt_device *dt,
763                     struct thandle *th);
764 int osp_insert_update_callback(const struct lu_env *env,
765                                struct osp_update_request *update,
766                                struct osp_object *obj, void *data,
767                                osp_update_interpreter_t interpreter);
768
769 struct osp_update_request *osp_update_request_create(struct dt_device *dt);
770 void osp_update_request_destroy(const struct lu_env *env,
771                                 struct osp_update_request *update);
772
773 int osp_send_update_thread(void *arg);
774 int osp_check_and_set_rpc_version(struct osp_thandle *oth,
775                                   struct osp_object *obj);
776
777 void osp_thandle_destroy(const struct lu_env *env, struct osp_thandle *oth);
778 static inline void osp_thandle_get(struct osp_thandle *oth)
779 {
780         atomic_inc(&oth->ot_refcount);
781 }
782
783 static inline void osp_thandle_put(const struct lu_env *env,
784                                    struct osp_thandle *oth)
785 {
786         if (atomic_dec_and_test(&oth->ot_refcount))
787                 osp_thandle_destroy(env, oth);
788 }
789
790 int osp_prep_update_req(const struct lu_env *env, struct obd_import *imp,
791                         struct osp_update_request *our,
792                         struct ptlrpc_request **reqp);
793 int osp_remote_sync(const struct lu_env *env, struct osp_device *osp,
794                     struct osp_update_request *update,
795                     struct ptlrpc_request **reqp);
796
797 struct thandle *osp_get_storage_thandle(const struct lu_env *env,
798                                         struct thandle *th,
799                                         struct osp_device *osp);
800 void osp_trans_callback(const struct lu_env *env,
801                         struct osp_thandle *oth, int rc);
802 void osp_invalidate_request(struct osp_device *osp);
803 /* osp_object.c */
804 int osp_attr_get(const struct lu_env *env, struct dt_object *dt,
805                  struct lu_attr *attr);
806 int osp_xattr_get(const struct lu_env *env, struct dt_object *dt,
807                   struct lu_buf *buf, const char *name);
808 int osp_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
809                           const struct lu_buf *buf, const char *name,
810                           int flag, struct thandle *th);
811 int osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
812                   const struct lu_buf *buf, const char *name, int fl,
813                   struct thandle *th);
814 int osp_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
815                           const char *name, struct thandle *th);
816 int osp_xattr_del(const struct lu_env *env, struct dt_object *dt,
817                   const char *name, struct thandle *th);
818 int osp_invalidate(const struct lu_env *env, struct dt_object *dt);
819 bool osp_check_stale(struct dt_object *dt);
820 void osp_obj_invalidate_cache(struct osp_object *obj);
821
822 int osp_trans_stop(const struct lu_env *env, struct dt_device *dt,
823                    struct thandle *th);
824 int osp_trans_cb_add(struct thandle *th, struct dt_txn_commit_cb *dcb);
825
826 struct dt_it *osp_it_init(const struct lu_env *env, struct dt_object *dt,
827                           __u32 attr);
828 void osp_it_fini(const struct lu_env *env, struct dt_it *di);
829 int osp_it_get(const struct lu_env *env, struct dt_it *di,
830                const struct dt_key *key);
831 void osp_it_put(const struct lu_env *env, struct dt_it *di);
832 __u64 osp_it_store(const struct lu_env *env, const struct dt_it *di);
833 int osp_it_key_rec(const struct lu_env *env, const struct dt_it *di,
834                    void *key_rec);
835 int osp_it_next_page(const struct lu_env *env, struct dt_it *di);
836 /* osp_md_object.c */
837 int osp_md_declare_create(const struct lu_env *env, struct dt_object *dt,
838                           struct lu_attr *attr, struct dt_allocation_hint *hint,
839                           struct dt_object_format *dof, struct thandle *th);
840 int osp_md_create(const struct lu_env *env, struct dt_object *dt,
841                   struct lu_attr *attr, struct dt_allocation_hint *hint,
842                   struct dt_object_format *dof, struct thandle *th);
843 int osp_md_declare_attr_set(const struct lu_env *env, struct dt_object *dt,
844                             const struct lu_attr *attr, struct thandle *th);
845 int osp_md_attr_set(const struct lu_env *env, struct dt_object *dt,
846                     const struct lu_attr *attr, struct thandle *th);
847 extern const struct dt_index_operations osp_md_index_ops;
848
849 /* osp_precreate.c */
850 int osp_init_precreate(struct osp_device *d);
851 int osp_precreate_reserve(const struct lu_env *env,
852                           struct osp_device *d, bool can_block);
853 __u64 osp_precreate_get_id(struct osp_device *d);
854 int osp_precreate_get_fid(const struct lu_env *env, struct osp_device *d,
855                           struct lu_fid *fid);
856 void osp_precreate_fini(struct osp_device *d);
857 int osp_object_truncate(const struct lu_env *env, struct dt_object *dt, __u64);
858 void osp_pre_update_status(struct osp_device *d, int rc);
859 void osp_statfs_need_now(struct osp_device *d);
860 int osp_reset_last_used(const struct lu_env *env, struct osp_device *osp);
861 int osp_write_last_oid_seq_files(struct lu_env *env, struct osp_device *osp,
862                                  struct lu_fid *fid, int sync);
863 int osp_init_pre_fid(struct osp_device *osp);
864 int osp_init_statfs(struct osp_device *osp);
865 void osp_fini_statfs(struct osp_device *osp);
866 void osp_statfs_fini(struct osp_device *d);
867
868 /* lproc_osp.c */
869 void osp_tunables_init(struct osp_device *osp);
870 void osp_tunables_fini(struct osp_device *osp);
871
872 /* osp_sync.c */
873 int osp_sync_declare_add(const struct lu_env *env, struct osp_object *o,
874                          enum llog_op_type type, struct thandle *th);
875 int osp_sync_add(const struct lu_env *env, struct osp_object *o,
876                  enum llog_op_type type, struct thandle *th,
877                  const struct lu_attr *attr);
878 int osp_sync_init(const struct lu_env *env, struct osp_device *d);
879 int osp_sync_fini(struct osp_device *d);
880 void osp_sync_check_for_work(struct osp_device *osp);
881 void osp_sync_force(const struct lu_env *env, struct osp_device *d);
882 int osp_sync_add_commit_cb_1s(const struct lu_env *env, struct osp_device *d,
883                               struct thandle *th);
884
885 /* lwp_dev.c */
886 extern const struct obd_ops lwp_obd_device_ops;
887 extern struct lu_device_type lwp_device_type;
888
889 static inline struct lu_device *osp2top(const struct osp_device *osp)
890 {
891         return osp->opd_dt_dev.dd_lu_dev.ld_site->ls_top_dev;
892 }
893
894 static inline void osp_set_req_replay(const struct osp_device *osp,
895                                       struct ptlrpc_request *req)
896 {
897         struct obd_device *obd = osp2top(osp)->ld_obd;
898
899         /* The RPC must be recovery related for the cases:
900          *
901          * 1. sent during recovery, or
902          * 2. sent before the recovery thread target_recovery_thread() start,
903          *    such as triggered by lod_sub_recovery_thread(). */
904         if (obd->obd_recovering || (obd->obd_replayable && obd->obd_no_conn))
905                 req->rq_allow_replay = 1;
906 }
907
908 #endif