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