Whamcloud - gitweb
69795d54347a0911af0dc1f067d243665e057d7a
[fs/lustre-release.git] / lustre / osp / osp_object.c
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, 2016, Intel Corporation.
27  */
28 /*
29  * lustre/osp/osp_object.c
30  *
31  * Lustre OST Proxy Device (OSP) is the agent on the local MDT for the OST
32  * or remote MDT.
33  *
34  * OSP object attributes cache
35  * ---------------------------
36  * OSP object is the stub of the remote OST-object or MDT-object. Both the
37  * attribute and the extended attributes are stored on the peer side remotely.
38  * It is inefficient to send RPC to peer to fetch those attributes when every
39  * get_attr()/get_xattr() called. For a large system, the LFSCK synchronous
40  * mode scanning is prohibitively inefficient.
41  *
42  * So the OSP maintains the OSP object attributes cache to cache some
43  * attributes on the local MDT. The cache is organized against the OSP
44  * object as follows:
45  *
46  * struct osp_xattr_entry {
47  *      struct list_head         oxe_list;
48  *      atomic_t                 oxe_ref;
49  *      void                    *oxe_value;
50  *      int                      oxe_buflen;
51  *      int                      oxe_namelen;
52  *      int                      oxe_vallen;
53  *      unsigned int             oxe_exist:1,
54  *                               oxe_ready:1;
55  *      char                     oxe_buf[0];
56  * };
57  *
58  * struct osp_object {
59  *      ...
60  *      struct lu_attr          opo_attr;
61  *      struct list_head        opo_xattr_list;
62  *      spinlock_t              opo_lock;
63  *      ...
64  * };
65  *
66  * The basic attributes, such as owner/mode/flags, are stored in the
67  * osp_object::opo_attr. The extended attributes will be stored
68  * as osp_xattr_entry. Every extended attribute has an independent
69  * osp_xattr_entry, and all the osp_xattr_entry are linked into the
70  * osp_object::opo_xattr_list. The OSP object attributes cache
71  * is protected by the osp_object::opo_lock.
72  *
73  * Not all OSP objects have an attributes cache because maintaining
74  * the cache requires some resources. Currently, the OSP object
75  * attributes cache will be initialized when the attributes or the
76  * extended attributes are pre-fetched via osp_declare_attr_get()
77  * or osp_declare_xattr_get(). That is usually for LFSCK purpose,
78  * but it also can be shared by others.
79  *
80  *
81  * XXX: NOT prepare out RPC for remote transaction. ((please refer to the
82  *      comment of osp_trans_create() for remote transaction)
83  *
84  * According to our current transaction/dt_object_lock framework (to make
85  * the cross-MDTs modification for DNE1 to be workable), the transaction
86  * sponsor will start the transaction firstly, then try to acquire related
87  * dt_object_lock if needed. Under such rules, if we want to prepare the
88  * OUT RPC in the transaction declare phase, then related attr/xattr
89  * should be known without dt_object_lock. But such condition maybe not
90  * true for some remote transaction case. For example:
91  *
92  * For linkEA repairing (by LFSCK) case, before the LFSCK thread obtained
93  * the dt_object_lock on the target MDT-object, it cannot know whether
94  * the MDT-object has linkEA or not, neither invalid or not.
95  *
96  * Since the LFSCK thread cannot hold dt_object_lock before the remote
97  * transaction start (otherwise there will be some potential deadlock),
98  * it cannot prepare related OUT RPC for repairing during the declare
99  * phase as other normal transactions do.
100  *
101  * To resolve the trouble, we will make OSP to prepare related OUT RPC
102  * after remote transaction started, and trigger the remote updating
103  * (send RPC) when trans_stop. Then the up layer users, such as LFSCK,
104  * can follow the general rule to handle trans_start/dt_object_lock
105  * for repairing linkEA inconsistency without distinguishing remote
106  * MDT-object.
107  *
108  * In fact, above solution for remote transaction should be the normal
109  * model without considering DNE1. The trouble brought by DNE1 will be
110  * resolved in DNE2. At that time, this patch can be removed.
111  *
112  *
113  * Author: Alex Zhuravlev <alexey.zhuravlev@intel.com>
114  * Author: Mikhail Pershin <mike.tappro@intel.com>
115  */
116
117 #define DEBUG_SUBSYSTEM S_MDS
118
119 #include <lustre_obdo.h>
120 #include <lustre_swab.h>
121
122 #include "osp_internal.h"
123
124 static inline __u32 osp_dev2node(struct osp_device *osp)
125 {
126         return osp->opd_storage->dd_lu_dev.ld_site->ld_seq_site->ss_node_id;
127 }
128
129 static inline bool is_ost_obj(struct lu_object *lo)
130 {
131         return !lu2osp_dev(lo->lo_dev)->opd_connect_mdt;
132 }
133
134 /**
135  * Assign FID to the OST object.
136  *
137  * This function will assign the FID to the OST object of a striped file.
138  *
139  * \param[in] env       pointer to the thread context
140  * \param[in] d         pointer to the OSP device
141  * \param[in] o         pointer to the OSP object that the FID will be
142  *                      assigned to
143  */
144 static void osp_object_assign_fid(const struct lu_env *env,
145                                   struct osp_device *d, struct osp_object *o)
146 {
147         struct osp_thread_info *osi = osp_env_info(env);
148
149         LASSERT(fid_is_zero(lu_object_fid(&o->opo_obj.do_lu)));
150         LASSERT(o->opo_reserved);
151         o->opo_reserved = 0;
152
153         osp_precreate_get_fid(env, d, &osi->osi_fid);
154
155         lu_object_assign_fid(env, &o->opo_obj.do_lu, &osi->osi_fid);
156 }
157
158 /**
159  * Find the named extended attribute in the OSP object attributes cache.
160  *
161  * The caller should take the osp_object::opo_lock before calling
162  * this function.
163  *
164  * \param[in] obj       pointer to the OSP object
165  * \param[in] name      the name of the extended attribute
166  * \param[in] namelen   the name length of the extended attribute
167  *
168  * \retval              pointer to the found extended attribute entry
169  * \retval              NULL if the specified extended attribute is not
170  *                      in the cache
171  */
172 static struct osp_xattr_entry *
173 osp_oac_xattr_find_locked(struct osp_object *obj, const char *name,
174                           size_t namelen)
175 {
176         struct osp_xattr_entry *oxe;
177
178         list_for_each_entry(oxe, &obj->opo_xattr_list, oxe_list) {
179                 if (namelen == oxe->oxe_namelen &&
180                     strncmp(name, oxe->oxe_buf, namelen) == 0)
181                         return oxe;
182         }
183
184         return NULL;
185 }
186
187 /**
188  * Find the named extended attribute in the OSP object attributes cache.
189  *
190  * Call osp_oac_xattr_find_locked() with the osp_object::opo_lock held.
191  *
192  * \param[in] obj       pointer to the OSP object
193  * \param[in] name      the name of the extended attribute
194  * \param[in] unlink    true if the extended attribute entry is to be removed
195  *                      from the cache
196  *
197  * \retval              pointer to the found extended attribute entry
198  * \retval              NULL if the specified extended attribute is not
199  *                      in the cache
200  */
201 static struct osp_xattr_entry *osp_oac_xattr_find(struct osp_object *obj,
202                                                   const char *name, bool unlink)
203 {
204         struct osp_xattr_entry *oxe = NULL;
205
206         spin_lock(&obj->opo_lock);
207         oxe = osp_oac_xattr_find_locked(obj, name, strlen(name));
208         if (oxe != NULL) {
209                 if (unlink)
210                         list_del_init(&oxe->oxe_list);
211                 else
212                         atomic_inc(&oxe->oxe_ref);
213         }
214         spin_unlock(&obj->opo_lock);
215
216         return oxe;
217 }
218
219 /**
220  * Find the named extended attribute in the OSP object attributes cache.
221  *
222  * If it is not in the cache, then add an empty entry (that will be
223  * filled later) to cache with the given name.
224  *
225  * \param[in] obj       pointer to the OSP object
226  * \param[in] name      the name of the extended attribute
227  * \param[in] len       the length of the extended attribute value
228  *
229  * \retval              pointer to the found or new-created extended
230  *                      attribute entry
231  * \retval              NULL if the specified extended attribute is not in the
232  *                      cache or fail to add new empty entry to the cache.
233  */
234 static struct osp_xattr_entry *
235 osp_oac_xattr_find_or_add(struct osp_object *obj, const char *name, size_t len)
236 {
237         struct osp_xattr_entry *oxe;
238         struct osp_xattr_entry *tmp     = NULL;
239         size_t                  namelen = strlen(name);
240         size_t                  size    = sizeof(*oxe) + namelen + 1 + len;
241
242         oxe = osp_oac_xattr_find(obj, name, false);
243         if (oxe != NULL)
244                 return oxe;
245
246         OBD_ALLOC(oxe, size);
247         if (unlikely(oxe == NULL))
248                 return NULL;
249
250         INIT_LIST_HEAD(&oxe->oxe_list);
251         oxe->oxe_buflen = size;
252         oxe->oxe_namelen = namelen;
253         memcpy(oxe->oxe_buf, name, namelen);
254         oxe->oxe_value = oxe->oxe_buf + namelen + 1;
255         /* One ref is for the caller, the other is for the entry on the list. */
256         atomic_set(&oxe->oxe_ref, 2);
257
258         spin_lock(&obj->opo_lock);
259         tmp = osp_oac_xattr_find_locked(obj, name, namelen);
260         if (tmp == NULL)
261                 list_add_tail(&oxe->oxe_list, &obj->opo_xattr_list);
262         else
263                 atomic_inc(&tmp->oxe_ref);
264         spin_unlock(&obj->opo_lock);
265
266         if (tmp != NULL) {
267                 OBD_FREE(oxe, size);
268                 oxe = tmp;
269         }
270
271         return oxe;
272 }
273
274 /**
275  * Add the given extended attribute to the OSP object attributes cache.
276  *
277  * If there is an old extended attributed entry with the same name,
278  * remove it from the cache and return it via the parameter \a poxe.
279  *
280  * \param[in] obj       pointer to the OSP object
281  * \param[in,out] poxe  double pointer to the OSP object extended attribute
282  *                      entry: the new extended attribute entry is transferred
283  *                      via such pointer target, and if old the extended
284  *                      attribute entry exists, then it will be returned back
285  *                      via such pointer target.
286  * \param[in] len       the length of the (new) extended attribute value
287  *
288  * \retval              pointer to the new extended attribute entry
289  * \retval              NULL for failure cases.
290  */
291 static struct osp_xattr_entry *
292 osp_oac_xattr_replace(struct osp_object *obj,
293                       struct osp_xattr_entry **poxe, size_t len)
294 {
295         struct osp_xattr_entry *oxe;
296         size_t                  namelen = (*poxe)->oxe_namelen;
297         size_t                  size    = sizeof(*oxe) + namelen + 1 + len;
298
299         OBD_ALLOC(oxe, size);
300         if (unlikely(oxe == NULL))
301                 return NULL;
302
303         INIT_LIST_HEAD(&oxe->oxe_list);
304         oxe->oxe_buflen = size;
305         oxe->oxe_namelen = namelen;
306         memcpy(oxe->oxe_buf, (*poxe)->oxe_buf, namelen);
307         oxe->oxe_value = oxe->oxe_buf + namelen + 1;
308         /* One ref is for the caller, the other is for the entry on the list. */
309         atomic_set(&oxe->oxe_ref, 2);
310
311         spin_lock(&obj->opo_lock);
312         *poxe = osp_oac_xattr_find_locked(obj, oxe->oxe_buf, namelen);
313         LASSERT(*poxe != NULL);
314
315         list_del_init(&(*poxe)->oxe_list);
316         list_add_tail(&oxe->oxe_list, &obj->opo_xattr_list);
317         spin_unlock(&obj->opo_lock);
318
319         return oxe;
320 }
321
322 /**
323  * Release reference from the OSP object extended attribute entry.
324  *
325  * If it is the last reference, then free the entry.
326  *
327  * \param[in] oxe       pointer to the OSP object extended attribute entry.
328  */
329 static inline void osp_oac_xattr_put(struct osp_xattr_entry *oxe)
330 {
331         if (atomic_dec_and_test(&oxe->oxe_ref)) {
332                 LASSERT(list_empty(&oxe->oxe_list));
333
334                 OBD_FREE(oxe, oxe->oxe_buflen);
335         }
336 }
337
338 /**
339  * Parse the OSP object attribute from the RPC reply.
340  *
341  * If the attribute is valid, then it will be added to the OSP object
342  * attributes cache.
343  *
344  * \param[in] env       pointer to the thread context
345  * \param[in] reply     pointer to the RPC reply
346  * \param[in] req       pointer to the RPC request
347  * \param[out] attr     pointer to buffer to hold the output attribute
348  * \param[in] obj       pointer to the OSP object
349  * \param[in] index     the index of the attribute buffer in the reply
350  *
351  * \retval              0 for success
352  * \retval              negative error number on failure
353  */
354 static int osp_get_attr_from_reply(const struct lu_env *env,
355                                    struct object_update_reply *reply,
356                                    struct ptlrpc_request *req,
357                                    struct lu_attr *attr,
358                                    struct osp_object *obj, int index)
359 {
360         struct osp_thread_info  *osi    = osp_env_info(env);
361         struct lu_buf           *rbuf   = &osi->osi_lb2;
362         struct obdo             *lobdo  = &osi->osi_obdo;
363         struct obdo             *wobdo;
364         int                     rc;
365
366         rc = object_update_result_data_get(reply, rbuf, index);
367         if (rc < 0)
368                 return rc;
369
370         wobdo = rbuf->lb_buf;
371         if (rbuf->lb_len != sizeof(*wobdo))
372                 return -EPROTO;
373
374         LASSERT(req != NULL);
375         if (ptlrpc_req_need_swab(req))
376                 lustre_swab_obdo(wobdo);
377
378         lustre_get_wire_obdo(NULL, lobdo, wobdo);
379         spin_lock(&obj->opo_lock);
380         la_from_obdo(&obj->opo_attr, lobdo, lobdo->o_valid);
381         if (attr != NULL)
382                 *attr = obj->opo_attr;
383         spin_unlock(&obj->opo_lock);
384
385         return 0;
386 }
387
388 /**
389  * Interpreter function for getting OSP object attribute asynchronously.
390  *
391  * Called to interpret the result of an async mode RPC for getting the
392  * OSP object attribute.
393  *
394  * \param[in] env       pointer to the thread context
395  * \param[in] reply     pointer to the RPC reply
396  * \param[in] req       pointer to the RPC request
397  * \param[in] obj       pointer to the OSP object
398  * \param[out] data     pointer to buffer to hold the output attribute
399  * \param[in] index     the index of the attribute buffer in the reply
400  * \param[in] rc        the result for handling the RPC
401  *
402  * \retval              0 for success
403  * \retval              negative error number on failure
404  */
405 static int osp_attr_get_interpterer(const struct lu_env *env,
406                                     struct object_update_reply *reply,
407                                     struct ptlrpc_request *req,
408                                     struct osp_object *obj,
409                                     void *data, int index, int rc)
410 {
411         struct lu_attr *attr = data;
412
413         if (rc == 0) {
414                 osp2lu_obj(obj)->lo_header->loh_attr |= LOHA_EXISTS;
415                 obj->opo_non_exist = 0;
416
417                 return osp_get_attr_from_reply(env, reply, req, NULL, obj,
418                                                index);
419         } else {
420                 if (rc == -ENOENT) {
421                         osp2lu_obj(obj)->lo_header->loh_attr &= ~LOHA_EXISTS;
422                         obj->opo_non_exist = 1;
423                 }
424
425                 spin_lock(&obj->opo_lock);
426                 attr->la_valid = 0;
427                 spin_unlock(&obj->opo_lock);
428         }
429
430         return 0;
431 }
432
433 /**
434  * Implement OSP layer dt_object_operations::do_declare_attr_get() interface.
435  *
436  * Declare that the caller will get attribute from the specified OST object.
437  *
438  * This function adds an Object Unified Target (OUT) sub-request to the per-OSP
439  * based shared asynchronous request queue. The osp_attr_get_interpterer()
440  * is registered as the interpreter function to handle the result of this
441  * sub-request.
442  *
443  * \param[in] env       pointer to the thread context
444  * \param[in] dt        pointer to the OSP layer dt_object
445  *
446  * \retval              0 for success
447  * \retval              negative error number on failure
448  */
449 static int osp_declare_attr_get(const struct lu_env *env, struct dt_object *dt)
450 {
451         struct osp_object       *obj    = dt2osp_obj(dt);
452         struct osp_device       *osp    = lu2osp_dev(dt->do_lu.lo_dev);
453         int                      rc     = 0;
454
455         mutex_lock(&osp->opd_async_requests_mutex);
456         rc = osp_insert_async_request(env, OUT_ATTR_GET, obj, 0, NULL, NULL,
457                                       &obj->opo_attr, sizeof(struct obdo),
458                                       osp_attr_get_interpterer);
459         mutex_unlock(&osp->opd_async_requests_mutex);
460
461         return rc;
462 }
463
464 /**
465  * Implement OSP layer dt_object_operations::do_attr_get() interface.
466  *
467  * Get attribute from the specified MDT/OST object.
468  *
469  * If the attribute is in the OSP object attributes cache, then return
470  * the cached attribute directly. Otherwise it will trigger an OUT RPC
471  * to the peer to get the attribute synchronously, if successful, add it
472  * to the OSP attributes cache. (\see lustre/osp/osp_trans.c for OUT RPC.)
473  *
474  * \param[in] env       pointer to the thread context
475  * \param[in] dt        pointer to the OSP layer dt_object
476  * \param[out] attr     pointer to the buffer to hold the output attribute
477  *
478  * \retval              0 for success
479  * \retval              negative error number on failure
480  */
481 int osp_attr_get(const struct lu_env *env, struct dt_object *dt,
482                  struct lu_attr *attr)
483 {
484         struct osp_device               *osp = lu2osp_dev(dt->do_lu.lo_dev);
485         struct osp_object               *obj = dt2osp_obj(dt);
486         struct dt_device                *dev = &osp->opd_dt_dev;
487         struct osp_update_request       *update;
488         struct object_update_reply      *reply;
489         struct ptlrpc_request           *req = NULL;
490         int                             rc = 0;
491         ENTRY;
492
493         if (is_ost_obj(&dt->do_lu) && obj->opo_non_exist)
494                 RETURN(-ENOENT);
495
496         spin_lock(&obj->opo_lock);
497         if (obj->opo_attr.la_valid != 0 && !obj->opo_stale) {
498                 *attr = obj->opo_attr;
499                 spin_unlock(&obj->opo_lock);
500
501                 RETURN(0);
502         }
503         spin_unlock(&obj->opo_lock);
504
505         update = osp_update_request_create(dev);
506         if (IS_ERR(update))
507                 RETURN(PTR_ERR(update));
508
509         rc = osp_update_rpc_pack(env, attr_get, update, OUT_ATTR_GET,
510                                  lu_object_fid(&dt->do_lu));
511         if (rc != 0) {
512                 CERROR("%s: Insert update error "DFID": rc = %d\n",
513                        dev->dd_lu_dev.ld_obd->obd_name,
514                        PFID(lu_object_fid(&dt->do_lu)), rc);
515
516                 GOTO(out, rc);
517         }
518
519         rc = osp_remote_sync(env, osp, update, &req);
520         if (rc != 0) {
521                 if (rc == -ENOENT) {
522                         osp2lu_obj(obj)->lo_header->loh_attr &= ~LOHA_EXISTS;
523                         obj->opo_non_exist = 1;
524                 } else {
525                         CERROR("%s:osp_attr_get update error "DFID": rc = %d\n",
526                                dev->dd_lu_dev.ld_obd->obd_name,
527                                PFID(lu_object_fid(&dt->do_lu)), rc);
528                 }
529
530                 GOTO(out, rc);
531         }
532
533         osp2lu_obj(obj)->lo_header->loh_attr |= LOHA_EXISTS;
534         obj->opo_non_exist = 0;
535         reply = req_capsule_server_sized_get(&req->rq_pill,
536                                              &RMF_OUT_UPDATE_REPLY,
537                                              OUT_UPDATE_REPLY_SIZE);
538         if (reply == NULL || reply->ourp_magic != UPDATE_REPLY_MAGIC)
539                 GOTO(out, rc = -EPROTO);
540
541         rc = osp_get_attr_from_reply(env, reply, req, attr, obj, 0);
542         if (rc != 0)
543                 GOTO(out, rc);
544
545         spin_lock(&obj->opo_lock);
546         obj->opo_stale = 0;
547         spin_unlock(&obj->opo_lock);
548
549         GOTO(out, rc);
550
551 out:
552         if (req != NULL)
553                 ptlrpc_req_finished(req);
554
555         osp_update_request_destroy(env, update);
556
557         return rc;
558 }
559
560 /**
561  * Implement OSP layer dt_object_operations::do_declare_attr_set() interface.
562  *
563  * If the transaction is not remote one, then declare the credits that will
564  * be used for the subsequent llog record for the object's attributes.
565  *
566  * \param[in] env       pointer to the thread context
567  * \param[in] dt        pointer to the OSP layer dt_object
568  * \param[in] attr      pointer to the attribute to be set
569  * \param[in] th        pointer to the transaction handler
570  *
571  * \retval              0 for success
572  * \retval              negative error number on failure
573  */
574 static int osp_declare_attr_set(const struct lu_env *env, struct dt_object *dt,
575                                 const struct lu_attr *attr, struct thandle *th)
576 {
577         struct osp_device       *d = lu2osp_dev(dt->do_lu.lo_dev);
578         struct osp_object       *o = dt2osp_obj(dt);
579         int                     rc;
580
581         if (is_only_remote_trans(th))
582                 return osp_md_declare_attr_set(env, dt, attr, th);
583         /*
584          * Usually we don't allow server stack to manipulate size
585          * but there is a special case when striping is created
586          * late, after stripeless file got truncated to non-zero.
587          *
588          * In this case we do the following:
589          *
590          * 1) grab id in declare - this can lead to leaked OST objects
591          *    but we don't currently have proper mechanism and the only
592          *    options we have are to do truncate RPC holding transaction
593          *    open (very bad) or to grab id in declare at cost of leaked
594          *    OST object in same very rare unfortunate case (just bad)
595          *    notice 1.6-2.0 do assignment outside of running transaction
596          *    all the time, meaning many more chances for leaked objects.
597          *
598          * 2) send synchronous truncate RPC with just assigned id
599          */
600
601         /* there are few places in MDD code still passing NULL
602          * XXX: to be fixed soon */
603         if (attr == NULL)
604                 RETURN(0);
605
606         if (attr->la_valid & LA_SIZE && attr->la_size > 0 &&
607             fid_is_zero(lu_object_fid(&o->opo_obj.do_lu))) {
608                 LASSERT(!dt_object_exists(dt));
609                 osp_object_assign_fid(env, d, o);
610                 rc = osp_object_truncate(env, dt, attr->la_size);
611                 if (rc != 0)
612                         RETURN(rc);
613         }
614
615         if (!(attr->la_valid & (LA_UID | LA_GID)))
616                 RETURN(0);
617
618         /* track all UID/GID changes via llog */
619         rc = osp_sync_declare_add(env, o, MDS_SETATTR64_REC, th);
620
621         return 0;
622 }
623
624 /**
625  * Implement OSP layer dt_object_operations::do_attr_set() interface.
626  *
627  * Set attribute to the specified OST object.
628  *
629  * If the transaction is a remote one, then add OUT_ATTR_SET sub-request
630  * in the OUT RPC that will be flushed when the remote transaction stop.
631  * Otherwise, it will generate a MDS_SETATTR64_REC record in the llog that
632  * will be handled by a dedicated thread asynchronously.
633  *
634  * If the attribute entry exists in the OSP object attributes cache,
635  * then update the cached attribute according to given attribute.
636  *
637  * \param[in] env       pointer to the thread context
638  * \param[in] dt        pointer to the OSP layer dt_object
639  * \param[in] attr      pointer to the attribute to be set
640  * \param[in] th        pointer to the transaction handler
641  *
642  * \retval              0 for success
643  * \retval              negative error number on failure
644  */
645 static int osp_attr_set(const struct lu_env *env, struct dt_object *dt,
646                         const struct lu_attr *attr, struct thandle *th)
647 {
648         struct osp_object       *o = dt2osp_obj(dt);
649         int                      rc = 0;
650         ENTRY;
651
652         /* we're interested in uid/gid changes only */
653         if (!(attr->la_valid & (LA_UID | LA_GID)))
654                 RETURN(0);
655
656         if (!is_only_remote_trans(th)) {
657                 rc = osp_sync_add(env, o, MDS_SETATTR64_REC, th, attr);
658                 /* XXX: send new uid/gid to OST ASAP? */
659         } else {
660                 struct lu_attr  *la;
661
662                 /* It is for OST-object attr_set directly without updating
663                  * local MDT-object attribute. It is usually used by LFSCK. */
664                 rc = osp_md_attr_set(env, dt, attr, th);
665                 CDEBUG(D_INFO, "(1) set attr "DFID": rc = %d\n",
666                        PFID(&dt->do_lu.lo_header->loh_fid), rc);
667
668                 if (rc != 0)
669                         RETURN(rc);
670
671                 /* Update the OSP object attributes cache. */
672                 la = &o->opo_attr;
673                 spin_lock(&o->opo_lock);
674                 if (attr->la_valid & LA_UID) {
675                         la->la_uid = attr->la_uid;
676                         la->la_valid |= LA_UID;
677                 }
678
679                 if (attr->la_valid & LA_GID) {
680                         la->la_gid = attr->la_gid;
681                         la->la_valid |= LA_GID;
682                 }
683                 spin_unlock(&o->opo_lock);
684         }
685
686         RETURN(rc);
687 }
688
689 /**
690  * Interpreter function for getting OSP object extended attribute asynchronously
691  *
692  * Called to interpret the result of an async mode RPC for getting the
693  * OSP object extended attribute.
694  *
695  * \param[in] env       pointer to the thread context
696  * \param[in] reply     pointer to the RPC reply
697  * \param[in] req       pointer to the RPC request
698  * \param[in] obj       pointer to the OSP object
699  * \param[out] data     pointer to OSP object attributes cache
700  * \param[in] index     the index of the attribute buffer in the reply
701  * \param[in] rc        the result for handling the RPC
702  *
703  * \retval              0 for success
704  * \retval              negative error number on failure
705  */
706 static int osp_xattr_get_interpterer(const struct lu_env *env,
707                                      struct object_update_reply *reply,
708                                      struct ptlrpc_request *req,
709                                      struct osp_object *obj,
710                                      void *data, int index, int rc)
711 {
712         struct osp_xattr_entry  *oxe  = data;
713         struct lu_buf           *rbuf = &osp_env_info(env)->osi_lb2;
714
715         if (rc == 0) {
716                 size_t len = sizeof(*oxe) + oxe->oxe_namelen + 1;
717
718                 rc = object_update_result_data_get(reply, rbuf, index);
719                 if (rc < 0 || rbuf->lb_len > (oxe->oxe_buflen - len)) {
720                         spin_lock(&obj->opo_lock);
721                         oxe->oxe_ready = 0;
722                         spin_unlock(&obj->opo_lock);
723                         osp_oac_xattr_put(oxe);
724
725                         return rc < 0 ? rc : -ERANGE;
726                 }
727
728                 spin_lock(&obj->opo_lock);
729                 oxe->oxe_vallen = rbuf->lb_len;
730                 memcpy(oxe->oxe_value, rbuf->lb_buf, rbuf->lb_len);
731                 oxe->oxe_exist = 1;
732                 oxe->oxe_ready = 1;
733                 spin_unlock(&obj->opo_lock);
734         } else if (rc == -ENOENT || rc == -ENODATA) {
735                 spin_lock(&obj->opo_lock);
736                 oxe->oxe_exist = 0;
737                 oxe->oxe_ready = 1;
738                 spin_unlock(&obj->opo_lock);
739         } else {
740                 spin_lock(&obj->opo_lock);
741                 oxe->oxe_ready = 0;
742                 spin_unlock(&obj->opo_lock);
743         }
744
745         osp_oac_xattr_put(oxe);
746
747         return 0;
748 }
749
750 /**
751  * Implement OSP dt_object_operations::do_declare_xattr_get() interface.
752  *
753  * Declare that the caller will get extended attribute from the specified
754  * OST object.
755  *
756  * This function will add an OUT_XATTR_GET sub-request to the per OSP
757  * based shared asynchronous request queue with the interpreter function:
758  * osp_xattr_get_interpterer().
759  *
760  * \param[in] env       pointer to the thread context
761  * \param[in] dt        pointer to the OSP layer dt_object
762  * \param[out] buf      pointer to the lu_buf to hold the extended attribute
763  * \param[in] name      the name for the expected extended attribute
764  *
765  * \retval              0 for success
766  * \retval              negative error number on failure
767  */
768 static int osp_declare_xattr_get(const struct lu_env *env, struct dt_object *dt,
769                                  struct lu_buf *buf, const char *name)
770 {
771         struct osp_object       *obj     = dt2osp_obj(dt);
772         struct osp_device       *osp     = lu2osp_dev(dt->do_lu.lo_dev);
773         struct osp_xattr_entry  *oxe;
774         __u16                    namelen = strlen(name);
775         int                      rc      = 0;
776
777         LASSERT(buf != NULL);
778         LASSERT(name != NULL);
779
780         /* If only for xattr size, return directly. */
781         if (unlikely(buf->lb_len == 0))
782                 return 0;
783
784         oxe = osp_oac_xattr_find_or_add(obj, name, buf->lb_len);
785         if (oxe == NULL)
786                 return -ENOMEM;
787
788         mutex_lock(&osp->opd_async_requests_mutex);
789         rc = osp_insert_async_request(env, OUT_XATTR_GET, obj, 1,
790                                       &namelen, (const void **)&name,
791                                       oxe, buf->lb_len,
792                                       osp_xattr_get_interpterer);
793         if (rc != 0) {
794                 mutex_unlock(&osp->opd_async_requests_mutex);
795                 osp_oac_xattr_put(oxe);
796         } else {
797                 struct osp_update_request *our;
798                 struct osp_update_request_sub *ours;
799
800                 /* XXX: Currently, we trigger the batched async OUT
801                  *      RPC via dt_declare_xattr_get(). It is not
802                  *      perfect solution, but works well now.
803                  *
804                  *      We will improve it in the future. */
805                 our = osp->opd_async_requests;
806                 ours = osp_current_object_update_request(our);
807                 if (ours != NULL && ours->ours_req != NULL &&
808                     ours->ours_req->ourq_count > 0) {
809                         osp->opd_async_requests = NULL;
810                         mutex_unlock(&osp->opd_async_requests_mutex);
811                         rc = osp_unplug_async_request(env, osp, our);
812                 } else {
813                         mutex_unlock(&osp->opd_async_requests_mutex);
814                 }
815         }
816
817         return rc;
818 }
819
820 /**
821  * Implement OSP layer dt_object_operations::do_xattr_get() interface.
822  *
823  * Get extended attribute from the specified MDT/OST object.
824  *
825  * If the extended attribute is in the OSP object attributes cache, then
826  * return the cached extended attribute directly. Otherwise it will get
827  * the extended attribute synchronously, if successful, add it to the OSP
828  * attributes cache. (\see lustre/osp/osp_trans.c for OUT RPC.)
829  *
830  * There is a race condition: some other thread has added the named extended
831  * attributed entry to the OSP object attributes cache during the current
832  * OUT_XATTR_GET handling. If such case happens, the OSP will replace the
833  * (just) existing extended attribute entry with the new replied one.
834  *
835  * \param[in] env       pointer to the thread context
836  * \param[in] dt        pointer to the OSP layer dt_object
837  * \param[out] buf      pointer to the lu_buf to hold the extended attribute
838  * \param[in] name      the name for the expected extended attribute
839  *
840  * \retval              0 for success
841  * \retval              negative error number on failure
842  */
843 int osp_xattr_get(const struct lu_env *env, struct dt_object *dt,
844                   struct lu_buf *buf, const char *name)
845 {
846         struct osp_device       *osp    = lu2osp_dev(dt->do_lu.lo_dev);
847         struct osp_object       *obj    = dt2osp_obj(dt);
848         struct dt_device        *dev    = &osp->opd_dt_dev;
849         struct lu_buf           *rbuf   = &osp_env_info(env)->osi_lb2;
850         struct osp_update_request *update = NULL;
851         struct ptlrpc_request   *req    = NULL;
852         struct object_update_reply *reply;
853         struct osp_xattr_entry  *oxe    = NULL;
854         const char              *dname  = dt->do_lu.lo_dev->ld_obd->obd_name;
855         int                      rc     = 0;
856         ENTRY;
857
858         LASSERT(buf != NULL);
859         LASSERT(name != NULL);
860
861         if (OBD_FAIL_CHECK(OBD_FAIL_LFSCK_BAD_NETWORK) &&
862             osp->opd_index == cfs_fail_val) {
863                 if (is_ost_obj(&dt->do_lu)) {
864                         if (osp_dev2node(osp) == cfs_fail_val)
865                                 RETURN(-ENOTCONN);
866                 } else {
867                         if (strcmp(name, XATTR_NAME_LINK) == 0)
868                                 RETURN(-ENOTCONN);
869                 }
870         }
871
872         if (unlikely(obj->opo_non_exist))
873                 RETURN(-ENOENT);
874
875         oxe = osp_oac_xattr_find(obj, name, false);
876         if (oxe != NULL) {
877                 spin_lock(&obj->opo_lock);
878                 if (oxe->oxe_ready) {
879                         if (!oxe->oxe_exist)
880                                 GOTO(unlock, rc = -ENODATA);
881
882                         if (buf->lb_buf == NULL)
883                                 GOTO(unlock, rc = oxe->oxe_vallen);
884
885                         if (buf->lb_len < oxe->oxe_vallen)
886                                 GOTO(unlock, rc = -ERANGE);
887
888                         memcpy(buf->lb_buf, oxe->oxe_value,
889                                oxe->oxe_vallen);
890
891                         GOTO(unlock, rc = oxe->oxe_vallen);
892
893 unlock:
894                         spin_unlock(&obj->opo_lock);
895                         osp_oac_xattr_put(oxe);
896
897                         return rc;
898                 }
899                 spin_unlock(&obj->opo_lock);
900         }
901         update = osp_update_request_create(dev);
902         if (IS_ERR(update))
903                 GOTO(out, rc = PTR_ERR(update));
904
905         rc = osp_update_rpc_pack(env, xattr_get, update, OUT_XATTR_GET,
906                                  lu_object_fid(&dt->do_lu), name, buf->lb_len);
907         if (rc != 0) {
908                 CERROR("%s: Insert update error "DFID": rc = %d\n",
909                        dname, PFID(lu_object_fid(&dt->do_lu)), rc);
910                 GOTO(out, rc);
911         }
912
913         rc = osp_remote_sync(env, osp, update, &req);
914         if (rc < 0) {
915                 if (rc == -ENOENT) {
916                         dt->do_lu.lo_header->loh_attr &= ~LOHA_EXISTS;
917                         obj->opo_non_exist = 1;
918                 }
919
920                 if (oxe == NULL)
921                         oxe = osp_oac_xattr_find_or_add(obj, name, buf->lb_len);
922
923                 if (oxe == NULL) {
924                         CWARN("%s: Fail to add xattr (%s) to cache for "
925                               DFID" (1): rc = %d\n", dname, name,
926                               PFID(lu_object_fid(&dt->do_lu)), rc);
927
928                         GOTO(out, rc);
929                 }
930
931                 spin_lock(&obj->opo_lock);
932                 if (rc == -ENOENT || rc == -ENODATA) {
933                         oxe->oxe_exist = 0;
934                         oxe->oxe_ready = 1;
935                 } else {
936                         oxe->oxe_ready = 0;
937                 }
938                 spin_unlock(&obj->opo_lock);
939
940                 GOTO(out, rc);
941         }
942
943         reply = req_capsule_server_sized_get(&req->rq_pill,
944                                              &RMF_OUT_UPDATE_REPLY,
945                                              OUT_UPDATE_REPLY_SIZE);
946         if (reply->ourp_magic != UPDATE_REPLY_MAGIC) {
947                 CERROR("%s: Wrong version %x expected %x "DFID": rc = %d\n",
948                        dname, reply->ourp_magic, UPDATE_REPLY_MAGIC,
949                        PFID(lu_object_fid(&dt->do_lu)), -EPROTO);
950
951                 GOTO(out, rc = -EPROTO);
952         }
953
954         rc = object_update_result_data_get(reply, rbuf, 0);
955         if (rc < 0)
956                 GOTO(out, rc);
957
958         if (buf->lb_buf == NULL)
959                 GOTO(out, rc);
960
961         if (unlikely(buf->lb_len < rbuf->lb_len))
962                 GOTO(out, rc = -ERANGE);
963
964         memcpy(buf->lb_buf, rbuf->lb_buf, rbuf->lb_len);
965
966         if (oxe == NULL) {
967                 oxe = osp_oac_xattr_find_or_add(obj, name, rbuf->lb_len);
968                 if (oxe == NULL) {
969                         CWARN("%s: Fail to add xattr (%s) to "
970                               "cache for "DFID" (2): rc = %d\n",
971                               dname, name, PFID(lu_object_fid(&dt->do_lu)), rc);
972
973                         GOTO(out, rc);
974                 }
975         }
976
977         if (oxe->oxe_buflen - oxe->oxe_namelen - 1 < rbuf->lb_len) {
978                 struct osp_xattr_entry *old = oxe;
979                 struct osp_xattr_entry *tmp;
980
981                 tmp = osp_oac_xattr_replace(obj, &old, rbuf->lb_len);
982                 osp_oac_xattr_put(oxe);
983                 oxe = tmp;
984                 if (tmp == NULL) {
985                         CWARN("%s: Fail to update xattr (%s) to "
986                               "cache for "DFID": rc = %d\n",
987                               dname, name, PFID(lu_object_fid(&dt->do_lu)), rc);
988                         spin_lock(&obj->opo_lock);
989                         old->oxe_ready = 0;
990                         spin_unlock(&obj->opo_lock);
991
992                         GOTO(out, rc);
993                 }
994
995                 /* Drop the ref for entry on list. */
996                 osp_oac_xattr_put(old);
997         }
998
999         spin_lock(&obj->opo_lock);
1000         oxe->oxe_vallen = rbuf->lb_len;
1001         memcpy(oxe->oxe_value, rbuf->lb_buf, rbuf->lb_len);
1002         oxe->oxe_exist = 1;
1003         oxe->oxe_ready = 1;
1004         spin_unlock(&obj->opo_lock);
1005
1006         GOTO(out, rc);
1007
1008 out:
1009         if (req != NULL)
1010                 ptlrpc_req_finished(req);
1011
1012         if (update != NULL && !IS_ERR(update))
1013                 osp_update_request_destroy(env, update);
1014
1015         if (oxe != NULL)
1016                 osp_oac_xattr_put(oxe);
1017
1018         return rc;
1019 }
1020
1021 /**
1022  * Implement OSP layer dt_object_operations::do_declare_xattr_set() interface.
1023  *
1024  * Declare that the caller will set extended attribute to the specified
1025  * MDT/OST object.
1026  *
1027  * If it is non-remote transaction, it will add an OUT_XATTR_SET sub-request
1028  * to the OUT RPC that will be flushed when the transaction start. And if the
1029  * OSP attributes cache is initialized, then check whether the name extended
1030  * attribute entry exists in the cache or not. If yes, replace it; otherwise,
1031  * add the extended attribute to the cache.
1032  *
1033  * \param[in] env       pointer to the thread context
1034  * \param[in] dt        pointer to the OSP layer dt_object
1035  * \param[in] buf       pointer to the lu_buf to hold the extended attribute
1036  * \param[in] name      the name of the extended attribute to be set
1037  * \param[in] flag      to indicate the detailed set operation: LU_XATTR_CREATE
1038  *                      or LU_XATTR_REPLACE or others
1039  * \param[in] th        pointer to the transaction handler
1040  *
1041  * \retval              0 for success
1042  * \retval              negative error number on failure
1043  */
1044 int osp_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
1045                           const struct lu_buf *buf, const char *name,
1046                           int flag, struct thandle *th)
1047 {
1048         return osp_trans_update_request_create(th);
1049 }
1050
1051 /**
1052  * Implement OSP layer dt_object_operations::do_xattr_set() interface.
1053  *
1054  * Set extended attribute to the specified MDT/OST object.
1055  *
1056  * Add an OUT_XATTR_SET sub-request into the OUT RPC that will be flushed in
1057  * the transaction stop. And if the OSP attributes cache is initialized, then
1058  * check whether the name extended attribute entry exists in the cache or not.
1059  * If yes, replace it; otherwise, add the extended attribute to the cache.
1060  *
1061  * \param[in] env       pointer to the thread context
1062  * \param[in] dt        pointer to the OSP layer dt_object
1063  * \param[in] buf       pointer to the lu_buf to hold the extended attribute
1064  * \param[in] name      the name of the extended attribute to be set
1065  * \param[in] fl        to indicate the detailed set operation: LU_XATTR_CREATE
1066  *                      or LU_XATTR_REPLACE or others
1067  * \param[in] th        pointer to the transaction handler
1068  *
1069  * \retval              0 for success
1070  * \retval              negative error number on failure
1071  */
1072 int osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
1073                   const struct lu_buf *buf, const char *name, int fl,
1074                   struct thandle *th)
1075 {
1076         struct osp_object       *o = dt2osp_obj(dt);
1077         struct osp_update_request *update;
1078         struct osp_xattr_entry  *oxe;
1079         int                     rc;
1080         ENTRY;
1081
1082         update = thandle_to_osp_update_request(th);
1083         LASSERT(update != NULL);
1084
1085         CDEBUG(D_INODE, DFID" set xattr '%s' with size %zd\n",
1086                PFID(lu_object_fid(&dt->do_lu)), name, buf->lb_len);
1087
1088         rc = osp_update_rpc_pack(env, xattr_set, update, OUT_XATTR_SET,
1089                                  lu_object_fid(&dt->do_lu), buf, name, fl);
1090         if (rc != 0)
1091                 RETURN(rc);
1092
1093         oxe = osp_oac_xattr_find_or_add(o, name, buf->lb_len);
1094         if (oxe == NULL) {
1095                 CWARN("%s: cannot cache xattr '%s' of "DFID"\n",
1096                       dt->do_lu.lo_dev->ld_obd->obd_name,
1097                       name, PFID(lu_object_fid(&dt->do_lu)));
1098
1099                 RETURN(0);
1100         }
1101
1102         if (oxe->oxe_buflen - oxe->oxe_namelen - 1 < buf->lb_len) {
1103                 struct osp_xattr_entry *old = oxe;
1104                 struct osp_xattr_entry *tmp;
1105
1106                 tmp = osp_oac_xattr_replace(o, &old, buf->lb_len);
1107                 osp_oac_xattr_put(oxe);
1108                 oxe = tmp;
1109                 if (tmp == NULL) {
1110                         CWARN("%s: cannot update cached xattr '%s' of "DFID"\n",
1111                               dt->do_lu.lo_dev->ld_obd->obd_name,
1112                               name, PFID(lu_object_fid(&dt->do_lu)));
1113                         spin_lock(&o->opo_lock);
1114                         old->oxe_ready = 0;
1115                         spin_unlock(&o->opo_lock);
1116
1117                         RETURN(0);
1118                 }
1119
1120                 /* Drop the ref for entry on list. */
1121                 osp_oac_xattr_put(old);
1122         }
1123
1124         spin_lock(&o->opo_lock);
1125         oxe->oxe_vallen = buf->lb_len;
1126         memcpy(oxe->oxe_value, buf->lb_buf, buf->lb_len);
1127         oxe->oxe_exist = 1;
1128         oxe->oxe_ready = 1;
1129         spin_unlock(&o->opo_lock);
1130         osp_oac_xattr_put(oxe);
1131
1132         RETURN(0);
1133 }
1134
1135 /**
1136  * Implement OSP layer dt_object_operations::do_declare_xattr_del() interface.
1137  *
1138  * Declare that the caller will delete extended attribute on the specified
1139  * MDT/OST object.
1140  *
1141  * If it is non-remote transaction, it will add an OUT_XATTR_DEL sub-request
1142  * to the OUT RPC that will be flushed when the transaction start. And if the
1143  * name extended attribute entry exists in the OSP attributes cache, then remove
1144  * it from the cache.
1145  *
1146  * \param[in] env       pointer to the thread context
1147  * \param[in] dt        pointer to the OSP layer dt_object
1148  * \param[in] name      the name of the extended attribute to be set
1149  * \param[in] th        pointer to the transaction handler
1150  *
1151  * \retval              0 for success
1152  * \retval              negative error number on failure
1153  */
1154 int osp_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
1155                           const char *name, struct thandle *th)
1156 {
1157         return osp_trans_update_request_create(th);
1158 }
1159
1160 /**
1161  * Implement OSP layer dt_object_operations::do_xattr_del() interface.
1162  *
1163  * Delete extended attribute on the specified MDT/OST object.
1164  *
1165  * If it is remote transaction, it will add an OUT_XATTR_DEL sub-request into
1166  * the OUT RPC that will be flushed when the transaction stop. And if the name
1167  * extended attribute entry exists in the OSP attributes cache, then remove it
1168  * from the cache.
1169  *
1170  * \param[in] env       pointer to the thread context
1171  * \param[in] dt        pointer to the OSP layer dt_object
1172  * \param[in] name      the name of the extended attribute to be set
1173  * \param[in] th        pointer to the transaction handler
1174  *
1175  * \retval              0 for success
1176  * \retval              negative error number on failure
1177  */
1178 int osp_xattr_del(const struct lu_env *env, struct dt_object *dt,
1179                   const char *name, struct thandle *th)
1180 {
1181         struct osp_update_request *update;
1182         const struct lu_fid      *fid = lu_object_fid(&dt->do_lu);
1183         struct osp_object        *o     = dt2osp_obj(dt);
1184         struct osp_xattr_entry   *oxe;
1185         int                       rc;
1186
1187         update = thandle_to_osp_update_request(th);
1188         LASSERT(update != NULL);
1189
1190         rc = osp_update_rpc_pack(env, xattr_del, update, OUT_XATTR_DEL,
1191                                  fid, name);
1192         if (rc != 0)
1193                 return rc;
1194
1195         oxe = osp_oac_xattr_find(o, name, true);
1196         if (oxe != NULL)
1197                 /* Drop the ref for entry on list. */
1198                 osp_oac_xattr_put(oxe);
1199
1200         return 0;
1201 }
1202
1203 void osp_obj_invalidate_cache(struct osp_object *obj)
1204 {
1205         struct osp_xattr_entry *oxe;
1206         struct osp_xattr_entry *tmp;
1207
1208         spin_lock(&obj->opo_lock);
1209         list_for_each_entry_safe(oxe, tmp, &obj->opo_xattr_list, oxe_list) {
1210                 oxe->oxe_ready = 0;
1211                 list_del_init(&oxe->oxe_list);
1212                 osp_oac_xattr_put(oxe);
1213         }
1214         obj->opo_attr.la_valid = 0;
1215         spin_unlock(&obj->opo_lock);
1216 }
1217
1218 /**
1219  * Implement OSP layer dt_object_operations::do_invalidate() interface.
1220  *
1221  * Invalidate attributes cached on the specified MDT/OST object.
1222  *
1223  * \param[in] env       pointer to the thread context
1224  * \param[in] dt        pointer to the OSP layer dt_object
1225  *
1226  * \retval              0 for success
1227  * \retval              negative error number on failure
1228  */
1229 int osp_invalidate(const struct lu_env *env, struct dt_object *dt)
1230 {
1231         struct osp_object *obj = dt2osp_obj(dt);
1232         ENTRY;
1233
1234         osp_obj_invalidate_cache(obj);
1235
1236         spin_lock(&obj->opo_lock);
1237         obj->opo_stale = 1;
1238         spin_unlock(&obj->opo_lock);
1239
1240         RETURN(0);
1241 }
1242
1243 /**
1244  * Implement OSP layer dt_object_operations::do_declare_create() interface.
1245  *
1246  * Declare that the caller will create the OST object.
1247  *
1248  * If the transaction is a remote transaction and the FID for the OST-object
1249  * has been assigned already, then handle it as creating (remote) MDT object
1250  * via osp_md_declare_object_create(). This function is usually used for LFSCK
1251  * to re-create the lost OST object. Otherwise, if it is not replay case, the
1252  * OSP will reserve pre-created object for the subsequent create operation;
1253  * if the MDT side cached pre-created objects are less than some threshold,
1254  * then it will wakeup the pre-create thread.
1255  *
1256  * \param[in] env       pointer to the thread context
1257  * \param[in] dt        pointer to the OSP layer dt_object
1258  * \param[in] attr      the attribute for the object to be created
1259  * \param[in] hint      pointer to the hint for creating the object, such as
1260  *                      the parent object
1261  * \param[in] dof       pointer to the dt_object_format for help the creation
1262  * \param[in] th        pointer to the transaction handler
1263  *
1264  * \retval              0 for success
1265  * \retval              negative error number on failure
1266  */
1267 static int osp_declare_object_create(const struct lu_env *env,
1268                                      struct dt_object *dt,
1269                                      struct lu_attr *attr,
1270                                      struct dt_allocation_hint *hint,
1271                                      struct dt_object_format *dof,
1272                                      struct thandle *th)
1273 {
1274         struct osp_thread_info  *osi = osp_env_info(env);
1275         struct osp_device       *d = lu2osp_dev(dt->do_lu.lo_dev);
1276         struct osp_object       *o = dt2osp_obj(dt);
1277         const struct lu_fid     *fid = lu_object_fid(&dt->do_lu);
1278         struct thandle          *local_th;
1279         int                      rc = 0;
1280
1281         ENTRY;
1282
1283         if (is_only_remote_trans(th) && !fid_is_zero(fid)) {
1284                 LASSERT(fid_is_sane(fid));
1285
1286                 rc = osp_md_declare_object_create(env, dt, attr, hint, dof, th);
1287
1288                 RETURN(rc);
1289         }
1290
1291         /* should happen to non-0 OSP only so that at least one object
1292          * has been already declared in the scenario and LOD should
1293          * cleanup that */
1294         if (OBD_FAIL_CHECK(OBD_FAIL_MDS_OSC_CREATE_FAIL) && d->opd_index == 1)
1295                 RETURN(-ENOSPC);
1296
1297         LASSERT(d->opd_last_used_oid_file);
1298
1299         /*
1300          * There can be gaps in precreated ids and record to unlink llog
1301          * XXX: we do not handle gaps yet, implemented before solution
1302          *      was found to be racy, so we disabled that. there is no
1303          *      point in making useless but expensive llog declaration.
1304          */
1305         /* rc = osp_sync_declare_add(env, o, MDS_UNLINK64_REC, th); */
1306
1307         local_th = osp_get_storage_thandle(env, th, d);
1308         if (IS_ERR(local_th))
1309                 RETURN(PTR_ERR(local_th));
1310
1311         if (unlikely(!fid_is_zero(fid))) {
1312                 /* replay case: caller knows fid */
1313                 osi->osi_off = sizeof(osi->osi_id) * d->opd_index;
1314                 osi->osi_lb.lb_len = sizeof(osi->osi_id);
1315                 osi->osi_lb.lb_buf = NULL;
1316
1317                 rc = dt_declare_record_write(env, d->opd_last_used_oid_file,
1318                                              &osi->osi_lb, osi->osi_off,
1319                                              local_th);
1320                 RETURN(rc);
1321         }
1322
1323         /*
1324          * in declaration we need to reserve object so that we don't block
1325          * awaiting precreation RPC to complete
1326          */
1327         rc = osp_precreate_reserve(env, d);
1328         /*
1329          * we also need to declare update to local "last used id" file for
1330          * recovery if object isn't used for a reason, we need to release
1331          * reservation, this can be made in osd_object_release()
1332          */
1333         if (rc == 0) {
1334                 /* mark id is reserved: in create we don't want to talk
1335                  * to OST */
1336                 LASSERT(o->opo_reserved == 0);
1337                 o->opo_reserved = 1;
1338
1339                 /* common for all OSPs file hystorically */
1340                 osi->osi_off = sizeof(osi->osi_id) * d->opd_index;
1341                 osi->osi_lb.lb_len = sizeof(osi->osi_id);
1342                 osi->osi_lb.lb_buf = NULL;
1343                 rc = dt_declare_record_write(env, d->opd_last_used_oid_file,
1344                                              &osi->osi_lb, osi->osi_off,
1345                                              local_th);
1346         } else {
1347                 /* not needed in the cache anymore */
1348                 set_bit(LU_OBJECT_HEARD_BANSHEE,
1349                             &dt->do_lu.lo_header->loh_flags);
1350         }
1351         RETURN(rc);
1352 }
1353
1354 /**
1355  * Implement OSP layer dt_object_operations::do_create() interface.
1356  *
1357  * Create the OST object.
1358  *
1359  * If the transaction is a remote transaction and the FID for the OST-object
1360  * has been assigned already, then handle it as handling MDT object via the
1361  * osp_md_object_create(). For other cases, the OSP will assign FID to the
1362  * object to be created, and update last_used Object ID (OID) file.
1363  *
1364  * \param[in] env       pointer to the thread context
1365  * \param[in] dt        pointer to the OSP layer dt_object
1366  * \param[in] attr      the attribute for the object to be created
1367  * \param[in] hint      pointer to the hint for creating the object, such as
1368  *                      the parent object
1369  * \param[in] dof       pointer to the dt_object_format for help the creation
1370  * \param[in] th        pointer to the transaction handler
1371  *
1372  * \retval              0 for success
1373  * \retval              negative error number on failure
1374  */
1375 static int osp_object_create(const struct lu_env *env, struct dt_object *dt,
1376                              struct lu_attr *attr,
1377                              struct dt_allocation_hint *hint,
1378                              struct dt_object_format *dof, struct thandle *th)
1379 {
1380         struct osp_thread_info  *osi = osp_env_info(env);
1381         struct osp_device       *d = lu2osp_dev(dt->do_lu.lo_dev);
1382         struct osp_object       *o = dt2osp_obj(dt);
1383         int                     rc = 0;
1384         struct lu_fid           *fid = &osi->osi_fid;
1385         struct thandle          *local_th;
1386         ENTRY;
1387
1388         if (is_only_remote_trans(th) &&
1389             !fid_is_zero(lu_object_fid(&dt->do_lu))) {
1390                 LASSERT(fid_is_sane(lu_object_fid(&dt->do_lu)));
1391
1392                 rc = osp_md_object_create(env, dt, attr, hint, dof, th);
1393                 if (rc == 0)
1394                         o->opo_non_exist = 0;
1395
1396                 RETURN(rc);
1397         }
1398
1399         o->opo_non_exist = 0;
1400         if (o->opo_reserved) {
1401                 /* regular case, fid is assigned holding transaction open */
1402                  osp_object_assign_fid(env, d, o);
1403         }
1404
1405         memcpy(fid, lu_object_fid(&dt->do_lu), sizeof(*fid));
1406
1407         LASSERTF(fid_is_sane(fid), "fid for osp_object %p is insane"DFID"!\n",
1408                  o, PFID(fid));
1409
1410         if (!o->opo_reserved) {
1411                 /* special case, id was assigned outside of transaction
1412                  * see comments in osp_declare_attr_set */
1413                 LASSERT(d->opd_pre != NULL);
1414                 spin_lock(&d->opd_pre_lock);
1415                 osp_update_last_fid(d, fid);
1416                 spin_unlock(&d->opd_pre_lock);
1417         }
1418
1419         CDEBUG(D_INODE, "fid for osp_object %p is "DFID"\n", o, PFID(fid));
1420
1421         /* If the precreate ends, it means it will be ready to rollover to
1422          * the new sequence soon, all the creation should be synchronized,
1423          * otherwise during replay, the replay fid will be inconsistent with
1424          * last_used/create fid */
1425         if (osp_precreate_end_seq(env, d) && osp_is_fid_client(d))
1426                 th->th_sync = 1;
1427
1428         local_th = osp_get_storage_thandle(env, th, d);
1429         if (IS_ERR(local_th))
1430                 RETURN(PTR_ERR(local_th));
1431         /*
1432          * it's OK if the import is inactive by this moment - id was created
1433          * by OST earlier, we just need to maintain it consistently on the disk
1434          * once import is reconnected, OSP will claim this and other objects
1435          * used and OST either keep them, if they exist or recreate
1436          */
1437
1438         /* we might have lost precreated objects */
1439         if (unlikely(d->opd_gap_count) > 0) {
1440                 LASSERT(d->opd_pre != NULL);
1441                 spin_lock(&d->opd_pre_lock);
1442                 if (d->opd_gap_count > 0) {
1443                         int count = d->opd_gap_count;
1444
1445                         ostid_set_id(&osi->osi_oi,
1446                                      fid_oid(&d->opd_gap_start_fid));
1447                         d->opd_gap_count = 0;
1448                         spin_unlock(&d->opd_pre_lock);
1449
1450                         CDEBUG(D_HA, "Writing gap "DFID"+%d in llog\n",
1451                                PFID(&d->opd_gap_start_fid), count);
1452                         /* real gap handling is disabled intil ORI-692 will be
1453                          * fixed, now we only report gaps */
1454                 } else {
1455                         spin_unlock(&d->opd_pre_lock);
1456                 }
1457         }
1458
1459         /* Only need update last_used oid file, seq file will only be update
1460          * during seq rollover */
1461         osp_objid_buf_prep(&osi->osi_lb, &osi->osi_off,
1462                            &d->opd_last_used_fid.f_oid, d->opd_index);
1463
1464         rc = dt_record_write(env, d->opd_last_used_oid_file, &osi->osi_lb,
1465                              &osi->osi_off, local_th);
1466
1467         CDEBUG(D_HA, "%s: Wrote last used FID: "DFID", index %d: %d\n",
1468                d->opd_obd->obd_name, PFID(fid), d->opd_index, rc);
1469
1470         RETURN(rc);
1471 }
1472
1473 /**
1474  * Implement OSP layer dt_object_operations::do_declare_destroy() interface.
1475  *
1476  * Declare that the caller will destroy the specified OST object.
1477  *
1478  * The OST object destroy will be handled via llog asynchronously. This
1479  * function will declare the credits for generating MDS_UNLINK64_REC llog.
1480  *
1481  * \param[in] env       pointer to the thread context
1482  * \param[in] dt        pointer to the OSP layer dt_object to be destroyed
1483  * \param[in] th        pointer to the transaction handler
1484  *
1485  * \retval              0 for success
1486  * \retval              negative error number on failure
1487  */
1488 int osp_declare_object_destroy(const struct lu_env *env,
1489                                struct dt_object *dt, struct thandle *th)
1490 {
1491         struct osp_object       *o = dt2osp_obj(dt);
1492         struct osp_device       *osp = lu2osp_dev(dt->do_lu.lo_dev);
1493         int                      rc = 0;
1494
1495         ENTRY;
1496
1497         LASSERT(!osp->opd_connect_mdt);
1498         rc = osp_sync_declare_add(env, o, MDS_UNLINK64_REC, th);
1499
1500         RETURN(rc);
1501 }
1502
1503 /**
1504  * Implement OSP layer dt_object_operations::do_destroy() interface.
1505  *
1506  * Destroy the specified OST object.
1507  *
1508  * The OSP generates a MDS_UNLINK64_REC record in the llog. There
1509  * will be some dedicated thread to handle the llog asynchronously.
1510  *
1511  * It also marks the object as non-cached.
1512  *
1513  * \param[in] env       pointer to the thread context
1514  * \param[in] dt        pointer to the OSP layer dt_object to be destroyed
1515  * \param[in] th        pointer to the transaction handler
1516  *
1517  * \retval              0 for success
1518  * \retval              negative error number on failure
1519  */
1520 static int osp_object_destroy(const struct lu_env *env, struct dt_object *dt,
1521                               struct thandle *th)
1522 {
1523         struct osp_object       *o = dt2osp_obj(dt);
1524         struct osp_device       *osp = lu2osp_dev(dt->do_lu.lo_dev);
1525         int                      rc = 0;
1526
1527         ENTRY;
1528
1529         o->opo_non_exist = 1;
1530
1531         LASSERT(!osp->opd_connect_mdt);
1532         /* once transaction is committed put proper command on
1533          * the queue going to our OST. */
1534         rc = osp_sync_add(env, o, MDS_UNLINK64_REC, th, NULL);
1535         if (rc < 0)
1536                 RETURN(rc);
1537
1538         /* not needed in cache any more */
1539         set_bit(LU_OBJECT_HEARD_BANSHEE, &dt->do_lu.lo_header->loh_flags);
1540
1541         RETURN(rc);
1542 }
1543
1544 static int osp_orphan_index_lookup(const struct lu_env *env,
1545                                    struct dt_object *dt,
1546                                    struct dt_rec *rec,
1547                                    const struct dt_key *key)
1548 {
1549         return -EOPNOTSUPP;
1550 }
1551
1552 static int osp_orphan_index_declare_insert(const struct lu_env *env,
1553                                            struct dt_object *dt,
1554                                            const struct dt_rec *rec,
1555                                            const struct dt_key *key,
1556                                            struct thandle *handle)
1557 {
1558         return -EOPNOTSUPP;
1559 }
1560
1561 static int osp_orphan_index_insert(const struct lu_env *env,
1562                                    struct dt_object *dt,
1563                                    const struct dt_rec *rec,
1564                                    const struct dt_key *key,
1565                                    struct thandle *handle,
1566                                    int ignore_quota)
1567 {
1568         return -EOPNOTSUPP;
1569 }
1570
1571 static int osp_orphan_index_declare_delete(const struct lu_env *env,
1572                                            struct dt_object *dt,
1573                                            const struct dt_key *key,
1574                                            struct thandle *handle)
1575 {
1576         return -EOPNOTSUPP;
1577 }
1578
1579 static int osp_orphan_index_delete(const struct lu_env *env,
1580                                    struct dt_object *dt,
1581                                    const struct dt_key *key,
1582                                    struct thandle *handle)
1583 {
1584         return -EOPNOTSUPP;
1585 }
1586
1587 /**
1588  * Initialize the OSP layer index iteration.
1589  *
1590  * \param[in] env       pointer to the thread context
1591  * \param[in] dt        pointer to the index object to be iterated
1592  * \param[in] attr      unused
1593  *
1594  * \retval              pointer to the iteration structure
1595  * \retval              negative error number on failure
1596  */
1597 struct dt_it *osp_it_init(const struct lu_env *env, struct dt_object *dt,
1598                           __u32 attr)
1599 {
1600         struct osp_it *it;
1601
1602         OBD_ALLOC_PTR(it);
1603         if (it == NULL)
1604                 return ERR_PTR(-ENOMEM);
1605
1606         it->ooi_pos_ent = -1;
1607         it->ooi_obj = dt;
1608         it->ooi_attr = attr;
1609
1610         return (struct dt_it *)it;
1611 }
1612
1613 /**
1614  * Finalize the OSP layer index iteration.
1615  *
1616  * \param[in] env       pointer to the thread context
1617  * \param[in] di        pointer to the iteration structure
1618  */
1619 void osp_it_fini(const struct lu_env *env, struct dt_it *di)
1620 {
1621         struct osp_it   *it = (struct osp_it *)di;
1622         struct page     **pages = it->ooi_pages;
1623         int             npages = it->ooi_total_npages;
1624         int             i;
1625
1626         if (pages != NULL) {
1627                 for (i = 0; i < npages; i++) {
1628                         if (pages[i] != NULL) {
1629                                 if (pages[i] == it->ooi_cur_page) {
1630                                         kunmap(pages[i]);
1631                                         it->ooi_cur_page = NULL;
1632                                 }
1633                                 __free_page(pages[i]);
1634                         }
1635                 }
1636                 OBD_FREE(pages, npages * sizeof(*pages));
1637         }
1638         OBD_FREE_PTR(it);
1639 }
1640
1641 /**
1642  * Get more records for the iteration from peer.
1643  *
1644  * The new records will be filled in an array of pages. The OSP side
1645  * allows 1MB bulk data to be transferred.
1646  *
1647  * \param[in] env       pointer to the thread context
1648  * \param[in] it        pointer to the iteration structure
1649  *
1650  * \retval              0 for success
1651  * \retval              negative error number on failure
1652  */
1653 static int osp_it_fetch(const struct lu_env *env, struct osp_it *it)
1654 {
1655         struct lu_device         *dev   = it->ooi_obj->do_lu.lo_dev;
1656         struct osp_device        *osp   = lu2osp_dev(dev);
1657         struct page             **pages;
1658         struct ptlrpc_request    *req   = NULL;
1659         struct ptlrpc_bulk_desc  *desc;
1660         struct idx_info          *ii;
1661         int                       npages;
1662         int                       rc;
1663         int                       i;
1664         ENTRY;
1665
1666         /* 1MB bulk */
1667         npages = min_t(unsigned int, OFD_MAX_BRW_SIZE, 1 << 20);
1668         npages /= PAGE_SIZE;
1669
1670         OBD_ALLOC(pages, npages * sizeof(*pages));
1671         if (pages == NULL)
1672                 RETURN(-ENOMEM);
1673
1674         it->ooi_pages = pages;
1675         it->ooi_total_npages = npages;
1676         for (i = 0; i < npages; i++) {
1677                 pages[i] = alloc_page(GFP_NOFS);
1678                 if (pages[i] == NULL)
1679                         RETURN(-ENOMEM);
1680         }
1681
1682         req = ptlrpc_request_alloc(osp->opd_obd->u.cli.cl_import,
1683                                    &RQF_OBD_IDX_READ);
1684         if (req == NULL)
1685                 RETURN(-ENOMEM);
1686
1687         rc = ptlrpc_request_pack(req, LUSTRE_OBD_VERSION, OBD_IDX_READ);
1688         if (rc != 0) {
1689                 ptlrpc_request_free(req);
1690                 RETURN(rc);
1691         }
1692
1693         osp_set_req_replay(osp, req);
1694         req->rq_request_portal = OUT_PORTAL;
1695         ii = req_capsule_client_get(&req->rq_pill, &RMF_IDX_INFO);
1696         memset(ii, 0, sizeof(*ii));
1697         if (fid_is_last_id(lu_object_fid(&it->ooi_obj->do_lu))) {
1698                 /* LFSCK will iterate orphan object[FID_SEQ_LAYOUT_BTREE,
1699                  * ost_index, 0] with LAST_ID FID, so it needs to replace
1700                  * the FID with orphan FID here */
1701                 ii->ii_fid.f_seq = FID_SEQ_LAYOUT_RBTREE;
1702                 ii->ii_fid.f_oid = osp->opd_index;
1703                 ii->ii_fid.f_ver = 0;
1704                 ii->ii_flags = II_FL_NOHASH;
1705                 ii->ii_attrs = osp_dev2node(osp);
1706         } else {
1707                 ii->ii_fid = *lu_object_fid(&it->ooi_obj->do_lu);
1708                 ii->ii_flags = II_FL_NOHASH | II_FL_NOKEY | II_FL_VARKEY |
1709                                II_FL_VARREC;
1710                 ii->ii_attrs = it->ooi_attr;
1711         }
1712         ii->ii_magic = IDX_INFO_MAGIC;
1713         ii->ii_count = npages * LU_PAGE_COUNT;
1714         ii->ii_hash_start = it->ooi_next;
1715
1716         ptlrpc_at_set_req_timeout(req);
1717
1718         desc = ptlrpc_prep_bulk_imp(req, npages, 1,
1719                                     PTLRPC_BULK_PUT_SINK | PTLRPC_BULK_BUF_KIOV,
1720                                     MDS_BULK_PORTAL,
1721                                     &ptlrpc_bulk_kiov_pin_ops);
1722         if (desc == NULL) {
1723                 ptlrpc_request_free(req);
1724                 RETURN(-ENOMEM);
1725         }
1726
1727         for (i = 0; i < npages; i++)
1728                 desc->bd_frag_ops->add_kiov_frag(desc, pages[i], 0,
1729                                                  PAGE_SIZE);
1730
1731         ptlrpc_request_set_replen(req);
1732         rc = ptlrpc_queue_wait(req);
1733         if (rc != 0)
1734                 GOTO(out, rc);
1735
1736         rc = sptlrpc_cli_unwrap_bulk_read(req, req->rq_bulk,
1737                                           req->rq_bulk->bd_nob_transferred);
1738         if (rc < 0)
1739                 GOTO(out, rc);
1740         rc = 0;
1741
1742         ii = req_capsule_server_get(&req->rq_pill, &RMF_IDX_INFO);
1743         if (ii->ii_magic != IDX_INFO_MAGIC)
1744                  GOTO(out, rc = -EPROTO);
1745
1746         npages = (ii->ii_count + LU_PAGE_COUNT - 1) >>
1747                  (PAGE_SHIFT - LU_PAGE_SHIFT);
1748         if (npages > it->ooi_total_npages) {
1749                 CERROR("%s: returned more pages than expected, %u > %u\n",
1750                        osp->opd_obd->obd_name, npages, it->ooi_total_npages);
1751                 GOTO(out, rc = -EINVAL);
1752         }
1753
1754         it->ooi_valid_npages = npages;
1755         if (ptlrpc_rep_need_swab(req))
1756                 it->ooi_swab = 1;
1757
1758         it->ooi_next = ii->ii_hash_end;
1759
1760 out:
1761         ptlrpc_req_finished(req);
1762
1763         return rc;
1764 }
1765
1766 /**
1767  * Move the iteration cursor to the next lu_page.
1768  *
1769  * One system page (PAGE_SIZE) may contain multiple lu_page (4KB),
1770  * that depends on the LU_PAGE_COUNT. If it is not the last lu_page
1771  * in current system page, then move the iteration cursor to the next
1772  * lu_page in current system page. Otherwise, if there are more system
1773  * pages in the cache, then move the iteration cursor to the next system
1774  * page. If all the cached records (pages) have been iterated, then fetch
1775  * more records via osp_it_fetch().
1776  *
1777  * \param[in] env       pointer to the thread context
1778  * \param[in] di        pointer to the iteration structure
1779  *
1780  * \retval              positive for end of the directory
1781  * \retval              0 for success
1782  * \retval              negative error number on failure
1783  */
1784 int osp_it_next_page(const struct lu_env *env, struct dt_it *di)
1785 {
1786         struct osp_it           *it = (struct osp_it *)di;
1787         struct lu_idxpage       *idxpage;
1788         struct page             **pages;
1789         int                     rc;
1790         int                     i;
1791         ENTRY;
1792
1793 again2:
1794         idxpage = it->ooi_cur_idxpage;
1795         if (idxpage != NULL) {
1796                 if (idxpage->lip_nr == 0)
1797                         RETURN(1);
1798
1799                 if (it->ooi_pos_ent < idxpage->lip_nr) {
1800                         CDEBUG(D_INFO, "ooi_pos %d nr %d\n",
1801                                (int)it->ooi_pos_ent, (int)idxpage->lip_nr);
1802                         RETURN(0);
1803                 }
1804                 it->ooi_cur_idxpage = NULL;
1805                 it->ooi_pos_lu_page++;
1806
1807 again1:
1808                 if (it->ooi_pos_lu_page < LU_PAGE_COUNT) {
1809                         it->ooi_cur_idxpage = (void *)it->ooi_cur_page +
1810                                          LU_PAGE_SIZE * it->ooi_pos_lu_page;
1811                         if (it->ooi_swab)
1812                                 lustre_swab_lip_header(it->ooi_cur_idxpage);
1813                         if (it->ooi_cur_idxpage->lip_magic != LIP_MAGIC) {
1814                                 struct osp_device *osp =
1815                                         lu2osp_dev(it->ooi_obj->do_lu.lo_dev);
1816
1817                                 CERROR("%s: invalid magic (%x != %x) for page "
1818                                        "%d/%d while read layout orphan index\n",
1819                                        osp->opd_obd->obd_name,
1820                                        it->ooi_cur_idxpage->lip_magic,
1821                                        LIP_MAGIC, it->ooi_pos_page,
1822                                        it->ooi_pos_lu_page);
1823                                 /* Skip this lu_page next time. */
1824                                 it->ooi_pos_ent = idxpage->lip_nr - 1;
1825                                 RETURN(-EINVAL);
1826                         }
1827                         it->ooi_pos_ent = -1;
1828                         goto again2;
1829                 }
1830
1831                 kunmap(it->ooi_cur_page);
1832                 it->ooi_cur_page = NULL;
1833                 it->ooi_pos_page++;
1834
1835 again0:
1836                 pages = it->ooi_pages;
1837                 if (it->ooi_pos_page < it->ooi_valid_npages) {
1838                         it->ooi_cur_page = kmap(pages[it->ooi_pos_page]);
1839                         it->ooi_pos_lu_page = 0;
1840                         goto again1;
1841                 }
1842
1843                 for (i = 0; i < it->ooi_total_npages; i++) {
1844                         if (pages[i] != NULL)
1845                                 __free_page(pages[i]);
1846                 }
1847                 OBD_FREE(pages, it->ooi_total_npages * sizeof(*pages));
1848
1849                 it->ooi_pos_page = 0;
1850                 it->ooi_total_npages = 0;
1851                 it->ooi_valid_npages = 0;
1852                 it->ooi_swab = 0;
1853                 it->ooi_ent = NULL;
1854                 it->ooi_cur_page = NULL;
1855                 it->ooi_cur_idxpage = NULL;
1856                 it->ooi_pages = NULL;
1857         }
1858
1859         if (it->ooi_next == II_END_OFF)
1860                 RETURN(1);
1861
1862         rc = osp_it_fetch(env, it);
1863         if (rc == 0)
1864                 goto again0;
1865
1866         RETURN(rc);
1867 }
1868
1869 /**
1870  * Move the iteration cursor to the next record.
1871  *
1872  * If there are more records in the lu_page, then move the iteration
1873  * cursor to the next record directly. Otherwise, move the iteration
1874  * cursor to the record in the next lu_page via osp_it_next_page()
1875  *
1876  * \param[in] env       pointer to the thread context
1877  * \param[in] di        pointer to the iteration structure
1878  *
1879  * \retval              positive for end of the directory
1880  * \retval              0 for success
1881  * \retval              negative error number on failure
1882  */
1883 static int osp_orphan_it_next(const struct lu_env *env, struct dt_it *di)
1884 {
1885         struct osp_it           *it = (struct osp_it *)di;
1886         struct lu_idxpage       *idxpage;
1887         int                     rc;
1888         ENTRY;
1889
1890 again:
1891         idxpage = it->ooi_cur_idxpage;
1892         if (idxpage != NULL) {
1893                 if (idxpage->lip_nr == 0)
1894                         RETURN(1);
1895
1896                 it->ooi_pos_ent++;
1897                 if (it->ooi_pos_ent < idxpage->lip_nr) {
1898                         it->ooi_ent =
1899                                 (struct lu_orphan_ent *)idxpage->lip_entries +
1900                                                         it->ooi_pos_ent;
1901                         if (it->ooi_swab)
1902                                 lustre_swab_orphan_ent(it->ooi_ent);
1903                         RETURN(0);
1904                 }
1905         }
1906
1907         rc = osp_it_next_page(env, di);
1908         if (rc == 0)
1909                 goto again;
1910
1911         RETURN(rc);
1912 }
1913
1914 int osp_it_get(const struct lu_env *env, struct dt_it *di,
1915                const struct dt_key *key)
1916 {
1917         return 1;
1918 }
1919
1920 void osp_it_put(const struct lu_env *env, struct dt_it *di)
1921 {
1922 }
1923
1924 static struct dt_key *osp_orphan_it_key(const struct lu_env *env,
1925                                         const struct dt_it *di)
1926 {
1927         struct osp_it   *it  = (struct osp_it *)di;
1928         struct lu_orphan_ent    *ent = (struct lu_orphan_ent *)it->ooi_ent;
1929
1930         if (likely(ent != NULL))
1931                 return (struct dt_key *)(&ent->loe_key);
1932
1933         return NULL;
1934 }
1935
1936 static int osp_orphan_it_key_size(const struct lu_env *env,
1937                                   const struct dt_it *di)
1938 {
1939         return sizeof(struct lu_fid);
1940 }
1941
1942 static int osp_orphan_it_rec(const struct lu_env *env, const struct dt_it *di,
1943                              struct dt_rec *rec, __u32 attr)
1944 {
1945         struct osp_it   *it  = (struct osp_it *)di;
1946         struct lu_orphan_ent    *ent = (struct lu_orphan_ent *)it->ooi_ent;
1947
1948         if (likely(ent != NULL)) {
1949                 *(struct lu_orphan_rec *)rec = ent->loe_rec;
1950                 return 0;
1951         }
1952
1953         return -EINVAL;
1954 }
1955
1956 __u64 osp_it_store(const struct lu_env *env, const struct dt_it *di)
1957 {
1958         struct osp_it   *it = (struct osp_it *)di;
1959
1960         return it->ooi_next;
1961 }
1962
1963 /**
1964  * Locate the iteration cursor to the specified position (cookie).
1965  *
1966  * \param[in] env       pointer to the thread context
1967  * \param[in] di        pointer to the iteration structure
1968  * \param[in] hash      the specified position
1969  *
1970  * \retval              positive number for locating to the exactly position
1971  *                      or the next
1972  * \retval              0 for arriving at the end of the iteration
1973  * \retval              negative error number on failure
1974  */
1975 int osp_orphan_it_load(const struct lu_env *env, const struct dt_it *di,
1976                        __u64 hash)
1977 {
1978         struct osp_it   *it     = (struct osp_it *)di;
1979         int              rc;
1980
1981         it->ooi_next = hash;
1982         rc = osp_orphan_it_next(env, (struct dt_it *)di);
1983         if (rc == 1)
1984                 return 0;
1985
1986         if (rc == 0)
1987                 return 1;
1988
1989         return rc;
1990 }
1991
1992 int osp_it_key_rec(const struct lu_env *env, const struct dt_it *di,
1993                    void *key_rec)
1994 {
1995         return 0;
1996 }
1997
1998 static const struct dt_index_operations osp_orphan_index_ops = {
1999         .dio_lookup             = osp_orphan_index_lookup,
2000         .dio_declare_insert     = osp_orphan_index_declare_insert,
2001         .dio_insert             = osp_orphan_index_insert,
2002         .dio_declare_delete     = osp_orphan_index_declare_delete,
2003         .dio_delete             = osp_orphan_index_delete,
2004         .dio_it = {
2005                 .init           = osp_it_init,
2006                 .fini           = osp_it_fini,
2007                 .next           = osp_orphan_it_next,
2008                 .get            = osp_it_get,
2009                 .put            = osp_it_put,
2010                 .key            = osp_orphan_it_key,
2011                 .key_size       = osp_orphan_it_key_size,
2012                 .rec            = osp_orphan_it_rec,
2013                 .store          = osp_it_store,
2014                 .load           = osp_orphan_it_load,
2015                 .key_rec        = osp_it_key_rec,
2016         }
2017 };
2018
2019 /**
2020  * Implement OSP layer dt_object_operations::do_index_try() interface.
2021  *
2022  * Negotiate the index type.
2023  *
2024  * If the target index is an IDIF object, then use osp_orphan_index_ops.
2025  * Otherwise, assign osp_md_index_ops to the dt_object::do_index_ops.
2026  * (\see lustre/include/lustre_fid.h for IDIF.)
2027  *
2028  * \param[in] env       pointer to the thread context
2029  * \param[in] dt        pointer to the OSP layer dt_object
2030  * \param[in] feat      unused
2031  *
2032  * \retval              0 for success
2033  */
2034 static int osp_index_try(const struct lu_env *env,
2035                          struct dt_object *dt,
2036                          const struct dt_index_features *feat)
2037 {
2038         const struct lu_fid *fid = lu_object_fid(&dt->do_lu);
2039
2040         if (fid_is_last_id(fid) && fid_is_idif(fid))
2041                 dt->do_index_ops = &osp_orphan_index_ops;
2042         else
2043                 dt->do_index_ops = &osp_md_index_ops;
2044         return 0;
2045 }
2046
2047 static struct dt_object_operations osp_obj_ops = {
2048         .do_declare_attr_get    = osp_declare_attr_get,
2049         .do_attr_get            = osp_attr_get,
2050         .do_declare_attr_set    = osp_declare_attr_set,
2051         .do_attr_set            = osp_attr_set,
2052         .do_declare_xattr_get   = osp_declare_xattr_get,
2053         .do_xattr_get           = osp_xattr_get,
2054         .do_declare_xattr_set   = osp_declare_xattr_set,
2055         .do_xattr_set           = osp_xattr_set,
2056         .do_declare_create      = osp_declare_object_create,
2057         .do_create              = osp_object_create,
2058         .do_declare_destroy     = osp_declare_object_destroy,
2059         .do_destroy             = osp_object_destroy,
2060         .do_index_try           = osp_index_try,
2061 };
2062
2063 /**
2064  * Implement OSP layer lu_object_operations::loo_object_init() interface.
2065  *
2066  * Initialize the object.
2067  *
2068  * If it is a remote MDT object, then call do_attr_get() to fetch
2069  * the attribute from the peer.
2070  *
2071  * \param[in] env       pointer to the thread context
2072  * \param[in] o         pointer to the OSP layer lu_object
2073  * \param[in] conf      unused
2074  *
2075  * \retval              0 for success
2076  * \retval              negative error number on failure
2077  */
2078 static int osp_object_init(const struct lu_env *env, struct lu_object *o,
2079                            const struct lu_object_conf *conf)
2080 {
2081         struct osp_object       *po = lu2osp_obj(o);
2082         int                     rc = 0;
2083         ENTRY;
2084
2085         spin_lock_init(&po->opo_lock);
2086         o->lo_header->loh_attr |= LOHA_REMOTE;
2087         INIT_LIST_HEAD(&po->opo_xattr_list);
2088         INIT_LIST_HEAD(&po->opo_invalidate_cb_list);
2089
2090         if (is_ost_obj(o)) {
2091                 po->opo_obj.do_ops = &osp_obj_ops;
2092         } else {
2093                 struct lu_attr *la = &osp_env_info(env)->osi_attr;
2094
2095                 po->opo_obj.do_ops = &osp_md_obj_ops;
2096                 po->opo_obj.do_body_ops = &osp_md_body_ops;
2097
2098                 if (conf != NULL && conf->loc_flags & LOC_F_NEW) {
2099                         po->opo_non_exist = 1;
2100                 } else {
2101                         rc = po->opo_obj.do_ops->do_attr_get(env, lu2dt_obj(o),
2102                                                              la);
2103                         if (rc == 0)
2104                                 o->lo_header->loh_attr |=
2105                                         LOHA_EXISTS | (la->la_mode & S_IFMT);
2106                         if (rc == -ENOENT) {
2107                                 po->opo_non_exist = 1;
2108                                 rc = 0;
2109                         }
2110                 }
2111                 init_rwsem(&po->opo_sem);
2112         }
2113         RETURN(rc);
2114 }
2115
2116 /**
2117  * Implement OSP layer lu_object_operations::loo_object_free() interface.
2118  *
2119  * Finalize the object.
2120  *
2121  * If the OSP object has attributes cache, then destroy the cache.
2122  * Free the object finally.
2123  *
2124  * \param[in] env       pointer to the thread context
2125  * \param[in] o         pointer to the OSP layer lu_object
2126  */
2127 static void osp_object_free(const struct lu_env *env, struct lu_object *o)
2128 {
2129         struct osp_object       *obj = lu2osp_obj(o);
2130         struct lu_object_header *h = o->lo_header;
2131         struct osp_xattr_entry *oxe;
2132         struct osp_xattr_entry *tmp;
2133         int                     count;
2134
2135         dt_object_fini(&obj->opo_obj);
2136         lu_object_header_fini(h);
2137         list_for_each_entry_safe(oxe, tmp, &obj->opo_xattr_list, oxe_list) {
2138                 list_del(&oxe->oxe_list);
2139                 count = atomic_read(&oxe->oxe_ref);
2140                 LASSERTF(count == 1,
2141                          "Still has %d users on the xattr entry %.*s\n",
2142                          count-1, (int)oxe->oxe_namelen, oxe->oxe_buf);
2143
2144                 OBD_FREE(oxe, oxe->oxe_buflen);
2145         }
2146         OBD_SLAB_FREE_PTR(obj, osp_object_kmem);
2147 }
2148
2149 /**
2150  * Implement OSP layer lu_object_operations::loo_object_release() interface.
2151  *
2152  * Cleanup (not free) the object.
2153  *
2154  * If it is a reserved object but failed to be created, or it is an OST
2155  * object, then mark the object as non-cached.
2156  *
2157  * \param[in] env       pointer to the thread context
2158  * \param[in] o         pointer to the OSP layer lu_object
2159  */
2160 static void osp_object_release(const struct lu_env *env, struct lu_object *o)
2161 {
2162         struct osp_object       *po = lu2osp_obj(o);
2163         struct osp_device       *d  = lu2osp_dev(o->lo_dev);
2164
2165         ENTRY;
2166
2167         /*
2168          * release reservation if object was declared but not created
2169          * this may require lu_object_put() in LOD
2170          */
2171         if (unlikely(po->opo_reserved)) {
2172                 LASSERT(d->opd_pre != NULL);
2173                 LASSERT(d->opd_pre_reserved > 0);
2174                 spin_lock(&d->opd_pre_lock);
2175                 d->opd_pre_reserved--;
2176                 spin_unlock(&d->opd_pre_lock);
2177
2178                 /* not needed in cache any more */
2179                 set_bit(LU_OBJECT_HEARD_BANSHEE, &o->lo_header->loh_flags);
2180         }
2181
2182         if (is_ost_obj(o))
2183                 /* XXX: Currently, NOT cache OST-object on MDT because:
2184                  *      1. it is not often accessed on MDT.
2185                  *      2. avoid up layer (such as LFSCK) to load too many
2186                  *         once-used OST-objects. */
2187                 set_bit(LU_OBJECT_HEARD_BANSHEE, &o->lo_header->loh_flags);
2188
2189         EXIT;
2190 }
2191
2192 static int osp_object_print(const struct lu_env *env, void *cookie,
2193                             lu_printer_t p, const struct lu_object *l)
2194 {
2195         const struct osp_object *o = lu2osp_obj((struct lu_object *)l);
2196
2197         return (*p)(env, cookie, LUSTRE_OSP_NAME"-object@%p", o);
2198 }
2199
2200 static int osp_object_invariant(const struct lu_object *o)
2201 {
2202         LBUG();
2203 }
2204
2205 struct lu_object_operations osp_lu_obj_ops = {
2206         .loo_object_init        = osp_object_init,
2207         .loo_object_free        = osp_object_free,
2208         .loo_object_release     = osp_object_release,
2209         .loo_object_print       = osp_object_print,
2210         .loo_object_invariant   = osp_object_invariant
2211 };