Whamcloud - gitweb
LU-10308 misc: update Intel copyright messages for 2017
[fs/lustre-release.git] / lustre / obdclass / llog_osd.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) 2003, 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  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32 /*
33  * lustre/obdclass/llog_osd.c
34  *
35  * Low level llog routines on top of OSD API
36  *
37  * This file provides set of methods for llog operations on top of
38  * dt_device. It contains all supported llog_operations interfaces and
39  * supplimental functions.
40  *
41  * Author: Alexey Zhuravlev <alexey.zhuravlev@intel.com>
42  * Author: Mikhail Pershin <mike.pershin@intel.com>
43  */
44
45 #define DEBUG_SUBSYSTEM S_LOG
46
47 #include <dt_object.h>
48 #include <llog_swab.h>
49 #include <lustre_fid.h>
50 #include <obd.h>
51 #include <obd_class.h>
52
53 #include "llog_internal.h"
54 #include "local_storage.h"
55
56 /**
57  * Implementation of the llog_operations::lop_declare_create
58  *
59  * This function is a wrapper over local_storage API function
60  * local_object_declare_create().
61  *
62  * \param[in] env       execution environment
63  * \param[in] los       local_storage for bottom storage device
64  * \param[in] o         dt_object to create
65  * \param[in] th        current transaction handle
66  *
67  * \retval              0 on successful declaration of the new object
68  * \retval              negative error if declaration was failed
69  */
70 static int llog_osd_declare_new_object(const struct lu_env *env,
71                                        struct local_oid_storage *los,
72                                        struct dt_object *o,
73                                        struct thandle *th)
74 {
75         struct llog_thread_info *lgi = llog_info(env);
76
77         lgi->lgi_attr.la_valid = LA_MODE;
78         lgi->lgi_attr.la_mode = S_IFREG | S_IRUGO | S_IWUSR;
79         lgi->lgi_dof.dof_type = dt_mode_to_dft(S_IFREG);
80
81         return local_object_declare_create(env, los, o, &lgi->lgi_attr,
82                                            &lgi->lgi_dof, th);
83 }
84
85 /**
86  * Implementation of the llog_operations::lop_create
87  *
88  * This function is a wrapper over local_storage API function
89  * local_object_create().
90  *
91  * \param[in] env       execution environment
92  * \param[in] los       local_storage for bottom storage device
93  * \param[in] o         dt_object to create
94  * \param[in] th        current transaction handle
95  *
96  * \retval              0 on successful creation of the new object
97  * \retval              negative error if creation was failed
98  */
99 static int llog_osd_create_new_object(const struct lu_env *env,
100                                       struct local_oid_storage *los,
101                                       struct dt_object *o,
102                                       struct thandle *th)
103 {
104         struct llog_thread_info *lgi = llog_info(env);
105
106         lgi->lgi_attr.la_valid = LA_MODE;
107         lgi->lgi_attr.la_mode = S_IFREG | S_IRUGO | S_IWUSR;
108         lgi->lgi_dof.dof_type = dt_mode_to_dft(S_IFREG);
109
110         return local_object_create(env, los, o, &lgi->lgi_attr,
111                                    &lgi->lgi_dof, th);
112 }
113
114 /**
115  * Implementation of the llog_operations::lop_exist
116  *
117  * This function checks that llog exists on storage.
118  *
119  * \param[in] handle    llog handle of the current llog
120  *
121  * \retval              true if llog object exists and is not just destroyed
122  * \retval              false if llog doesn't exist or just destroyed
123  */
124 static int llog_osd_exist(struct llog_handle *handle)
125 {
126         LASSERT(handle->lgh_obj);
127         return dt_object_exists(handle->lgh_obj) &&
128                 !lu_object_is_dying(handle->lgh_obj->do_lu.lo_header);
129 }
130
131 static void *rec_tail(struct llog_rec_hdr *rec)
132 {
133         return (void *)((char *)rec + rec->lrh_len -
134                         sizeof(struct llog_rec_tail));
135 }
136
137 /**
138  * Write a padding record to the llog
139  *
140  * This function writes a padding record to the end of llog. That may
141  * be needed if llog contains records of variable size, e.g. config logs
142  * or changelogs.
143  * The padding record just aligns llog to the llog chunk_size boundary if
144  * the current record doesn't fit in the remaining space.
145  *
146  * It allocates full length to avoid two separate writes for header and tail.
147  * Such 2-steps scheme needs extra protection and complex error handling.
148  *
149  * \param[in]     env   execution environment
150  * \param[in]     o     dt_object to create
151  * \param[in,out] off   pointer to the padding start offset
152  * \param[in]     len   padding length
153  * \param[in]     index index of the padding record in a llog
154  * \param[in]     th    current transaction handle
155  *
156  * \retval              0 on successful padding write
157  * \retval              negative error if write failed
158  */
159 static int llog_osd_pad(const struct lu_env *env, struct dt_object *o,
160                         loff_t *off, int len, int index, struct thandle *th)
161 {
162         struct llog_thread_info *lgi = llog_info(env);
163         struct llog_rec_hdr     *rec;
164         struct llog_rec_tail    *tail;
165         int                      rc;
166
167         ENTRY;
168
169         LASSERT(th);
170         LASSERT(off);
171         LASSERT(len >= LLOG_MIN_REC_SIZE && (len & 0x7) == 0);
172
173         OBD_ALLOC(rec, len);
174         if (rec == NULL)
175                 RETURN(-ENOMEM);
176
177         rec->lrh_len = len;
178         rec->lrh_index = index;
179         rec->lrh_type = LLOG_PAD_MAGIC;
180
181         tail = rec_tail(rec);
182         tail->lrt_len = len;
183         tail->lrt_index = index;
184
185         lgi->lgi_buf.lb_buf = rec;
186         lgi->lgi_buf.lb_len = len;
187         rc = dt_record_write(env, o, &lgi->lgi_buf, off, th);
188         if (rc)
189                 CERROR("%s: error writing padding record: rc = %d\n",
190                        o->do_lu.lo_dev->ld_obd->obd_name, rc);
191
192         OBD_FREE(rec, len);
193         RETURN(rc);
194 }
195
196 /**
197  * Implementation of the llog_operations::lop_read_header
198  *
199  * This function reads the current llog header from the bottom storage
200  * device.
201  *
202  * \param[in] env       execution environment
203  * \param[in] handle    llog handle of the current llog
204  *
205  * \retval              0 on successful header read
206  * \retval              negative error if read failed
207  */
208 static int llog_osd_read_header(const struct lu_env *env,
209                                 struct llog_handle *handle)
210 {
211         struct llog_rec_hdr     *llh_hdr;
212         struct dt_object        *o;
213         struct llog_thread_info *lgi;
214         enum llog_flag           flags;
215         int                      rc;
216
217         ENTRY;
218
219         o = handle->lgh_obj;
220         LASSERT(o);
221
222         lgi = llog_info(env);
223
224         rc = dt_attr_get(env, o, &lgi->lgi_attr);
225         if (rc)
226                 RETURN(rc);
227
228         LASSERT(lgi->lgi_attr.la_valid & LA_SIZE);
229
230         if (lgi->lgi_attr.la_size == 0) {
231                 CDEBUG(D_HA, "not reading header from 0-byte log\n");
232                 RETURN(LLOG_EEMPTY);
233         }
234
235         flags = handle->lgh_hdr->llh_flags;
236
237         lgi->lgi_off = 0;
238         lgi->lgi_buf.lb_buf = handle->lgh_hdr;
239         lgi->lgi_buf.lb_len = handle->lgh_hdr_size;
240         rc = dt_read(env, o, &lgi->lgi_buf, &lgi->lgi_off);
241         llh_hdr = &handle->lgh_hdr->llh_hdr;
242         if (rc < sizeof(*llh_hdr) || rc < llh_hdr->lrh_len) {
243                 CERROR("%s: error reading "DFID" log header size %d: rc = %d\n",
244                        o->do_lu.lo_dev->ld_obd->obd_name,
245                        PFID(lu_object_fid(&o->do_lu)), rc < 0 ? 0 : rc,
246                        -EFAULT);
247
248                 if (rc >= 0)
249                         rc = -EFAULT;
250
251                 RETURN(rc);
252         }
253
254         if (LLOG_REC_HDR_NEEDS_SWABBING(llh_hdr))
255                 lustre_swab_llog_hdr(handle->lgh_hdr);
256
257         if (llh_hdr->lrh_type != LLOG_HDR_MAGIC) {
258                 CERROR("%s: bad log %s "DFID" header magic: %#x "
259                        "(expected %#x)\n", o->do_lu.lo_dev->ld_obd->obd_name,
260                        handle->lgh_name ? handle->lgh_name : "",
261                        PFID(lu_object_fid(&o->do_lu)),
262                        llh_hdr->lrh_type, LLOG_HDR_MAGIC);
263                 RETURN(-EIO);
264         } else if (llh_hdr->lrh_len < LLOG_MIN_CHUNK_SIZE ||
265                    llh_hdr->lrh_len > handle->lgh_hdr_size) {
266                 CERROR("%s: incorrectly sized log %s "DFID" header: "
267                        "%#x (expected at least %#x)\n"
268                        "you may need to re-run lconf --write_conf.\n",
269                        o->do_lu.lo_dev->ld_obd->obd_name,
270                        handle->lgh_name ? handle->lgh_name : "",
271                        PFID(lu_object_fid(&o->do_lu)),
272                        llh_hdr->lrh_len, LLOG_MIN_CHUNK_SIZE);
273                 RETURN(-EIO);
274         } else if (LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_index >
275                    LLOG_HDR_BITMAP_SIZE(handle->lgh_hdr) ||
276                    LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_len !=
277                         llh_hdr->lrh_len) {
278                 CERROR("%s: incorrectly sized log %s "DFID" tailer: "
279                        "%#x : rc = %d\n",
280                        o->do_lu.lo_dev->ld_obd->obd_name,
281                        handle->lgh_name ? handle->lgh_name : "",
282                        PFID(lu_object_fid(&o->do_lu)),
283                        LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_len, -EIO);
284                 RETURN(-EIO);
285         }
286
287         handle->lgh_hdr->llh_flags |= (flags & LLOG_F_EXT_MASK);
288         handle->lgh_last_idx = LLOG_HDR_TAIL(handle->lgh_hdr)->lrt_index;
289
290         RETURN(0);
291 }
292
293 /**
294  * Implementation of the llog_operations::lop_declare_write
295  *
296  * This function declares the new record write.
297  *
298  * \param[in] env       execution environment
299  * \param[in] loghandle llog handle of the current llog
300  * \param[in] rec       llog record header. This is a real header of the full
301  *                      llog record to write. This is the beginning of buffer
302  *                      to write, the length of buffer is stored in
303  *                      \a rec::lrh_len
304  * \param[in] idx       index of the llog record. If \a idx == -1 then this is
305  *                      append case, otherwise \a idx is the index of record
306  *                      to modify
307  * \param[in] th        current transaction handle
308  *
309  * \retval              0 on successful declaration
310  * \retval              negative error if declaration failed
311  */
312 static int llog_osd_declare_write_rec(const struct lu_env *env,
313                                       struct llog_handle *loghandle,
314                                       struct llog_rec_hdr *rec,
315                                       int idx, struct thandle *th)
316 {
317         struct llog_thread_info *lgi = llog_info(env);
318         __u32                   chunk_size;
319         struct dt_object        *o;
320         int                      rc;
321
322         ENTRY;
323
324         LASSERT(env);
325         LASSERT(th);
326         LASSERT(loghandle);
327         LASSERT(rec);
328         LASSERT(rec->lrh_len <= loghandle->lgh_ctxt->loc_chunk_size);
329
330         o = loghandle->lgh_obj;
331         LASSERT(o);
332
333         chunk_size = loghandle->lgh_ctxt->loc_chunk_size;
334         lgi->lgi_buf.lb_len = chunk_size;
335         lgi->lgi_buf.lb_buf = NULL;
336         /* each time we update header */
337         rc = dt_declare_record_write(env, o, &lgi->lgi_buf, 0,
338                                      th);
339         if (rc || idx == 0) /* if error or just header */
340                 RETURN(rc);
341
342         /**
343          * the pad record can be inserted so take into account double
344          * record size
345          */
346         lgi->lgi_buf.lb_len = chunk_size * 2;
347         lgi->lgi_buf.lb_buf = NULL;
348         /* XXX: implement declared window or multi-chunks approach */
349         rc = dt_declare_record_write(env, o, &lgi->lgi_buf, -1, th);
350
351         RETURN(rc);
352 }
353
354 /**
355  * Implementation of the llog_operations::lop_write
356  *
357  * This function writes the new record in the llog or modify the existed one.
358  *
359  * \param[in]  env              execution environment
360  * \param[in]  loghandle        llog handle of the current llog
361  * \param[in]  rec              llog record header. This is a real header of
362  *                              the full llog record to write. This is
363  *                              the beginning of buffer to write, the length
364  *                              of buffer is stored in \a rec::lrh_len
365  * \param[in,out] reccookie     pointer to the cookie to return back if needed.
366  *                              It is used for further cancel of this llog
367  *                              record.
368  * \param[in]  idx              index of the llog record. If \a idx == -1 then
369  *                              this is append case, otherwise \a idx is
370  *                              the index of record to modify
371  * \param[in]  th               current transaction handle
372  *
373  * \retval                      0 on successful write && \a reccookie == NULL
374  *                              1 on successful write && \a reccookie != NULL
375  * \retval                      negative error if write failed
376  */
377 static int llog_osd_write_rec(const struct lu_env *env,
378                               struct llog_handle *loghandle,
379                               struct llog_rec_hdr *rec,
380                               struct llog_cookie *reccookie,
381                               int idx, struct thandle *th)
382 {
383         struct llog_thread_info *lgi = llog_info(env);
384         struct llog_log_hdr     *llh;
385         int                      reclen = rec->lrh_len;
386         int                      index, rc;
387         struct llog_rec_tail    *lrt;
388         struct dt_object        *o;
389         __u32                   chunk_size;
390         size_t                   left;
391         __u32                   orig_last_idx;
392         ENTRY;
393
394         llh = loghandle->lgh_hdr;
395         o = loghandle->lgh_obj;
396
397         chunk_size = llh->llh_hdr.lrh_len;
398         CDEBUG(D_OTHER, "new record %x to "DFID"\n",
399                rec->lrh_type, PFID(lu_object_fid(&o->do_lu)));
400
401         if (!llog_osd_exist(loghandle))
402                 RETURN(-ENOENT);
403
404         /* record length should not bigger than  */
405         if (reclen > loghandle->lgh_hdr->llh_hdr.lrh_len)
406                 RETURN(-E2BIG);
407
408         /* sanity check for fixed-records llog */
409         if (idx != LLOG_HEADER_IDX && (llh->llh_flags & LLOG_F_IS_FIXSIZE)) {
410                 LASSERT(llh->llh_size != 0);
411                 LASSERT(llh->llh_size == reclen);
412         }
413
414         rc = dt_attr_get(env, o, &lgi->lgi_attr);
415         if (rc)
416                 RETURN(rc);
417
418         /**
419          * The modification case.
420          * If idx set then the record with that index must be modified.
421          * There are three cases possible:
422          * 1) the common case is the llog header update (idx == 0)
423          * 2) the llog record modification during llog process.
424          *    This is indicated by the \a loghandle::lgh_cur_idx > 0.
425          *    In that case the \a loghandle::lgh_cur_offset
426          * 3) otherwise this is assumed that llog consist of records of
427          *    fixed size, i.e. catalog. The llog header must has llh_size
428          *    field equal to record size. The record offset is calculated
429          *    just by /a idx value
430          *
431          * During modification we don't need extra header update because
432          * the bitmap and record count are not changed. The record header
433          * and tail remains the same too.
434          */
435         if (idx != LLOG_NEXT_IDX) {
436                 /* llog can be empty only when first record is being written */
437                 LASSERT(ergo(idx > 0, lgi->lgi_attr.la_size > 0));
438
439                 if (!ext2_test_bit(idx, LLOG_HDR_BITMAP(llh))) {
440                         CERROR("%s: modify unset record %u\n",
441                                o->do_lu.lo_dev->ld_obd->obd_name, idx);
442                         RETURN(-ENOENT);
443                 }
444
445                 if (idx != rec->lrh_index) {
446                         CERROR("%s: modify index mismatch %d %u\n",
447                                o->do_lu.lo_dev->ld_obd->obd_name, idx,
448                                rec->lrh_index);
449                         RETURN(-EFAULT);
450                 }
451
452                 if (idx == LLOG_HEADER_IDX) {
453                         /* llog header update */
454                         __u32   *bitmap = LLOG_HDR_BITMAP(llh);
455
456                         lgi->lgi_off = 0;
457
458                         /* If it does not indicate the bitmap index
459                          * (reccookie == NULL), then it means update
460                          * the whole update header. Otherwise only
461                          * update header and bits needs to be updated,
462                          * and in DNE cases, it will signaficantly
463                          * shrink the RPC size.
464                          * see distribute_txn_cancel_records()*/
465                         if (reccookie == NULL) {
466                                 lgi->lgi_buf.lb_len = reclen;
467                                 lgi->lgi_buf.lb_buf = rec;
468                                 rc = dt_record_write(env, o, &lgi->lgi_buf,
469                                                      &lgi->lgi_off, th);
470                                 RETURN(rc);
471                         }
472
473                         /* update the header */
474                         lgi->lgi_buf.lb_len = llh->llh_bitmap_offset;
475                         lgi->lgi_buf.lb_buf = llh;
476                         rc = dt_record_write(env, o, &lgi->lgi_buf,
477                                              &lgi->lgi_off, th);
478                         if (rc != 0)
479                                 RETURN(rc);
480
481                         /* update the bitmap */
482                         index = reccookie->lgc_index;
483                         lgi->lgi_off = llh->llh_bitmap_offset +
484                                       (index / (sizeof(*bitmap) * 8)) *
485                                                         sizeof(*bitmap);
486                         lgi->lgi_buf.lb_len = sizeof(*bitmap);
487                         lgi->lgi_buf.lb_buf =
488                                         &bitmap[index/(sizeof(*bitmap)*8)];
489                         rc = dt_record_write(env, o, &lgi->lgi_buf,
490                                              &lgi->lgi_off, th);
491
492                         RETURN(rc);
493                 } else if (llh->llh_flags & LLOG_F_IS_FIXSIZE) {
494                         lgi->lgi_off = llh->llh_hdr.lrh_len +
495                                        (idx - 1) * reclen;
496                 } else if (reccookie != NULL && reccookie->lgc_index > 0) {
497                         /**
498                          * The lgc_offset can be used only if index is
499                          * the same.
500                          */
501                         if (idx != reccookie->lgc_index) {
502                                 CERROR("%s: modify index mismatch %d %d\n",
503                                        o->do_lu.lo_dev->ld_obd->obd_name, idx,
504                                        reccookie->lgc_index);
505                                 RETURN(-EFAULT);
506                         }
507
508                         lgi->lgi_off = reccookie->lgc_offset;
509                         CDEBUG(D_OTHER, "modify record "DFID": idx:%u, "
510                                "len:%u offset %llu\n",
511                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid), idx,
512                                rec->lrh_len, (long long)lgi->lgi_off);
513                 } else {
514                         /* This can be result of lgh_cur_idx is not set during
515                          * llog processing or llh_size is not set to proper
516                          * record size for fixed records llog. Therefore it is
517                          * impossible to get record offset. */
518                         CERROR("%s: can't get record offset, idx:%d, "
519                                "len:%u.\n", o->do_lu.lo_dev->ld_obd->obd_name,
520                                idx, rec->lrh_len);
521                         RETURN(-EFAULT);
522                 }
523
524                 /* update only data, header and tail remain the same */
525                 lgi->lgi_off += sizeof(struct llog_rec_hdr);
526                 lgi->lgi_buf.lb_len = REC_DATA_LEN(rec);
527                 lgi->lgi_buf.lb_buf = REC_DATA(rec);
528                 rc = dt_record_write(env, o, &lgi->lgi_buf, &lgi->lgi_off, th);
529                 if (rc == 0 && reccookie) {
530                         reccookie->lgc_lgl = loghandle->lgh_id;
531                         reccookie->lgc_index = idx;
532                         rc = 1;
533                 }
534                 RETURN(rc);
535         }
536
537         /**
538          * The append case.
539          * The most common case of using llog. The new index is assigned to
540          * the new record, new bit is set in llog bitmap and llog count is
541          * incremented.
542          *
543          * Make sure that records don't cross a chunk boundary, so we can
544          * process them page-at-a-time if needed.  If it will cross a chunk
545          * boundary, write in a fake (but referenced) entry to pad the chunk.
546          */
547
548
549         /* simulate ENOSPC when new plain llog is being added to the
550          * catalog */
551         if (OBD_FAIL_CHECK(OBD_FAIL_MDS_LLOG_CREATE_FAILED2) &&
552             llh->llh_flags & LLOG_F_IS_CAT)
553                 RETURN(-ENOSPC);
554
555         LASSERT(lgi->lgi_attr.la_valid & LA_SIZE);
556         orig_last_idx = loghandle->lgh_last_idx;
557         lgi->lgi_off = lgi->lgi_attr.la_size;
558
559         if (loghandle->lgh_max_size > 0 &&
560             lgi->lgi_off >= loghandle->lgh_max_size) {
561                 CDEBUG(D_OTHER, "llog is getting too large (%u > %u) at %u "
562                        DFID"\n", (unsigned)lgi->lgi_off,
563                        loghandle->lgh_max_size, (int)loghandle->lgh_last_idx,
564                        PFID(&loghandle->lgh_id.lgl_oi.oi_fid));
565                 /* this is to signal that this llog is full */
566                 loghandle->lgh_last_idx = LLOG_HDR_BITMAP_SIZE(llh) - 1;
567                 RETURN(-ENOSPC);
568         }
569
570         left = chunk_size - (lgi->lgi_off & (chunk_size - 1));
571         /* NOTE: padding is a record, but no bit is set */
572         if (left != 0 && left != reclen &&
573             left < (reclen + LLOG_MIN_REC_SIZE)) {
574                 index = loghandle->lgh_last_idx + 1;
575                 rc = llog_osd_pad(env, o, &lgi->lgi_off, left, index, th);
576                 if (rc)
577                         RETURN(rc);
578
579                 loghandle->lgh_last_idx++; /* for pad rec */
580         }
581         /* if it's the last idx in log file, then return -ENOSPC
582          * or wrap around if a catalog */
583         if (llog_is_full(loghandle) ||
584             unlikely(llh->llh_flags & LLOG_F_IS_CAT &&
585                      OBD_FAIL_PRECHECK(OBD_FAIL_CAT_RECORDS) &&
586                      loghandle->lgh_last_idx >= cfs_fail_val)) {
587                 if (llh->llh_flags & LLOG_F_IS_CAT)
588                         loghandle->lgh_last_idx = 0;
589                 else
590                         RETURN(-ENOSPC);
591         }
592
593         /* increment the last_idx along with llh_tail index, they should
594          * be equal for a llog lifetime */
595         loghandle->lgh_last_idx++;
596         index = loghandle->lgh_last_idx;
597         LLOG_HDR_TAIL(llh)->lrt_index = index;
598         /**
599          * NB: the caller should make sure only 1 process access
600          * the lgh_last_idx, e.g. append should be exclusive.
601          * Otherwise it might hit the assert.
602          */
603         LASSERT(index < LLOG_HDR_BITMAP_SIZE(llh));
604         rec->lrh_index = index;
605         lrt = rec_tail(rec);
606         lrt->lrt_len = rec->lrh_len;
607         lrt->lrt_index = rec->lrh_index;
608
609         /* the lgh_hdr_mutex protects llog header data from concurrent
610          * update/cancel, the llh_count and llh_bitmap are protected */
611         mutex_lock(&loghandle->lgh_hdr_mutex);
612         if (ext2_set_bit(index, LLOG_HDR_BITMAP(llh))) {
613                 CERROR("%s: index %u already set in log bitmap\n",
614                        o->do_lu.lo_dev->ld_obd->obd_name, index);
615                 mutex_unlock(&loghandle->lgh_hdr_mutex);
616                 LBUG(); /* should never happen */
617         }
618         llh->llh_count++;
619
620         if (!(llh->llh_flags & LLOG_F_IS_FIXSIZE)) {
621                 /* Update the minimum size of the llog record */
622                 if (llh->llh_size == 0)
623                         llh->llh_size = reclen;
624                 else if (reclen < llh->llh_size)
625                         llh->llh_size = reclen;
626         }
627
628         if (lgi->lgi_attr.la_size == 0) {
629                 lgi->lgi_off = 0;
630                 lgi->lgi_buf.lb_len = llh->llh_hdr.lrh_len;
631                 lgi->lgi_buf.lb_buf = &llh->llh_hdr;
632                 rc = dt_record_write(env, o, &lgi->lgi_buf, &lgi->lgi_off, th);
633                 if (rc != 0)
634                         GOTO(out_unlock, rc);
635         } else {
636                 __u32   *bitmap = LLOG_HDR_BITMAP(llh);
637
638                 /* Note: If this is not initialization (size == 0), then do not
639                  * write the whole header (8k bytes), only update header/tail
640                  * and bits needs to be updated. Because this update might be
641                  * part of cross-MDT operation, which needs to write these
642                  * updates into the update log(32KB limit) and also pack inside
643                  * the RPC (1MB limit), if we write 8K for each operation, which
644                  * will cost a lot space, and keep us adding more updates to one
645                  * update log.*/
646                 lgi->lgi_off = 0;
647                 lgi->lgi_buf.lb_len = llh->llh_bitmap_offset;
648                 lgi->lgi_buf.lb_buf = &llh->llh_hdr;
649                 rc = dt_record_write(env, o, &lgi->lgi_buf, &lgi->lgi_off, th);
650                 if (rc != 0)
651                         GOTO(out_unlock, rc);
652
653                 lgi->lgi_off = llh->llh_bitmap_offset +
654                               (index / (sizeof(*bitmap) * 8)) * sizeof(*bitmap);
655                 lgi->lgi_buf.lb_len = sizeof(*bitmap);
656                 lgi->lgi_buf.lb_buf = &bitmap[index/(sizeof(*bitmap)*8)];
657                 rc = dt_record_write(env, o, &lgi->lgi_buf, &lgi->lgi_off, th);
658                 if (rc != 0)
659                         GOTO(out_unlock, rc);
660
661                 lgi->lgi_off =  (unsigned long)LLOG_HDR_TAIL(llh) -
662                                 (unsigned long)llh;
663                 lgi->lgi_buf.lb_len = sizeof(llh->llh_tail);
664                 lgi->lgi_buf.lb_buf = LLOG_HDR_TAIL(llh);
665                 rc = dt_record_write(env, o, &lgi->lgi_buf, &lgi->lgi_off, th);
666                 if (rc != 0)
667                         GOTO(out_unlock, rc);
668         }
669
670 out_unlock:
671         /* unlock here for remote object */
672         mutex_unlock(&loghandle->lgh_hdr_mutex);
673         if (rc)
674                 GOTO(out, rc);
675
676         /* computed index can be used to determine offset for fixed-size
677          * records. This also allows to handle Catalog wrap around case */
678         if (llh->llh_flags & LLOG_F_IS_FIXSIZE) {
679                 lgi->lgi_off = llh->llh_hdr.lrh_len + (index - 1) * reclen;
680         } else {
681                 rc = dt_attr_get(env, o, &lgi->lgi_attr);
682                 if (rc)
683                         GOTO(out, rc);
684
685                 LASSERT(lgi->lgi_attr.la_valid & LA_SIZE);
686                 lgi->lgi_off = max_t(__u64, lgi->lgi_attr.la_size,
687                                      lgi->lgi_off);
688         }
689
690         lgi->lgi_buf.lb_len = reclen;
691         lgi->lgi_buf.lb_buf = rec;
692         rc = dt_record_write(env, o, &lgi->lgi_buf, &lgi->lgi_off, th);
693         if (rc < 0)
694                 GOTO(out, rc);
695
696         CDEBUG(D_HA, "added record "DFID".%u, %u off%llu\n",
697                PFID(lu_object_fid(&o->do_lu)), index, rec->lrh_len,
698                lgi->lgi_off);
699         if (reccookie != NULL) {
700                 reccookie->lgc_lgl = loghandle->lgh_id;
701                 reccookie->lgc_index = index;
702                 if ((rec->lrh_type == MDS_UNLINK_REC) ||
703                     (rec->lrh_type == MDS_SETATTR64_REC))
704                         reccookie->lgc_subsys = LLOG_MDS_OST_ORIG_CTXT;
705                 else if (rec->lrh_type == OST_SZ_REC)
706                         reccookie->lgc_subsys = LLOG_SIZE_ORIG_CTXT;
707                 else
708                         reccookie->lgc_subsys = -1;
709                 rc = 1;
710         }
711         RETURN(rc);
712 out:
713         /* cleanup llog for error case */
714         mutex_lock(&loghandle->lgh_hdr_mutex);
715         ext2_clear_bit(index, LLOG_HDR_BITMAP(llh));
716         llh->llh_count--;
717         mutex_unlock(&loghandle->lgh_hdr_mutex);
718
719         /* restore llog last_idx */
720         if (dt_object_remote(o)) {
721                 loghandle->lgh_last_idx = orig_last_idx;
722         } else if (--loghandle->lgh_last_idx == 0 &&
723             (llh->llh_flags & LLOG_F_IS_CAT) && llh->llh_cat_idx != 0) {
724                 /* catalog had just wrap-around case */
725                 loghandle->lgh_last_idx = LLOG_HDR_BITMAP_SIZE(llh) - 1;
726         }
727
728         LLOG_HDR_TAIL(llh)->lrt_index = loghandle->lgh_last_idx;
729
730         RETURN(rc);
731 }
732
733 /**
734  * We can skip reading at least as many log blocks as the number of
735  * minimum sized log records we are skipping.  If it turns out
736  * that we are not far enough along the log (because the
737  * actual records are larger than minimum size) we just skip
738  * some more records.
739  *
740  * Note: in llog_process_thread, it will use bitmap offset as
741  * the index to locate the record, which also includs some pad
742  * records, whose record size is very small, and it also does not
743  * consider pad record when recording minimum record size (otherwise
744  * min_record size might be too small), so in some rare cases,
745  * it might skip too much record for @goal, see llog_osd_next_block().
746  *
747  * When force_mini_rec is true, it means we have to use LLOG_MIN_REC_SIZE
748  * as the min record size to skip over, usually because in the previous
749  * try, it skip too much record, see loog_osd_next(prev)_block().
750  */
751 static inline void llog_skip_over(struct llog_handle *lgh, __u64 *off,
752                                   int curr, int goal, __u32 chunk_size,
753                                   bool force_mini_rec)
754 {
755         struct llog_log_hdr *llh = lgh->lgh_hdr;
756
757         /* Goal should not bigger than the record count */
758         if (goal > lgh->lgh_last_idx)
759                 goal = lgh->lgh_last_idx;
760
761         if (goal > curr) {
762                 if (llh->llh_flags & LLOG_F_IS_FIXSIZE) {
763                         *off = chunk_size + (goal - 1) * llh->llh_size;
764                 } else {
765                         __u64 min_rec_size = LLOG_MIN_REC_SIZE;
766
767                         if (llh->llh_size > 0 && !force_mini_rec)
768                                 min_rec_size = llh->llh_size;
769
770                         *off = *off + (goal - curr - 1) * min_rec_size;
771                 }
772         }
773         /* always align with lower chunk boundary*/
774         *off &= ~(chunk_size - 1);
775 }
776
777 /**
778  * Remove optional fields that the client doesn't expect.
779  * This is typically in order to ensure compatibility with older clients.
780  * It is assumed that since we exclusively remove fields, the block will be
781  * big enough to handle the remapped records. It is also assumed that records
782  * of a block have the same format (i.e.: the same features enabled).
783  *
784  * \param[in,out]    hdr           Header of the block of records to remap.
785  * \param[in,out]    last_hdr      Last header, don't read past this point.
786  * \param[in]        flags         Flags describing the fields to keep.
787  * \param[in]        extra_flags   Flags describing the extra fields to keep.
788  */
789 static void changelog_block_trim_ext(struct llog_rec_hdr *hdr,
790                                      struct llog_rec_hdr *last_hdr,
791                                      enum changelog_rec_flags flags,
792                                      enum changelog_rec_extra_flags extra_flags)
793 {
794         if (hdr->lrh_type != CHANGELOG_REC)
795                 return;
796
797         do {
798                 struct changelog_rec *rec = (struct changelog_rec *)(hdr + 1);
799                 enum changelog_rec_extra_flags xflag = CLFE_INVALID;
800
801                 if (flags & CLF_EXTRA_FLAGS &&
802                     rec->cr_flags & CLF_EXTRA_FLAGS) {
803                         xflag = changelog_rec_extra_flags(rec)->cr_extra_flags &
804                                 extra_flags;
805                 }
806
807                 changelog_remap_rec(rec, rec->cr_flags & flags, xflag);
808                 hdr = llog_rec_hdr_next(hdr);
809         } while ((char *)hdr <= (char *)last_hdr);
810 }
811
812 /**
813  * Implementation of the llog_operations::lop_next_block
814  *
815  * This function finds the the next llog block to return which contains
816  * record with required index. It is main part of llog processing.
817  *
818  * \param[in]     env           execution environment
819  * \param[in]     loghandle     llog handle of the current llog
820  * \param[in,out] cur_idx       index preceeding cur_offset
821  * \param[in]     next_idx      target index to find
822  * \param[in,out] cur_offset    furtherst point read in the file
823  * \param[in]     buf           pointer to data buffer to fill
824  * \param[in]     len           required len to read, it is
825  *                              usually llog chunk_size.
826  *
827  * \retval                      0 on successful buffer read
828  * \retval                      negative value on error
829  */
830 static int llog_osd_next_block(const struct lu_env *env,
831                                struct llog_handle *loghandle, int *cur_idx,
832                                int next_idx, __u64 *cur_offset, void *buf,
833                                int len)
834 {
835         struct llog_thread_info *lgi = llog_info(env);
836         struct dt_object        *o;
837         struct dt_device        *dt;
838         int                      rc;
839         __u32                   chunk_size;
840         int last_idx = *cur_idx;
841         __u64 last_offset = *cur_offset;
842         bool force_mini_rec = false;
843         enum changelog_rec_flags flags;
844         enum changelog_rec_extra_flags xflags;
845
846         ENTRY;
847
848         LASSERT(env);
849         LASSERT(lgi);
850
851         chunk_size = loghandle->lgh_hdr->llh_hdr.lrh_len;
852         if (len == 0 || len & (chunk_size - 1))
853                 RETURN(-EINVAL);
854
855         LASSERT(loghandle);
856         LASSERT(loghandle->lgh_ctxt);
857
858         o = loghandle->lgh_obj;
859         LASSERT(o);
860         LASSERT(dt_object_exists(o));
861         dt = lu2dt_dev(o->do_lu.lo_dev);
862         LASSERT(dt);
863
864         rc = dt_attr_get(env, o, &lgi->lgi_attr);
865         if (rc)
866                 GOTO(out, rc);
867
868         CDEBUG(D_OTHER, "looking for log index %u (cur idx %u off"
869                "%llu), size %llu\n", next_idx, *cur_idx,
870                *cur_offset, lgi->lgi_attr.la_size);
871
872         while (*cur_offset < lgi->lgi_attr.la_size) {
873                 struct llog_rec_hdr     *rec, *last_rec;
874                 struct llog_rec_tail    *tail;
875
876                 llog_skip_over(loghandle, cur_offset, *cur_idx,
877                                next_idx, chunk_size, force_mini_rec);
878
879                 /* read up to next llog chunk_size block */
880                 lgi->lgi_buf.lb_len = chunk_size -
881                                       (*cur_offset & (chunk_size - 1));
882                 lgi->lgi_buf.lb_buf = buf;
883
884                 rc = dt_read(env, o, &lgi->lgi_buf, cur_offset);
885                 if (rc < 0) {
886                         if (rc == -EBADR && !force_mini_rec)
887                                 goto retry;
888
889                         CERROR("%s: can't read llog block from log "DFID
890                                " offset %llu: rc = %d\n",
891                                o->do_lu.lo_dev->ld_obd->obd_name,
892                                PFID(lu_object_fid(&o->do_lu)), *cur_offset,
893                                rc);
894                         GOTO(out, rc);
895                 }
896
897                 if (rc < len) {
898                         /* signal the end of the valid buffer to
899                          * llog_process */
900                         memset(buf + rc, 0, len - rc);
901                 }
902
903                 if (rc == 0) { /* end of file, nothing to do */
904                         if (!force_mini_rec)
905                                 goto retry;
906                         GOTO(out, rc);
907                 }
908
909                 if (rc < sizeof(*tail)) {
910                         if (!force_mini_rec)
911                                 goto retry;
912
913                         CERROR("%s: invalid llog block at log id "DFID":%x "
914                                "offset %llu\n",
915                                o->do_lu.lo_dev->ld_obd->obd_name,
916                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid),
917                                loghandle->lgh_id.lgl_ogen, *cur_offset);
918                         GOTO(out, rc = -EINVAL);
919                 }
920
921                 rec = buf;
922                 if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
923                         lustre_swab_llog_rec(rec);
924
925                 tail = (struct llog_rec_tail *)((char *)buf + rc -
926                                                 sizeof(struct llog_rec_tail));
927                 /* get the last record in block */
928                 last_rec = (struct llog_rec_hdr *)((char *)buf + rc -
929                                                    tail->lrt_len);
930
931                 if (LLOG_REC_HDR_NEEDS_SWABBING(last_rec))
932                         lustre_swab_llog_rec(last_rec);
933
934                 if (last_rec->lrh_index != tail->lrt_index) {
935                         CERROR("%s: invalid llog tail at log id "DFID":%x "
936                                "offset %llu last_rec idx %u tail idx %u"
937                                "lrt len %u read_size %d\n",
938                                o->do_lu.lo_dev->ld_obd->obd_name,
939                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid),
940                                loghandle->lgh_id.lgl_ogen, *cur_offset,
941                                last_rec->lrh_index, tail->lrt_index,
942                                tail->lrt_len, rc);
943                         GOTO(out, rc = -EINVAL);
944                 }
945
946                 *cur_idx = tail->lrt_index;
947
948                 /* this shouldn't happen */
949                 if (tail->lrt_index == 0) {
950                         CERROR("%s: invalid llog tail at log id "DFID":%x "
951                                "offset %llu bytes %d\n",
952                                o->do_lu.lo_dev->ld_obd->obd_name,
953                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid),
954                                loghandle->lgh_id.lgl_ogen, *cur_offset, rc);
955                         GOTO(out, rc = -EINVAL);
956                 }
957                 if (tail->lrt_index < next_idx) {
958                         last_idx = *cur_idx;
959                         last_offset = *cur_offset;
960                         continue;
961                 }
962
963                 /* sanity check that the start of the new buffer is no farther
964                  * than the record that we wanted.  This shouldn't happen. */
965                 if (rec->lrh_index > next_idx) {
966                         if (!force_mini_rec && next_idx > last_idx)
967                                 goto retry;
968
969                         CERROR("%s: missed desired record? %u > %u\n",
970                                o->do_lu.lo_dev->ld_obd->obd_name,
971                                rec->lrh_index, next_idx);
972                         GOTO(out, rc = -ENOENT);
973                 }
974
975                 /* Trim unsupported extensions for compat w/ older clients */
976                 flags = CLF_SUPPORTED;
977                 xflags = CLFE_SUPPORTED;
978                 if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_X_UIDGID))
979                         xflags &= ~CLFE_UIDGID;
980                 if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_EXTRA_FLAGS))
981                         flags &= ~CLF_EXTRA_FLAGS;
982                 if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_JOBID))
983                         flags &= ~CLF_JOBID;
984                 if (flags != CLF_SUPPORTED || xflags != CLFE_SUPPORTED)
985                         changelog_block_trim_ext(rec, last_rec, flags, xflags);
986
987                 GOTO(out, rc = 0);
988
989 retry:
990                 /* Note: because there are some pad records in the
991                  * llog, so llog_skip_over() might skip too much
992                  * records, let's try skip again with minimum record */
993                 force_mini_rec = true;
994                 *cur_offset = last_offset;
995                 *cur_idx = last_idx;
996         }
997         GOTO(out, rc = -EIO);
998 out:
999         return rc;
1000 }
1001
1002 /**
1003  * Implementation of the llog_operations::lop_prev_block
1004  *
1005  * This function finds the llog block to return which contains
1006  * record with required index but in reverse order - from end of llog
1007  * to the beginning.
1008  * It is main part of reverse llog processing.
1009  *
1010  * \param[in] env       execution environment
1011  * \param[in] loghandle llog handle of the current llog
1012  * \param[in] prev_idx  target index to find
1013  * \param[in] buf       pointer to data buffer to fill
1014  * \param[in] len       required len to read, it is llog_chunk_size usually.
1015  *
1016  * \retval              0 on successful buffer read
1017  * \retval              negative value on error
1018  */
1019 static int llog_osd_prev_block(const struct lu_env *env,
1020                                struct llog_handle *loghandle,
1021                                int prev_idx, void *buf, int len)
1022 {
1023         struct llog_thread_info *lgi = llog_info(env);
1024         struct dt_object        *o;
1025         struct dt_device        *dt;
1026         loff_t                   cur_offset;
1027         __u32                   chunk_size;
1028         enum changelog_rec_flags flags;
1029         enum changelog_rec_extra_flags xflags;
1030         int                      rc;
1031
1032         ENTRY;
1033
1034         chunk_size = loghandle->lgh_hdr->llh_hdr.lrh_len;
1035         if (len == 0 || len & (chunk_size - 1))
1036                 RETURN(-EINVAL);
1037
1038         CDEBUG(D_OTHER, "looking for log index %u\n", prev_idx);
1039
1040         LASSERT(loghandle);
1041         LASSERT(loghandle->lgh_ctxt);
1042
1043         o = loghandle->lgh_obj;
1044         LASSERT(o);
1045         LASSERT(dt_object_exists(o));
1046         dt = lu2dt_dev(o->do_lu.lo_dev);
1047         LASSERT(dt);
1048
1049         /* Let's only use mini record size for previous block read
1050          * for now XXX */
1051         cur_offset = chunk_size;
1052         llog_skip_over(loghandle, &cur_offset, 0, prev_idx,
1053                        chunk_size, true);
1054
1055         rc = dt_attr_get(env, o, &lgi->lgi_attr);
1056         if (rc)
1057                 GOTO(out, rc);
1058
1059         while (cur_offset < lgi->lgi_attr.la_size) {
1060                 struct llog_rec_hdr     *rec, *last_rec;
1061                 struct llog_rec_tail    *tail;
1062
1063                 lgi->lgi_buf.lb_len = len;
1064                 lgi->lgi_buf.lb_buf = buf;
1065                 rc = dt_read(env, o, &lgi->lgi_buf, &cur_offset);
1066                 if (rc < 0) {
1067                         CERROR("%s: can't read llog block from log "DFID
1068                                " offset %llu: rc = %d\n",
1069                                o->do_lu.lo_dev->ld_obd->obd_name,
1070                                PFID(lu_object_fid(&o->do_lu)), cur_offset, rc);
1071                         GOTO(out, rc);
1072                 }
1073
1074                 if (rc == 0) /* end of file, nothing to do */
1075                         GOTO(out, rc);
1076
1077                 if (rc < sizeof(*tail)) {
1078                         CERROR("%s: invalid llog block at log id "DFID":%x "
1079                                "offset %llu\n",
1080                                o->do_lu.lo_dev->ld_obd->obd_name,
1081                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid),
1082                                loghandle->lgh_id.lgl_ogen, cur_offset);
1083                         GOTO(out, rc = -EINVAL);
1084                 }
1085
1086                 rec = buf;
1087                 if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
1088                         lustre_swab_llog_rec(rec);
1089
1090                 tail = (struct llog_rec_tail *)((char *)buf + rc -
1091                                                 sizeof(struct llog_rec_tail));
1092                 /* get the last record in block */
1093                 last_rec = (struct llog_rec_hdr *)((char *)buf + rc -
1094                                                    le32_to_cpu(tail->lrt_len));
1095
1096                 if (LLOG_REC_HDR_NEEDS_SWABBING(last_rec))
1097                         lustre_swab_llog_rec(last_rec);
1098                 LASSERT(last_rec->lrh_index == tail->lrt_index);
1099
1100                 /* this shouldn't happen */
1101                 if (tail->lrt_index == 0) {
1102                         CERROR("%s: invalid llog tail at log id "DFID":%x "
1103                                "offset %llu\n",
1104                                o->do_lu.lo_dev->ld_obd->obd_name,
1105                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid),
1106                                loghandle->lgh_id.lgl_ogen, cur_offset);
1107                         GOTO(out, rc = -EINVAL);
1108                 }
1109                 if (tail->lrt_index < prev_idx)
1110                         continue;
1111
1112                 /* sanity check that the start of the new buffer is no farther
1113                  * than the record that we wanted.  This shouldn't happen. */
1114                 if (rec->lrh_index > prev_idx) {
1115                         CERROR("%s: missed desired record? %u > %u\n",
1116                                o->do_lu.lo_dev->ld_obd->obd_name,
1117                                rec->lrh_index, prev_idx);
1118                         GOTO(out, rc = -ENOENT);
1119                 }
1120
1121                 /* Trim unsupported extensions for compat w/ older clients */
1122                 flags = CLF_SUPPORTED;
1123                 xflags = CLFE_SUPPORTED;
1124                 if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_X_UIDGID))
1125                         xflags &= ~CLFE_UIDGID;
1126                 if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_EXTRA_FLAGS))
1127                         flags &= ~CLF_EXTRA_FLAGS;
1128                 if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_JOBID))
1129                         flags &= ~CLF_JOBID;
1130                 if (flags != CLF_SUPPORTED || xflags != CLFE_SUPPORTED)
1131                         changelog_block_trim_ext(rec, last_rec, flags, xflags);
1132
1133                 GOTO(out, rc = 0);
1134         }
1135         GOTO(out, rc = -EIO);
1136 out:
1137         return rc;
1138 }
1139
1140 /**
1141  * This is helper function to get llog directory object. It is used by named
1142  * llog operations to find/insert/delete llog entry from llog directory.
1143  *
1144  * \param[in] env       execution environment
1145  * \param[in] ctxt      llog context
1146  *
1147  * \retval              dt_object of llog directory
1148  * \retval              ERR_PTR of negative value on error
1149  */
1150 static struct dt_object *llog_osd_dir_get(const struct lu_env *env,
1151                                           struct llog_ctxt *ctxt)
1152 {
1153         struct dt_device        *dt;
1154         struct dt_thread_info   *dti = dt_info(env);
1155         struct dt_object        *dir;
1156         int                      rc;
1157
1158         dt = ctxt->loc_exp->exp_obd->obd_lvfs_ctxt.dt;
1159         if (ctxt->loc_dir == NULL) {
1160                 rc = dt_root_get(env, dt, &dti->dti_fid);
1161                 if (rc)
1162                         return ERR_PTR(rc);
1163                 dir = dt_locate(env, dt, &dti->dti_fid);
1164
1165                 if (!IS_ERR(dir) && !dt_try_as_dir(env, dir)) {
1166                         dt_object_put(env, dir);
1167                         return ERR_PTR(-ENOTDIR);
1168                 }
1169         } else {
1170                 lu_object_get(&ctxt->loc_dir->do_lu);
1171                 dir = ctxt->loc_dir;
1172         }
1173
1174         return dir;
1175 }
1176
1177 /**
1178  * Implementation of the llog_operations::lop_open
1179  *
1180  * This function opens the llog by its logid or by name, it may open also
1181  * non existent llog and assing then new id to it.
1182  * The llog_open/llog_close pair works similar to lu_object_find/put,
1183  * the object may not exist prior open. The result of open is just dt_object
1184  * in the llog header.
1185  *
1186  * \param[in] env               execution environment
1187  * \param[in] handle            llog handle of the current llog
1188  * \param[in] logid             logid of llog to open (nameless llog)
1189  * \param[in] name              name of llog to open (named llog)
1190  * \param[in] open_param
1191  *                              LLOG_OPEN_NEW - new llog, may not exist
1192  *                              LLOG_OPEN_EXIST - old llog, must exist
1193  *
1194  * \retval                      0 on successful open, llog_handle::lgh_obj
1195  *                              contains the dt_object of the llog.
1196  * \retval                      negative value on error
1197  */
1198 static int llog_osd_open(const struct lu_env *env, struct llog_handle *handle,
1199                          struct llog_logid *logid, char *name,
1200                          enum llog_open_param open_param)
1201 {
1202         struct llog_thread_info         *lgi = llog_info(env);
1203         struct llog_ctxt                *ctxt = handle->lgh_ctxt;
1204         struct dt_object                *o;
1205         struct dt_device                *dt;
1206         struct ls_device                *ls;
1207         struct local_oid_storage        *los = NULL;
1208         int                              rc = 0;
1209         bool new_id = false;
1210
1211         ENTRY;
1212
1213         LASSERT(env);
1214         LASSERT(ctxt);
1215         LASSERT(ctxt->loc_exp);
1216         LASSERT(ctxt->loc_exp->exp_obd);
1217         dt = ctxt->loc_exp->exp_obd->obd_lvfs_ctxt.dt;
1218         LASSERT(dt);
1219         if (ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1220                 struct lu_object_conf conf = { 0 };
1221                 if (logid != NULL) {
1222                         logid_to_fid(logid, &lgi->lgi_fid);
1223                 } else {
1224                         /* If logid == NULL, then it means the caller needs
1225                          * to allocate new FID (llog_cat_declare_add_rec()). */
1226                         rc = obd_fid_alloc(env, ctxt->loc_exp,
1227                                            &lgi->lgi_fid, NULL);
1228                         if (rc < 0)
1229                                 RETURN(rc);
1230                         rc = 0;
1231                         conf.loc_flags = LOC_F_NEW;
1232                 }
1233
1234                 o = dt_locate_at(env, dt, &lgi->lgi_fid,
1235                                  dt->dd_lu_dev.ld_site->ls_top_dev, &conf);
1236                 if (IS_ERR(o))
1237                         RETURN(PTR_ERR(o));
1238
1239                 goto after_open;
1240         }
1241
1242         ls = ls_device_get(dt);
1243         if (IS_ERR(ls))
1244                 RETURN(PTR_ERR(ls));
1245
1246         mutex_lock(&ls->ls_los_mutex);
1247         los = dt_los_find(ls, name != NULL ? FID_SEQ_LLOG_NAME : FID_SEQ_LLOG);
1248         mutex_unlock(&ls->ls_los_mutex);
1249         LASSERT(los);
1250         ls_device_put(env, ls);
1251
1252         LASSERT(handle);
1253
1254         if (logid != NULL) {
1255                 logid_to_fid(logid, &lgi->lgi_fid);
1256         } else if (name) {
1257                 struct dt_object *llog_dir;
1258
1259                 llog_dir = llog_osd_dir_get(env, ctxt);
1260                 if (IS_ERR(llog_dir))
1261                         GOTO(out, rc = PTR_ERR(llog_dir));
1262                 dt_read_lock(env, llog_dir, 0);
1263                 rc = dt_lookup_dir(env, llog_dir, name, &lgi->lgi_fid);
1264                 dt_read_unlock(env, llog_dir);
1265                 dt_object_put(env, llog_dir);
1266                 if (rc == -ENOENT && open_param == LLOG_OPEN_NEW) {
1267                         /* generate fid for new llog */
1268                         rc = local_object_fid_generate(env, los,
1269                                                        &lgi->lgi_fid);
1270                         new_id = true;
1271                 }
1272                 if (rc < 0)
1273                         GOTO(out, rc);
1274                 OBD_ALLOC(handle->lgh_name, strlen(name) + 1);
1275                 if (handle->lgh_name)
1276                         strcpy(handle->lgh_name, name);
1277                 else
1278                         GOTO(out, rc = -ENOMEM);
1279         } else {
1280                 LASSERTF(open_param & LLOG_OPEN_NEW, "%#x\n", open_param);
1281                 /* generate fid for new llog */
1282 generate:
1283                 rc = local_object_fid_generate(env, los, &lgi->lgi_fid);
1284                 if (rc < 0)
1285                         GOTO(out, rc);
1286                 new_id = true;
1287         }
1288
1289         o = ls_locate(env, ls, &lgi->lgi_fid, NULL);
1290         if (IS_ERR(o))
1291                 GOTO(out_name, rc = PTR_ERR(o));
1292
1293         if (dt_object_exists(o) && new_id) {
1294                 /* llog exists with just generated ID, e.g. some old llog file
1295                  * still is in use or is orphan, drop a warn and skip it. */
1296                 CDEBUG(D_INFO, "%s: llog exists with the same FID: "DFID
1297                        ", skipping\n",
1298                        o->do_lu.lo_dev->ld_obd->obd_name,
1299                        PFID(lu_object_fid(&o->do_lu)));
1300                 dt_object_put(env, o);
1301                 /* just skip this llog ID, we shouldn't delete it because we
1302                  * don't know exactly what is its purpose and state. */
1303                 goto generate;
1304         }
1305
1306 after_open:
1307         /* No new llog is expected but doesn't exist */
1308         if (open_param != LLOG_OPEN_NEW && !dt_object_exists(o)) {
1309                 CDEBUG(D_INFO, "%s: llog FID: "DFID" obj %p doesn`t exist\n",
1310                        o->do_lu.lo_dev->ld_obd->obd_name,
1311                        PFID(lu_object_fid(&o->do_lu)), o);
1312                 GOTO(out_put, rc = -ENOENT);
1313         }
1314         fid_to_logid(&lgi->lgi_fid, &handle->lgh_id);
1315         handle->lgh_obj = o;
1316         handle->private_data = los;
1317         LASSERT(handle->lgh_ctxt);
1318
1319         RETURN(rc);
1320
1321 out_put:
1322         dt_object_put(env, o);
1323 out_name:
1324         if (handle->lgh_name != NULL)
1325                 OBD_FREE(handle->lgh_name, strlen(name) + 1);
1326 out:
1327         if (los != NULL)
1328                 dt_los_put(los);
1329         RETURN(rc);
1330 }
1331
1332 /**
1333  * Get dir for regular fid log object
1334  *
1335  * Get directory for regular fid log object, and these regular fid log
1336  * object will be inserted under this directory, to satisfy the FS
1337  * consistency check, e2fsck etc.
1338  *
1339  * \param [in] env      execution environment
1340  * \param [in] dto      llog object
1341  *
1342  * \retval              pointer to the directory if it is found.
1343  * \retval              ERR_PTR(negative errno) if it fails.
1344  */
1345 struct dt_object *llog_osd_get_regular_fid_dir(const struct lu_env *env,
1346                                                struct dt_object *dto)
1347 {
1348         struct llog_thread_info *lgi = llog_info(env);
1349         struct seq_server_site *ss = dto->do_lu.lo_dev->ld_site->ld_seq_site;
1350         struct lu_seq_range     *range = &lgi->lgi_range;
1351         struct lu_fid           *dir_fid = &lgi->lgi_fid;
1352         struct dt_object        *dir;
1353         int                     rc;
1354         ENTRY;
1355
1356         fld_range_set_any(range);
1357         LASSERT(ss != NULL);
1358         rc = ss->ss_server_fld->lsf_seq_lookup(env, ss->ss_server_fld,
1359                                    fid_seq(lu_object_fid(&dto->do_lu)), range);
1360         if (rc < 0)
1361                 RETURN(ERR_PTR(rc));
1362
1363         lu_update_log_dir_fid(dir_fid, range->lsr_index);
1364         dir = dt_locate(env, lu2dt_dev(dto->do_lu.lo_dev), dir_fid);
1365         if (IS_ERR(dir))
1366                 RETURN(dir);
1367
1368         if (!dt_try_as_dir(env, dir)) {
1369                 dt_object_put(env, dir);
1370                 RETURN(ERR_PTR(-ENOTDIR));
1371         }
1372
1373         RETURN(dir);
1374 }
1375
1376 /**
1377  * Add llog object with regular FID to name entry
1378  *
1379  * Add llog object with regular FID to name space, and each llog
1380  * object on each MDT will be /update_log_dir/[seq:oid:ver],
1381  * so to satisfy the namespace consistency check, e2fsck etc.
1382  *
1383  * \param [in] env      execution environment
1384  * \param [in] dto      llog object
1385  * \param [in] th       thandle
1386  * \param [in] declare  if it is declare or execution
1387  *
1388  * \retval              0 if insertion succeeds.
1389  * \retval              negative errno if insertion fails.
1390  */
1391 static int
1392 llog_osd_regular_fid_add_name_entry(const struct lu_env *env,
1393                                     struct dt_object *dto,
1394                                     struct thandle *th, bool declare)
1395 {
1396         struct llog_thread_info *lgi = llog_info(env);
1397         const struct lu_fid     *fid = lu_object_fid(&dto->do_lu);
1398         struct dt_insert_rec    *rec = &lgi->lgi_dt_rec;
1399         struct dt_object        *dir;
1400         char                    *name = lgi->lgi_name;
1401         int                     rc;
1402         ENTRY;
1403
1404         if (!fid_is_norm(fid))
1405                 RETURN(0);
1406
1407         dir = llog_osd_get_regular_fid_dir(env, dto);
1408         if (IS_ERR(dir))
1409                 RETURN(PTR_ERR(dir));
1410
1411         rec->rec_fid = fid;
1412         rec->rec_type = S_IFREG;
1413         snprintf(name, sizeof(lgi->lgi_name), DFID, PFID(fid));
1414         dt_write_lock(env, dir, 0);
1415         if (declare) {
1416                 rc = dt_declare_insert(env, dir, (struct dt_rec *)rec,
1417                                (struct dt_key *)name, th);
1418         } else {
1419                 rc = dt_insert(env, dir, (struct dt_rec *)rec,
1420                                (struct dt_key *)name, th, 1);
1421         }
1422         dt_write_unlock(env, dir);
1423
1424         dt_object_put(env, dir);
1425         RETURN(rc);
1426 }
1427
1428
1429 /**
1430  * Implementation of the llog_operations::lop_declare_create
1431  *
1432  * This function declares the llog create. It declares also name insert
1433  * into llog directory in case of named llog.
1434  *
1435  * \param[in] env       execution environment
1436  * \param[in] res       llog handle of the current llog
1437  * \param[in] th        current transaction handle
1438  *
1439  * \retval              0 on successful create declaration
1440  * \retval              negative value on error
1441  */
1442 static int llog_osd_declare_create(const struct lu_env *env,
1443                                    struct llog_handle *res, struct thandle *th)
1444 {
1445         struct llog_thread_info         *lgi = llog_info(env);
1446         struct dt_insert_rec            *rec = &lgi->lgi_dt_rec;
1447         struct local_oid_storage        *los;
1448         struct dt_object                *o;
1449         int                              rc;
1450
1451         ENTRY;
1452
1453         LASSERT(res->lgh_obj);
1454         LASSERT(th);
1455
1456         /* object can be created by another thread */
1457         o = res->lgh_obj;
1458         if (dt_object_exists(o))
1459                 RETURN(0);
1460
1461         if (res->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1462                 struct llog_thread_info *lgi = llog_info(env);
1463
1464                 lgi->lgi_attr.la_valid = LA_MODE | LA_SIZE;
1465                 lgi->lgi_attr.la_size = 0;
1466                 lgi->lgi_attr.la_mode = S_IFREG | S_IRUGO | S_IWUSR;
1467                 lgi->lgi_dof.dof_type = dt_mode_to_dft(S_IFREG);
1468
1469                 rc = dt_declare_create(env, o, &lgi->lgi_attr, NULL,
1470                                        &lgi->lgi_dof, th);
1471                 if (rc < 0)
1472                         RETURN(rc);
1473
1474
1475                 rc = llog_osd_regular_fid_add_name_entry(env, o, th, true);
1476
1477                 RETURN(rc);
1478         }
1479         los = res->private_data;
1480         LASSERT(los);
1481
1482         rc = llog_osd_declare_new_object(env, los, o, th);
1483         if (rc)
1484                 RETURN(rc);
1485
1486         /* do not declare header initialization here as it's declared
1487          * in llog_osd_declare_write_rec() which is always called */
1488
1489         if (res->lgh_name) {
1490                 struct dt_object *llog_dir;
1491
1492                 llog_dir = llog_osd_dir_get(env, res->lgh_ctxt);
1493                 if (IS_ERR(llog_dir))
1494                         RETURN(PTR_ERR(llog_dir));
1495                 logid_to_fid(&res->lgh_id, &lgi->lgi_fid);
1496                 rec->rec_fid = &lgi->lgi_fid;
1497                 rec->rec_type = S_IFREG;
1498                 rc = dt_declare_insert(env, llog_dir,
1499                                        (struct dt_rec *)rec,
1500                                        (struct dt_key *)res->lgh_name, th);
1501                 dt_object_put(env, llog_dir);
1502                 if (rc)
1503                         CERROR("%s: can't declare named llog %s: rc = %d\n",
1504                                o->do_lu.lo_dev->ld_obd->obd_name,
1505                                res->lgh_name, rc);
1506         }
1507         RETURN(rc);
1508 }
1509
1510 /**
1511  * Implementation of the llog_operations::lop_create
1512  *
1513  * This function creates the llog according with llog_handle::lgh_obj
1514  * and llog_handle::lgh_name.
1515  *
1516  * \param[in] env       execution environment
1517  * \param[in] res       llog handle of the current llog
1518  * \param[in] th        current transaction handle
1519  *
1520  * \retval              0 on successful create
1521  * \retval              negative value on error
1522  */
1523 static int llog_osd_create(const struct lu_env *env, struct llog_handle *res,
1524                            struct thandle *th)
1525 {
1526         struct llog_thread_info *lgi = llog_info(env);
1527         struct dt_insert_rec    *rec = &lgi->lgi_dt_rec;
1528         struct local_oid_storage *los;
1529         struct dt_object        *o;
1530         int                      rc = 0;
1531
1532         ENTRY;
1533
1534         LASSERT(env);
1535         o = res->lgh_obj;
1536         LASSERT(o);
1537
1538         /* llog can be already created */
1539         if (dt_object_exists(o))
1540                 RETURN(-EEXIST);
1541
1542         if (res->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1543                 struct llog_thread_info *lgi = llog_info(env);
1544
1545                 lgi->lgi_attr.la_valid = LA_MODE | LA_SIZE | LA_TYPE;
1546                 lgi->lgi_attr.la_size = 0;
1547                 lgi->lgi_attr.la_mode = S_IFREG | S_IRUGO | S_IWUSR;
1548                 lgi->lgi_dof.dof_type = dt_mode_to_dft(S_IFREG);
1549
1550                 dt_write_lock(env, o, 0);
1551                 rc = dt_create(env, o, &lgi->lgi_attr, NULL,
1552                                &lgi->lgi_dof, th);
1553                 dt_write_unlock(env, o);
1554                 if (rc < 0)
1555                         RETURN(rc);
1556
1557                 rc = llog_osd_regular_fid_add_name_entry(env, o, th, false);
1558
1559                 RETURN(rc);
1560         }
1561
1562         los = res->private_data;
1563         LASSERT(los);
1564
1565         dt_write_lock(env, o, 0);
1566         if (!dt_object_exists(o))
1567                 rc = llog_osd_create_new_object(env, los, o, th);
1568         else
1569                 rc = -EEXIST;
1570
1571         dt_write_unlock(env, o);
1572         if (rc)
1573                 RETURN(rc);
1574
1575         if (res->lgh_name) {
1576                 struct dt_object *llog_dir;
1577
1578                 llog_dir = llog_osd_dir_get(env, res->lgh_ctxt);
1579                 if (IS_ERR(llog_dir))
1580                         RETURN(PTR_ERR(llog_dir));
1581
1582                 logid_to_fid(&res->lgh_id, &lgi->lgi_fid);
1583                 rec->rec_fid = &lgi->lgi_fid;
1584                 rec->rec_type = S_IFREG;
1585                 dt_read_lock(env, llog_dir, 0);
1586                 rc = dt_insert(env, llog_dir, (struct dt_rec *)rec,
1587                                (struct dt_key *)res->lgh_name,
1588                                th, 1);
1589                 dt_read_unlock(env, llog_dir);
1590                 dt_object_put(env, llog_dir);
1591                 if (rc)
1592                         CERROR("%s: can't create named llog %s: rc = %d\n",
1593                                o->do_lu.lo_dev->ld_obd->obd_name,
1594                                res->lgh_name, rc);
1595         }
1596         RETURN(rc);
1597 }
1598
1599 /**
1600  * Implementation of the llog_operations::lop_close
1601  *
1602  * This function closes the llog. It just put llog object and referenced
1603  * local storage.
1604  *
1605  * \param[in] env       execution environment
1606  * \param[in] handle    llog handle of the current llog
1607  *
1608  * \retval              0 on successful llog close
1609  * \retval              negative value on error
1610  */
1611 static int llog_osd_close(const struct lu_env *env, struct llog_handle *handle)
1612 {
1613         struct local_oid_storage        *los;
1614         int                              rc = 0;
1615
1616         ENTRY;
1617
1618         LASSERT(handle->lgh_obj);
1619
1620         if (handle->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1621                 /* Remove the object from the cache, otherwise it may
1622                  * hold LOD being released during cleanup process */
1623                 dt_object_put_nocache(env, handle->lgh_obj);
1624                 LASSERT(handle->private_data == NULL);
1625                 RETURN(rc);
1626         } else {
1627                 dt_object_put(env, handle->lgh_obj);
1628         }
1629         los = handle->private_data;
1630         LASSERT(los);
1631         dt_los_put(los);
1632
1633         if (handle->lgh_name)
1634                 OBD_FREE(handle->lgh_name, strlen(handle->lgh_name) + 1);
1635
1636         RETURN(rc);
1637 }
1638
1639 /**
1640  * delete llog object name entry
1641  *
1642  * Delete llog object (with regular FID) from name space (under
1643  * update_log_dir).
1644  *
1645  * \param [in] env      execution environment
1646  * \param [in] dto      llog object
1647  * \param [in] th       thandle
1648  * \param [in] declare  if it is declare or execution
1649  *
1650  * \retval              0 if deletion succeeds.
1651  * \retval              negative errno if deletion fails.
1652  */
1653 static int
1654 llog_osd_regular_fid_del_name_entry(const struct lu_env *env,
1655                                     struct dt_object *dto,
1656                                     struct thandle *th, bool declare)
1657 {
1658         struct llog_thread_info *lgi = llog_info(env);
1659         const struct lu_fid     *fid = lu_object_fid(&dto->do_lu);
1660         struct dt_object        *dir;
1661         char                    *name = lgi->lgi_name;
1662         int                     rc;
1663         ENTRY;
1664
1665         if (!fid_is_norm(fid))
1666                 RETURN(0);
1667
1668         dir = llog_osd_get_regular_fid_dir(env, dto);
1669         if (IS_ERR(dir))
1670                 RETURN(PTR_ERR(dir));
1671
1672         snprintf(name, sizeof(lgi->lgi_name), DFID, PFID(fid));
1673         dt_write_lock(env, dir, 0);
1674         if (declare) {
1675                 rc = dt_declare_delete(env, dir, (struct dt_key *)name,
1676                                        th);
1677         } else {
1678                 rc = dt_delete(env, dir, (struct dt_key *)name, th);
1679         }
1680         dt_write_unlock(env, dir);
1681
1682         dt_object_put(env, dir);
1683         RETURN(rc);
1684 }
1685
1686 /**
1687  * Implementation of the llog_operations::lop_declare_destroy
1688  *
1689  * This function declare destroys the llog and deletes also entry in the
1690  * llog directory in case of named llog. Llog should be opened prior that.
1691  *
1692  * \param[in] env               execution environment
1693  * \param[in] loghandle llog handle of the current llog
1694  *
1695  * \retval              0 on successful destroy
1696  * \retval              negative value on error
1697  */
1698 static int llog_osd_declare_destroy(const struct lu_env *env,
1699                                     struct llog_handle *loghandle,
1700                                     struct thandle *th)
1701 {
1702         struct llog_ctxt        *ctxt;
1703         struct dt_object        *o, *llog_dir = NULL;
1704         int                      rc;
1705
1706         ENTRY;
1707
1708         ctxt = loghandle->lgh_ctxt;
1709         LASSERT(ctxt);
1710
1711         o = loghandle->lgh_obj;
1712         LASSERT(o);
1713
1714         if (loghandle->lgh_name) {
1715                 llog_dir = llog_osd_dir_get(env, ctxt);
1716                 if (IS_ERR(llog_dir))
1717                         RETURN(PTR_ERR(llog_dir));
1718
1719                 rc = dt_declare_delete(env, llog_dir,
1720                                        (struct dt_key *)loghandle->lgh_name,
1721                                        th);
1722                 if (rc < 0)
1723                         GOTO(out_put, rc);
1724         }
1725
1726         rc = dt_declare_ref_del(env, o, th);
1727         if (rc < 0)
1728                 GOTO(out_put, rc);
1729
1730         rc = dt_declare_destroy(env, o, th);
1731         if (rc < 0)
1732                 GOTO(out_put, rc);
1733
1734         if (loghandle->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1735                 rc = llog_osd_regular_fid_del_name_entry(env, o, th, true);
1736                 if (rc < 0)
1737                         GOTO(out_put, rc);
1738         }
1739
1740 out_put:
1741         if (!(IS_ERR_OR_NULL(llog_dir)))
1742                 dt_object_put(env, llog_dir);
1743
1744         RETURN(rc);
1745 }
1746
1747
1748 /**
1749  * Implementation of the llog_operations::lop_destroy
1750  *
1751  * This function destroys the llog and deletes also entry in the
1752  * llog directory in case of named llog. Llog should be opened prior that.
1753  * Destroy method is not part of external transaction and does everything
1754  * inside.
1755  *
1756  * \param[in] env               execution environment
1757  * \param[in] loghandle llog handle of the current llog
1758  *
1759  * \retval              0 on successful destroy
1760  * \retval              negative value on error
1761  */
1762 static int llog_osd_destroy(const struct lu_env *env,
1763                             struct llog_handle *loghandle, struct thandle *th)
1764 {
1765         struct llog_ctxt        *ctxt;
1766         struct dt_object        *o, *llog_dir = NULL;
1767         int                      rc;
1768
1769         ENTRY;
1770
1771         ctxt = loghandle->lgh_ctxt;
1772         LASSERT(ctxt != NULL);
1773
1774         o = loghandle->lgh_obj;
1775         LASSERT(o != NULL);
1776
1777         dt_write_lock(env, o, 0);
1778         if (!dt_object_exists(o))
1779                 GOTO(out_unlock, rc = 0);
1780
1781         if (loghandle->lgh_name) {
1782                 llog_dir = llog_osd_dir_get(env, ctxt);
1783                 if (IS_ERR(llog_dir))
1784                         GOTO(out_unlock, rc = PTR_ERR(llog_dir));
1785
1786                 dt_read_lock(env, llog_dir, 0);
1787                 rc = dt_delete(env, llog_dir,
1788                                (struct dt_key *)loghandle->lgh_name,
1789                                th);
1790                 dt_read_unlock(env, llog_dir);
1791                 if (rc) {
1792                         CERROR("%s: can't remove llog %s: rc = %d\n",
1793                                o->do_lu.lo_dev->ld_obd->obd_name,
1794                                loghandle->lgh_name, rc);
1795                         GOTO(out_unlock, rc);
1796                 }
1797         }
1798
1799         dt_ref_del(env, o, th);
1800         rc = dt_destroy(env, o, th);
1801         if (rc < 0)
1802                 GOTO(out_unlock, rc);
1803
1804         if (loghandle->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1805                 rc = llog_osd_regular_fid_del_name_entry(env, o, th, false);
1806                 if (rc < 0)
1807                         GOTO(out_unlock, rc);
1808         }
1809
1810 out_unlock:
1811         dt_write_unlock(env, o);
1812         if (!(IS_ERR_OR_NULL(llog_dir)))
1813                 dt_object_put(env, llog_dir);
1814         RETURN(rc);
1815 }
1816
1817 /**
1818  * Implementation of the llog_operations::lop_setup
1819  *
1820  * This function setup the llog on local storage.
1821  *
1822  * \param[in] env       execution environment
1823  * \param[in] obd       obd device the llog belongs to
1824  * \param[in] olg       the llog group, it is always zero group now.
1825  * \param[in] ctxt_idx  the llog index, it defines the purpose of this llog.
1826  *                      Every new llog type have to use own index.
1827  * \param[in] disk_obd  the storage obd, where llog is stored.
1828  *
1829  * \retval              0 on successful llog setup
1830  * \retval              negative value on error
1831  */
1832 static int llog_osd_setup(const struct lu_env *env, struct obd_device *obd,
1833                           struct obd_llog_group *olg, int ctxt_idx,
1834                           struct obd_device *disk_obd)
1835 {
1836         struct llog_thread_info         *lgi = llog_info(env);
1837         struct llog_ctxt                *ctxt;
1838         int                              rc = 0;
1839         ENTRY;
1840
1841         LASSERT(obd);
1842         LASSERT(olg->olg_ctxts[ctxt_idx]);
1843
1844         ctxt = llog_ctxt_get(olg->olg_ctxts[ctxt_idx]);
1845         LASSERT(ctxt);
1846
1847         if (disk_obd == NULL)
1848                 GOTO(out, rc = 0);
1849
1850         /* initialize data allowing to generate new fids,
1851          * literally we need a sequece */
1852         lgi->lgi_fid.f_seq = FID_SEQ_LLOG;
1853         lgi->lgi_fid.f_oid = 1;
1854         lgi->lgi_fid.f_ver = 0;
1855         rc = local_oid_storage_init(env, disk_obd->obd_lvfs_ctxt.dt,
1856                                     &lgi->lgi_fid,
1857                                     &ctxt->loc_los_nameless);
1858         if (rc != 0)
1859                 GOTO(out, rc);
1860
1861         lgi->lgi_fid.f_seq = FID_SEQ_LLOG_NAME;
1862         lgi->lgi_fid.f_oid = 1;
1863         lgi->lgi_fid.f_ver = 0;
1864         rc = local_oid_storage_init(env, disk_obd->obd_lvfs_ctxt.dt,
1865                                     &lgi->lgi_fid,
1866                                     &ctxt->loc_los_named);
1867         if (rc != 0) {
1868                 local_oid_storage_fini(env, ctxt->loc_los_nameless);
1869                 ctxt->loc_los_nameless = NULL;
1870         }
1871
1872         GOTO(out, rc);
1873
1874 out:
1875         llog_ctxt_put(ctxt);
1876         return rc;
1877 }
1878
1879 /**
1880  * Implementation of the llog_operations::lop_cleanup
1881  *
1882  * This function cleanups the llog on local storage.
1883  *
1884  * \param[in] env       execution environment
1885  * \param[in] ctxt      the llog context
1886  *
1887  * \retval              0
1888  */
1889 static int llog_osd_cleanup(const struct lu_env *env, struct llog_ctxt *ctxt)
1890 {
1891         if (ctxt->loc_los_nameless != NULL) {
1892                 local_oid_storage_fini(env, ctxt->loc_los_nameless);
1893                 ctxt->loc_los_nameless = NULL;
1894         }
1895
1896         if (ctxt->loc_los_named != NULL) {
1897                 local_oid_storage_fini(env, ctxt->loc_los_named);
1898                 ctxt->loc_los_named = NULL;
1899         }
1900
1901         return 0;
1902 }
1903
1904 struct llog_operations llog_osd_ops = {
1905         .lop_next_block         = llog_osd_next_block,
1906         .lop_prev_block         = llog_osd_prev_block,
1907         .lop_read_header        = llog_osd_read_header,
1908         .lop_declare_destroy    = llog_osd_declare_destroy,
1909         .lop_destroy            = llog_osd_destroy,
1910         .lop_setup              = llog_osd_setup,
1911         .lop_cleanup            = llog_osd_cleanup,
1912         .lop_open               = llog_osd_open,
1913         .lop_exist              = llog_osd_exist,
1914         .lop_declare_create     = llog_osd_declare_create,
1915         .lop_create             = llog_osd_create,
1916         .lop_declare_write_rec  = llog_osd_declare_write_rec,
1917         .lop_write_rec          = llog_osd_write_rec,
1918         .lop_close              = llog_osd_close,
1919 };
1920 EXPORT_SYMBOL(llog_osd_ops);
1921
1922 struct llog_operations llog_common_cat_ops = {
1923         .lop_next_block         = llog_osd_next_block,
1924         .lop_prev_block         = llog_osd_prev_block,
1925         .lop_read_header        = llog_osd_read_header,
1926         .lop_declare_destroy    = llog_osd_declare_destroy,
1927         .lop_destroy            = llog_osd_destroy,
1928         .lop_setup              = llog_osd_setup,
1929         .lop_cleanup            = llog_osd_cleanup,
1930         .lop_open               = llog_osd_open,
1931         .lop_exist              = llog_osd_exist,
1932         .lop_declare_create     = llog_osd_declare_create,
1933         .lop_create             = llog_osd_create,
1934         .lop_declare_write_rec  = llog_osd_declare_write_rec,
1935         .lop_write_rec          = llog_osd_write_rec,
1936         .lop_close              = llog_osd_close,
1937         .lop_add                = llog_cat_add_rec,
1938         .lop_declare_add        = llog_cat_declare_add_rec,
1939 };
1940 EXPORT_SYMBOL(llog_common_cat_ops);
1941
1942 /**
1943  * Read the special file which contains the list of llog catalogs IDs
1944  *
1945  * This function reads the CATALOGS file which contains the array of llog
1946  * catalogs IDs. The main purpose of this file is to store OSP llogs indexed
1947  * by OST/MDT number.
1948  *
1949  * \param[in]  env              execution environment
1950  * \param[in]  d                corresponding storage device
1951  * \param[in]  idx              position to start from, usually OST/MDT index
1952  * \param[in]  count            how many catalog IDs to read
1953  * \param[out] idarray          the buffer for the data. If it is NULL then
1954  *                              function returns just number of catalog IDs
1955  *                              in the file.
1956  * \param[in]  fid              LLOG_CATALOGS_OID for CATALOG object
1957  *
1958  * \retval                      0 on successful read of catalog IDs
1959  * \retval                      negative value on error
1960  * \retval                      positive value which is number of records in
1961  *                              the file if \a idarray is NULL
1962  */
1963 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
1964                           int idx, int count, struct llog_catid *idarray,
1965                           const struct lu_fid *fid)
1966 {
1967         struct llog_thread_info *lgi = llog_info(env);
1968         struct dt_object        *o = NULL;
1969         struct thandle          *th;
1970         int                      rc, size;
1971
1972         ENTRY;
1973
1974         LASSERT(d);
1975
1976         size = sizeof(*idarray) * count;
1977         lgi->lgi_off = idx *  sizeof(*idarray);
1978
1979         lgi->lgi_fid = *fid;
1980         o = dt_locate(env, d, &lgi->lgi_fid);
1981         if (IS_ERR(o))
1982                 RETURN(PTR_ERR(o));
1983
1984         if (!dt_object_exists(o)) {
1985                 th = dt_trans_create(env, d);
1986                 if (IS_ERR(th))
1987                         GOTO(out, rc = PTR_ERR(th));
1988
1989                 lgi->lgi_attr.la_valid = LA_MODE;
1990                 lgi->lgi_attr.la_mode = S_IFREG | S_IRUGO | S_IWUSR;
1991                 lgi->lgi_dof.dof_type = dt_mode_to_dft(S_IFREG);
1992
1993                 th->th_wait_submit = 1;
1994                 /* Make the llog object creation synchronization, so
1995                  * it will be reliable to the reference, especially
1996                  * for remote reference */
1997                 th->th_sync = 1;
1998
1999                 rc = dt_declare_create(env, o, &lgi->lgi_attr, NULL,
2000                                        &lgi->lgi_dof, th);
2001                 if (rc)
2002                         GOTO(out_trans, rc);
2003
2004                 rc = dt_trans_start_local(env, d, th);
2005                 if (rc)
2006                         GOTO(out_trans, rc);
2007
2008                 dt_write_lock(env, o, 0);
2009                 if (!dt_object_exists(o))
2010                         rc = dt_create(env, o, &lgi->lgi_attr, NULL,
2011                                        &lgi->lgi_dof, th);
2012                 dt_write_unlock(env, o);
2013 out_trans:
2014                 dt_trans_stop(env, d, th);
2015                 if (rc)
2016                         GOTO(out, rc);
2017         }
2018
2019         rc = dt_attr_get(env, o, &lgi->lgi_attr);
2020         if (rc)
2021                 GOTO(out, rc);
2022
2023         if (!S_ISREG(lgi->lgi_attr.la_mode)) {
2024                 CERROR("%s: CATALOGS is not a regular file!: mode = %o\n",
2025                        o->do_lu.lo_dev->ld_obd->obd_name,
2026                        lgi->lgi_attr.la_mode);
2027                 GOTO(out, rc = -ENOENT);
2028         }
2029
2030         CDEBUG(D_CONFIG, "cat list: disk size=%d, read=%d\n",
2031                (int)lgi->lgi_attr.la_size, size);
2032
2033         /* return just number of llogs */
2034         if (idarray == NULL) {
2035                 rc = lgi->lgi_attr.la_size / sizeof(*idarray);
2036                 GOTO(out, rc);
2037         }
2038
2039         /* read for new ost index or for empty file */
2040         memset(idarray, 0, size);
2041         if (lgi->lgi_attr.la_size <= lgi->lgi_off)
2042                 GOTO(out, rc = 0);
2043         if (lgi->lgi_attr.la_size < lgi->lgi_off + size)
2044                 size = lgi->lgi_attr.la_size - lgi->lgi_off;
2045
2046         lgi->lgi_buf.lb_buf = idarray;
2047         lgi->lgi_buf.lb_len = size;
2048         rc = dt_record_read(env, o, &lgi->lgi_buf, &lgi->lgi_off);
2049         /* -EFAULT means the llog is a sparse file. This is not an error
2050          * after arbitrary OST index is supported. */
2051         if (rc < 0 && rc != -EFAULT) {
2052                 CERROR("%s: error reading CATALOGS: rc = %d\n",
2053                        o->do_lu.lo_dev->ld_obd->obd_name,  rc);
2054                 GOTO(out, rc);
2055         }
2056
2057         EXIT;
2058 out:
2059         dt_object_put(env, o);
2060         RETURN(rc);
2061 }
2062 EXPORT_SYMBOL(llog_osd_get_cat_list);
2063
2064 /**
2065  * Write the special file which contains the list of llog catalogs IDs
2066  *
2067  * This function writes the CATALOG file which contains the array of llog
2068  * catalogs IDs. It is used mostly to store OSP llogs indexed by OST/MDT
2069  * number.
2070  *
2071  * \param[in]  env      execution environment
2072  * \param[in]  d        corresponding storage device
2073  * \param[in]  idx      position to start from, usually OST/MDT index
2074  * \param[in]  count    how many catalog IDs to write
2075  * \param[out] idarray  the buffer with the data to write.
2076  * \param[in]  fid      LLOG_CATALOGS_OID for CATALOG object
2077  *
2078  * \retval              0 on successful write of catalog IDs
2079  * \retval              negative value on error
2080  */
2081 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
2082                           int idx, int count, struct llog_catid *idarray,
2083                           const struct lu_fid *fid)
2084 {
2085         struct llog_thread_info *lgi = llog_info(env);
2086         struct dt_object        *o = NULL;
2087         struct thandle          *th;
2088         int                      rc, size;
2089
2090         if (count == 0)
2091                 RETURN(0);
2092
2093         LASSERT(d);
2094
2095         size = sizeof(*idarray) * count;
2096         lgi->lgi_off = idx * sizeof(*idarray);
2097         lgi->lgi_fid = *fid;
2098
2099         o = dt_locate(env, d, &lgi->lgi_fid);
2100         if (IS_ERR(o))
2101                 RETURN(PTR_ERR(o));
2102
2103         if (!dt_object_exists(o))
2104                 GOTO(out, rc = -ENOENT);
2105
2106         rc = dt_attr_get(env, o, &lgi->lgi_attr);
2107         if (rc)
2108                 GOTO(out, rc);
2109
2110         if (!S_ISREG(lgi->lgi_attr.la_mode)) {
2111                 CERROR("%s: CATALOGS is not a regular file!: mode = %o\n",
2112                        o->do_lu.lo_dev->ld_obd->obd_name,
2113                        lgi->lgi_attr.la_mode);
2114                 GOTO(out, rc = -ENOENT);
2115         }
2116
2117         th = dt_trans_create(env, d);
2118         if (IS_ERR(th))
2119                 GOTO(out, rc = PTR_ERR(th));
2120
2121         lgi->lgi_buf.lb_len = size;
2122         lgi->lgi_buf.lb_buf = idarray;
2123         rc = dt_declare_record_write(env, o, &lgi->lgi_buf, lgi->lgi_off, th);
2124         if (rc)
2125                 GOTO(out_trans, rc);
2126
2127         /* For update log, this happens during initialization,
2128          * see lod_sub_prep_llog(), and we need make sure catlog
2129          * file ID is written to catlist file(committed) before
2130          * cross-MDT operation write update records to catlog FILE,
2131          * otherwise, during failover these update records might
2132          * missing */
2133         if (fid_is_update_log(fid))
2134                 th->th_sync = 1;
2135
2136         rc = dt_trans_start_local(env, d, th);
2137         if (rc)
2138                 GOTO(out_trans, rc);
2139
2140         th->th_wait_submit = 1;
2141
2142         rc = dt_record_write(env, o, &lgi->lgi_buf, &lgi->lgi_off, th);
2143         if (rc)
2144                 CDEBUG(D_INODE, "can't write CATALOGS at index %d: rc = %d\n",
2145                        idx, rc);
2146 out_trans:
2147         dt_trans_stop(env, d, th);
2148 out:
2149         dt_object_put(env, o);
2150         RETURN(rc);
2151 }
2152 EXPORT_SYMBOL(llog_osd_put_cat_list);