Whamcloud - gitweb
LU-6838 llog: limit file size of plain logs
[fs/lustre-release.git] / lustre / include / lustre_log.h
index e9d3f2c..fe107c7 100644 (file)
  *
  * You should have received a copy of the GNU General Public License
  * version 2 along with this program; If not, see
- * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
- *
- * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
- * CA 95054 USA or visit www.sun.com if you need additional information or
- * have any questions.
+ * http://www.gnu.org/licenses/gpl-2.0.html
  *
  * GPL HEADER END
  */
  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
  *
- * Copyright (c) 2012, Intel Corporation.
+ * Copyright (c) 2012, 2015, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
- * Lustre is a trademark of Sun Microsystems, Inc.
  *
  * lustre/include/lustre_log.h
  *
  * @{
  */
 
-#if defined(__linux__)
-#include <linux/lustre_log.h>
-#elif defined(__APPLE__)
-#include <darwin/lustre_log.h>
-#elif defined(__WINNT__)
-#include <winnt/lustre_log.h>
-#else
-#error Unsupported operating system.
-#endif
-
 #include <obd_class.h>
-#include <obd_ost.h>
 #include <lustre/lustre_idl.h>
 #include <dt_object.h>
+#include <lustre_log_user.h>
 
 #define LOG_NAME_LIMIT(logname, name)                   \
         snprintf(logname, sizeof(logname), "LOGS/%s", name)
@@ -81,56 +66,18 @@ enum llog_open_param {
 };
 
 struct plain_handle_data {
-        cfs_list_t          phd_entry;
-        struct llog_handle *phd_cat_handle;
-        struct llog_cookie  phd_cookie; /* cookie of this log in its cat */
+       struct list_head        phd_entry;
+       struct llog_handle      *phd_cat_handle;
+       /* cookie of this log in its cat */
+       struct llog_cookie      phd_cookie;
 };
 
 struct cat_handle_data {
-        cfs_list_t              chd_head;
-        struct llog_handle     *chd_current_log; /* currently open log */
-       struct llog_handle      *chd_next_log; /* llog to be used next */
+       struct list_head        chd_head;
+       struct llog_handle     *chd_current_log;/* currently open log */
+       struct llog_handle     *chd_next_log;   /* llog to be used next */
 };
 
-static inline void logid_to_fid(struct llog_logid *id, struct lu_fid *fid)
-{
-       /* For compatibility purposes we identify pre-OSD (~< 2.3.51 MDS)
-        * logid's by non-zero ogen (inode generation) and convert them
-        * into IGIF */
-       if (id->lgl_ogen == 0)
-               ostid_to_fid(fid, &id->lgl_oi, 0);
-       else
-               lu_igif_build(fid, ostid_id(&id->lgl_oi), id->lgl_ogen);
-}
-
-static inline void fid_to_logid(struct lu_fid *fid, struct llog_logid *id)
-{
-       if (fid_is_igif(fid)) {
-               /* See above lu_igif_build */
-               ostid_set_id(&id->lgl_oi, fid->f_seq);
-               id->lgl_ogen = fid->f_oid;
-       } else {
-               fid_to_ostid(fid, &id->lgl_oi);
-               id->lgl_ogen = 0;
-       }
-}
-
-static inline void logid_set_id(struct llog_logid *log_id, __u64 id)
-{
-       if (log_id->lgl_ogen == 0)
-               ostid_set_id(&log_id->lgl_oi, id);
-       else
-               log_id->lgl_oi.oi.oi_id = id;
-}
-
-static inline __u64 logid_id(struct llog_logid *log_id)
-{
-       if (log_id->lgl_ogen == 0)
-               return ostid_id(&log_id->lgl_oi);
-       else
-               return log_id->lgl_oi.oi.oi_id;
-}
-
 struct llog_handle;
 
 /* llog.c  -  general API */
@@ -152,7 +99,14 @@ int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
              struct llog_handle **lgh, struct llog_logid *logid,
              char *name, enum llog_open_param open_param);
 int llog_close(const struct lu_env *env, struct llog_handle *cathandle);
-int llog_get_size(struct llog_handle *loghandle);
+int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
+                 char *name);
+int llog_backup(const struct lu_env *env, struct obd_device *obd,
+               struct llog_ctxt *ctxt, struct llog_ctxt *bak_ctxt,
+               char *name, char *backup);
+int llog_read_header(const struct lu_env *env, struct llog_handle *handle,
+                    const struct obd_uuid *uuid);
+__u64 llog_size(const struct lu_env *env, struct llog_handle *llh);
 
 /* llog_process flags */
 #define LLOG_FLAG_NODEAMON 0x0001
