Whamcloud - gitweb
- documentation update for MDS recovery
[fs/lustre-release.git] / lustre / include / linux / lustre_idl.h
index d38063b..1c9890f 100644 (file)
 #include <asm/types.h>
 
 #include <linux/types.h>
-#else 
+#else
 #define __KERNEL__
 #include <linux/list.h>
 #undef __KERNEL__
 #include <stdint.h>
 #endif
-/* 
+/*
  * this file contains all data structures used in Lustre interfaces:
  * - obdo and obd_request records
  * - mds_request records
+ * - ldlm data
  * - ioctl's
- */ 
+ */
 
+#define PTL_RPC_MSG_REQUEST 4711
+#define PTL_RPC_MSG_ERR 4712
+
+struct lustre_msg {
+        __u64 conn;
+        __u64 token;
+
+        __u32 opc;
+        __u32 xid;
+        __u64 last_rcvd;
+        __u64 last_committed;
+        __u64 transno;
+        __u32 status;
+        __u32 type;
+        __u32   connid;
+        __u32   bufcount;
+        __u32   buflens[0];
+};
 
-/* 
+/*
  *   OST requests: OBDO & OBD request records
  */
 
-
 /* opcodes */
-#define OST_GET_INFO  6
-#define OST_CONNECT  7
+#define OST_GETATTR    1
+#define OST_SETATTR    2
+#define OST_BRW        3
+#define OST_CREATE     4
+#define OST_DESTROY    5
+#define OST_GET_INFO   6
+#define OST_CONNECT    7
 #define OST_DISCONNECT 8
-#define OST_GETATTR  1
-#define OST_SETATTR  2
-#define OST_PREPW    3
-#define OST_CREATE   4
-#define OST_DESTROY  5
-
-/* packet types */
-#define OST_TYPE_REQ 1
-#define OST_TYPE_REP 2
-#define OST_TYPE_ERR 3
-
-struct ptlreq_hdr { 
-       __u32 opc;
-       __u64 seqno;
-       __u32 status;
-       __u32 type;
-};
+#define OST_PUNCH      9
+#define OST_OPEN      10
+#define OST_CLOSE     11
 
-struct ptlrep_hdr { 
-       __u32 opc;
-       __u64 seqno;
-       __u32 status;
-       __u32 type;
-};
 
 typedef uint64_t        obd_id;
 typedef uint64_t        obd_gr;
@@ -90,7 +93,7 @@ typedef uint32_t        obd_rdev;
 typedef uint32_t        obd_flag;
 typedef uint32_t        obd_count;
 
-#define OBD_FL_INLINEDATA       (0x00000001UL)  
+#define OBD_FL_INLINEDATA       (0x00000001UL)
 #define OBD_FL_OBDMDEXISTS      (0x00000002UL)
 
 #define OBD_INLINESZ    60
