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