Whamcloud - gitweb
668b73ead336c5fca66cdc77ad3c5911fbe60c63
[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, 2016, 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 <lustre/lustre_idl.h>
56 #include <dt_object.h>
57 #include <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_open(const struct lu_env *env, struct llog_ctxt *ctxt,
99               struct llog_handle **lgh, struct llog_logid *logid,
100               char *name, enum llog_open_param open_param);
101 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
102 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
103                   char *name);
104 int llog_backup(const struct lu_env *env, struct obd_device *obd,
105                 struct llog_ctxt *ctxt, struct llog_ctxt *bak_ctxt,
106                 char *name, char *backup);
107 int llog_read_header(const struct lu_env *env, struct llog_handle *handle,
108                      const struct obd_uuid *uuid);
109 __u64 llog_size(const struct lu_env *env, struct llog_handle *llh);
110
111 /* llog_process flags */
112 #define LLOG_FLAG_NODEAMON 0x0001
113
114 /* llog_cat.c - catalog api */
115 struct llog_process_data {
116         /**
117          * Any useful data needed while processing catalog. This is
118          * passed later to process callback.
119          */
120         void                *lpd_data;
121         /**
122          * Catalog process callback function, called for each record
123          * in catalog.
124          */
125         llog_cb_t            lpd_cb;
126         /**
127          * Start processing the catalog from startcat/startidx
128          */
129         int                  lpd_startcat;
130         int                  lpd_startidx;
131 };
132
133 struct llog_process_cat_data {
134         /**
135          * Temporary stored first_idx while scanning log.
136          */
137         int                  lpcd_first_idx;
138         /**
139          * Temporary stored last_idx while scanning log.
140          */
141         int                  lpcd_last_idx;
142 };
143
144 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
145 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
146                      struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
147                      struct thandle *th);
148 int llog_cat_declare_add_rec(const struct lu_env *env,
149                              struct llog_handle *cathandle,
150                              struct llog_rec_hdr *rec, struct thandle *th);
151 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
152                  struct llog_rec_hdr *rec, struct llog_cookie *reccookie);
153 int llog_cat_cancel_records(const struct lu_env *env,
154                             struct llog_handle *cathandle, int count,
155                             struct llog_cookie *cookies);
156 int llog_cat_process_or_fork(const struct lu_env *env,
157                              struct llog_handle *cat_llh, llog_cb_t cat_cb,
158                              llog_cb_t cb, void *data, int startcat,
159                              int startidx, bool fork);
160 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
161                      llog_cb_t cb, void *data, int startcat, int startidx);
162 __u64 llog_cat_size(const struct lu_env *env, struct llog_handle *cat_llh);
163 int llog_cat_reverse_process(const struct lu_env *env,
164                              struct llog_handle *cat_llh, llog_cb_t cb,
165                              void *data);
166 /* llog_obd.c */
167 int llog_setup(const struct lu_env *env, struct obd_device *obd,
168                struct obd_llog_group *olg, int index,
169                struct obd_device *disk_obd, struct llog_operations *op);
170 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
171 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
172 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
173 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
174                 struct llog_cookie *cookies, int flags);
175
176 /* llog_ioctl.c */
177 struct obd_ioctl_data;
178 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
179                struct obd_ioctl_data *data);
180 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
181                       int count, struct obd_ioctl_data *data,
182                       const struct lu_fid *fid);
183
184 /* llog_net.c */
185 int llog_initiator_connect(struct llog_ctxt *ctxt);
186
187 struct llog_operations {
188         int (*lop_declare_destroy)(const struct lu_env *env,
189                            struct llog_handle *handle, struct thandle *th);
190         int (*lop_destroy)(const struct lu_env *env,
191                            struct llog_handle *handle, struct thandle *th);
192         int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
193                               int *curr_idx, int next_idx, __u64 *offset,
194                               void *buf, int len);
195         int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
196                               int prev_idx, void *buf, int len);
197         int (*lop_read_header)(const struct lu_env *env,
198                                struct llog_handle *handle);
199         int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
200                          struct obd_llog_group *olg, int ctxt_idx,
201                          struct obd_device *disk_obd);
202         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
203                         int flags);
204         int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
205         int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
206                           struct llog_cookie *cookies, int flags);
207         int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
208                            struct llog_gen *gen, struct obd_uuid *uuid);
209         /**
210          * Any llog file must be opened first using llog_open().  Llog can be
211          * opened by name, logid or without both, in last case the new logid
212          * will be generated.
213          */
214         int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
215                         struct llog_logid *logid, char *name,
216                         enum llog_open_param);
217         /**
218          * Opened llog may not exist and this must be checked where needed using
219          * the llog_exist() call.
220          */
221         int (*lop_exist)(struct llog_handle *lgh);
222         /**
223          * Close llog file and calls llog_free_handle() implicitly.
224          * Any opened llog must be closed by llog_close() call.
225          */
226         int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
227         /**
228          * Create new llog file. The llog must be opened.
229          * Must be used only for local llog operations.
230          */
231         int (*lop_declare_create)(const struct lu_env *env,
232                                   struct llog_handle *handle,
233                                   struct thandle *th);
234         int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
235                           struct thandle *th);
236         /**
237          * write new record in llog. It appends records usually but can edit
238          * existing records too.
239          */
240         int (*lop_declare_write_rec)(const struct lu_env *env,
241                                      struct llog_handle *lgh,
242                                      struct llog_rec_hdr *rec,
243                                      int idx, struct thandle *th);
244         int (*lop_write_rec)(const struct lu_env *env,
245                              struct llog_handle *loghandle,
246                              struct llog_rec_hdr *rec,
247                              struct llog_cookie *cookie,
248                              int idx, struct thandle *th);
249         /**
250          * Add new record in llog catalog. Does the same as llog_write_rec()
251          * but using llog catalog.
252          */
253         int (*lop_declare_add)(const struct lu_env *env,
254                                struct llog_handle *lgh,
255                                struct llog_rec_hdr *rec, struct thandle *th);
256         int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
257                        struct llog_rec_hdr *rec, struct llog_cookie *cookie,
258                        struct thandle *th);
259 };
260
261 /* In-memory descriptor for a log object or log catalog */
262 struct llog_handle {
263         struct rw_semaphore      lgh_lock;
264         struct mutex             lgh_hdr_mutex; /* protect lgh_hdr data */
265         struct llog_logid        lgh_id; /* id of this log */
266         struct llog_log_hdr     *lgh_hdr; /* may be vmalloc'd */
267         size_t                  lgh_hdr_size;
268         struct dt_object        *lgh_obj;
269         /* For a Catalog, is the last/newest used index for a plain slot.
270          * Used in conjunction with llh_cat_idx to handle Catalog wrap-around
271          * case, after it will have reached LLOG_HDR_BITMAP_SIZE, llh_cat_idx
272          * will become its upper limit */
273         int                      lgh_last_idx;
274         int                      lgh_cur_idx; /* used during llog_process */
275         __u64                    lgh_cur_offset; /* used during llog_process */
276         /* used during llog_osd_write_rec */
277         __u64                    lgh_write_offset;
278         int                      lgh_max_size;
279         struct llog_ctxt        *lgh_ctxt;
280         union {
281                 struct plain_handle_data         phd;
282                 struct cat_handle_data           chd;
283         } u;
284         char                    *lgh_name;
285         void                    *private_data;
286         struct llog_operations  *lgh_logops;
287         atomic_t                 lgh_refcount;
288
289         __u32                   lgh_stale:1;
290 };
291
292 /* llog_osd.c */
293 extern struct llog_operations llog_osd_ops;
294 extern struct llog_operations llog_common_cat_ops;
295 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
296                           int idx, int count, struct llog_catid *idarray,
297                           const struct lu_fid *fid);
298 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
299                           int idx, int count, struct llog_catid *idarray,
300                           const struct lu_fid *fid);
301
302 #define LLOG_CTXT_FLAG_UNINITIALIZED     0x00000001
303 #define LLOG_CTXT_FLAG_STOP              0x00000002
304
305 /* Indicate the llog objects under this context are normal FID objects,
306  * instead of objects with local FID. */
307 #define LLOG_CTXT_FLAG_NORMAL_FID        0x00000004
308
309 struct llog_ctxt {
310         int                      loc_idx; /* my index the obd array of ctxt's */
311         struct obd_device       *loc_obd; /* points back to the containing obd*/
312         struct obd_llog_group   *loc_olg; /* group containing that ctxt */
313         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
314         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
315                                              pointing import */
316         struct llog_operations  *loc_logops;
317         struct llog_handle      *loc_handle;
318         struct mutex             loc_mutex; /* protect loc_imp */
319         atomic_t                 loc_refcount;
320         long                     loc_flags; /* flags, see above defines */
321         struct dt_object        *loc_dir;
322         struct local_oid_storage *loc_los_nameless;
323         struct local_oid_storage *loc_los_named;
324         /* llog chunk size, and llog record size can not be bigger than
325          * loc_chunk_size */
326         __u32                    loc_chunk_size;
327 };
328
329 #define LLOG_PROC_BREAK 0x0001
330 #define LLOG_DEL_RECORD 0x0002
331 #define LLOG_DEL_PLAIN  0x0003
332
333 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
334                                struct llog_operations **lop)
335 {
336         if (ctxt == NULL)
337                 return -ENOTCONN;
338
339         *lop = ctxt->loc_logops;
340         if (*lop == NULL)
341                 return -EOPNOTSUPP;
342
343         return 0;
344 }
345
346 static inline int llog_handle2ops(struct llog_handle *loghandle,
347                                   struct llog_operations **lop)
348 {
349         if (loghandle == NULL || loghandle->lgh_logops == NULL)
350                 return -EINVAL;
351
352         *lop = loghandle->lgh_logops;
353         return 0;
354 }
355
356 static inline int llog_data_len(int len)
357 {
358         return cfs_size_round(len);
359 }
360
361 static inline int llog_get_size(struct llog_handle *loghandle)
362 {
363         if (loghandle && loghandle->lgh_hdr)
364                 return loghandle->lgh_hdr->llh_count;
365         return 0;
366 }
367
368 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
369 {
370         atomic_inc(&ctxt->loc_refcount);
371         CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
372                atomic_read(&ctxt->loc_refcount));
373         return ctxt;
374 }
375
376 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
377 {
378         if (ctxt == NULL)
379                 return;
380         LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
381         CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
382                atomic_read(&ctxt->loc_refcount) - 1);
383         __llog_ctxt_put(NULL, ctxt);
384 }
385
386 static inline void llog_group_init(struct obd_llog_group *olg)
387 {
388         init_waitqueue_head(&olg->olg_waitq);
389         spin_lock_init(&olg->olg_lock);
390         mutex_init(&olg->olg_cat_processing);
391 }
392
393 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
394                                       struct llog_ctxt *ctxt, int index)
395 {
396         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
397
398         spin_lock(&olg->olg_lock);
399         if (olg->olg_ctxts[index] != NULL) {
400                 spin_unlock(&olg->olg_lock);
401                 return -EEXIST;
402         }
403         olg->olg_ctxts[index] = ctxt;
404         spin_unlock(&olg->olg_lock);
405         return 0;
406 }
407
408 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
409                                                     int index)
410 {
411         struct llog_ctxt *ctxt;
412
413         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
414
415         spin_lock(&olg->olg_lock);
416         if (olg->olg_ctxts[index] == NULL)
417                 ctxt = NULL;
418         else
419                 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
420         spin_unlock(&olg->olg_lock);
421         return ctxt;
422 }
423
424 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
425 {
426         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
427         spin_lock(&olg->olg_lock);
428         olg->olg_ctxts[index] = NULL;
429         spin_unlock(&olg->olg_lock);
430 }
431
432 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
433                                                  int index)
434 {
435         return llog_group_get_ctxt(&obd->obd_olg, index);
436 }
437
438 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
439 {
440         return (olg->olg_ctxts[index] == NULL);
441 }
442
443 static inline int llog_ctxt_null(struct obd_device *obd, int index)
444 {
445         return (llog_group_ctxt_null(&obd->obd_olg, index));
446 }
447
448 static inline int llog_next_block(const struct lu_env *env,
449                                   struct llog_handle *loghandle, int *cur_idx,
450                                   int next_idx, __u64 *cur_offset, void *buf,
451                                   int len)
452 {
453         struct llog_operations *lop;
454         int rc;
455
456         ENTRY;
457
458         rc = llog_handle2ops(loghandle, &lop);
459         if (rc)
460                 RETURN(rc);
461         if (lop->lop_next_block == NULL)
462                 RETURN(-EOPNOTSUPP);
463
464         rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
465                                  cur_offset, buf, len);
466         RETURN(rc);
467 }
468
469 static inline int llog_prev_block(const struct lu_env *env,
470                                   struct llog_handle *loghandle,
471                                   int prev_idx, void *buf, int len)
472 {
473         struct llog_operations *lop;
474         int rc;
475
476         ENTRY;
477
478         rc = llog_handle2ops(loghandle, &lop);
479         if (rc)
480                 RETURN(rc);
481         if (lop->lop_prev_block == NULL)
482                 RETURN(-EOPNOTSUPP);
483
484         rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
485         RETURN(rc);
486 }
487
488 static inline int llog_connect(struct llog_ctxt *ctxt,
489                                struct llog_logid *logid, struct llog_gen *gen,
490                                struct obd_uuid *uuid)
491 {
492         struct llog_operations  *lop;
493         int                      rc;
494
495         ENTRY;
496
497         rc = llog_obd2ops(ctxt, &lop);
498         if (rc)
499                 RETURN(rc);
500         if (lop->lop_connect == NULL)
501                 RETURN(-EOPNOTSUPP);
502
503         rc = lop->lop_connect(ctxt, logid, gen, uuid);
504         RETURN(rc);
505 }
506
507 static inline int llog_is_full(struct llog_handle *llh)
508 {
509         return llh->lgh_last_idx >= LLOG_HDR_BITMAP_SIZE(llh->lgh_hdr) - 1;
510 }
511
512 struct llog_cfg_rec {
513         struct llog_rec_hdr     lcr_hdr;
514         struct lustre_cfg       lcr_cfg;
515         struct llog_rec_tail    lcr_tail;
516 };
517
518 struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
519 void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
520
521 enum {
522         LLOG_NEXT_IDX = -1,
523         LLOG_HEADER_IDX = 0,
524 };
525
526 /* llog.c */
527 int llog_exist(struct llog_handle *loghandle);
528 int llog_declare_create(const struct lu_env *env,
529                         struct llog_handle *loghandle, struct thandle *th);
530 int llog_create(const struct lu_env *env, struct llog_handle *handle,
531                 struct thandle *th);
532 int llog_trans_destroy(const struct lu_env *env, struct llog_handle *handle,
533                        struct thandle *th);
534 int llog_destroy(const struct lu_env *env, struct llog_handle *handle);
535
536 int llog_declare_write_rec(const struct lu_env *env,
537                            struct llog_handle *handle,
538                            struct llog_rec_hdr *rec, int idx,
539                            struct thandle *th);
540 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
541                    struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
542                    int idx, struct thandle *th);
543 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
544              struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
545              struct thandle *th);
546 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
547                      struct llog_rec_hdr *rec, struct thandle *th);
548 int lustre_process_log(struct super_block *sb, char *logname,
549                        struct config_llog_instance *cfg);
550 int lustre_end_log(struct super_block *sb, char *logname,
551                    struct config_llog_instance *cfg);
552 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
553                      struct llog_handle **res, struct llog_logid *logid,
554                      char *name);
555 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
556                struct llog_logid *logid, char *name);
557 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
558                struct llog_rec_hdr *rec, int idx);
559
560 /** @} log */
561
562 #endif