@@ -144,280 +147,324 @@ struct obdo {
 
 #define OST_REQ_HAS_OA1  0x1
 
-struct ost_req { 
-       __u32   connid;
-       __u32   cmd; 
-       struct  obdo oa;
-       __u32   buflen1;
-       __u32   buflen2;
+struct ost_body {
+        __u32   connid;
+        __u32   data;
+        struct  obdo oa;
 };
 
-struct ost_rep {
-       __u32   result;
-       __u32   connid;
-       struct  obdo oa;
-       __u32   buflen1;
-       __u32   buflen2;
-};
-
-struct obd_ioobj { 
+struct obd_ioobj {
         obd_id    ioo_id;
         obd_gr    ioo_gr;
         __u32     ioo_type;
         __u32     ioo_bufcnt;
 };
 
-
-/* 
+/*
  *   MDS REQ RECORDS
  */
 
-
-#define MDS_TYPE_REQ 1
-#define MDS_TYPE_REP 2
-#define MDS_TYPE_ERR 3
-
+/* opcodes */
 #define MDS_GETATTR   1
-#define MDS_REINT     2
-#define MDS_READPAGE  3
-
-#define REINT_SETATTR 0
-#define REINT_CREATE  1
-#define REINT_MAX     1
-
-struct ll_fid { 
-       __u64 id;
-       __u32 generation;
-       __u32 f_type;
+#define MDS_OPEN      2
+#define MDS_CLOSE     3
+#define MDS_REINT     4
+#define MDS_READPAGE  5
+#define MDS_CONNECT   6
+
+#define REINT_SETATTR 1
+#define REINT_CREATE  2
+#define REINT_LINK    3
+#define REINT_UNLINK  4
+#define REINT_RENAME  5
+#define REINT_MAX     5
+
+struct ll_fid {
+        __u64 id;
+        __u32 generation;
+        __u32 f_type;
 };
 
-struct niobuf { 
+struct niobuf {
         __u64 addr;
-        __u64 offset; 
+        __u64 offset;
         __u32 len;
         __u32 flags;
+        __u32 xid;
+        void *page;
 };
 
-struct mds_req {
-       struct ll_fid        fid1;
-       struct ll_fid        fid2;
-        __u32                       namelen;
-        __u32                       tgtlen;
-        __u32                       opcode;
-        __u32                       valid;
-        __u32                      mode;
-        __u32                       uid;
-        __u32                       gid;
-        __u64                       size;
-        __u32                       mtime;
-        __u32                       ctime;
-        __u32                       atime;
-        __u32                       flags;
-        __u32                       major;
-        __u32                       minor;
-        __u32                       ino;
-        __u32                       nlink;
-        __u32                       generation;
-        __u64                       objid;
-};
-
-struct mds_rep {
-       struct ll_fid               fid1;
-       struct ll_fid               fid2;
-        __u32                       namelen;
-        __u32                       tgtlen;
-        __u32                       valid;
-        __u32                      mode;
-        __u32                       uid;
-        __u32                       gid;
-        __u64                       size;
-        __u32                       mtime;
-        __u32                       ctime;
-        __u32                       atime;
-        __u32                       flags;
-        __u32                       major;
-        __u32                       minor;
-        __u32                       ino;
-        __u32                       nlink;
-        __u32                       generation;
-        __u64                       objid;
+struct mds_body {
+        struct ll_fid  fid1;
+        struct ll_fid  fid2;
+        __u64          objid;
+        __u64          size;
+        __u32          valid;
+        __u32          mode;
+        __u32          uid;
+        __u32          gid;
+        __u32          mtime;
+        __u32          ctime;
+        __u32          atime;
+        __u32          flags;
+        __u32          major;
+        __u32          minor;
+        __u32          ino;
+        __u32          nlink;
+        __u32          generation;
+        __u32          last_xid;
 };
 
-
-/* MDS update records */ 
-
-struct mds_update_record_hdr { 
-        __u32 ur_reclen;
+/* MDS update records */
+struct mds_update_record_hdr {
         __u32 ur_opcode;
 };
 
-struct mds_rec_setattr { 
-        __u32           sa_reclen;
+struct mds_rec_setattr {
         __u32           sa_opcode;
-       struct ll_fid   sa_fid;
-       __u32           sa_valid;
-       __u32           sa_mode;
-       __u32           sa_uid;
-       __u32           sa_gid;
-       __u64           sa_size;
-       __u64           sa_atime;
-       __u64           sa_mtime;
-       __u64           sa_ctime;
-       __u32           sa_attr_flags;
+        struct ll_fid   sa_fid;
+        __u32           sa_valid;
+        __u32           sa_mode;
+        __u32           sa_uid;
+        __u32           sa_gid;
+        __u64           sa_size;
+        __u64           sa_atime;
+        __u64           sa_mtime;
+        __u64           sa_ctime;
+        __u32           sa_attr_flags;
 };
 
-struct mds_rec_create { 
-        __u32           cr_reclen;
+struct mds_rec_create {
         __u32           cr_opcode;
-       struct ll_fid   cr_fid;
+        struct ll_fid   cr_fid;
         __u32           cr_uid;
         __u32           cr_gid;
         __u64           cr_time;
-       __u32           cr_mode;
-        /* overloaded: id for create, tgtlen for symlink, rdev for mknod */ 
-       __u64           cr_id; 
-        __u32           cr_namelen;
-        /* name here */
+        __u32           cr_mode;
+        /* overloaded: id for create, tgtlen for symlink, rdev for mknod */
+        __u64           cr_id;
 };
 
-#ifdef __KERNEL__ 
+struct mds_rec_link {
+        __u32           lk_opcode;
+        struct ll_fid   lk_fid1;
+        struct ll_fid   lk_fid2;
+};
 
-static inline void ll_ino2fid(struct ll_fid *fid, ino_t ino, __u32 generation, int type)
-{
-        fid->id = HTON__u64((__u64)ino);
-        fid->generation = HTON__u32(generation);
-        fid->f_type = HTON__u32(type);
-}
+struct mds_rec_unlink {
+        __u32           ul_opcode;
+        struct ll_fid   ul_fid1;
+        struct ll_fid   ul_fid2;
+};
 
-static inline void ll_inode2fid(struct ll_fid *fid, struct inode *inode)
-{
-        fid->id = HTON__u64((__u64)inode->i_ino);
-        fid->generation = HTON__u32(inode->i_generation);
-        fid->f_type = HTON__u32(inode->i_mode & S_IFMT);
-}
+struct mds_rec_rename {
+        __u32           rn_opcode;
+        struct ll_fid   rn_fid1;
+        struct ll_fid   rn_fid2;
+};
 
-#endif 
 
-/* 
+/*
+ *   LDLM requests:
+ */
+
+/* opcodes */
+#define LDLM_NAMESPACE_NEW 1
+#define LDLM_ENQUEUE       2
+#define LDLM_CONVERT       3
+#define LDLM_CANCEL        4
+#define LDLM_CALLBACK      5
+
+#define RES_NAME_SIZE 3
+#define RES_VERSION_SIZE 4
+
+/* lock types */
+typedef enum {
+        LCK_EX = 1,
+        LCK_PW,
+        LCK_PR,
+        LCK_CW,
+        LCK_CR,
+        LCK_NL
+} ldlm_mode_t;
+
+struct ldlm_handle {
+        __u64 addr;
+        __u64 cookie;
+};
+
+struct ldlm_extent {
+        __u64 start;
+        __u64 end;
+};
+
+struct ldlm_resource_desc {
+        __u32 lr_ns_id;
+        __u32 lr_type;
+        __u64 lr_name[RES_NAME_SIZE];
+        __u64 lr_version[RES_VERSION_SIZE];
+};
+
+struct ldlm_lock_desc {
+        struct ldlm_resource_desc l_resource;
+        ldlm_mode_t l_req_mode;
+        ldlm_mode_t l_granted_mode;
+        struct ldlm_extent l_extent;
+        __u32 l_version[RES_VERSION_SIZE];
+};
+
+struct ldlm_request {
+        __u32 flags;
+        struct ldlm_lock_desc lock_desc;
+        struct ldlm_handle lock_handle1;
+        struct ldlm_handle lock_handle2;
+};
+
+struct ldlm_reply {
+        __u32 flags;
+        struct ldlm_handle lock_handle;
+        struct ldlm_extent lock_extent;
+};
+
+/*
  *   OBD IOCTLS
  */
 
 
 #define OBD_IOCTL_VERSION 0x00010001
 
-struct obd_ioctl_data { 
-       uint32_t ioc_len;
-       uint32_t ioc_version;
+struct obd_ioctl_data {
+        uint32_t ioc_len;
+        uint32_t ioc_version;
         uint32_t ioc_conn1;
         uint32_t ioc_conn2;
-       struct obdo ioc_obdo1;
-       struct obdo ioc_obdo2;
+        struct obdo ioc_obdo1;
+        struct obdo ioc_obdo2;
         obd_size         ioc_count;
         obd_off          ioc_offset;
-       uint32_t         ioc_dev;
+        uint32_t         ioc_dev;
 
-       /* buffers the kernel will treat as user pointers */
-       uint32_t ioc_plen1;
-       char    *ioc_pbuf1;
-       uint32_t ioc_plen2;
-       char    *ioc_pbuf2;
+        /* buffers the kernel will treat as user pointers */
+        uint32_t ioc_plen1;
+        char    *ioc_pbuf1;
+        uint32_t ioc_plen2;
+        char    *ioc_pbuf2;
 
-       /* two inline buffers */
-       uint32_t ioc_inllen1;
-       char    *ioc_inlbuf1;
-       uint32_t ioc_inllen2;
-       char    *ioc_inlbuf2;
+        /* two inline buffers */
+        uint32_t ioc_inllen1;
+        char    *ioc_inlbuf1;
+        uint32_t ioc_inllen2;
+        char    *ioc_inlbuf2;
 
-       char    ioc_bulk[0];
+        char    ioc_bulk[0];
 };
 
-struct obd_ioctl_hdr { 
-       uint32_t ioc_len;
-       uint32_t ioc_version;
+struct obd_ioctl_hdr {
+        uint32_t ioc_len;
+        uint32_t ioc_version;
 };
 
 static inline int obd_ioctl_packlen(struct obd_ioctl_data *data)
 {
-       int len = sizeof(struct obd_ioctl_data);
-       len += size_round(data->ioc_inllen1);
-       len += size_round(data->ioc_inllen2);
-       return len;
+        int len = sizeof(struct obd_ioctl_data);
+        len += size_round(data->ioc_inllen1);
+        len += size_round(data->ioc_inllen2);
+        return len;
 }
 
 static inline int obd_ioctl_is_invalid(struct obd_ioctl_data *data)
 {
-       if (data->ioc_len > (1<<30)) { 
-               printk("OBD ioctl: ioc_len larger than 1<<30\n");
-               return 1;
-       }
-       if (data->ioc_inllen1 > (1<<30)) { 
-               printk("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
-               return 1;
-       }
-       if (data->ioc_inllen2 > (1<<30)) { 
-               printk("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
-               return 1;
-       }
-       if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
-               printk("OBD ioctl: inlbuf1 pointer but 0 length\n");
-               return 1;
-       }
-       if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
-               printk("OBD ioctl: inlbuf2 pointer but 0 length\n");
-               return 1;
-       }
-       if (data->ioc_pbuf1 && !data->ioc_plen1) {
-               printk("OBD ioctl: pbuf1 pointer but 0 length\n");
-               return 1;
-       }
-       if (data->ioc_pbuf2 && !data->ioc_plen2) {
-               printk("OBD ioctl: pbuf2 pointer but 0 length\n");
-               return 1;
-       }
-       if (obd_ioctl_packlen(data) != data->ioc_len ) {
-               printk("OBD ioctl: packlen exceeds ioc_len\n");
-               return 1;
-       }
-       if (data->ioc_inllen1 && 
-           data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') { 
-               printk("OBD ioctl: inlbuf1 not 0 terminated\n");
-               return 1;
-       }
-       if (data->ioc_inllen2 && 
-           data->ioc_bulk[size_round(data->ioc_inllen1) + data->ioc_inllen2 - 1] != '\0') { 
-               printk("OBD ioctl: inlbuf2 not 0 terminated\n");
-               return 1;
-       }
-       return 0;
+        if (data->ioc_len > (1<<30)) {
+                printk("OBD ioctl: ioc_len larger than 1<<30\n");
+                return 1;
+        }
+        if (data->ioc_inllen1 > (1<<30)) {
+                printk("OBD ioctl: ioc_inllen1 larger than 1<<30\n");
+                return 1;
+        }
+        if (data->ioc_inllen2 > (1<<30)) {
+                printk("OBD ioctl: ioc_inllen2 larger than 1<<30\n");
+                return 1;
+        }
+        if (data->ioc_inlbuf1 && !data->ioc_inllen1) {
+                printk("OBD ioctl: inlbuf1 pointer but 0 length\n");
+                return 1;
+        }
+        if (data->ioc_inlbuf2 && !data->ioc_inllen2) {
+                printk("OBD ioctl: inlbuf2 pointer but 0 length\n");
+                return 1;
+        }
+        if (data->ioc_pbuf1 && !data->ioc_plen1) {
+                printk("OBD ioctl: pbuf1 pointer but 0 length\n");
+                return 1;
+        }
+        if (data->ioc_pbuf2 && !data->ioc_plen2) {
+                printk("OBD ioctl: pbuf2 pointer but 0 length\n");
+                return 1;
+        }
+        /*
+        if (data->ioc_inllen1 && !data->ioc_inlbuf1) {
+                printk("OBD ioctl: inllen1 set but NULL pointer\n");
+                return 1;
+        }
+        if (data->ioc_inllen2 && !data->ioc_inlbuf2) {
+                printk("OBD ioctl: inllen2 set but NULL pointer\n");
+                return 1;
+        }
+        if (data->ioc_plen1 && !data->ioc_pbuf1) {
+                printk("OBD ioctl: plen1 set but NULL pointer\n");
+                return 1;
+        }
+        if (data->ioc_plen2 && !data->ioc_pbuf2) {
+                printk("OBD ioctl: plen2 set but NULL pointer\n");
+                return 1;
+        }
+        */
+        if (obd_ioctl_packlen(data) != data->ioc_len ) {
+                printk("OBD ioctl: packlen exceeds ioc_len\n");
+                return 1;
+        }
+        if (data->ioc_inllen1 &&
+            data->ioc_bulk[data->ioc_inllen1 - 1] != '\0') {
+                printk("OBD ioctl: inlbuf1 not 0 terminated\n");
+                return 1;
+        }
+        if (data->ioc_inllen2 &&
+            data->ioc_bulk[size_round(data->ioc_inllen1) + data->ioc_inllen2 - 1] != '\0') {
+                printk("OBD ioctl: inlbuf2 not 0 terminated\n");
+                return 1;
+        }
+        return 0;
 }
 
 #ifndef __KERNEL__
-static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max)
+static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf,
+                                 int max)
 {
-       char *ptr;
-       struct obd_ioctl_data *overlay;
-       data->ioc_len = obd_ioctl_packlen(data);
-       data->ioc_version = OBD_IOCTL_VERSION;
-
-       if (*pbuf && obd_ioctl_packlen(data) > max) 
-               return 1;
-       if (*pbuf == NULL) { 
-               *pbuf = malloc(data->ioc_len);
-       }
-       if (!*pbuf)
-               return 1;
-       overlay = (struct obd_ioctl_data *)*pbuf;
-       memcpy(*pbuf, data, sizeof(*data));
-
-       ptr = overlay->ioc_bulk;
-       if (data->ioc_inlbuf1)
-               LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
-       if (data->ioc_inlbuf2)
-               LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
-       if (obd_ioctl_is_invalid(overlay))
-               return 1;
-
-       return 0;
+        char *ptr;
+        struct obd_ioctl_data *overlay;
+        data->ioc_len = obd_ioctl_packlen(data);
+        data->ioc_version = OBD_IOCTL_VERSION;
+
+        if (*pbuf && obd_ioctl_packlen(data) > max)
+                return 1;
+        if (*pbuf == NULL) {
+                *pbuf = malloc(data->ioc_len);
+        }
+        if (!*pbuf)
+                return 1;
+        overlay = (struct obd_ioctl_data *)*pbuf;
+        memcpy(*pbuf, data, sizeof(*data));
+
+        ptr = overlay->ioc_bulk;
+        if (data->ioc_inlbuf1)
+                LOGL(data->ioc_inlbuf1, data->ioc_inllen1, ptr);
+        if (data->ioc_inlbuf2)
+                LOGL(data->ioc_inlbuf2, data->ioc_inllen2, ptr);
+        if (obd_ioctl_is_invalid(overlay))
+                return 1;
+
+        return 0;
 }
 #else
 
@@ -425,57 +472,57 @@ static inline int obd_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int m
 /* buffer MUST be at least the size of obd_ioctl_hdr */
 static inline int obd_ioctl_getdata(char *buf, char *end, void *arg)
 {
-       struct obd_ioctl_hdr *hdr;
-       struct obd_ioctl_data *data;
-       int err;
-       ENTRY;
-
-       hdr = (struct obd_ioctl_hdr *)buf;
-       data = (struct obd_ioctl_data *)buf;
-
-       err = copy_from_user(buf, (void *)arg, sizeof(*hdr));
-       if ( err ) {
-               EXIT;
-               return err;
-       }
-
-       if (hdr->ioc_version != OBD_IOCTL_VERSION) { 
-               printk("OBD: version mismatch kernel vs application\n");
-               return -EINVAL;
-       }
-
-       if (hdr->ioc_len + buf >= end) { 
-               printk("OBD: user buffer exceeds kernel buffer\n");
-               return -EINVAL;
-       }
-
-
-       if (hdr->ioc_len < sizeof(struct obd_ioctl_data)) { 
-               printk("OBD: user buffer too small for ioctl\n");
-               return -EINVAL;
-       }
-
-       err = copy_from_user(buf, (void *)arg, hdr->ioc_len);
-       if ( err ) {
-               EXIT;
-               return err;
-       }
-
-       if (obd_ioctl_is_invalid(data)) { 
-               printk("OBD: ioctl not correctly formatted\n");
-               return -EINVAL;
-       }
-
-       if (data->ioc_inllen1) { 
-               data->ioc_inlbuf1 = &data->ioc_bulk[0];
-       }
-
-       if (data->ioc_inllen2) { 
-               data->ioc_inlbuf2 = &data->ioc_bulk[0] + size_round(data->ioc_inllen1);
-       }
-
-       EXIT;
-       return 0;
+        struct obd_ioctl_hdr *hdr;
+        struct obd_ioctl_data *data;
+        int err;
+        ENTRY;
+
+        hdr = (struct obd_ioctl_hdr *)buf;
+        data = (struct obd_ioctl_data *)buf;
+
+        err = copy_from_user(buf, (void *)arg, sizeof(*hdr));
+        if ( err ) {
+                EXIT;
+                return err;
+        }
+
+        if (hdr->ioc_version != OBD_IOCTL_VERSION) {
+                printk("OBD: version mismatch kernel vs application\n");
+                return -EINVAL;
+        }
+
+        if (hdr->ioc_len + buf >= end) {
+                printk("OBD: user buffer exceeds kernel buffer\n");
+                return -EINVAL;
+        }
+
+
+        if (hdr->ioc_len < sizeof(struct obd_ioctl_data)) {
+                printk("OBD: user buffer too small for ioctl\n");
+                return -EINVAL;
+        }
+
+        err = copy_from_user(buf, (void *)arg, hdr->ioc_len);
+        if ( err ) {
+                EXIT;
+                return err;
+        }
+
+        if (obd_ioctl_is_invalid(data)) {
+                printk("OBD: ioctl not correctly formatted\n");
+                return -EINVAL;
+        }
+
+        if (data->ioc_inllen1) {
+                data->ioc_inlbuf1 = &data->ioc_bulk[0];
+        }
+
+        if (data->ioc_inllen2) {
+                data->ioc_inlbuf2 = &data->ioc_bulk[0] + size_round(data->ioc_inllen1);
+        }
+
+        EXIT;
+        return 0;
 }
 #endif
 
@@ -503,20 +550,14 @@ static inline int obd_ioctl_getdata(char *buf, char *end, void *arg)
 #define OBD_IOC_MIGR                   _IOWR('f', 23, long)
 #define OBD_IOC_PUNCH                  _IOWR('f', 24, long)
 #define OBD_IOC_DEVICE                 _IOWR('f', 25, long)
+#define OBD_IOC_MODULE_DEBUG           _IOWR('f', 26, long)
+#define OBD_IOC_BRW_READ               _IOWR('f', 27, long)
+#define OBD_IOC_BRW_WRITE              _IOWR('f', 28, long)
+#define OBD_IOC_NAME2DEV               _IOWR('f', 29, long)
+#define OBD_IOC_NEWDEV                 _IOWR('f', 30, long)
 
-#define OBD_IOC_DEC_FS_USE_COUNT       _IO  ('f', 32      )
-
-
-/* GENERAL THINGS */
-union ptl_rep { 
-        struct mds_rep *mds;
-        struct ost_rep *ost;
-};
-
-union ptl_req { 
-        struct mds_req *mds;
-        struct ost_req *ost;
-};
+#define OBD_RECOVD_NEWCONN             _IOWR('f', 31, long)
 
+#define OBD_IOC_DEC_FS_USE_COUNT       _IO  ('f', 32      )
 
 #endif