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