@@ -190,27 +144,25 @@ struct llog_process_cat_data {
 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle);
 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
                     struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
-                    void *buf, struct thandle *th);
+                    struct thandle *th);
 int llog_cat_declare_add_rec(const struct lu_env *env,
                             struct llog_handle *cathandle,
                             struct llog_rec_hdr *rec, struct thandle *th);
 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
-                struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
-                void *buf);
+                struct llog_rec_hdr *rec, struct llog_cookie *reccookie);
 int llog_cat_cancel_records(const struct lu_env *env,
                            struct llog_handle *cathandle, int count,
                            struct llog_cookie *cookies);
 int llog_cat_process_or_fork(const struct lu_env *env,
-                            struct llog_handle *cat_llh, llog_cb_t cb,
-                            void *data, int startcat, int startidx, bool fork);
+                            struct llog_handle *cat_llh, llog_cb_t cat_cb,
+                            llog_cb_t cb, void *data, int startcat,
+                            int startidx, bool fork);
 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
                     llog_cb_t cb, void *data, int startcat, int startidx);
+__u64 llog_cat_size(const struct lu_env *env, struct llog_handle *cat_llh);
 int llog_cat_reverse_process(const struct lu_env *env,
                             struct llog_handle *cat_llh, llog_cb_t cb,
                             void *data);
-int llog_cat_init_and_process(const struct lu_env *env,
-                             struct llog_handle *llh);
-
 /* llog_obd.c */
 int llog_setup(const struct lu_env *env, struct obd_device *obd,
               struct obd_llog_group *olg, int index,
@@ -218,28 +170,25 @@ int llog_setup(const struct lu_env *env, struct obd_device *obd,
 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt);
 int llog_cleanup(const struct lu_env *env, struct llog_ctxt *);
 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags);
-int llog_obd_add(const struct lu_env *env, struct llog_ctxt *ctxt,
-                struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
-                struct llog_cookie *logcookies, int numcookies);
 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
-               struct lov_stripe_md *lsm, int count,
                struct llog_cookie *cookies, int flags);
 
-int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
-                  struct obd_device *disk_obd, int *idx);
-
-int obd_llog_finish(struct obd_device *obd, int count);
-
 /* llog_ioctl.c */
+struct obd_ioctl_data;
 int llog_ioctl(const struct lu_env *env, struct llog_ctxt *ctxt, int cmd,
               struct obd_ioctl_data *data);
+int llog_catalog_list(const struct lu_env *env, struct dt_device *d,
+                     int count, struct obd_ioctl_data *data,
+                     const struct lu_fid *fid);
 
 /* llog_net.c */
 int llog_initiator_connect(struct llog_ctxt *ctxt);
 
 struct llog_operations {
+       int (*lop_declare_destroy)(const struct lu_env *env,
+                          struct llog_handle *handle, struct thandle *th);
        int (*lop_destroy)(const struct lu_env *env,
-                          struct llog_handle *handle);
+                          struct llog_handle *handle, struct thandle *th);
        int (*lop_next_block)(const struct lu_env *env, struct llog_handle *h,
                              int *curr_idx, int next_idx, __u64 *offset,
                              void *buf, int len);
@@ -254,7 +203,6 @@ struct llog_operations {
                        int flags);
        int (*lop_cleanup)(const struct lu_env *env, struct llog_ctxt *ctxt);
        int (*lop_cancel)(const struct lu_env *env, struct llog_ctxt *ctxt,
-                         struct lov_stripe_md *lsm, int count,
                          struct llog_cookie *cookies, int flags);
        int (*lop_connect)(struct llog_ctxt *ctxt, struct llog_logid *logid,
                           struct llog_gen *gen, struct obd_uuid *uuid);
