Whamcloud - gitweb
360ba26dd52c822280901dbf03e402f0129e3cef
[fs/lustre-release.git] / lustre / include / lustre_log.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * lustre/include/lustre_log.h
32  *
33  * Generic infrastructure for managing a collection of logs.
34  * These logs are used for:
35  *
36  * - orphan recovery: OST adds record on create
37  * - mtime/size consistency: the OST adds a record on first write
38  * - open/unlinked objects: OST adds a record on destroy
39  *
40  * - mds unlink log: the MDS adds an entry upon delete
41  *
42  * - raid1 replication log between OST's
43  * - MDS replication logs
44  */
45
46 #ifndef _LUSTRE_LOG_H
47 #define _LUSTRE_LOG_H
48
49 /** \defgroup log log
50  *
51  * @{
52  */
53
54 #include <obd_class.h>
55 #include <dt_object.h>
56 #include <uapi/linux/lustre/lustre_idl.h>
57 #include <uapi/linux/lustre/lustre_log_user.h>
58
59 #define LOG_NAME_LIMIT(logname, name)                   \
60         snprintf(logname, sizeof(logname), "LOGS/%s", name)
61 #define LLOG_EEMPTY 4711
62
63 enum llog_open_param {
64         LLOG_OPEN_EXISTS        = 0x0000,
65         LLOG_OPEN_NEW           = 0x0001,
66 };
67
68 struct plain_handle_data {
69         struct list_head        phd_entry;
70         struct llog_handle      *phd_cat_handle;
71         /* cookie of this log in its cat */
72         struct llog_cookie      phd_cookie;
73 };
74
75 struct cat_handle_data {
76         struct list_head        chd_head;
77         struct llog_handle     *chd_current_log;/* currently open log */
78         struct llog_handle     *chd_next_log;   /* llog to be used next */
79 };
80
81 struct llog_handle;
82
83 /* llog.c  -  general API */
84 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
85                      int flags, struct obd_uuid *uuid);
86 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
87                       struct llog_rec_hdr *rec, void *data);
88 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
89                  llog_cb_t cb, void *data, void *catdata);
90 int llog_process_or_fork(const struct lu_env *env,
91                          struct llog_handle *loghandle,
92                          llog_cb_t cb, void *data, void *catdata, bool fork);
93 int llog_reverse_process(const struct lu_env *env,
94                          struct llog_handle *loghandle, llog_cb_t cb,
95                          void *data, void *catdata);
96 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
97                     int index);
98 int llog_cancel_arr_rec(const struct lu_env *env, struct llog_handle *loghandle,
99                     int num, int *index);
100 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
101               struct llog_handle **lgh, struct llog_logid *logid,
102               char *name, enum llog_open_param open_param);
103 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
104 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
105                   char *name);
106 int llog_backup(const struct lu_env *env, struct obd_device *obd,
107                 struct llog_ctxt *ctxt, struct llog_ctxt *bak_ctxt,
108                 char *name, char *backup);
109 int llog_read_header(const struct lu_env *env, struct llog_handle *handle,
110                      const struct obd_uuid *uuid);
111 __u64 llog_size(const struct lu_env *env, struct llog_handle *llh);
112
113 /* llog_process flags */
114 #define LLOG_FLAG_NODEAMON 0x0001
115
116 /* llog read mode, LLOG_READ_MODE_RAW will process llog canceled records */
117 enum llog_read_mode {
118         LLOG_READ_MODE_NORMAL   = 0x0000,
119         LLOG_READ_MODE_RAW      = 0x0001,
120 };
121
122
123 /* llog_cat.c - catalog api */
124 struct llog_process_data {
125         /**
126          * Any useful data needed while processing catalog. This is
127          * passed later to process callback.
128          */
129         void                *lpd_data;
130         /**
131          * Catalog process callback function, called for each record
132          * in catalog.
133          */
134         llog_cb_t            lpd_cb;
135         /**
136          * Start processing the catalog from startcat/startidx
137          */
138         int                  lpd_startcat;
139         int                  lpd_startidx;
140 };
141
142 struct llog_process_cat_data {
143         /**
144          * Temporary stored first_idx while scanning log.
145          */
146         int                  lpcd_first_idx;
147         /**
148          * Temporary stored last_idx while scanning log.
149          */
150         int                  lpcd_last_idx;
151         /**
152          * llog read mode
153          */
154         enum llog_read_mode  lpcd_read_mode;
155 };
156
157 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
158 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
159                      struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
160                      struct thandle *th);
161 int llog_cat_declare_add_rec(const struct lu_env *env,
162                              struct llog_handle *cathandle,
163                              struct llog_rec_hdr *rec, struct thandle *th);
164 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
165                  struct llog_rec_hdr *rec, struct llog_cookie *reccookie);
166 int llog_cat_cancel_arr_rec(const struct lu_env *env,
167                             struct llog_handle *cathandle,
168                             struct llog_logid *lgl, int count, int *index);
169 int llog_cat_cancel_records(const struct lu_env *env,
170                             struct llog_handle *cathandle, int count,
171                             struct llog_cookie *cookies);
172 int llog_cat_process_or_fork(const struct lu_env *env,
173                              struct llog_handle *cat_llh, llog_cb_t cat_cb,
174                              llog_cb_t cb, void *data, int startcat,
175                              int startidx, bool fork);
176 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
177                      llog_cb_t cb, void *data, int startcat, int startidx);
178 __u64 llog_cat_size(const struct lu_env *env, struct llog_handle *cat_llh);
179 __u32 llog_cat_free_space(struct llog_handle *cat_llh);
180 int llog_cat_reverse_process(const struct lu_env *env,
181                              struct llog_handle *cat_llh, llog_cb_t cb,
182                              void *data);
183 /* llog_obd.c */
184 int llog_setup(const struct lu_env *env, struct obd_device *obd,
185                struct obd_llog_group *olg, int index,
186                struct obd_device *disk_obd, const struct llog_operations *op);
187 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
188 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
189 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
190
191 /* llog_ioctl.c */
192 struct obd_ioctl_data;
193 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
194                struct obd_ioctl_data *data);
195 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
196                       int count, struct obd_ioctl_data *data,
197                       const struct lu_fid *fid);
198
199 /* llog_net.c */
200 int llog_initiator_connect(struct llog_ctxt *ctxt);
201
202 struct llog_operations {
203         int (*lop_declare_destroy)(const struct lu_env *env,
204                            struct llog_handle *handle, struct thandle *th);
205         int (*lop_destroy)(const struct lu_env *env,
206                            struct llog_handle *handle, struct thandle *th);
207         int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
208                               int *curr_idx, int next_idx, __u64 *offset,
209                               void *buf, int len);
210         int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
211                               int prev_idx, void *buf, int len);
212         int (*lop_read_header)(const struct lu_env *env,
213                                struct llog_handle *handle);
214         int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
215                          struct obd_llog_group *olg, int ctxt_idx,
216                          struct obd_device *disk_obd);
217         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
218                         int flags);
219         int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
220         int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
221                            struct llog_gen *gen, struct obd_uuid *uuid);
222         /**
223          * Any llog file must be opened first using llog_open().  Llog can be
224          * opened by name, logid or without both, in last case the new logid
225          * will be generated.
226          */
227         int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
228                         struct llog_logid *logid, char *name,
229                         enum llog_open_param);
230         /**
231          * Opened llog may not exist and this must be checked where needed using
232          * the llog_exist() call.
233          */
234         int (*lop_exist)(struct llog_handle *lgh);
235         /**
236          * Close llog file and calls llog_free_handle() implicitly.
237          * Any opened llog must be closed by llog_close() call.
238          */
239         int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
240         /**
241          * Create new llog file. The llog must be opened.
242          * Must be used only for local llog operations.
243          */
244         int (*lop_declare_create)(const struct lu_env *env,
245                                   struct llog_handle *handle,
246                                   struct thandle *th);
247         int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
248                           struct thandle *th);
249         /**
250          * write new record in llog. It appends records usually but can edit
251          * existing records too.
252          */
253         int (*lop_declare_write_rec)(const struct lu_env *env,
254                                      struct llog_handle *lgh,
255                                      struct llog_rec_hdr *rec,
256                                      int idx, struct thandle *th);
257         int (*lop_write_rec)(const struct lu_env *env,
258                              struct llog_handle *loghandle,
259                              struct llog_rec_hdr *rec,
260                              struct llog_cookie *cookie,
261                              int idx, struct thandle *th);
262         /**
263          * Add new record in llog catalog. Does the same as llog_write_rec()
264          * but using llog catalog.
265          */
266         int (*lop_declare_add)(const struct lu_env *env,
267                                struct llog_handle *lgh,
268                                struct llog_rec_hdr *rec, struct thandle *th);
269         int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
270                        struct llog_rec_hdr *rec, struct llog_cookie *cookie,
271                        struct thandle *th);
272 };
273
274 /* In-memory descriptor for a log object or log catalog */
275 struct llog_handle {
276         struct rw_semaphore      lgh_lock;
277         struct mutex             lgh_hdr_mutex; /* protect lgh_hdr data */
278         struct llog_logid        lgh_id; /* id of this log */
279         struct llog_log_hdr     *lgh_hdr; /* may be vmalloc'd */
280         size_t                  lgh_hdr_size;
281         struct dt_object        *lgh_obj;
282         /* For a Catalog, is the last/newest used index for a plain slot.
283          * Used in conjunction with llh_cat_idx to handle Catalog wrap-around
284          * case, after it will have reached LLOG_HDR_BITMAP_SIZE, llh_cat_idx
285          * will become its upper limit */
286         int                      lgh_last_idx;
287         struct rw_semaphore      lgh_last_sem;
288         __u64                    lgh_cur_offset; /* used for test only */
289         struct llog_ctxt        *lgh_ctxt;
290         union {
291                 struct plain_handle_data         phd;
292                 struct cat_handle_data           chd;
293         } u;
294         char                    *lgh_name;
295         void                    *private_data;
296         const struct llog_operations    *lgh_logops;
297         refcount_t               lgh_refcount;
298
299         int                     lgh_max_size;
300         bool                    lgh_destroyed;
301 };
302
303 /* llog_osd.c */
304 extern const struct llog_operations llog_osd_ops;
305 extern const struct llog_operations llog_common_cat_ops;
306 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
307                           int idx, int count, struct llog_catid *idarray,
308                           const struct lu_fid *fid);
309 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
310                           int idx, int count, struct llog_catid *idarray,
311                           const struct lu_fid *fid);
312
313 #define LLOG_CTXT_FLAG_UNINITIALIZED     0x00000001
314 #define LLOG_CTXT_FLAG_STOP              0x00000002
315
316 /* Indicate the llog objects under this context are normal FID objects,
317  * instead of objects with local FID. */
318 #define LLOG_CTXT_FLAG_NORMAL_FID        0x00000004
319
320 struct llog_ctxt {
321         int                      loc_idx; /* my index the obd array of ctxt's */
322         struct obd_device       *loc_obd; /* points back to the containing obd*/
323         struct obd_llog_group   *loc_olg; /* group containing that ctxt */
324         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
325         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
326                                            * pointing import */
327         const struct llog_operations  *loc_logops;
328         struct llog_handle      *loc_handle;
329         struct mutex             loc_mutex; /* protect loc_imp */
330         atomic_t                 loc_refcount;
331         long                     loc_flags; /* flags, see above defines */
332         struct dt_object        *loc_dir;
333         struct local_oid_storage *loc_los_nameless;
334         struct local_oid_storage *loc_los_named;
335         /* llog chunk size, and llog record size can not be bigger than
336          * loc_chunk_size */
337         __u32                    loc_chunk_size;
338 };
339
340 #define LLOG_PROC_BREAK 0x0001
341 #define LLOG_DEL_RECORD 0x0002
342 #define LLOG_DEL_PLAIN  0x0003
343
344 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
345                                const struct llog_operations **lop)
346 {
347         if (ctxt == NULL)
348                 return -ENOTCONN;
349
350         *lop = ctxt->loc_logops;
351         if (*lop == NULL)
352                 return -EOPNOTSUPP;
353
354         return 0;
355 }
356
357 static inline int llog_handle2ops(struct llog_handle *loghandle,
358                                   const struct llog_operations **lop)
359 {
360         if (loghandle == NULL || loghandle->lgh_logops == NULL)
361                 return -EINVAL;
362
363         *lop = loghandle->lgh_logops;
364         return 0;
365 }
366
367 static inline int llog_data_len(int len)
368 {
369         return cfs_size_round(len);
370 }
371
372 static inline int llog_get_size(struct llog_handle *loghandle)
373 {
374         if (loghandle && loghandle->lgh_hdr)
375                 return loghandle->lgh_hdr->llh_count;
376         return 0;
377 }
378
379 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
380 {
381         atomic_inc(&ctxt->loc_refcount);
382         CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
383                atomic_read(&ctxt->loc_refcount));
384         return ctxt;
385 }
386
387 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
388 {
389         if (ctxt == NULL)
390                 return;
391         LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
392         CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
393                atomic_read(&ctxt->loc_refcount) - 1);
394         __llog_ctxt_put(NULL, ctxt);
395 }
396
397 static inline void llog_group_init(struct obd_llog_group *olg)
398 {
399         init_waitqueue_head(&olg->olg_waitq);
400         spin_lock_init(&olg->olg_lock);
401 }
402
403 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
404                                       struct llog_ctxt *ctxt, int index)
405 {
406         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
407
408         spin_lock(&olg->olg_lock);
409         if (olg->olg_ctxts[index] != NULL) {
410                 spin_unlock(&olg->olg_lock);
411                 return -EEXIST;
412         }
413         olg->olg_ctxts[index] = ctxt;
414         spin_unlock(&olg->olg_lock);
415         return 0;
416 }
417
418 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
419                                                     int index)
420 {
421         struct llog_ctxt *ctxt;
422
423         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
424
425         spin_lock(&olg->olg_lock);
426         if (olg->olg_ctxts[index] == NULL)
427                 ctxt = NULL;
428         else
429                 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
430         spin_unlock(&olg->olg_lock);
431         return ctxt;
432 }
433
434 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
435 {
436         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
437         spin_lock(&olg->olg_lock);
438         olg->olg_ctxts[index] = NULL;
439         spin_unlock(&olg->olg_lock);
440 }
441
442 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
443                                                  int index)
444 {
445         return llog_group_get_ctxt(&obd->obd_olg, index);
446 }
447
448 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
449 {
450         return (olg->olg_ctxts[index] == NULL);
451 }
452
453 static inline int llog_ctxt_null(struct obd_device *obd, int index)
454 {
455         return (llog_group_ctxt_null(&obd->obd_olg, index));
456 }
457
458 static inline int llog_next_block(const struct lu_env *env,
459                                   struct llog_handle *loghandle, int *cur_idx,
460                                   int next_idx, __u64 *cur_offset, void *buf,
461                                   int len)
462 {
463         const struct llog_operations *lop;
464         int rc;
465
466         ENTRY;
467
468         rc = llog_handle2ops(loghandle, &lop);
469         if (rc)
470                 RETURN(rc);
471         if (lop->lop_next_block == NULL)
472                 RETURN(-EOPNOTSUPP);
473
474         rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
475                                  cur_offset, buf, len);
476         RETURN(rc);
477 }
478
479 static inline int llog_prev_block(const struct lu_env *env,
480                                   struct llog_handle *loghandle,
481                                   int prev_idx, void *buf, int len)
482 {
483         const struct llog_operations *lop;
484         int rc;
485
486         ENTRY;
487
488         rc = llog_handle2ops(loghandle, &lop);
489         if (rc)
490                 RETURN(rc);
491         if (lop->lop_prev_block == NULL)
492                 RETURN(-EOPNOTSUPP);
493
494         rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
495         RETURN(rc);
496 }
497
498 static inline int llog_connect(struct llog_ctxt *ctxt,
499                                struct llog_logid *logid, struct llog_gen *gen,
500                                struct obd_uuid *uuid)
501 {
502         const struct llog_operations *lop;
503         int rc;
504
505         ENTRY;
506
507         rc = llog_obd2ops(ctxt, &lop);
508         if (rc)
509                 RETURN(rc);
510         if (lop->lop_connect == NULL)
511                 RETURN(-EOPNOTSUPP);
512
513         rc = lop->lop_connect(ctxt, logid, gen, uuid);
514         RETURN(rc);
515 }
516
517 static inline int llog_is_full(struct llog_handle *llh)
518 {
519         return llh->lgh_last_idx >= LLOG_HDR_BITMAP_SIZE(llh->lgh_hdr) - 1;
520 }
521
522 struct llog_cfg_rec {
523         struct llog_rec_hdr     lcr_hdr;
524         struct lustre_cfg       lcr_cfg;
525         struct llog_rec_tail    lcr_tail;
526 };
527
528 struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
529 void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
530
531 enum {
532         LLOG_NEXT_IDX = -1,
533         LLOG_HEADER_IDX = 0,
534 };
535
536 /* llog.c */
537 int llog_exist(struct llog_handle *loghandle);
538 int llog_declare_create(const struct lu_env *env,
539                         struct llog_handle *loghandle, struct thandle *th);
540 int llog_create(const struct lu_env *env, struct llog_handle *handle,
541                 struct thandle *th);
542 int llog_trans_destroy(const struct lu_env *env, struct llog_handle *handle,
543                        struct thandle *th);
544 int llog_destroy(const struct lu_env *env, struct llog_handle *handle);
545
546 int llog_declare_write_rec(const struct lu_env *env,
547                            struct llog_handle *handle,
548                            struct llog_rec_hdr *rec, int idx,
549                            struct thandle *th);
550 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
551                    struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
552                    int idx, struct thandle *th);
553 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
554              struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
555              struct thandle *th);
556 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
557                      struct llog_rec_hdr *rec, struct thandle *th);
558 int lustre_process_log(struct super_block *sb, char *logname,
559                        struct config_llog_instance *cfg);
560 int lustre_end_log(struct super_block *sb, char *logname,
561                    struct config_llog_instance *cfg);
562 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
563                      struct llog_handle **res, struct llog_logid *logid,
564                      char *name);
565 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
566                struct llog_logid *logid, char *name);
567 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
568                struct llog_rec_hdr *rec, int idx);
569
570 /** @} log */
571
572 #endif