Whamcloud - gitweb
6d1e07cdab3e55f085cbf885d7d9f20f134809ad
[fs/lustre-release.git] / lustre / obdclass / llog.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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2012, 2014, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/obdclass/llog.c
37  *
38  * OST<->MDS recovery logging infrastructure.
39  * Invariants in implementation:
40  * - we do not share logs among different OST<->MDS connections, so that
41  *   if an OST or MDS fails it need only look at log(s) relevant to itself
42  *
43  * Author: Andreas Dilger <adilger@clusterfs.com>
44  * Author: Alex Zhuravlev <bzzz@whamcloud.com>
45  * Author: Mikhail Pershin <tappro@whamcloud.com>
46  */
47
48 #define DEBUG_SUBSYSTEM S_LOG
49
50 #include <linux/kthread.h>
51 #include <obd_class.h>
52 #include <lustre_log.h>
53 #include "llog_internal.h"
54
55 /*
56  * Allocate a new log or catalog handle
57  * Used inside llog_open().
58  */
59 static struct llog_handle *llog_alloc_handle(void)
60 {
61         struct llog_handle *loghandle;
62
63         OBD_ALLOC_PTR(loghandle);
64         if (loghandle == NULL)
65                 return NULL;
66
67         init_rwsem(&loghandle->lgh_lock);
68         mutex_init(&loghandle->lgh_hdr_mutex);
69         INIT_LIST_HEAD(&loghandle->u.phd.phd_entry);
70         atomic_set(&loghandle->lgh_refcount, 1);
71
72         return loghandle;
73 }
74
75 /*
76  * Free llog handle and header data if exists. Used in llog_close() only
77  */
78 static void llog_free_handle(struct llog_handle *loghandle)
79 {
80         LASSERT(loghandle != NULL);
81
82         /* failed llog_init_handle */
83         if (loghandle->lgh_hdr == NULL)
84                 goto out;
85
86         if (loghandle->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)
87                 LASSERT(list_empty(&loghandle->u.phd.phd_entry));
88         else if (loghandle->lgh_hdr->llh_flags & LLOG_F_IS_CAT)
89                 LASSERT(list_empty(&loghandle->u.chd.chd_head));
90         OBD_FREE_LARGE(loghandle->lgh_hdr, loghandle->lgh_hdr_size);
91 out:
92         OBD_FREE_PTR(loghandle);
93 }
94
95 void llog_handle_get(struct llog_handle *loghandle)
96 {
97         atomic_inc(&loghandle->lgh_refcount);
98 }
99
100 void llog_handle_put(struct llog_handle *loghandle)
101 {
102         LASSERT(atomic_read(&loghandle->lgh_refcount) > 0);
103         if (atomic_dec_and_test(&loghandle->lgh_refcount))
104                 llog_free_handle(loghandle);
105 }
106
107 static int llog_declare_destroy(const struct lu_env *env,
108                                 struct llog_handle *handle,
109                                 struct thandle *th)
110 {
111         struct llog_operations *lop;
112         int rc;
113
114         ENTRY;
115
116         rc = llog_handle2ops(handle, &lop);
117         if (rc)
118                 RETURN(rc);
119         if (lop->lop_declare_destroy == NULL)
120                 RETURN(-EOPNOTSUPP);
121
122         rc = lop->lop_declare_destroy(env, handle, th);
123
124         RETURN(rc);
125 }
126
127 int llog_trans_destroy(const struct lu_env *env, struct llog_handle *handle,
128                        struct thandle *th)
129 {
130         struct llog_operations  *lop;
131         int rc;
132         ENTRY;
133
134         rc = llog_handle2ops(handle, &lop);
135         if (rc < 0)
136                 RETURN(rc);
137         if (lop->lop_destroy == NULL)
138                 RETURN(-EOPNOTSUPP);
139
140         LASSERT(handle->lgh_obj != NULL);
141         if (!dt_object_exists(handle->lgh_obj))
142                 RETURN(0);
143
144         rc = lop->lop_destroy(env, handle, th);
145
146         RETURN(rc);
147 }
148
149 int llog_destroy(const struct lu_env *env, struct llog_handle *handle)
150 {
151         struct llog_operations  *lop;
152         struct dt_device        *dt;
153         struct thandle          *th;
154         int rc;
155
156         ENTRY;
157
158         rc = llog_handle2ops(handle, &lop);
159         if (rc < 0)
160                 RETURN(rc);
161         if (lop->lop_destroy == NULL)
162                 RETURN(-EOPNOTSUPP);
163
164         if (handle->lgh_obj == NULL) {
165                 /* if lgh_obj == NULL, then it is from client side destroy */
166                 rc = lop->lop_destroy(env, handle, NULL);
167                 RETURN(rc);
168         }
169
170         if (!dt_object_exists(handle->lgh_obj))
171                 RETURN(0);
172
173         dt = lu2dt_dev(handle->lgh_obj->do_lu.lo_dev);
174
175         th = dt_trans_create(env, dt);
176         if (IS_ERR(th))
177                 RETURN(PTR_ERR(th));
178
179         rc = llog_declare_destroy(env, handle, th);
180         if (rc != 0)
181                 GOTO(out_trans, rc);
182
183         rc = dt_trans_start_local(env, dt, th);
184         if (rc < 0)
185                 GOTO(out_trans, rc);
186
187         rc = lop->lop_destroy(env, handle, th);
188
189 out_trans:
190         dt_trans_stop(env, dt, th);
191
192         RETURN(rc);
193 }
194 EXPORT_SYMBOL(llog_destroy);
195
196 /* returns negative on error; 0 if success; 1 if success & log destroyed */
197 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
198                     int index)
199 {
200         struct llog_thread_info *lgi = llog_info(env);
201         struct dt_device        *dt;
202         struct llog_log_hdr     *llh = loghandle->lgh_hdr;
203         struct thandle          *th;
204         int                      rc;
205
206         ENTRY;
207
208         CDEBUG(D_RPCTRACE, "Canceling %d in log "DOSTID"\n", index,
209                POSTID(&loghandle->lgh_id.lgl_oi));
210
211         if (index == 0) {
212                 CERROR("Can't cancel index 0 which is header\n");
213                 RETURN(-EINVAL);
214         }
215
216         LASSERT(loghandle != NULL);
217         LASSERT(loghandle->lgh_ctxt != NULL);
218         LASSERT(loghandle->lgh_obj != NULL);
219
220         dt = lu2dt_dev(loghandle->lgh_obj->do_lu.lo_dev);
221
222         th = dt_trans_create(env, dt);
223         if (IS_ERR(th))
224                 RETURN(PTR_ERR(th));
225
226         rc = llog_declare_write_rec(env, loghandle, &llh->llh_hdr, index, th);
227         if (rc < 0)
228                 GOTO(out_trans, rc);
229
230         if ((llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY))
231                 rc = llog_declare_destroy(env, loghandle, th);
232
233         th->th_wait_submit = 1;
234         rc = dt_trans_start_local(env, dt, th);
235         if (rc < 0)
236                 GOTO(out_trans, rc);
237
238         down_write(&loghandle->lgh_lock);
239         /* clear bitmap */
240         mutex_lock(&loghandle->lgh_hdr_mutex);
241         if (!ext2_clear_bit(index, LLOG_HDR_BITMAP(llh))) {
242                 CDEBUG(D_RPCTRACE, "Catalog index %u already clear?\n", index);
243                 GOTO(out_unlock, rc);
244         }
245
246         loghandle->lgh_hdr->llh_count--;
247         /* Pass this index to llog_osd_write_rec(), which will use the index
248          * to only update the necesary bitmap. */
249         lgi->lgi_cookie.lgc_index = index;
250         /* update header */
251         rc = llog_write_rec(env, loghandle, &llh->llh_hdr, &lgi->lgi_cookie,
252                             LLOG_HEADER_IDX, th);
253         if (rc != 0) {
254                 loghandle->lgh_hdr->llh_count++;
255                 ext2_set_bit(index, LLOG_HDR_BITMAP(llh));
256                 GOTO(out_unlock, rc);
257         }
258
259         if ((llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
260             (llh->llh_count == 1) &&
261             (loghandle->lgh_last_idx == LLOG_HDR_BITMAP_SIZE(llh) - 1)) {
262                 rc = llog_trans_destroy(env, loghandle, th);
263                 if (rc < 0) {
264                         /* Sigh, can not destroy the final plain llog, but
265                          * the bitmap has been clearly, so the record can not
266                          * be accessed anymore, let's return 0 for now, and
267                          * the orphan will be handled by LFSCK. */
268                         CERROR("%s: can't destroy empty llog #"DOSTID
269                                "#%08x: rc = %d\n",
270                                loghandle->lgh_ctxt->loc_obd->obd_name,
271                                POSTID(&loghandle->lgh_id.lgl_oi),
272                                loghandle->lgh_id.lgl_ogen, rc);
273                         GOTO(out_unlock, rc = 0);
274                 }
275                 rc = LLOG_DEL_PLAIN;
276         }
277
278 out_unlock:
279         mutex_unlock(&loghandle->lgh_hdr_mutex);
280         up_write(&loghandle->lgh_lock);
281 out_trans:
282         dt_trans_stop(env, dt, th);
283         RETURN(rc);
284 }
285
286 static int llog_read_header(const struct lu_env *env,
287                             struct llog_handle *handle,
288                             struct obd_uuid *uuid)
289 {
290         struct llog_operations *lop;
291         int rc;
292
293         rc = llog_handle2ops(handle, &lop);
294         if (rc)
295                 RETURN(rc);
296
297         if (lop->lop_read_header == NULL)
298                 RETURN(-EOPNOTSUPP);
299
300         rc = lop->lop_read_header(env, handle);
301         if (rc == LLOG_EEMPTY) {
302                 struct llog_log_hdr *llh = handle->lgh_hdr;
303
304                 /* lrh_len should be initialized in llog_init_handle */
305                 handle->lgh_last_idx = 0; /* header is record with index 0 */
306                 llh->llh_count = 1;         /* for the header record */
307                 llh->llh_hdr.lrh_type = LLOG_HDR_MAGIC;
308                 LASSERT(handle->lgh_ctxt->loc_chunk_size >=
309                                                 LLOG_MIN_CHUNK_SIZE);
310                 llh->llh_hdr.lrh_len = handle->lgh_ctxt->loc_chunk_size;
311                 llh->llh_hdr.lrh_index = 0;
312                 llh->llh_timestamp = cfs_time_current_sec();
313                 if (uuid)
314                         memcpy(&llh->llh_tgtuuid, uuid,
315                                sizeof(llh->llh_tgtuuid));
316                 llh->llh_bitmap_offset = offsetof(typeof(*llh), llh_bitmap);
317                 ext2_set_bit(0, LLOG_HDR_BITMAP(llh));
318                 LLOG_HDR_TAIL(llh)->lrt_len = llh->llh_hdr.lrh_len;
319                 LLOG_HDR_TAIL(llh)->lrt_index = llh->llh_hdr.lrh_index;
320                 rc = 0;
321         }
322         return rc;
323 }
324
325 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
326                      int flags, struct obd_uuid *uuid)
327 {
328         struct llog_log_hdr     *llh;
329         enum llog_flag           fmt = flags & LLOG_F_EXT_MASK;
330         int                      rc;
331         int                     chunk_size = handle->lgh_ctxt->loc_chunk_size;
332         ENTRY;
333
334         LASSERT(handle->lgh_hdr == NULL);
335
336         LASSERT(chunk_size >= LLOG_MIN_CHUNK_SIZE);
337         OBD_ALLOC_LARGE(llh, chunk_size);
338         if (llh == NULL)
339                 RETURN(-ENOMEM);
340
341         handle->lgh_hdr = llh;
342         handle->lgh_hdr_size = chunk_size;
343         /* first assign flags to use llog_client_ops */
344         llh->llh_flags = flags;
345         rc = llog_read_header(env, handle, uuid);
346         if (rc == 0) {
347                 if (unlikely((llh->llh_flags & LLOG_F_IS_PLAIN &&
348                               flags & LLOG_F_IS_CAT) ||
349                              (llh->llh_flags & LLOG_F_IS_CAT &&
350                               flags & LLOG_F_IS_PLAIN))) {
351                         CERROR("%s: llog type is %s but initializing %s\n",
352                                handle->lgh_ctxt->loc_obd->obd_name,
353                                llh->llh_flags & LLOG_F_IS_CAT ?
354                                "catalog" : "plain",
355                                flags & LLOG_F_IS_CAT ? "catalog" : "plain");
356                         GOTO(out, rc = -EINVAL);
357                 } else if (llh->llh_flags &
358                            (LLOG_F_IS_PLAIN | LLOG_F_IS_CAT)) {
359                         /*
360                          * it is possible to open llog without specifying llog
361                          * type so it is taken from llh_flags
362                          */
363                         flags = llh->llh_flags;
364                 } else {
365                         /* for some reason the llh_flags has no type set */
366                         CERROR("llog type is not specified!\n");
367                         GOTO(out, rc = -EINVAL);
368                 }
369                 if (unlikely(uuid &&
370                              !obd_uuid_equals(uuid, &llh->llh_tgtuuid))) {
371                         CERROR("%s: llog uuid mismatch: %s/%s\n",
372                                handle->lgh_ctxt->loc_obd->obd_name,
373                                (char *)uuid->uuid,
374                                (char *)llh->llh_tgtuuid.uuid);
375                         GOTO(out, rc = -EEXIST);
376                 }
377         }
378         if (flags & LLOG_F_IS_CAT) {
379                 LASSERT(list_empty(&handle->u.chd.chd_head));
380                 INIT_LIST_HEAD(&handle->u.chd.chd_head);
381                 llh->llh_size = sizeof(struct llog_logid_rec);
382                 llh->llh_flags |= LLOG_F_IS_FIXSIZE;
383         } else if (!(flags & LLOG_F_IS_PLAIN)) {
384                 CERROR("%s: unknown flags: %#x (expected %#x or %#x)\n",
385                        handle->lgh_ctxt->loc_obd->obd_name,
386                        flags, LLOG_F_IS_CAT, LLOG_F_IS_PLAIN);
387                 rc = -EINVAL;
388         }
389         llh->llh_flags |= fmt;
390 out:
391         if (rc) {
392                 OBD_FREE_LARGE(llh, chunk_size);
393                 handle->lgh_hdr = NULL;
394         }
395         RETURN(rc);
396 }
397 EXPORT_SYMBOL(llog_init_handle);
398
399 static int llog_process_thread(void *arg)
400 {
401         struct llog_process_info        *lpi = arg;
402         struct llog_handle              *loghandle = lpi->lpi_loghandle;
403         struct llog_log_hdr             *llh = loghandle->lgh_hdr;
404         struct llog_process_cat_data    *cd  = lpi->lpi_catdata;
405         char                            *buf;
406         size_t                           chunk_size;
407         __u64                            cur_offset;
408         int                              rc = 0, index = 1, last_index;
409         int                              saved_index = 0;
410         int                              last_called_index = 0;
411
412         ENTRY;
413
414         if (llh == NULL)
415                 RETURN(-EINVAL);
416
417         cur_offset = chunk_size = llh->llh_hdr.lrh_len;
418         /* expect chunk_size to be power of two */
419         LASSERT(is_power_of_2(chunk_size));
420
421         OBD_ALLOC_LARGE(buf, chunk_size);
422         if (buf == NULL) {
423                 lpi->lpi_rc = -ENOMEM;
424                 RETURN(0);
425         }
426
427         if (cd != NULL) {
428                 last_called_index = cd->lpcd_first_idx;
429                 index = cd->lpcd_first_idx + 1;
430         }
431         if (cd != NULL && cd->lpcd_last_idx)
432                 last_index = cd->lpcd_last_idx;
433         else
434                 last_index = LLOG_HDR_BITMAP_SIZE(llh) - 1;
435
436         while (rc == 0) {
437                 struct llog_rec_hdr *rec;
438                 off_t chunk_offset;
439                 unsigned int buf_offset = 0;
440                 bool partial_chunk;
441
442                 /* skip records not set in bitmap */
443                 while (index <= last_index &&
444                        !ext2_test_bit(index, LLOG_HDR_BITMAP(llh)))
445                         ++index;
446
447                 /* There are no indices prior the last_index */
448                 if (index > last_index)
449                         break;
450
451                 CDEBUG(D_OTHER, "index: %d last_index %d\n", index,
452                        last_index);
453
454 repeat:
455                 /* get the buf with our target record; avoid old garbage */
456                 memset(buf, 0, chunk_size);
457                 rc = llog_next_block(lpi->lpi_env, loghandle, &saved_index,
458                                      index, &cur_offset, buf, chunk_size);
459                 if (rc != 0)
460                         GOTO(out, rc);
461
462                 /* NB: after llog_next_block() call the cur_offset is the
463                  * offset of the next block after read one.
464                  * The absolute offset of the current chunk is calculated
465                  * from cur_offset value and stored in chunk_offset variable.
466                  */
467                 if (cur_offset % chunk_size != 0) {
468                         partial_chunk = true;
469                         chunk_offset = cur_offset & ~(chunk_size - 1);
470                 } else {
471                         partial_chunk = false;
472                         chunk_offset = cur_offset - chunk_size;
473                 }
474
475                 /* NB: when rec->lrh_len is accessed it is already swabbed
476                  * since it is used at the "end" of the loop and the rec
477                  * swabbing is done at the beginning of the loop. */
478                 for (rec = (struct llog_rec_hdr *)(buf + buf_offset);
479                      (char *)rec < buf + chunk_size;
480                      rec = llog_rec_hdr_next(rec)) {
481
482                         CDEBUG(D_OTHER, "processing rec 0x%p type %#x\n",
483                                rec, rec->lrh_type);
484
485                         if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
486                                 lustre_swab_llog_rec(rec);
487
488                         CDEBUG(D_OTHER, "after swabbing, type=%#x idx=%d\n",
489                                rec->lrh_type, rec->lrh_index);
490
491                         /* for partial chunk the end of it is zeroed, check
492                          * for index 0 to distinguish it. */
493                         if (partial_chunk && rec->lrh_index == 0) {
494                                 /* concurrent llog_add() might add new records
495                                  * while llog_processing, check this is not
496                                  * the case and re-read the current chunk
497                                  * otherwise. */
498                                 if (index > loghandle->lgh_last_idx)
499                                         GOTO(out, rc = 0);
500                                 CDEBUG(D_OTHER, "Re-read last llog buffer for "
501                                        "new records, index %u, last %u\n",
502                                        index, loghandle->lgh_last_idx);
503                                 /* save offset inside buffer for the re-read */
504                                 buf_offset = (char *)rec - (char *)buf;
505                                 cur_offset = chunk_offset;
506                                 goto repeat;
507                         }
508
509                         if (rec->lrh_len == 0 || rec->lrh_len > chunk_size) {
510                                 CWARN("invalid length %d in llog record for "
511                                       "index %d/%d\n", rec->lrh_len,
512                                       rec->lrh_index, index);
513                                 GOTO(out, rc = -EINVAL);
514                         }
515
516                         if (rec->lrh_index < index) {
517                                 CDEBUG(D_OTHER, "skipping lrh_index %d\n",
518                                        rec->lrh_index);
519                                 continue;
520                         }
521
522                         if (rec->lrh_index != index) {
523                                 CERROR("%s: Invalid record: index %u but "
524                                        "expected %u\n",
525                                        loghandle->lgh_ctxt->loc_obd->obd_name,
526                                        rec->lrh_index, index);
527                                 GOTO(out, rc = -ERANGE);
528                         }
529
530                         CDEBUG(D_OTHER,
531                                "lrh_index: %d lrh_len: %d (%d remains)\n",
532                                rec->lrh_index, rec->lrh_len,
533                                (int)(buf + chunk_size - (char *)rec));
534
535                         loghandle->lgh_cur_idx = rec->lrh_index;
536                         loghandle->lgh_cur_offset = (char *)rec - (char *)buf +
537                                                     chunk_offset;
538
539                         /* if set, process the callback on this record */
540                         if (ext2_test_bit(index, LLOG_HDR_BITMAP(llh))) {
541                                 rc = lpi->lpi_cb(lpi->lpi_env, loghandle, rec,
542                                                  lpi->lpi_cbdata);
543                                 last_called_index = index;
544                                 if (rc == LLOG_PROC_BREAK) {
545                                         GOTO(out, rc);
546                                 } else if (rc == LLOG_DEL_RECORD) {
547                                         rc = llog_cancel_rec(lpi->lpi_env,
548                                                              loghandle,
549                                                              rec->lrh_index);
550                                 }
551                                 if (rc)
552                                         GOTO(out, rc);
553                         }
554                         /* exit if the last index is reached */
555                         if (index >= last_index)
556                                 GOTO(out, rc = 0);
557                         ++index;
558                 }
559         }
560
561 out:
562         if (cd != NULL)
563                 cd->lpcd_last_idx = last_called_index;
564
565         if (unlikely(rc == -EIO && loghandle->lgh_obj != NULL)) {
566                 /* something bad happened to the processing of a local
567                  * llog file, probably I/O error or the log got corrupted..
568                  * to be able to finally release the log we discard any
569                  * remaining bits in the header */
570                 CERROR("Local llog found corrupted\n");
571                 while (index <= last_index) {
572                         if (ext2_test_bit(index, LLOG_HDR_BITMAP(llh)) != 0)
573                                 llog_cancel_rec(lpi->lpi_env, loghandle, index);
574                         index++;
575                 }
576                 rc = 0;
577         }
578
579         OBD_FREE_LARGE(buf, chunk_size);
580         lpi->lpi_rc = rc;
581         return 0;
582 }
583
584 static int llog_process_thread_daemonize(void *arg)
585 {
586         struct llog_process_info        *lpi = arg;
587         struct lu_env                    env;
588         int                              rc;
589
590         unshare_fs_struct();
591
592         /* client env has no keys, tags is just 0 */
593         rc = lu_env_init(&env, LCT_LOCAL | LCT_MG_THREAD);
594         if (rc)
595                 goto out;
596         lpi->lpi_env = &env;
597
598         rc = llog_process_thread(arg);
599
600         lu_env_fini(&env);
601 out:
602         complete(&lpi->lpi_completion);
603         return rc;
604 }
605
606 int llog_process_or_fork(const struct lu_env *env,
607                          struct llog_handle *loghandle,
608                          llog_cb_t cb, void *data, void *catdata, bool fork)
609 {
610         struct llog_process_info *lpi;
611         int                      rc;
612
613         ENTRY;
614
615         OBD_ALLOC_PTR(lpi);
616         if (lpi == NULL) {
617                 CERROR("cannot alloc pointer\n");
618                 RETURN(-ENOMEM);
619         }
620         lpi->lpi_loghandle = loghandle;
621         lpi->lpi_cb        = cb;
622         lpi->lpi_cbdata    = data;
623         lpi->lpi_catdata   = catdata;
624
625         if (fork) {
626                 struct task_struct *task;
627
628                 /* The new thread can't use parent env,
629                  * init the new one in llog_process_thread_daemonize. */
630                 lpi->lpi_env = NULL;
631                 init_completion(&lpi->lpi_completion);
632                 task = kthread_run(llog_process_thread_daemonize, lpi,
633                                    "llog_process_thread");
634                 if (IS_ERR(task)) {
635                         rc = PTR_ERR(task);
636                         CERROR("%s: cannot start thread: rc = %d\n",
637                                loghandle->lgh_ctxt->loc_obd->obd_name, rc);
638                         GOTO(out_lpi, rc);
639                 }
640                 wait_for_completion(&lpi->lpi_completion);
641         } else {
642                 lpi->lpi_env = env;
643                 llog_process_thread(lpi);
644         }
645         rc = lpi->lpi_rc;
646
647 out_lpi:
648         OBD_FREE_PTR(lpi);
649         RETURN(rc);
650 }
651 EXPORT_SYMBOL(llog_process_or_fork);
652
653 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
654                  llog_cb_t cb, void *data, void *catdata)
655 {
656         int rc;
657         rc = llog_process_or_fork(env, loghandle, cb, data, catdata, true);
658         return rc == LLOG_DEL_PLAIN ? 0 : rc;
659 }
660 EXPORT_SYMBOL(llog_process);
661
662 int llog_reverse_process(const struct lu_env *env,
663                          struct llog_handle *loghandle, llog_cb_t cb,
664                          void *data, void *catdata)
665 {
666         struct llog_log_hdr *llh = loghandle->lgh_hdr;
667         struct llog_process_cat_data *cd = catdata;
668         void *buf;
669         int rc = 0, first_index = 1, index, idx;
670         __u32   chunk_size = llh->llh_hdr.lrh_len;
671         ENTRY;
672
673         OBD_ALLOC_LARGE(buf, chunk_size);
674         if (buf == NULL)
675                 RETURN(-ENOMEM);
676
677         if (cd != NULL)
678                 first_index = cd->lpcd_first_idx + 1;
679         if (cd != NULL && cd->lpcd_last_idx)
680                 index = cd->lpcd_last_idx;
681         else
682                 index = LLOG_HDR_BITMAP_SIZE(llh) - 1;
683
684         while (rc == 0) {
685                 struct llog_rec_hdr *rec;
686                 struct llog_rec_tail *tail;
687
688                 /* skip records not set in bitmap */
689                 while (index >= first_index &&
690                        !ext2_test_bit(index, LLOG_HDR_BITMAP(llh)))
691                         --index;
692
693                 LASSERT(index >= first_index - 1);
694                 if (index == first_index - 1)
695                         break;
696
697                 /* get the buf with our target record; avoid old garbage */
698                 memset(buf, 0, chunk_size);
699                 rc = llog_prev_block(env, loghandle, index, buf, chunk_size);
700                 if (rc)
701                         GOTO(out, rc);
702
703                 rec = buf;
704                 idx = rec->lrh_index;
705                 CDEBUG(D_RPCTRACE, "index %u : idx %u\n", index, idx);
706                 while (idx < index) {
707                         rec = (void *)rec + rec->lrh_len;
708                         if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
709                                 lustre_swab_llog_rec(rec);
710                         idx ++;
711                 }
712                 LASSERT(idx == index);
713                 tail = (void *)rec + rec->lrh_len - sizeof(*tail);
714
715                 /* process records in buffer, starting where we found one */
716                 while ((void *)tail > buf) {
717                         if (tail->lrt_index == 0)
718                                 GOTO(out, rc = 0); /* no more records */
719
720                         /* if set, process the callback on this record */
721                         if (ext2_test_bit(index, LLOG_HDR_BITMAP(llh))) {
722                                 rec = (void *)tail - tail->lrt_len +
723                                       sizeof(*tail);
724
725                                 rc = cb(env, loghandle, rec, data);
726                                 if (rc == LLOG_PROC_BREAK) {
727                                         GOTO(out, rc);
728                                 } else if (rc == LLOG_DEL_RECORD) {
729                                         rc = llog_cancel_rec(env, loghandle,
730                                                              tail->lrt_index);
731                                 }
732                                 if (rc)
733                                         GOTO(out, rc);
734                         }
735
736                         /* previous record, still in buffer? */
737                         --index;
738                         if (index < first_index)
739                                 GOTO(out, rc = 0);
740                         tail = (void *)tail - tail->lrt_len;
741                 }
742         }
743
744 out:
745         if (buf != NULL)
746                 OBD_FREE_LARGE(buf, chunk_size);
747         RETURN(rc);
748 }
749 EXPORT_SYMBOL(llog_reverse_process);
750
751 /**
752  * new llog API
753  *
754  * API functions:
755  *      llog_open - open llog, may not exist
756  *      llog_exist - check if llog exists
757  *      llog_close - close opened llog, pair for open, frees llog_handle
758  *      llog_declare_create - declare llog creation
759  *      llog_create - create new llog on disk, need transaction handle
760  *      llog_declare_write_rec - declaration of llog write
761  *      llog_write_rec - write llog record on disk, need transaction handle
762  *      llog_declare_add - declare llog catalog record addition
763  *      llog_add - add llog record in catalog, need transaction handle
764  */
765 int llog_exist(struct llog_handle *loghandle)
766 {
767         struct llog_operations  *lop;
768         int                      rc;
769
770         ENTRY;
771
772         rc = llog_handle2ops(loghandle, &lop);
773         if (rc)
774                 RETURN(rc);
775         if (lop->lop_exist == NULL)
776                 RETURN(-EOPNOTSUPP);
777
778         rc = lop->lop_exist(loghandle);
779         RETURN(rc);
780 }
781 EXPORT_SYMBOL(llog_exist);
782
783 int llog_declare_create(const struct lu_env *env,
784                         struct llog_handle *loghandle, struct thandle *th)
785 {
786         struct llog_operations  *lop;
787         int                      raised, rc;
788
789         ENTRY;
790
791         rc = llog_handle2ops(loghandle, &lop);
792         if (rc)
793                 RETURN(rc);
794         if (lop->lop_declare_create == NULL)
795                 RETURN(-EOPNOTSUPP);
796
797         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
798         if (!raised)
799                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
800         rc = lop->lop_declare_create(env, loghandle, th);
801         if (!raised)
802                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
803         RETURN(rc);
804 }
805
806 int llog_create(const struct lu_env *env, struct llog_handle *handle,
807                 struct thandle *th)
808 {
809         struct llog_operations  *lop;
810         int                      raised, rc;
811
812         ENTRY;
813
814         rc = llog_handle2ops(handle, &lop);
815         if (rc)
816                 RETURN(rc);
817         if (lop->lop_create == NULL)
818                 RETURN(-EOPNOTSUPP);
819
820         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
821         if (!raised)
822                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
823         rc = lop->lop_create(env, handle, th);
824         if (!raised)
825                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
826         RETURN(rc);
827 }
828
829 int llog_declare_write_rec(const struct lu_env *env,
830                            struct llog_handle *handle,
831                            struct llog_rec_hdr *rec, int idx,
832                            struct thandle *th)
833 {
834         struct llog_operations  *lop;
835         int                      raised, rc;
836
837         ENTRY;
838
839         rc = llog_handle2ops(handle, &lop);
840         if (rc)
841                 RETURN(rc);
842         LASSERT(lop);
843         if (lop->lop_declare_write_rec == NULL)
844                 RETURN(-EOPNOTSUPP);
845
846         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
847         if (!raised)
848                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
849         rc = lop->lop_declare_write_rec(env, handle, rec, idx, th);
850         if (!raised)
851                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
852         RETURN(rc);
853 }
854
855 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
856                    struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
857                    int idx, struct thandle *th)
858 {
859         struct llog_operations  *lop;
860         int                      raised, rc, buflen;
861
862         ENTRY;
863
864         rc = llog_handle2ops(handle, &lop);
865         if (rc)
866                 RETURN(rc);
867
868         LASSERT(lop);
869         if (lop->lop_write_rec == NULL)
870                 RETURN(-EOPNOTSUPP);
871
872         buflen = rec->lrh_len;
873         LASSERT(cfs_size_round(buflen) == buflen);
874
875         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
876         if (!raised)
877                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
878         rc = lop->lop_write_rec(env, handle, rec, logcookies, idx, th);
879         if (!raised)
880                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
881         RETURN(rc);
882 }
883
884 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
885              struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
886              struct thandle *th)
887 {
888         int raised, rc;
889
890         ENTRY;
891
892         if (lgh->lgh_logops->lop_add == NULL)
893                 RETURN(-EOPNOTSUPP);
894
895         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
896         if (!raised)
897                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
898         rc = lgh->lgh_logops->lop_add(env, lgh, rec, logcookies, th);
899         if (!raised)
900                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
901         RETURN(rc);
902 }
903 EXPORT_SYMBOL(llog_add);
904
905 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
906                      struct llog_rec_hdr *rec, struct thandle *th)
907 {
908         int raised, rc;
909
910         ENTRY;
911
912         if (lgh->lgh_logops->lop_declare_add == NULL)
913                 RETURN(-EOPNOTSUPP);
914
915         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
916         if (!raised)
917                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
918         rc = lgh->lgh_logops->lop_declare_add(env, lgh, rec, th);
919         if (!raised)
920                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
921         RETURN(rc);
922 }
923 EXPORT_SYMBOL(llog_declare_add);
924
925 /**
926  * Helper function to open llog or create it if doesn't exist.
927  * It hides all transaction handling from caller.
928  */
929 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
930                      struct llog_handle **res, struct llog_logid *logid,
931                      char *name)
932 {
933         struct dt_device        *d;
934         struct thandle          *th;
935         int                      rc;
936
937         ENTRY;
938
939         rc = llog_open(env, ctxt, res, logid, name, LLOG_OPEN_NEW);
940         if (rc)
941                 RETURN(rc);
942
943         if (llog_exist(*res))
944                 RETURN(0);
945
946         LASSERT((*res)->lgh_obj != NULL);
947
948         d = lu2dt_dev((*res)->lgh_obj->do_lu.lo_dev);
949
950         th = dt_trans_create(env, d);
951         if (IS_ERR(th))
952                 GOTO(out, rc = PTR_ERR(th));
953
954         /* Create update llog object synchronously, which
955          * happens during inialization process see
956          * lod_sub_prep_llog(), to make sure the update
957          * llog object is created before corss-MDT writing
958          * updates into the llog object */
959         if (ctxt->loc_flags & LLOG_CTXT_FLAG_NORMAL_FID)
960                 th->th_sync = 1;
961
962         th->th_wait_submit = 1;
963         rc = llog_declare_create(env, *res, th);
964         if (rc == 0) {
965                 rc = dt_trans_start_local(env, d, th);
966                 if (rc == 0)
967                         rc = llog_create(env, *res, th);
968         }
969         dt_trans_stop(env, d, th);
970 out:
971         if (rc)
972                 llog_close(env, *res);
973         RETURN(rc);
974 }
975 EXPORT_SYMBOL(llog_open_create);
976
977 /**
978  * Helper function to delete existent llog.
979  */
980 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
981                struct llog_logid *logid, char *name)
982 {
983         struct llog_handle      *handle;
984         int                      rc = 0, rc2;
985
986         ENTRY;
987
988         /* nothing to erase */
989         if (name == NULL && logid == NULL)
990                 RETURN(0);
991
992         rc = llog_open(env, ctxt, &handle, logid, name, LLOG_OPEN_EXISTS);
993         if (rc < 0)
994                 RETURN(rc);
995
996         rc = llog_init_handle(env, handle, LLOG_F_IS_PLAIN, NULL);
997         if (rc == 0)
998                 rc = llog_destroy(env, handle);
999
1000         rc2 = llog_close(env, handle);
1001         if (rc == 0)
1002                 rc = rc2;
1003         RETURN(rc);
1004 }
1005 EXPORT_SYMBOL(llog_erase);
1006
1007 /*
1008  * Helper function for write record in llog.
1009  * It hides all transaction handling from caller.
1010  * Valid only with local llog.
1011  */
1012 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
1013                struct llog_rec_hdr *rec, int idx)
1014 {
1015         struct dt_device        *dt;
1016         struct thandle          *th;
1017         int                      rc;
1018
1019         ENTRY;
1020
1021         LASSERT(loghandle);
1022         LASSERT(loghandle->lgh_ctxt);
1023         LASSERT(loghandle->lgh_obj != NULL);
1024
1025         dt = lu2dt_dev(loghandle->lgh_obj->do_lu.lo_dev);
1026
1027         th = dt_trans_create(env, dt);
1028         if (IS_ERR(th))
1029                 RETURN(PTR_ERR(th));
1030
1031         rc = llog_declare_write_rec(env, loghandle, rec, idx, th);
1032         if (rc)
1033                 GOTO(out_trans, rc);
1034
1035         th->th_wait_submit = 1;
1036         rc = dt_trans_start_local(env, dt, th);
1037         if (rc)
1038                 GOTO(out_trans, rc);
1039
1040         down_write(&loghandle->lgh_lock);
1041         rc = llog_write_rec(env, loghandle, rec, NULL, idx, th);
1042         up_write(&loghandle->lgh_lock);
1043 out_trans:
1044         dt_trans_stop(env, dt, th);
1045         RETURN(rc);
1046 }
1047 EXPORT_SYMBOL(llog_write);
1048
1049 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
1050               struct llog_handle **lgh, struct llog_logid *logid,
1051               char *name, enum llog_open_param open_param)
1052 {
1053         int      raised;
1054         int      rc;
1055
1056         ENTRY;
1057
1058         LASSERT(ctxt);
1059         LASSERT(ctxt->loc_logops);
1060
1061         if (ctxt->loc_logops->lop_open == NULL) {
1062                 *lgh = NULL;
1063                 RETURN(-EOPNOTSUPP);
1064         }
1065
1066         *lgh = llog_alloc_handle();
1067         if (*lgh == NULL)
1068                 RETURN(-ENOMEM);
1069         (*lgh)->lgh_ctxt = ctxt;
1070         (*lgh)->lgh_logops = ctxt->loc_logops;
1071
1072         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
1073         if (!raised)
1074                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
1075         rc = ctxt->loc_logops->lop_open(env, *lgh, logid, name, open_param);
1076         if (!raised)
1077                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
1078         if (rc) {
1079                 llog_free_handle(*lgh);
1080                 *lgh = NULL;
1081         }
1082         RETURN(rc);
1083 }
1084 EXPORT_SYMBOL(llog_open);
1085
1086 int llog_close(const struct lu_env *env, struct llog_handle *loghandle)
1087 {
1088         struct llog_operations  *lop;
1089         int                      rc;
1090
1091         ENTRY;
1092
1093         rc = llog_handle2ops(loghandle, &lop);
1094         if (rc)
1095                 GOTO(out, rc);
1096         if (lop->lop_close == NULL)
1097                 GOTO(out, rc = -EOPNOTSUPP);
1098         rc = lop->lop_close(env, loghandle);
1099 out:
1100         llog_handle_put(loghandle);
1101         RETURN(rc);
1102 }
1103 EXPORT_SYMBOL(llog_close);
1104
1105 /**
1106  * Helper function to get the llog size in records. It is used by MGS
1107  * mostly to check that config llog exists and contains data.
1108  *
1109  * \param[in] env       execution environment
1110  * \param[in] ctxt      llog context
1111  * \param[in] name      llog name
1112  *
1113  * \retval              true if there are records in llog besides a header
1114  * \retval              false on error or llog without records
1115  */
1116 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
1117                   char *name)
1118 {
1119         struct llog_handle      *llh;
1120         int                      rc = 0;
1121
1122         rc = llog_open(env, ctxt, &llh, NULL, name, LLOG_OPEN_EXISTS);
1123         if (rc < 0) {
1124                 if (likely(rc == -ENOENT))
1125                         rc = 0;
1126                 GOTO(out, rc);
1127         }
1128
1129         rc = llog_init_handle(env, llh, LLOG_F_IS_PLAIN, NULL);
1130         if (rc)
1131                 GOTO(out_close, rc);
1132         rc = llog_get_size(llh);
1133
1134 out_close:
1135         llog_close(env, llh);
1136 out:
1137         /* The header is record 1, the llog is still considered as empty
1138          * if there is only header */
1139         return (rc <= 1);
1140 }
1141 EXPORT_SYMBOL(llog_is_empty);
1142
1143 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
1144                       struct llog_rec_hdr *rec, void *data)
1145 {
1146         struct llog_handle      *copy_llh = data;
1147
1148         /* Append all records */
1149         return llog_write(env, copy_llh, rec, LLOG_NEXT_IDX);
1150 }
1151
1152 /* backup plain llog */
1153 int llog_backup(const struct lu_env *env, struct obd_device *obd,
1154                 struct llog_ctxt *ctxt, struct llog_ctxt *bctxt,
1155                 char *name, char *backup)
1156 {
1157         struct llog_handle      *llh, *bllh;
1158         int                      rc;
1159
1160         ENTRY;
1161
1162         /* open original log */
1163         rc = llog_open(env, ctxt, &llh, NULL, name, LLOG_OPEN_EXISTS);
1164         if (rc < 0) {
1165                 /* the -ENOENT case is also reported to the caller
1166                  * but silently so it should handle that if needed.
1167                  */
1168                 if (rc != -ENOENT)
1169                         CERROR("%s: failed to open log %s: rc = %d\n",
1170                                obd->obd_name, name, rc);
1171                 RETURN(rc);
1172         }
1173
1174         rc = llog_init_handle(env, llh, LLOG_F_IS_PLAIN, NULL);
1175         if (rc)
1176                 GOTO(out_close, rc);
1177
1178         /* Make sure there's no old backup log */
1179         rc = llog_erase(env, bctxt, NULL, backup);
1180         if (rc < 0 && rc != -ENOENT)
1181                 GOTO(out_close, rc);
1182
1183         /* open backup log */
1184         rc = llog_open_create(env, bctxt, &bllh, NULL, backup);
1185         if (rc) {
1186                 CERROR("%s: failed to open backup logfile %s: rc = %d\n",
1187                        obd->obd_name, backup, rc);
1188                 GOTO(out_close, rc);
1189         }
1190
1191         /* check that backup llog is not the same object as original one */
1192         if (llh->lgh_obj == bllh->lgh_obj) {
1193                 CERROR("%s: backup llog %s to itself (%s), objects %p/%p\n",
1194                        obd->obd_name, name, backup, llh->lgh_obj,
1195                        bllh->lgh_obj);
1196                 GOTO(out_backup, rc = -EEXIST);
1197         }
1198
1199         rc = llog_init_handle(env, bllh, LLOG_F_IS_PLAIN, NULL);
1200         if (rc)
1201                 GOTO(out_backup, rc);
1202
1203         /* Copy log record by record */
1204         rc = llog_process_or_fork(env, llh, llog_copy_handler, (void *)bllh,
1205                                   NULL, false);
1206         if (rc)
1207                 CERROR("%s: failed to backup log %s: rc = %d\n",
1208                        obd->obd_name, name, rc);
1209 out_backup:
1210         llog_close(env, bllh);
1211 out_close:
1212         llog_close(env, llh);
1213         RETURN(rc);
1214 }
1215 EXPORT_SYMBOL(llog_backup);