@@ -296,8 +244,8 @@ struct llog_operations {
        int (*lop_write_rec)(const struct lu_env *env,
                             struct llog_handle *loghandle,
                             struct llog_rec_hdr *rec,
-                            struct llog_cookie *cookie, int cookiecount,
-                            void *buf, int idx, struct thandle *th);
+                            struct llog_cookie *cookie,
+                            int idx, struct thandle *th);
        /**
         * Add new record in llog catalog. Does the same as llog_write_rec()
         * but using llog catalog.
@@ -307,25 +255,27 @@ struct llog_operations {
                               struct llog_rec_hdr *rec, struct thandle *th);
        int (*lop_add)(const struct lu_env *env, struct llog_handle *lgh,
                       struct llog_rec_hdr *rec, struct llog_cookie *cookie,
-                      void *buf, struct thandle *th);
-       /* Old llog_add version, used in MDS-LOV-OSC now and will gone with
-        * LOD/OSP replacement */
-       int (*lop_obd_add)(const struct lu_env *env, struct llog_ctxt *ctxt,
-                          struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
-                          struct llog_cookie *logcookies, int numcookies);
+                      struct thandle *th);
 };
 
 /* In-memory descriptor for a log object or log catalog */
 struct llog_handle {
        struct rw_semaphore      lgh_lock;
-       spinlock_t               lgh_hdr_lock; /* protect lgh_hdr data */
+       struct mutex             lgh_hdr_mutex; /* protect lgh_hdr data */
        struct llog_logid        lgh_id; /* id of this log */
-       struct llog_log_hdr     *lgh_hdr;
-       struct file             *lgh_file;
+       struct llog_log_hdr     *lgh_hdr; /* may be vmalloc'd */
+       size_t                  lgh_hdr_size;
        struct dt_object        *lgh_obj;
+       /* For a Catalog, is the last/newest used index for a plain slot.
+        * Used in conjunction with llh_cat_idx to handle Catalog wrap-around
+        * case, after it will have reached LLOG_HDR_BITMAP_SIZE, llh_cat_idx
+        * will become its upper limit */
        int                      lgh_last_idx;
        int                      lgh_cur_idx; /* used during llog_process */
        __u64                    lgh_cur_offset; /* used during llog_process */
+       /* used during llog_osd_write_rec */
+       __u64                    lgh_write_offset;
+       int                      lgh_max_size;
        struct llog_ctxt        *lgh_ctxt;
        union {
                struct plain_handle_data         phd;
@@ -334,24 +284,28 @@ struct llog_handle {
        char                    *lgh_name;
        void                    *private_data;
        struct llog_operations  *lgh_logops;
-       cfs_atomic_t             lgh_refcount;
-};
+       atomic_t                 lgh_refcount;
 
-/* llog_lvfs.c */
-extern struct llog_operations llog_lvfs_ops;
+       __u32                   lgh_stale:1;
+};
 
 /* llog_osd.c */
 extern struct llog_operations llog_osd_ops;
+extern struct llog_operations llog_common_cat_ops;
 int llog_osd_get_cat_list(const struct lu_env *env, struct dt_device *d,
-                         int idx, int count,
-                         struct llog_catid *idarray);
+                         int idx, int count, struct llog_catid *idarray,
+                         const struct lu_fid *fid);
 int llog_osd_put_cat_list(const struct lu_env *env, struct dt_device *d,
-                         int idx, int count,
-                         struct llog_catid *idarray);
+                         int idx, int count, struct llog_catid *idarray,
+                         const struct lu_fid *fid);
 
 #define LLOG_CTXT_FLAG_UNINITIALIZED     0x00000001
 #define LLOG_CTXT_FLAG_STOP             0x00000002
 
+/* Indicate the llog objects under this context are normal FID objects,
+ * instead of objects with local FID. */
+#define LLOG_CTXT_FLAG_NORMAL_FID       0x00000004
+
 struct llog_ctxt {
         int                      loc_idx; /* my index the obd array of ctxt's */
         struct obd_device       *loc_obd; /* points back to the containing obd*/
@@ -359,16 +313,22 @@ struct llog_ctxt {
         struct obd_export       *loc_exp; /* parent "disk" export (e.g. MDS) */
         struct obd_import       *loc_imp; /* to use in RPC's: can be backward
                                              pointing import */
-        struct llog_operations  *loc_logops;
-        struct llog_handle      *loc_handle;
+       struct llog_operations  *loc_logops;
+       struct llog_handle      *loc_handle;
        struct mutex             loc_mutex; /* protect loc_imp */
-        cfs_atomic_t             loc_refcount;
-        long                     loc_flags; /* flags, see above defines */
+       atomic_t                 loc_refcount;
+       long                     loc_flags; /* flags, see above defines */
        struct dt_object        *loc_dir;
+       struct local_oid_storage *loc_los_nameless;
+       struct local_oid_storage *loc_los_named;
+       /* llog chunk size, and llog record size can not be bigger than
+        * loc_chunk_size */
+       __u32                    loc_chunk_size;
 };
 
 #define LLOG_PROC_BREAK 0x0001
 #define LLOG_DEL_RECORD 0x0002
+#define LLOG_DEL_PLAIN  0x0003
 
 static inline int llog_obd2ops(struct llog_ctxt *ctxt,
                                struct llog_operations **lop)
@@ -398,30 +358,36 @@ static inline int llog_data_len(int len)
         return cfs_size_round(len);
 }
 
