Whamcloud - gitweb
LU-6158 mdt: always shrink_capsule in getxattr_all
[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, 2014, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/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 /* llog_ioctl.c */
210 struct obd_ioctl_data;
211 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
212                struct obd_ioctl_data *data);
213 int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
214                       int count, struct obd_ioctl_data *data,
215                       const struct lu_fid *fid);
216
217 /* llog_net.c */
218 int llog_initiator_connect(struct llog_ctxt *ctxt);
219
220 struct llog_operations {
221         int (*lop_declare_destroy)(const struct lu_env *env,
222                            struct llog_handle *handle, struct thandle *th);
223         int (*lop_destroy)(const struct lu_env *env,
224                            struct llog_handle *handle, struct thandle *th);
225         int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
226                               int *curr_idx, int next_idx, __u64 *offset,
227                               void *buf, int len);
228         int (*lop_prev_block)(const struct lu_env *env, struct llog_handle *h,
229                               int prev_idx, void *buf, int len);
230         int (*lop_read_header)(const struct lu_env *env,
231                                struct llog_handle *handle);
232         int (*lop_setup)(const struct lu_env *env, struct obd_device *obd,
233                          struct obd_llog_group *olg, int ctxt_idx,
234                          struct obd_device *disk_obd);
235         int (*lop_sync)(struct llog_ctxt *ctxt, struct obd_export *exp,
236                         int flags);
237         int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
238         int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
239                           struct llog_cookie *cookies, int flags);
240         int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
241                            struct llog_gen *gen, struct obd_uuid *uuid);
242         /**
243          * Any llog file must be opened first using llog_open().  Llog can be
244          * opened by name, logid or without both, in last case the new logid
245          * will be generated.
246          */
247         int (*lop_open)(const struct lu_env *env, struct llog_handle *lgh,
248                         struct llog_logid *logid, char *name,
249                         enum llog_open_param);
250         /**
251          * Opened llog may not exist and this must be checked where needed using
252          * the llog_exist() call.
253          */
254         int (*lop_exist)(struct llog_handle *lgh);
255         /**
256          * Close llog file and calls llog_free_handle() implicitly.
257          * Any opened llog must be closed by llog_close() call.
258          */
259         int (*lop_close)(const struct lu_env *env, struct llog_handle *handle);
260         /**
261          * Create new llog file. The llog must be opened.
262          * Must be used only for local llog operations.
263          */
264         int (*lop_declare_create)(const struct lu_env *env,
265                                   struct llog_handle *handle,
266                                   struct thandle *th);
267         int (*lop_create)(const struct lu_env *env, struct llog_handle *handle,
268                           struct thandle *th);
269         /**
270          * write new record in llog. It appends records usually but can edit
271          * existing records too.
272          */
273         int (*lop_declare_write_rec)(const struct lu_env *env,
274                                      struct llog_handle *lgh,
275                                      struct llog_rec_hdr *rec,
276                                      int idx, struct thandle *th);
277         int (*lop_write_rec)(const struct lu_env *env,
278                              struct llog_handle *loghandle,
279                              struct llog_rec_hdr *rec,
280                              struct llog_cookie *cookie,
281                              int idx, struct thandle *th);
282         /**
283          * Add new record in llog catalog. Does the same as llog_write_rec()
284          * but using llog catalog.
285          */
286         int (*lop_declare_add)(const struct lu_env *env,
287                                struct llog_handle *lgh,
288                                struct llog_rec_hdr *rec, struct thandle *th);
289         int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
290                        struct llog_rec_hdr *rec, struct llog_cookie *cookie,
291                        struct thandle *th);
292 };
293
294 /* In-memory descriptor for a log object or log catalog */
295 struct llog_handle {
296         struct rw_semaphore      lgh_lock;
297         struct mutex             lgh_hdr_mutex; /* protect lgh_hdr data */
298         struct llog_logid        lgh_id; /* id of this log */
299         struct llog_log_hdr     *lgh_hdr;
300         size_t                  lgh_hdr_size;
301         struct dt_object        *lgh_obj;
302         int                      lgh_last_idx;
303         int                      lgh_cur_idx; /* used during llog_process */
304         __u64                    lgh_cur_offset; /* used during llog_process */
305         struct llog_ctxt        *lgh_ctxt;
306         union {
307                 struct plain_handle_data         phd;
308                 struct cat_handle_data           chd;
309         } u;
310         char                    *lgh_name;
311         void                    *private_data;
312         struct llog_operations  *lgh_logops;
313         atomic_t                 lgh_refcount;
314 };
315
316 /* llog_osd.c */
317 extern struct llog_operations llog_osd_ops;
318 extern struct llog_operations llog_common_cat_ops;
319 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
320                           int idx, int count, struct llog_catid *idarray,
321                           const struct lu_fid *fid);
322 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
323                           int idx, int count, struct llog_catid *idarray,
324                           const struct lu_fid *fid);
325
326 #define LLOG_CTXT_FLAG_UNINITIALIZED     0x00000001
327 #define LLOG_CTXT_FLAG_STOP              0x00000002
328
329 /* Indicate the llog objects under this context are normal FID objects,
330  * instead of objects with local FID. */
331 #define LLOG_CTXT_FLAG_NORMAL_FID        0x00000004
332
333 struct llog_ctxt {
334         int                      loc_idx; /* my index the obd array of ctxt's */
335         struct obd_device       *loc_obd; /* points back to the containing obd*/
336         struct obd_llog_group   *loc_olg; /* group containing that ctxt */
337         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
338         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
339                                              pointing import */
340         struct llog_operations  *loc_logops;
341         struct llog_handle      *loc_handle;
342         struct mutex             loc_mutex; /* protect loc_imp */
343         atomic_t                 loc_refcount;
344         long                     loc_flags; /* flags, see above defines */
345         struct dt_object        *loc_dir;
346         struct local_oid_storage *loc_los_nameless;
347         struct local_oid_storage *loc_los_named;
348         /* llog chunk size, and llog record size can not be bigger than
349          * loc_chunk_size */
350         __u32                    loc_chunk_size;
351 };
352
353 #define LLOG_PROC_BREAK 0x0001
354 #define LLOG_DEL_RECORD 0x0002
355 #define LLOG_DEL_PLAIN  0x0003
356
357 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
358                                struct llog_operations **lop)
359 {
360         if (ctxt == NULL)
361                 return -ENOTCONN;
362
363         *lop = ctxt->loc_logops;
364         if (*lop == NULL)
365                 return -EOPNOTSUPP;
366
367         return 0;
368 }
369
370 static inline int llog_handle2ops(struct llog_handle *loghandle,
371                                   struct llog_operations **lop)
372 {
373         if (loghandle == NULL || loghandle->lgh_logops == NULL)
374                 return -EINVAL;
375
376         *lop = loghandle->lgh_logops;
377         return 0;
378 }
379
380 static inline int llog_data_len(int len)
381 {
382         return cfs_size_round(len);
383 }
384
385 static inline int llog_get_size(struct llog_handle *loghandle)
386 {
387         if (loghandle && loghandle->lgh_hdr)
388                 return loghandle->lgh_hdr->llh_count;
389         return 0;
390 }
391
392 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
393 {
394         atomic_inc(&ctxt->loc_refcount);
395         CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
396                atomic_read(&ctxt->loc_refcount));
397         return ctxt;
398 }
399
400 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
401 {
402         if (ctxt == NULL)
403                 return;
404         LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
405         CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
406                atomic_read(&ctxt->loc_refcount) - 1);
407         __llog_ctxt_put(NULL, ctxt);
408 }
409
410 static inline void llog_group_init(struct obd_llog_group *olg)
411 {
412         init_waitqueue_head(&olg->olg_waitq);
413         spin_lock_init(&olg->olg_lock);
414         mutex_init(&olg->olg_cat_processing);
415 }
416
417 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
418                                       struct llog_ctxt *ctxt, int index)
419 {
420         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
421
422         spin_lock(&olg->olg_lock);
423         if (olg->olg_ctxts[index] != NULL) {
424                 spin_unlock(&olg->olg_lock);
425                 return -EEXIST;
426         }
427         olg->olg_ctxts[index] = ctxt;
428         spin_unlock(&olg->olg_lock);
429         return 0;
430 }
431
432 static inline struct llog_ctxt *llog_group_get_ctxt(struct obd_llog_group *olg,
433                                                     int index)
434 {
435         struct llog_ctxt *ctxt;
436
437         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
438
439         spin_lock(&olg->olg_lock);
440         if (olg->olg_ctxts[index] == NULL)
441                 ctxt = NULL;
442         else
443                 ctxt = llog_ctxt_get(olg->olg_ctxts[index]);
444         spin_unlock(&olg->olg_lock);
445         return ctxt;
446 }
447
448 static inline void llog_group_clear_ctxt(struct obd_llog_group *olg, int index)
449 {
450         LASSERT(index >= 0 && index < LLOG_MAX_CTXTS);
451         spin_lock(&olg->olg_lock);
452         olg->olg_ctxts[index] = NULL;
453         spin_unlock(&olg->olg_lock);
454 }
455
456 static inline struct llog_ctxt *llog_get_context(struct obd_device *obd,
457                                                  int index)
458 {
459         return llog_group_get_ctxt(&obd->obd_olg, index);
460 }
461
462 static inline int llog_group_ctxt_null(struct obd_llog_group *olg, int index)
463 {
464         return (olg->olg_ctxts[index] == NULL);
465 }
466
467 static inline int llog_ctxt_null(struct obd_device *obd, int index)
468 {
469         return (llog_group_ctxt_null(&obd->obd_olg, index));
470 }
471
472 static inline int llog_next_block(const struct lu_env *env,
473                                   struct llog_handle *loghandle, int *cur_idx,
474                                   int next_idx, __u64 *cur_offset, void *buf,
475                                   int len)
476 {
477         struct llog_operations *lop;
478         int rc;
479
480         ENTRY;
481
482         rc = llog_handle2ops(loghandle, &lop);
483         if (rc)
484                 RETURN(rc);
485         if (lop->lop_next_block == NULL)
486                 RETURN(-EOPNOTSUPP);
487
488         rc = lop->lop_next_block(env, loghandle, cur_idx, next_idx,
489                                  cur_offset, buf, len);
490         RETURN(rc);
491 }
492
493 static inline int llog_prev_block(const struct lu_env *env,
494                                   struct llog_handle *loghandle,
495                                   int prev_idx, void *buf, int len)
496 {
497         struct llog_operations *lop;
498         int rc;
499
500         ENTRY;
501
502         rc = llog_handle2ops(loghandle, &lop);
503         if (rc)
504                 RETURN(rc);
505         if (lop->lop_prev_block == NULL)
506                 RETURN(-EOPNOTSUPP);
507
508         rc = lop->lop_prev_block(env, loghandle, prev_idx, buf, len);
509         RETURN(rc);
510 }
511
512 static inline int llog_connect(struct llog_ctxt *ctxt,
513                                struct llog_logid *logid, struct llog_gen *gen,
514                                struct obd_uuid *uuid)
515 {
516         struct llog_operations  *lop;
517         int                      rc;
518
519         ENTRY;
520
521         rc = llog_obd2ops(ctxt, &lop);
522         if (rc)
523                 RETURN(rc);
524         if (lop->lop_connect == NULL)
525                 RETURN(-EOPNOTSUPP);
526
527         rc = lop->lop_connect(ctxt, logid, gen, uuid);
528         RETURN(rc);
529 }
530
531 struct llog_cfg_rec {
532         struct llog_rec_hdr     lcr_hdr;
533         struct lustre_cfg       lcr_cfg;
534         struct llog_rec_tail    lcr_tail;
535 };
536
537 struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
538 void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
539
540 enum {
541         LLOG_NEXT_IDX = -1,
542         LLOG_HEADER_IDX = 0,
543 };
544
545 /* llog.c */
546 int llog_exist(struct llog_handle *loghandle);
547 int llog_declare_create(const struct lu_env *env,
548                         struct llog_handle *loghandle, struct thandle *th);
549 int llog_create(const struct lu_env *env, struct llog_handle *handle,
550                 struct thandle *th);
551 int llog_trans_destroy(const struct lu_env *env, struct llog_handle *handle,
552                        struct thandle *th);
553 int llog_destroy(const struct lu_env *env, struct llog_handle *handle);
554
555 int llog_declare_write_rec(const struct lu_env *env,
556                            struct llog_handle *handle,
557                            struct llog_rec_hdr *rec, int idx,
558                            struct thandle *th);
559 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
560                    struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
561                    int idx, struct thandle *th);
562 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
563              struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
564              struct thandle *th);
565 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
566                      struct llog_rec_hdr *rec, struct thandle *th);
567 int lustre_process_log(struct super_block *sb, char *logname,
568                        struct config_llog_instance *cfg);
569 int lustre_end_log(struct super_block *sb, char *logname,
570                    struct config_llog_instance *cfg);
571 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
572                      struct llog_handle **res, struct llog_logid *logid,
573                      char *name);
574 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
575                struct llog_logid *logid, char *name);
576 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
577                struct llog_rec_hdr *rec, int idx);
578
579 /** @} log */
580
581 #endif