Whamcloud - gitweb
2fee9d80038362b40d170063f6fedcb87448fcd2
[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                                      struct llog_handle *loghandle)
792 {
793         enum changelog_rec_flags flags = CLF_SUPPORTED;
794         enum changelog_rec_extra_flags extra_flags = CLFE_SUPPORTED;
795
796         if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_X_XATTR))
797                 extra_flags &= ~CLFE_XATTR;
798         if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_X_OMODE))
799                 extra_flags &= ~CLFE_OPEN;
800         if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_X_NID))
801                 extra_flags &= ~CLFE_NID;
802         if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_X_UIDGID))
803                 extra_flags &= ~CLFE_UIDGID;
804         if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_EXTRA_FLAGS))
805                 flags &= ~CLF_EXTRA_FLAGS;
806         if (!(loghandle->lgh_hdr->llh_flags & LLOG_F_EXT_JOBID))
807                 flags &= ~CLF_JOBID;
808
809         if (flags == CLF_SUPPORTED && extra_flags == CLFE_SUPPORTED)
810                 return;
811
812         if (hdr->lrh_type != CHANGELOG_REC)
813                 return;
814
815         do {
816                 struct changelog_rec *rec = (struct changelog_rec *)(hdr + 1);
817                 enum changelog_rec_extra_flags xflag = CLFE_INVALID;
818
819                 if (flags & CLF_EXTRA_FLAGS &&
820                     rec->cr_flags & CLF_EXTRA_FLAGS) {
821                         xflag = changelog_rec_extra_flags(rec)->cr_extra_flags &
822                                 extra_flags;
823                 }
824
825                 changelog_remap_rec(rec, rec->cr_flags & flags, xflag);
826                 hdr = llog_rec_hdr_next(hdr);
827         } while ((char *)hdr <= (char *)last_hdr);
828 }
829
830 /**
831  * Implementation of the llog_operations::lop_next_block
832  *
833  * This function finds the the next llog block to return which contains
834  * record with required index. It is main part of llog processing.
835  *
836  * \param[in]     env           execution environment
837  * \param[in]     loghandle     llog handle of the current llog
838  * \param[in,out] cur_idx       index preceeding cur_offset
839  * \param[in]     next_idx      target index to find
840  * \param[in,out] cur_offset    furtherst point read in the file
841  * \param[in]     buf           pointer to data buffer to fill
842  * \param[in]     len           required len to read, it is
843  *                              usually llog chunk_size.
844  *
845  * \retval                      0 on successful buffer read
846  * \retval                      negative value on error
847  */
848 static int llog_osd_next_block(const struct lu_env *env,
849                                struct llog_handle *loghandle, int *cur_idx,
850                                int next_idx, __u64 *cur_offset, void *buf,
851                                int len)
852 {
853         struct llog_thread_info *lgi = llog_info(env);
854         struct dt_object        *o;
855         struct dt_device        *dt;
856         int                      rc;
857         __u32                   chunk_size;
858         int last_idx = *cur_idx;
859         __u64 last_offset = *cur_offset;
860         bool force_mini_rec = false;
861
862         ENTRY;
863
864         LASSERT(env);
865         LASSERT(lgi);
866
867         chunk_size = loghandle->lgh_hdr->llh_hdr.lrh_len;
868         if (len == 0 || len & (chunk_size - 1))
869                 RETURN(-EINVAL);
870
871         LASSERT(loghandle);
872         LASSERT(loghandle->lgh_ctxt);
873
874         o = loghandle->lgh_obj;
875         LASSERT(o);
876         LASSERT(dt_object_exists(o));
877         dt = lu2dt_dev(o->do_lu.lo_dev);
878         LASSERT(dt);
879
880         rc = dt_attr_get(env, o, &lgi->lgi_attr);
881         if (rc)
882                 GOTO(out, rc);
883
884         CDEBUG(D_OTHER, "looking for log index %u (cur idx %u off"
885                "%llu), size %llu\n", next_idx, *cur_idx,
886                *cur_offset, lgi->lgi_attr.la_size);
887
888         while (*cur_offset < lgi->lgi_attr.la_size) {
889                 struct llog_rec_hdr     *rec, *last_rec;
890                 struct llog_rec_tail    *tail;
891
892                 llog_skip_over(loghandle, cur_offset, *cur_idx,
893                                next_idx, chunk_size, force_mini_rec);
894
895                 /* read up to next llog chunk_size block */
896                 lgi->lgi_buf.lb_len = chunk_size -
897                                       (*cur_offset & (chunk_size - 1));
898                 lgi->lgi_buf.lb_buf = buf;
899
900                 rc = dt_read(env, o, &lgi->lgi_buf, cur_offset);
901                 if (rc < 0) {
902                         if (rc == -EBADR && !force_mini_rec)
903                                 goto retry;
904
905                         CERROR("%s: can't read llog block from log "DFID
906                                " offset %llu: rc = %d\n",
907                                o->do_lu.lo_dev->ld_obd->obd_name,
908                                PFID(lu_object_fid(&o->do_lu)), *cur_offset,
909                                rc);
910                         GOTO(out, rc);
911                 }
912
913                 if (rc < len) {
914                         /* signal the end of the valid buffer to
915                          * llog_process */
916                         memset(buf + rc, 0, len - rc);
917                 }
918
919                 if (rc == 0) { /* end of file, nothing to do */
920                         if (!force_mini_rec)
921                                 goto retry;
922                         GOTO(out, rc);
923                 }
924
925                 if (rc < sizeof(*tail)) {
926                         if (!force_mini_rec)
927                                 goto retry;
928
929                         CERROR("%s: invalid llog block at log id "DFID":%x "
930                                "offset %llu\n",
931                                o->do_lu.lo_dev->ld_obd->obd_name,
932                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid),
933                                loghandle->lgh_id.lgl_ogen, *cur_offset);
934                         GOTO(out, rc = -EINVAL);
935                 }
936
937                 rec = buf;
938                 if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
939                         lustre_swab_llog_rec(rec);
940
941                 tail = (struct llog_rec_tail *)((char *)buf + rc -
942                                                 sizeof(struct llog_rec_tail));
943                 /* get the last record in block */
944                 last_rec = (struct llog_rec_hdr *)((char *)buf + rc -
945                                                    tail->lrt_len);
946
947                 if (LLOG_REC_HDR_NEEDS_SWABBING(last_rec))
948                         lustre_swab_llog_rec(last_rec);
949
950                 if (last_rec->lrh_index != tail->lrt_index) {
951                         CERROR("%s: invalid llog tail at log id "DFID":%x "
952                                "offset %llu last_rec idx %u tail idx %u"
953                                "lrt len %u read_size %d\n",
954                                o->do_lu.lo_dev->ld_obd->obd_name,
955                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid),
956                                loghandle->lgh_id.lgl_ogen, *cur_offset,
957                                last_rec->lrh_index, tail->lrt_index,
958                                tail->lrt_len, rc);
959                         GOTO(out, rc = -EINVAL);
960                 }
961
962                 *cur_idx = tail->lrt_index;
963
964                 /* this shouldn't happen */
965                 if (tail->lrt_index == 0) {
966                         CERROR("%s: invalid llog tail at log id "DFID":%x "
967                                "offset %llu bytes %d\n",
968                                o->do_lu.lo_dev->ld_obd->obd_name,
969                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid),
970                                loghandle->lgh_id.lgl_ogen, *cur_offset, rc);
971                         GOTO(out, rc = -EINVAL);
972                 }
973                 if (tail->lrt_index < next_idx) {
974                         last_idx = *cur_idx;
975                         last_offset = *cur_offset;
976                         continue;
977                 }
978
979                 /* sanity check that the start of the new buffer is no farther
980                  * than the record that we wanted.  This shouldn't happen. */
981                 if (rec->lrh_index > next_idx) {
982                         if (!force_mini_rec && next_idx > last_idx)
983                                 goto retry;
984
985                         CERROR("%s: missed desired record? %u > %u\n",
986                                o->do_lu.lo_dev->ld_obd->obd_name,
987                                rec->lrh_index, next_idx);
988                         GOTO(out, rc = -ENOENT);
989                 }
990
991                 /* Trim unsupported extensions for compat w/ older clients */
992                 changelog_block_trim_ext(rec, last_rec, loghandle);
993
994                 GOTO(out, rc = 0);
995
996 retry:
997                 /* Note: because there are some pad records in the
998                  * llog, so llog_skip_over() might skip too much
999                  * records, let's try skip again with minimum record */
1000                 force_mini_rec = true;
1001                 *cur_offset = last_offset;
1002                 *cur_idx = last_idx;
1003         }
1004         GOTO(out, rc = -EIO);
1005 out:
1006         return rc;
1007 }
1008
1009 /**
1010  * Implementation of the llog_operations::lop_prev_block
1011  *
1012  * This function finds the llog block to return which contains
1013  * record with required index but in reverse order - from end of llog
1014  * to the beginning.
1015  * It is main part of reverse llog processing.
1016  *
1017  * \param[in] env       execution environment
1018  * \param[in] loghandle llog handle of the current llog
1019  * \param[in] prev_idx  target index to find
1020  * \param[in] buf       pointer to data buffer to fill
1021  * \param[in] len       required len to read, it is llog_chunk_size usually.
1022  *
1023  * \retval              0 on successful buffer read
1024  * \retval              negative value on error
1025  */
1026 static int llog_osd_prev_block(const struct lu_env *env,
1027                                struct llog_handle *loghandle,
1028                                int prev_idx, void *buf, int len)
1029 {
1030         struct llog_thread_info *lgi = llog_info(env);
1031         struct dt_object        *o;
1032         struct dt_device        *dt;
1033         loff_t                   cur_offset;
1034         __u32                   chunk_size;
1035         int                      rc;
1036
1037         ENTRY;
1038
1039         chunk_size = loghandle->lgh_hdr->llh_hdr.lrh_len;
1040         if (len == 0 || len & (chunk_size - 1))
1041                 RETURN(-EINVAL);
1042
1043         CDEBUG(D_OTHER, "looking for log index %u\n", prev_idx);
1044
1045         LASSERT(loghandle);
1046         LASSERT(loghandle->lgh_ctxt);
1047
1048         o = loghandle->lgh_obj;
1049         LASSERT(o);
1050         LASSERT(dt_object_exists(o));
1051         dt = lu2dt_dev(o->do_lu.lo_dev);
1052         LASSERT(dt);
1053
1054         /* Let's only use mini record size for previous block read
1055          * for now XXX */
1056         cur_offset = chunk_size;
1057         llog_skip_over(loghandle, &cur_offset, 0, prev_idx,
1058                        chunk_size, true);
1059
1060         rc = dt_attr_get(env, o, &lgi->lgi_attr);
1061         if (rc)
1062                 GOTO(out, rc);
1063
1064         while (cur_offset < lgi->lgi_attr.la_size) {
1065                 struct llog_rec_hdr     *rec, *last_rec;
1066                 struct llog_rec_tail    *tail;
1067
1068                 lgi->lgi_buf.lb_len = len;
1069                 lgi->lgi_buf.lb_buf = buf;
1070                 rc = dt_read(env, o, &lgi->lgi_buf, &cur_offset);
1071                 if (rc < 0) {
1072                         CERROR("%s: can't read llog block from log "DFID
1073                                " offset %llu: rc = %d\n",
1074                                o->do_lu.lo_dev->ld_obd->obd_name,
1075                                PFID(lu_object_fid(&o->do_lu)), cur_offset, rc);
1076                         GOTO(out, rc);
1077                 }
1078
1079                 if (rc == 0) /* end of file, nothing to do */
1080                         GOTO(out, rc);
1081
1082                 if (rc < sizeof(*tail)) {
1083                         CERROR("%s: invalid llog block at log id "DFID":%x "
1084                                "offset %llu\n",
1085                                o->do_lu.lo_dev->ld_obd->obd_name,
1086                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid),
1087                                loghandle->lgh_id.lgl_ogen, cur_offset);
1088                         GOTO(out, rc = -EINVAL);
1089                 }
1090
1091                 rec = buf;
1092                 if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
1093                         lustre_swab_llog_rec(rec);
1094
1095                 tail = (struct llog_rec_tail *)((char *)buf + rc -
1096                                                 sizeof(struct llog_rec_tail));
1097                 /* get the last record in block */
1098                 last_rec = (struct llog_rec_hdr *)((char *)buf + rc -
1099                                                    le32_to_cpu(tail->lrt_len));
1100
1101                 if (LLOG_REC_HDR_NEEDS_SWABBING(last_rec))
1102                         lustre_swab_llog_rec(last_rec);
1103                 LASSERT(last_rec->lrh_index == tail->lrt_index);
1104
1105                 /* this shouldn't happen */
1106                 if (tail->lrt_index == 0) {
1107                         CERROR("%s: invalid llog tail at log id "DFID":%x "
1108                                "offset %llu\n",
1109                                o->do_lu.lo_dev->ld_obd->obd_name,
1110                                PFID(&loghandle->lgh_id.lgl_oi.oi_fid),
1111                                loghandle->lgh_id.lgl_ogen, cur_offset);
1112                         GOTO(out, rc = -EINVAL);
1113                 }
1114                 if (tail->lrt_index < prev_idx)
1115                         continue;
1116
1117                 /* sanity check that the start of the new buffer is no farther
1118                  * than the record that we wanted.  This shouldn't happen. */
1119                 if (rec->lrh_index > prev_idx) {
1120                         CERROR("%s: missed desired record? %u > %u\n",
1121                                o->do_lu.lo_dev->ld_obd->obd_name,
1122                                rec->lrh_index, prev_idx);
1123                         GOTO(out, rc = -ENOENT);
1124                 }
1125
1126                 /* Trim unsupported extensions for compat w/ older clients */
1127                 changelog_block_trim_ext(rec, last_rec, loghandle);
1128
1129                 GOTO(out, rc = 0);
1130         }
1131         GOTO(out, rc = -EIO);
1132 out:
1133         return rc;
1134 }
1135
1136 /**
1137  * This is helper function to get llog directory object. It is used by named
1138  * llog operations to find/insert/delete llog entry from llog directory.
1139  *
1140  * \param[in] env       execution environment
1141  * \param[in] ctxt      llog context
1142  *
1143  * \retval              dt_object of llog directory
1144  * \retval              ERR_PTR of negative value on error
1145  */
1146 static struct dt_object *llog_osd_dir_get(const struct lu_env *env,
1147                                           struct llog_ctxt *ctxt)
1148 {
1149         struct dt_device        *dt;
1150         struct dt_thread_info   *dti = dt_info(env);
1151         struct dt_object        *dir;
1152         int                      rc;
1153
1154         dt = ctxt->loc_exp->exp_obd->obd_lvfs_ctxt.dt;
1155         if (ctxt->loc_dir == NULL) {
1156                 rc = dt_root_get(env, dt, &dti->dti_fid);
1157                 if (rc)
1158                         return ERR_PTR(rc);
1159                 dir = dt_locate(env, dt, &dti->dti_fid);
1160
1161                 if (!IS_ERR(dir) && !dt_try_as_dir(env, dir)) {
1162                         dt_object_put(env, dir);
1163                         return ERR_PTR(-ENOTDIR);
1164                 }
1165         } else {
1166                 lu_object_get(&ctxt->loc_dir->do_lu);
1167                 dir = ctxt->loc_dir;
1168         }
1169
1170         return dir;
1171 }
1172
1173 /**
1174  * Implementation of the llog_operations::lop_open
1175  *
1176  * This function opens the llog by its logid or by name, it may open also
1177  * non existent llog and assing then new id to it.
1178  * The llog_open/llog_close pair works similar to lu_object_find/put,
1179  * the object may not exist prior open. The result of open is just dt_object
1180  * in the llog header.
1181  *
1182  * \param[in] env               execution environment
1183  * \param[in] handle            llog handle of the current llog
1184  * \param[in] logid             logid of llog to open (nameless llog)
1185  * \param[in] name              name of llog to open (named llog)
1186  * \param[in] open_param
1187  *                              LLOG_OPEN_NEW - new llog, may not exist
1188  *                              LLOG_OPEN_EXIST - old llog, must exist
1189  *
1190  * \retval                      0 on successful open, llog_handle::lgh_obj
1191  *                              contains the dt_object of the llog.
1192  * \retval                      negative value on error
1193  */
1194 static int llog_osd_open(const struct lu_env *env, struct llog_handle *handle,
1195                          struct llog_logid *logid, char *name,
1196                          enum llog_open_param open_param)
1197 {
1198         struct llog_thread_info         *lgi = llog_info(env);
1199         struct llog_ctxt                *ctxt = handle->lgh_ctxt;
1200         struct dt_object                *o;
1201         struct dt_device                *dt;
1202         struct ls_device                *ls;
1203         struct local_oid_storage        *los = NULL;
1204         int                              rc = 0;
1205         bool new_id = false;
1206
1207         ENTRY;
1208
1209         LASSERT(env);
1210         LASSERT(ctxt);
1211         LASSERT(ctxt->loc_exp);
1212         LASSERT(ctxt->loc_exp->exp_obd);
1213         dt = ctxt->loc_exp->exp_obd->obd_lvfs_ctxt.dt;
1214         LASSERT(dt);
1215         if (ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1216                 struct lu_object_conf conf = { 0 };
1217                 if (logid != NULL) {
1218                         logid_to_fid(logid, &lgi->lgi_fid);
1219                 } else {
1220                         /* If logid == NULL, then it means the caller needs
1221                          * to allocate new FID (llog_cat_declare_add_rec()). */
1222                         rc = obd_fid_alloc(env, ctxt->loc_exp,
1223                                            &lgi->lgi_fid, NULL);
1224                         if (rc < 0)
1225                                 RETURN(rc);
1226                         rc = 0;
1227                         conf.loc_flags = LOC_F_NEW;
1228                 }
1229
1230                 o = dt_locate_at(env, dt, &lgi->lgi_fid,
1231                                  dt->dd_lu_dev.ld_site->ls_top_dev, &conf);
1232                 if (IS_ERR(o))
1233                         RETURN(PTR_ERR(o));
1234
1235                 goto after_open;
1236         }
1237
1238         ls = ls_device_get(dt);
1239         if (IS_ERR(ls))
1240                 RETURN(PTR_ERR(ls));
1241
1242         mutex_lock(&ls->ls_los_mutex);
1243         los = dt_los_find(ls, name != NULL ? FID_SEQ_LLOG_NAME : FID_SEQ_LLOG);
1244         mutex_unlock(&ls->ls_los_mutex);
1245         LASSERT(los);
1246         ls_device_put(env, ls);
1247
1248         LASSERT(handle);
1249
1250         if (logid != NULL) {
1251                 logid_to_fid(logid, &lgi->lgi_fid);
1252         } else if (name) {
1253                 struct dt_object *llog_dir;
1254
1255                 llog_dir = llog_osd_dir_get(env, ctxt);
1256                 if (IS_ERR(llog_dir))
1257                         GOTO(out, rc = PTR_ERR(llog_dir));
1258                 dt_read_lock(env, llog_dir, 0);
1259                 rc = dt_lookup_dir(env, llog_dir, name, &lgi->lgi_fid);
1260                 dt_read_unlock(env, llog_dir);
1261                 dt_object_put(env, llog_dir);
1262                 if (rc == -ENOENT && open_param == LLOG_OPEN_NEW) {
1263                         /* generate fid for new llog */
1264                         rc = local_object_fid_generate(env, los,
1265                                                        &lgi->lgi_fid);
1266                         new_id = true;
1267                 }
1268                 if (rc < 0)
1269                         GOTO(out, rc);
1270                 OBD_ALLOC(handle->lgh_name, strlen(name) + 1);
1271                 if (handle->lgh_name)
1272                         strcpy(handle->lgh_name, name);
1273                 else
1274                         GOTO(out, rc = -ENOMEM);
1275         } else {
1276                 LASSERTF(open_param & LLOG_OPEN_NEW, "%#x\n", open_param);
1277                 /* generate fid for new llog */
1278 generate:
1279                 rc = local_object_fid_generate(env, los, &lgi->lgi_fid);
1280                 if (rc < 0)
1281                         GOTO(out, rc);
1282                 new_id = true;
1283         }
1284
1285         o = ls_locate(env, ls, &lgi->lgi_fid, NULL);
1286         if (IS_ERR(o))
1287                 GOTO(out_name, rc = PTR_ERR(o));
1288
1289         if (dt_object_exists(o) && new_id) {
1290                 /* llog exists with just generated ID, e.g. some old llog file
1291                  * still is in use or is orphan, drop a warn and skip it. */
1292                 CDEBUG(D_INFO, "%s: llog exists with the same FID: "DFID
1293                        ", skipping\n",
1294                        o->do_lu.lo_dev->ld_obd->obd_name,
1295                        PFID(lu_object_fid(&o->do_lu)));
1296                 dt_object_put(env, o);
1297                 /* just skip this llog ID, we shouldn't delete it because we
1298                  * don't know exactly what is its purpose and state. */
1299                 goto generate;
1300         }
1301
1302 after_open:
1303         /* No new llog is expected but doesn't exist */
1304         if (open_param != LLOG_OPEN_NEW && !dt_object_exists(o)) {
1305                 CDEBUG(D_INFO, "%s: llog FID: "DFID" obj %p doesn`t exist\n",
1306                        o->do_lu.lo_dev->ld_obd->obd_name,
1307                        PFID(lu_object_fid(&o->do_lu)), o);
1308                 GOTO(out_put, rc = -ENOENT);
1309         }
1310         fid_to_logid(&lgi->lgi_fid, &handle->lgh_id);
1311         handle->lgh_obj = o;
1312         handle->private_data = los;
1313         LASSERT(handle->lgh_ctxt);
1314
1315         RETURN(rc);
1316
1317 out_put:
1318         dt_object_put(env, o);
1319 out_name:
1320         if (handle->lgh_name != NULL)
1321                 OBD_FREE(handle->lgh_name, strlen(name) + 1);
1322 out:
1323         if (los != NULL)
1324                 dt_los_put(los);
1325         RETURN(rc);
1326 }
1327
1328 /**
1329  * Get dir for regular fid log object
1330  *
1331  * Get directory for regular fid log object, and these regular fid log
1332  * object will be inserted under this directory, to satisfy the FS
1333  * consistency check, e2fsck etc.
1334  *
1335  * \param [in] env      execution environment
1336  * \param [in] dto      llog object
1337  *
1338  * \retval              pointer to the directory if it is found.
1339  * \retval              ERR_PTR(negative errno) if it fails.
1340  */
1341 struct dt_object *llog_osd_get_regular_fid_dir(const struct lu_env *env,
1342                                                struct dt_object *dto)
1343 {
1344         struct llog_thread_info *lgi = llog_info(env);
1345         struct seq_server_site *ss = dto->do_lu.lo_dev->ld_site->ld_seq_site;
1346         struct lu_seq_range     *range = &lgi->lgi_range;
1347         struct lu_fid           *dir_fid = &lgi->lgi_fid;
1348         struct dt_object        *dir;
1349         int                     rc;
1350         ENTRY;
1351
1352         fld_range_set_any(range);
1353         LASSERT(ss != NULL);
1354         rc = ss->ss_server_fld->lsf_seq_lookup(env, ss->ss_server_fld,
1355                                    fid_seq(lu_object_fid(&dto->do_lu)), range);
1356         if (rc < 0)
1357                 RETURN(ERR_PTR(rc));
1358
1359         lu_update_log_dir_fid(dir_fid, range->lsr_index);
1360         dir = dt_locate(env, lu2dt_dev(dto->do_lu.lo_dev), dir_fid);
1361         if (IS_ERR(dir))
1362                 RETURN(dir);
1363
1364         if (!dt_try_as_dir(env, dir)) {
1365                 dt_object_put(env, dir);
1366                 RETURN(ERR_PTR(-ENOTDIR));
1367         }
1368
1369         RETURN(dir);
1370 }
1371
1372 /**
1373  * Add llog object with regular FID to name entry
1374  *
1375  * Add llog object with regular FID to name space, and each llog
1376  * object on each MDT will be /update_log_dir/[seq:oid:ver],
1377  * so to satisfy the namespace consistency check, e2fsck etc.
1378  *
1379  * \param [in] env      execution environment
1380  * \param [in] dto      llog object
1381  * \param [in] th       thandle
1382  * \param [in] declare  if it is declare or execution
1383  *
1384  * \retval              0 if insertion succeeds.
1385  * \retval              negative errno if insertion fails.
1386  */
1387 static int
1388 llog_osd_regular_fid_add_name_entry(const struct lu_env *env,
1389                                     struct dt_object *dto,
1390                                     struct thandle *th, bool declare)
1391 {
1392         struct llog_thread_info *lgi = llog_info(env);
1393         const struct lu_fid     *fid = lu_object_fid(&dto->do_lu);
1394         struct dt_insert_rec    *rec = &lgi->lgi_dt_rec;
1395         struct dt_object        *dir;
1396         char                    *name = lgi->lgi_name;
1397         int                     rc;
1398         ENTRY;
1399
1400         if (!fid_is_norm(fid))
1401                 RETURN(0);
1402
1403         dir = llog_osd_get_regular_fid_dir(env, dto);
1404         if (IS_ERR(dir))
1405                 RETURN(PTR_ERR(dir));
1406
1407         rec->rec_fid = fid;
1408         rec->rec_type = S_IFREG;
1409         snprintf(name, sizeof(lgi->lgi_name), DFID, PFID(fid));
1410         dt_write_lock(env, dir, 0);
1411         if (declare) {
1412                 rc = dt_declare_insert(env, dir, (struct dt_rec *)rec,
1413                                (struct dt_key *)name, th);
1414         } else {
1415                 rc = dt_insert(env, dir, (struct dt_rec *)rec,
1416                                (struct dt_key *)name, th, 1);
1417         }
1418         dt_write_unlock(env, dir);
1419
1420         dt_object_put(env, dir);
1421         RETURN(rc);
1422 }
1423
1424
1425 /**
1426  * Implementation of the llog_operations::lop_declare_create
1427  *
1428  * This function declares the llog create. It declares also name insert
1429  * into llog directory in case of named llog.
1430  *
1431  * \param[in] env       execution environment
1432  * \param[in] res       llog handle of the current llog
1433  * \param[in] th        current transaction handle
1434  *
1435  * \retval              0 on successful create declaration
1436  * \retval              negative value on error
1437  */
1438 static int llog_osd_declare_create(const struct lu_env *env,
1439                                    struct llog_handle *res, struct thandle *th)
1440 {
1441         struct llog_thread_info         *lgi = llog_info(env);
1442         struct dt_insert_rec            *rec = &lgi->lgi_dt_rec;
1443         struct local_oid_storage        *los;
1444         struct dt_object                *o;
1445         int                              rc;
1446
1447         ENTRY;
1448
1449         LASSERT(res->lgh_obj);
1450         LASSERT(th);
1451
1452         /* object can be created by another thread */
1453         o = res->lgh_obj;
1454         if (dt_object_exists(o))
1455                 RETURN(0);
1456
1457         if (res->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1458                 struct llog_thread_info *lgi = llog_info(env);
1459
1460                 lgi->lgi_attr.la_valid = LA_MODE | LA_SIZE;
1461                 lgi->lgi_attr.la_size = 0;
1462                 lgi->lgi_attr.la_mode = S_IFREG | S_IRUGO | S_IWUSR;
1463                 lgi->lgi_dof.dof_type = dt_mode_to_dft(S_IFREG);
1464
1465                 rc = dt_declare_create(env, o, &lgi->lgi_attr, NULL,
1466                                        &lgi->lgi_dof, th);
1467                 if (rc < 0)
1468                         RETURN(rc);
1469
1470
1471                 rc = llog_osd_regular_fid_add_name_entry(env, o, th, true);
1472
1473                 RETURN(rc);
1474         }
1475         los = res->private_data;
1476         LASSERT(los);
1477
1478         rc = llog_osd_declare_new_object(env, los, o, th);
1479         if (rc)
1480                 RETURN(rc);
1481
1482         /* do not declare header initialization here as it's declared
1483          * in llog_osd_declare_write_rec() which is always called */
1484
1485         if (res->lgh_name) {
1486                 struct dt_object *llog_dir;
1487
1488                 llog_dir = llog_osd_dir_get(env, res->lgh_ctxt);
1489                 if (IS_ERR(llog_dir))
1490                         RETURN(PTR_ERR(llog_dir));
1491                 logid_to_fid(&res->lgh_id, &lgi->lgi_fid);
1492                 rec->rec_fid = &lgi->lgi_fid;
1493                 rec->rec_type = S_IFREG;
1494                 rc = dt_declare_insert(env, llog_dir,
1495                                        (struct dt_rec *)rec,
1496                                        (struct dt_key *)res->lgh_name, th);
1497                 dt_object_put(env, llog_dir);
1498                 if (rc)
1499                         CERROR("%s: can't declare named llog %s: rc = %d\n",
1500                                o->do_lu.lo_dev->ld_obd->obd_name,
1501                                res->lgh_name, rc);
1502         }
1503         RETURN(rc);
1504 }
1505
1506 /**
1507  * Implementation of the llog_operations::lop_create
1508  *
1509  * This function creates the llog according with llog_handle::lgh_obj
1510  * and llog_handle::lgh_name.
1511  *
1512  * \param[in] env       execution environment
1513  * \param[in] res       llog handle of the current llog
1514  * \param[in] th        current transaction handle
1515  *
1516  * \retval              0 on successful create
1517  * \retval              negative value on error
1518  */
1519 static int llog_osd_create(const struct lu_env *env, struct llog_handle *res,
1520                            struct thandle *th)
1521 {
1522         struct llog_thread_info *lgi = llog_info(env);
1523         struct dt_insert_rec    *rec = &lgi->lgi_dt_rec;
1524         struct local_oid_storage *los;
1525         struct dt_object        *o;
1526         int                      rc = 0;
1527
1528         ENTRY;
1529
1530         LASSERT(env);
1531         o = res->lgh_obj;
1532         LASSERT(o);
1533
1534         /* llog can be already created */
1535         if (dt_object_exists(o))
1536                 RETURN(-EEXIST);
1537
1538         if (res->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1539                 struct llog_thread_info *lgi = llog_info(env);
1540
1541                 lgi->lgi_attr.la_valid = LA_MODE | LA_SIZE | LA_TYPE;
1542                 lgi->lgi_attr.la_size = 0;
1543                 lgi->lgi_attr.la_mode = S_IFREG | S_IRUGO | S_IWUSR;
1544                 lgi->lgi_dof.dof_type = dt_mode_to_dft(S_IFREG);
1545
1546                 dt_write_lock(env, o, 0);
1547                 rc = dt_create(env, o, &lgi->lgi_attr, NULL,
1548                                &lgi->lgi_dof, th);
1549                 dt_write_unlock(env, o);
1550                 if (rc < 0)
1551                         RETURN(rc);
1552
1553                 rc = llog_osd_regular_fid_add_name_entry(env, o, th, false);
1554
1555                 RETURN(rc);
1556         }
1557
1558         los = res->private_data;
1559         LASSERT(los);
1560
1561         dt_write_lock(env, o, 0);
1562         if (!dt_object_exists(o))
1563                 rc = llog_osd_create_new_object(env, los, o, th);
1564         else
1565                 rc = -EEXIST;
1566
1567         dt_write_unlock(env, o);
1568         if (rc)
1569                 RETURN(rc);
1570
1571         if (res->lgh_name) {
1572                 struct dt_object *llog_dir;
1573
1574                 llog_dir = llog_osd_dir_get(env, res->lgh_ctxt);
1575                 if (IS_ERR(llog_dir))
1576                         RETURN(PTR_ERR(llog_dir));
1577
1578                 logid_to_fid(&res->lgh_id, &lgi->lgi_fid);
1579                 rec->rec_fid = &lgi->lgi_fid;
1580                 rec->rec_type = S_IFREG;
1581                 dt_read_lock(env, llog_dir, 0);
1582                 rc = dt_insert(env, llog_dir, (struct dt_rec *)rec,
1583                                (struct dt_key *)res->lgh_name,
1584                                th, 1);
1585                 dt_read_unlock(env, llog_dir);
1586                 dt_object_put(env, llog_dir);
1587                 if (rc)
1588                         CERROR("%s: can't create named llog %s: rc = %d\n",
1589                                o->do_lu.lo_dev->ld_obd->obd_name,
1590                                res->lgh_name, rc);
1591         }
1592         RETURN(rc);
1593 }
1594
1595 /**
1596  * Implementation of the llog_operations::lop_close
1597  *
1598  * This function closes the llog. It just put llog object and referenced
1599  * local storage.
1600  *
1601  * \param[in] env       execution environment
1602  * \param[in] handle    llog handle of the current llog
1603  *
1604  * \retval              0 on successful llog close
1605  * \retval              negative value on error
1606  */
1607 static int llog_osd_close(const struct lu_env *env, struct llog_handle *handle)
1608 {
1609         struct local_oid_storage        *los;
1610         int                              rc = 0;
1611
1612         ENTRY;
1613
1614         LASSERT(handle->lgh_obj);
1615
1616         if (handle->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1617                 /* Remove the object from the cache, otherwise it may
1618                  * hold LOD being released during cleanup process */
1619                 dt_object_put_nocache(env, handle->lgh_obj);
1620                 LASSERT(handle->private_data == NULL);
1621                 RETURN(rc);
1622         } else {
1623                 dt_object_put(env, handle->lgh_obj);
1624         }
1625         los = handle->private_data;
1626         LASSERT(los);
1627         dt_los_put(los);
1628
1629         if (handle->lgh_name)
1630                 OBD_FREE(handle->lgh_name, strlen(handle->lgh_name) + 1);
1631
1632         RETURN(rc);
1633 }
1634
1635 /**
1636  * delete llog object name entry
1637  *
1638  * Delete llog object (with regular FID) from name space (under
1639  * update_log_dir).
1640  *
1641  * \param [in] env      execution environment
1642  * \param [in] dto      llog object
1643  * \param [in] th       thandle
1644  * \param [in] declare  if it is declare or execution
1645  *
1646  * \retval              0 if deletion succeeds.
1647  * \retval              negative errno if deletion fails.
1648  */
1649 static int
1650 llog_osd_regular_fid_del_name_entry(const struct lu_env *env,
1651                                     struct dt_object *dto,
1652                                     struct thandle *th, bool declare)
1653 {
1654         struct llog_thread_info *lgi = llog_info(env);
1655         const struct lu_fid     *fid = lu_object_fid(&dto->do_lu);
1656         struct dt_object        *dir;
1657         char                    *name = lgi->lgi_name;
1658         int                     rc;
1659         ENTRY;
1660
1661         if (!fid_is_norm(fid))
1662                 RETURN(0);
1663
1664         dir = llog_osd_get_regular_fid_dir(env, dto);
1665         if (IS_ERR(dir))
1666                 RETURN(PTR_ERR(dir));
1667
1668         snprintf(name, sizeof(lgi->lgi_name), DFID, PFID(fid));
1669         dt_write_lock(env, dir, 0);
1670         if (declare) {
1671                 rc = dt_declare_delete(env, dir, (struct dt_key *)name,
1672                                        th);
1673         } else {
1674                 rc = dt_delete(env, dir, (struct dt_key *)name, th);
1675         }
1676         dt_write_unlock(env, dir);
1677
1678         dt_object_put(env, dir);
1679         RETURN(rc);
1680 }
1681
1682 /**
1683  * Implementation of the llog_operations::lop_declare_destroy
1684  *
1685  * This function declare destroys the llog and deletes also entry in the
1686  * llog directory in case of named llog. Llog should be opened prior that.
1687  *
1688  * \param[in] env               execution environment
1689  * \param[in] loghandle llog handle of the current llog
1690  *
1691  * \retval              0 on successful destroy
1692  * \retval              negative value on error
1693  */
1694 static int llog_osd_declare_destroy(const struct lu_env *env,
1695                                     struct llog_handle *loghandle,
1696                                     struct thandle *th)
1697 {
1698         struct llog_ctxt        *ctxt;
1699         struct dt_object        *o, *llog_dir = NULL;
1700         int                      rc;
1701
1702         ENTRY;
1703
1704         ctxt = loghandle->lgh_ctxt;
1705         LASSERT(ctxt);
1706
1707         o = loghandle->lgh_obj;
1708         LASSERT(o);
1709
1710         if (loghandle->lgh_name) {
1711                 llog_dir = llog_osd_dir_get(env, ctxt);
1712                 if (IS_ERR(llog_dir))
1713                         RETURN(PTR_ERR(llog_dir));
1714
1715                 rc = dt_declare_delete(env, llog_dir,
1716                                        (struct dt_key *)loghandle->lgh_name,
1717                                        th);
1718                 if (rc < 0)
1719                         GOTO(out_put, rc);
1720         }
1721
1722         rc = dt_declare_ref_del(env, o, th);
1723         if (rc < 0)
1724                 GOTO(out_put, rc);
1725
1726         rc = dt_declare_destroy(env, o, th);
1727         if (rc < 0)
1728                 GOTO(out_put, rc);
1729
1730         if (loghandle->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1731                 rc = llog_osd_regular_fid_del_name_entry(env, o, th, true);
1732                 if (rc < 0)
1733                         GOTO(out_put, rc);
1734         }
1735
1736 out_put:
1737         if (!(IS_ERR_OR_NULL(llog_dir)))
1738                 dt_object_put(env, llog_dir);
1739
1740         RETURN(rc);
1741 }
1742
1743
1744 /**
1745  * Implementation of the llog_operations::lop_destroy
1746  *
1747  * This function destroys the llog and deletes also entry in the
1748  * llog directory in case of named llog. Llog should be opened prior that.
1749  * Destroy method is not part of external transaction and does everything
1750  * inside.
1751  *
1752  * \param[in] env               execution environment
1753  * \param[in] loghandle llog handle of the current llog
1754  *
1755  * \retval              0 on successful destroy
1756  * \retval              negative value on error
1757  */
1758 static int llog_osd_destroy(const struct lu_env *env,
1759                             struct llog_handle *loghandle, struct thandle *th)
1760 {
1761         struct llog_ctxt        *ctxt;
1762         struct dt_object        *o, *llog_dir = NULL;
1763         int                      rc;
1764
1765         ENTRY;
1766
1767         ctxt = loghandle->lgh_ctxt;
1768         LASSERT(ctxt != NULL);
1769
1770         o = loghandle->lgh_obj;
1771         LASSERT(o != NULL);
1772
1773         dt_write_lock(env, o, 0);
1774         if (!dt_object_exists(o))
1775                 GOTO(out_unlock, rc = 0);
1776
1777         if (loghandle->lgh_name) {
1778                 llog_dir = llog_osd_dir_get(env, ctxt);
1779                 if (IS_ERR(llog_dir))
1780                         GOTO(out_unlock, rc = PTR_ERR(llog_dir));
1781
1782                 dt_read_lock(env, llog_dir, 0);
1783                 rc = dt_delete(env, llog_dir,
1784                                (struct dt_key *)loghandle->lgh_name,
1785                                th);
1786                 dt_read_unlock(env, llog_dir);
1787                 if (rc) {
1788                         CERROR("%s: can't remove llog %s: rc = %d\n",
1789                                o->do_lu.lo_dev->ld_obd->obd_name,
1790                                loghandle->lgh_name, rc);
1791                         GOTO(out_unlock, rc);
1792                 }
1793         }
1794
1795         dt_ref_del(env, o, th);
1796         rc = dt_destroy(env, o, th);
1797         if (rc < 0)
1798                 GOTO(out_unlock, rc);
1799
1800         if (loghandle->lgh_ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID) {
1801                 rc = llog_osd_regular_fid_del_name_entry(env, o, th, false);
1802                 if (rc < 0)
1803                         GOTO(out_unlock, rc);
1804         }
1805
1806 out_unlock:
1807         dt_write_unlock(env, o);
1808         if (!(IS_ERR_OR_NULL(llog_dir)))
1809                 dt_object_put(env, llog_dir);
1810         RETURN(rc);
1811 }
1812
1813 /**
1814  * Implementation of the llog_operations::lop_setup
1815  *
1816  * This function setup the llog on local storage.
1817  *
1818  * \param[in] env       execution environment
1819  * \param[in] obd       obd device the llog belongs to
1820  * \param[in] olg       the llog group, it is always zero group now.
1821  * \param[in] ctxt_idx  the llog index, it defines the purpose of this llog.
1822  *                      Every new llog type have to use own index.
1823  * \param[in] disk_obd  the storage obd, where llog is stored.
1824  *
1825  * \retval              0 on successful llog setup
1826  * \retval              negative value on error
1827  */
1828 static int llog_osd_setup(const struct lu_env *env, struct obd_device *obd,
1829                           struct obd_llog_group *olg, int ctxt_idx,
1830                           struct obd_device *disk_obd)
1831 {
1832         struct llog_thread_info         *lgi = llog_info(env);
1833         struct llog_ctxt                *ctxt;
1834         int                              rc = 0;
1835         ENTRY;
1836
1837         LASSERT(obd);
1838         LASSERT(olg->olg_ctxts[ctxt_idx]);
1839
1840         ctxt = llog_ctxt_get(olg->olg_ctxts[ctxt_idx]);
1841         LASSERT(ctxt);
1842
1843         if (disk_obd == NULL)
1844                 GOTO(out, rc = 0);
1845
1846         /* initialize data allowing to generate new fids,
1847          * literally we need a sequece */
1848         lgi->lgi_fid.f_seq = FID_SEQ_LLOG;
1849         lgi->lgi_fid.f_oid = 1;
1850         lgi->lgi_fid.f_ver = 0;
1851         rc = local_oid_storage_init(env, disk_obd->obd_lvfs_ctxt.dt,
1852                                     &lgi->lgi_fid,
1853                                     &ctxt->loc_los_nameless);
1854         if (rc != 0)
1855                 GOTO(out, rc);
1856
1857         lgi->lgi_fid.f_seq = FID_SEQ_LLOG_NAME;
1858         lgi->lgi_fid.f_oid = 1;
1859         lgi->lgi_fid.f_ver = 0;
1860         rc = local_oid_storage_init(env, disk_obd->obd_lvfs_ctxt.dt,
1861                                     &lgi->lgi_fid,
1862                                     &ctxt->loc_los_named);
1863         if (rc != 0) {
1864                 local_oid_storage_fini(env, ctxt->loc_los_nameless);
1865                 ctxt->loc_los_nameless = NULL;
1866         }
1867
1868         GOTO(out, rc);
1869
1870 out:
1871         llog_ctxt_put(ctxt);
1872         return rc;
1873 }
1874
1875 /**
1876  * Implementation of the llog_operations::lop_cleanup
1877  *
1878  * This function cleanups the llog on local storage.
1879  *
1880  * \param[in] env       execution environment
1881  * \param[in] ctxt      the llog context
1882  *
1883  * \retval              0
1884  */
1885 static int llog_osd_cleanup(const struct lu_env *env, struct llog_ctxt *ctxt)
1886 {
1887         if (ctxt->loc_los_nameless != NULL) {
1888                 local_oid_storage_fini(env, ctxt->loc_los_nameless);
1889                 ctxt->loc_los_nameless = NULL;
1890         }
1891
1892         if (ctxt->loc_los_named != NULL) {
1893                 local_oid_storage_fini(env, ctxt->loc_los_named);
1894                 ctxt->loc_los_named = NULL;
1895         }
1896
1897         return 0;
1898 }
1899
1900 struct llog_operations llog_osd_ops = {
1901         .lop_next_block         = llog_osd_next_block,
1902         .lop_prev_block         = llog_osd_prev_block,
1903         .lop_read_header        = llog_osd_read_header,
1904         .lop_declare_destroy    = llog_osd_declare_destroy,
1905         .lop_destroy            = llog_osd_destroy,
1906         .lop_setup              = llog_osd_setup,
1907         .lop_cleanup            = llog_osd_cleanup,
1908         .lop_open               = llog_osd_open,
1909         .lop_exist              = llog_osd_exist,
1910         .lop_declare_create     = llog_osd_declare_create,
1911         .lop_create             = llog_osd_create,
1912         .lop_declare_write_rec  = llog_osd_declare_write_rec,
1913         .lop_write_rec          = llog_osd_write_rec,
1914         .lop_close              = llog_osd_close,
1915 };
1916 EXPORT_SYMBOL(llog_osd_ops);
1917
1918 struct llog_operations llog_common_cat_ops = {
1919         .lop_next_block         = llog_osd_next_block,
1920         .lop_prev_block         = llog_osd_prev_block,
1921         .lop_read_header        = llog_osd_read_header,
1922         .lop_declare_destroy    = llog_osd_declare_destroy,
1923         .lop_destroy            = llog_osd_destroy,
1924         .lop_setup              = llog_osd_setup,
1925         .lop_cleanup            = llog_osd_cleanup,
1926         .lop_open               = llog_osd_open,
1927         .lop_exist              = llog_osd_exist,
1928         .lop_declare_create     = llog_osd_declare_create,
1929         .lop_create             = llog_osd_create,
1930         .lop_declare_write_rec  = llog_osd_declare_write_rec,
1931         .lop_write_rec          = llog_osd_write_rec,
1932         .lop_close              = llog_osd_close,
1933         .lop_add                = llog_cat_add_rec,
1934         .lop_declare_add        = llog_cat_declare_add_rec,
1935 };
1936 EXPORT_SYMBOL(llog_common_cat_ops);
1937
1938 /**
1939  * Read the special file which contains the list of llog catalogs IDs
1940  *
1941  * This function reads the CATALOGS file which contains the array of llog
1942  * catalogs IDs. The main purpose of this file is to store OSP llogs indexed
1943  * by OST/MDT number.
1944  *
1945  * \param[in]  env              execution environment
1946  * \param[in]  d                corresponding storage device
1947  * \param[in]  idx              position to start from, usually OST/MDT index
1948  * \param[in]  count            how many catalog IDs to read
1949  * \param[out] idarray          the buffer for the data. If it is NULL then
1950  *                              function returns just number of catalog IDs
1951  *                              in the file.
1952  * \param[in]  fid              LLOG_CATALOGS_OID for CATALOG object
1953  *
1954  * \retval                      0 on successful read of catalog IDs
1955  * \retval                      negative value on error
1956  * \retval                      positive value which is number of records in
1957  *                              the file if \a idarray is NULL
1958  */
1959 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
1960                           int idx, int count, struct llog_catid *idarray,
1961                           const struct lu_fid *fid)
1962 {
1963         struct llog_thread_info *lgi = llog_info(env);
1964         struct dt_object        *o = NULL;
1965         struct thandle          *th;
1966         int                      rc, size;
1967
1968         ENTRY;
1969
1970         LASSERT(d);
1971
1972         size = sizeof(*idarray) * count;
1973         lgi->lgi_off = idx *  sizeof(*idarray);
1974
1975         lgi->lgi_fid = *fid;
1976         o = dt_locate(env, d, &lgi->lgi_fid);
1977         if (IS_ERR(o))
1978                 RETURN(PTR_ERR(o));
1979
1980         if (!dt_object_exists(o)) {
1981                 th = dt_trans_create(env, d);
1982                 if (IS_ERR(th))
1983                         GOTO(out, rc = PTR_ERR(th));
1984
1985                 lgi->lgi_attr.la_valid = LA_MODE;
1986                 lgi->lgi_attr.la_mode = S_IFREG | S_IRUGO | S_IWUSR;
1987                 lgi->lgi_dof.dof_type = dt_mode_to_dft(S_IFREG);
1988
1989                 th->th_wait_submit = 1;
1990                 /* Make the llog object creation synchronization, so
1991                  * it will be reliable to the reference, especially
1992                  * for remote reference */
1993                 th->th_sync = 1;
1994
1995                 rc = dt_declare_create(env, o, &lgi->lgi_attr, NULL,
1996                                        &lgi->lgi_dof, th);
1997                 if (rc)
1998                         GOTO(out_trans, rc);
1999
2000                 rc = dt_trans_start_local(env, d, th);
2001                 if (rc)
2002                         GOTO(out_trans, rc);
2003
2004                 dt_write_lock(env, o, 0);
2005                 if (!dt_object_exists(o))
2006                         rc = dt_create(env, o, &lgi->lgi_attr, NULL,
2007                                        &lgi->lgi_dof, th);
2008                 dt_write_unlock(env, o);
2009 out_trans:
2010                 dt_trans_stop(env, d, th);
2011                 if (rc)
2012                         GOTO(out, rc);
2013         }
2014
2015         rc = dt_attr_get(env, o, &lgi->lgi_attr);
2016         if (rc)
2017                 GOTO(out, rc);
2018
2019         if (!S_ISREG(lgi->lgi_attr.la_mode)) {
2020                 CERROR("%s: CATALOGS is not a regular file!: mode = %o\n",
2021                        o->do_lu.lo_dev->ld_obd->obd_name,
2022                        lgi->lgi_attr.la_mode);
2023                 GOTO(out, rc = -ENOENT);
2024         }
2025
2026         CDEBUG(D_CONFIG, "cat list: disk size=%d, read=%d\n",
2027                (int)lgi->lgi_attr.la_size, size);
2028
2029         /* return just number of llogs */
2030         if (idarray == NULL) {
2031                 rc = lgi->lgi_attr.la_size / sizeof(*idarray);
2032                 GOTO(out, rc);
2033         }
2034
2035         /* read for new ost index or for empty file */
2036         memset(idarray, 0, size);
2037         if (lgi->lgi_attr.la_size <= lgi->lgi_off)
2038                 GOTO(out, rc = 0);
2039         if (lgi->lgi_attr.la_size < lgi->lgi_off + size)
2040                 size = lgi->lgi_attr.la_size - lgi->lgi_off;
2041
2042         lgi->lgi_buf.lb_buf = idarray;
2043         lgi->lgi_buf.lb_len = size;
2044         rc = dt_record_read(env, o, &lgi->lgi_buf, &lgi->lgi_off);
2045         /* -EFAULT means the llog is a sparse file. This is not an error
2046          * after arbitrary OST index is supported. */
2047         if (rc < 0 && rc != -EFAULT) {
2048                 CERROR("%s: error reading CATALOGS: rc = %d\n",
2049                        o->do_lu.lo_dev->ld_obd->obd_name,  rc);
2050                 GOTO(out, rc);
2051         }
2052
2053         EXIT;
2054 out:
2055         dt_object_put(env, o);
2056         RETURN(rc);
2057 }
2058 EXPORT_SYMBOL(llog_osd_get_cat_list);
2059
2060 /**
2061  * Write the special file which contains the list of llog catalogs IDs
2062  *
2063  * This function writes the CATALOG file which contains the array of llog
2064  * catalogs IDs. It is used mostly to store OSP llogs indexed by OST/MDT
2065  * number.
2066  *
2067  * \param[in]  env      execution environment
2068  * \param[in]  d        corresponding storage device
2069  * \param[in]  idx      position to start from, usually OST/MDT index
2070  * \param[in]  count    how many catalog IDs to write
2071  * \param[out] idarray  the buffer with the data to write.
2072  * \param[in]  fid      LLOG_CATALOGS_OID for CATALOG object
2073  *
2074  * \retval              0 on successful write of catalog IDs
2075  * \retval              negative value on error
2076  */
2077 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
2078                           int idx, int count, struct llog_catid *idarray,
2079                           const struct lu_fid *fid)
2080 {
2081         struct llog_thread_info *lgi = llog_info(env);
2082         struct dt_object        *o = NULL;
2083         struct thandle          *th;
2084         int                      rc, size;
2085
2086         if (count == 0)
2087                 RETURN(0);
2088
2089         LASSERT(d);
2090
2091         size = sizeof(*idarray) * count;
2092         lgi->lgi_off = idx * sizeof(*idarray);
2093         lgi->lgi_fid = *fid;
2094
2095         o = dt_locate(env, d, &lgi->lgi_fid);
2096         if (IS_ERR(o))
2097                 RETURN(PTR_ERR(o));
2098
2099         if (!dt_object_exists(o))
2100                 GOTO(out, rc = -ENOENT);
2101
2102         rc = dt_attr_get(env, o, &lgi->lgi_attr);
2103         if (rc)
2104                 GOTO(out, rc);
2105
2106         if (!S_ISREG(lgi->lgi_attr.la_mode)) {
2107                 CERROR("%s: CATALOGS is not a regular file!: mode = %o\n",
2108                        o->do_lu.lo_dev->ld_obd->obd_name,
2109                        lgi->lgi_attr.la_mode);
2110                 GOTO(out, rc = -ENOENT);
2111         }
2112
2113         th = dt_trans_create(env, d);
2114         if (IS_ERR(th))
2115                 GOTO(out, rc = PTR_ERR(th));
2116
2117         lgi->lgi_buf.lb_len = size;
2118         lgi->lgi_buf.lb_buf = idarray;
2119         rc = dt_declare_record_write(env, o, &lgi->lgi_buf, lgi->lgi_off, th);
2120         if (rc)
2121                 GOTO(out_trans, rc);
2122
2123         /* For update log, this happens during initialization,
2124          * see lod_sub_prep_llog(), and we need make sure catlog
2125          * file ID is written to catlist file(committed) before
2126          * cross-MDT operation write update records to catlog FILE,
2127          * otherwise, during failover these update records might
2128          * missing */
2129         if (fid_is_update_log(fid))
2130                 th->th_sync = 1;
2131
2132         rc = dt_trans_start_local(env, d, th);
2133         if (rc)
2134                 GOTO(out_trans, rc);
2135
2136         th->th_wait_submit = 1;
2137
2138         rc = dt_record_write(env, o, &lgi->lgi_buf, &lgi->lgi_off, th);
2139         if (rc)
2140                 CDEBUG(D_INODE, "can't write CATALOGS at index %d: rc = %d\n",
2141                        idx, rc);
2142 out_trans:
2143         dt_trans_stop(env, d, th);
2144 out:
2145         dt_object_put(env, o);
2146         RETURN(rc);
2147 }
2148 EXPORT_SYMBOL(llog_osd_put_cat_list);