+static inline int llog_get_size(struct llog_handle *loghandle)
+{
+       if (loghandle && loghandle->lgh_hdr)
+               return loghandle->lgh_hdr->llh_count;
+       return 0;
+}
+
 static inline struct llog_ctxt *llog_ctxt_get(struct llog_ctxt *ctxt)
 {
-        cfs_atomic_inc(&ctxt->loc_refcount);
-        CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
-               cfs_atomic_read(&ctxt->loc_refcount));
-        return ctxt;
+       atomic_inc(&ctxt->loc_refcount);
+       CDEBUG(D_INFO, "GETting ctxt %p : new refcount %d\n", ctxt,
+              atomic_read(&ctxt->loc_refcount));
+       return ctxt;
 }
 
 static inline void llog_ctxt_put(struct llog_ctxt *ctxt)
 {
-        if (ctxt == NULL)
-                return;
-        LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
-        CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
-               cfs_atomic_read(&ctxt->loc_refcount) - 1);
+       if (ctxt == NULL)
+               return;
+       LASSERT_ATOMIC_GT_LT(&ctxt->loc_refcount, 0, LI_POISON);
+       CDEBUG(D_INFO, "PUTting ctxt %p : new refcount %d\n", ctxt,
+              atomic_read(&ctxt->loc_refcount) - 1);
        __llog_ctxt_put(NULL, ctxt);
 }
 
-static inline void llog_group_init(struct obd_llog_group *olg, int group)
+static inline void llog_group_init(struct obd_llog_group *olg)
 {
-       cfs_waitq_init(&olg->olg_waitq);
+       init_waitqueue_head(&olg->olg_waitq);
        spin_lock_init(&olg->olg_lock);
        mutex_init(&olg->olg_cat_processing);
-       olg->olg_seq = group;
 }
 
 static inline int llog_group_set_ctxt(struct obd_llog_group *olg,
@@ -479,24 +445,6 @@ static inline int llog_ctxt_null(struct obd_device *obd, int index)
         return (llog_group_ctxt_null(&obd->obd_olg, index));
 }
 
-static inline int llog_destroy(const struct lu_env *env,
-                              struct llog_handle *handle)
-{
-       struct llog_operations *lop;
-       int rc;
-
-       ENTRY;
-
-       rc = llog_handle2ops(handle, &lop);
-       if (rc)
-               RETURN(rc);
-       if (lop->lop_destroy == NULL)
-               RETURN(-EOPNOTSUPP);
-
-       rc = lop->lop_destroy(env, handle);
-       RETURN(rc);
-}
-
 static inline int llog_next_block(const struct lu_env *env,
                                  struct llog_handle *loghandle, int *cur_idx,
                                  int next_idx, __u64 *cur_offset, void *buf,
@@ -556,22 +504,45 @@ static inline int llog_connect(struct llog_ctxt *ctxt,
        RETURN(rc);
 }
 
+static inline int llog_is_full(struct llog_handle *llh)
+{
+       return llh->lgh_last_idx >= LLOG_HDR_BITMAP_SIZE(llh->lgh_hdr) - 1;
+}
+
+struct llog_cfg_rec {
+       struct llog_rec_hdr     lcr_hdr;
+       struct lustre_cfg       lcr_cfg;
+       struct llog_rec_tail    lcr_tail;
+};
+
+struct llog_cfg_rec *lustre_cfg_rec_new(int cmd, struct lustre_cfg_bufs *bufs);
+void lustre_cfg_rec_free(struct llog_cfg_rec *lcr);
+
+enum {
+       LLOG_NEXT_IDX = -1,
+       LLOG_HEADER_IDX = 0,
+};
+
 /* llog.c */
 int llog_exist(struct llog_handle *loghandle);
 int llog_declare_create(const struct lu_env *env,
                        struct llog_handle *loghandle, struct thandle *th);
 int llog_create(const struct lu_env *env, struct llog_handle *handle,
                struct thandle *th);
+int llog_trans_destroy(const struct lu_env *env, struct llog_handle *handle,
+                      struct thandle *th);
+int llog_destroy(const struct lu_env *env, struct llog_handle *handle);
+
 int llog_declare_write_rec(const struct lu_env *env,
                           struct llog_handle *handle,
                           struct llog_rec_hdr *rec, int idx,
                           struct thandle *th);
 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
                   struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
-                  int numcookies, void *buf, int idx, struct thandle *th);
+                  int idx, struct thandle *th);
 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
             struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
-            void *buf, struct thandle *th);
+            struct thandle *th);
 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
                     struct llog_rec_hdr *rec, struct thandle *th);
 int lustre_process_log(struct super_block *sb, char *logname,
@@ -584,8 +555,7 @@ int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
               struct llog_logid *logid, char *name);
 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
-              struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
-              int cookiecount, void *buf, int idx);
+              struct llog_rec_hdr *rec, int idx);
 
 /** @} log */