Whamcloud - gitweb
LU-3536 osp: move update packing into out_lib.c
[fs/lustre-release.git] / lustre / target / out_lib.c
index 061dac5..81c645b 100644 (file)
 #include <lu_target.h>
 #include <lustre_update.h>
 #include <obd.h>
+#include <obd_class.h>
+
+#define OUT_UPDATE_BUFFER_SIZE_ADD     4096
+#define OUT_UPDATE_BUFFER_SIZE_MAX     (256 * 4096)  /* 1MB update size now */
 
 struct dt_update_request*
 out_find_update(struct thandle_update *tu, struct dt_device *dt_dev)
@@ -49,53 +53,95 @@ out_find_update(struct thandle_update *tu, struct dt_device *dt_dev)
 }
 EXPORT_SYMBOL(out_find_update);
 
-void out_destroy_update_req(struct dt_update_request *dt_update)
+static struct object_update_request *object_update_request_alloc(size_t size)
+{
+       struct object_update_request *ourq;
+
+       OBD_ALLOC_LARGE(ourq, size);
+       if (ourq == NULL)
+               RETURN(ERR_PTR(-ENOMEM));
+
+       ourq->ourq_magic = UPDATE_REQUEST_MAGIC;
+       ourq->ourq_count = 0;
+
+       RETURN(ourq);
+}
+
+static void object_update_request_free(struct object_update_request *ourq,
+                                      size_t ourq_size)
+{
+       if (ourq != NULL)
+               OBD_FREE_LARGE(ourq, ourq_size);
+}
+
+void dt_update_request_destroy(struct dt_update_request *dt_update)
 {
        if (dt_update == NULL)
                return;
 
        list_del(&dt_update->dur_list);
-       if (dt_update->dur_req != NULL)
-               OBD_FREE_LARGE(dt_update->dur_req, dt_update->dur_req_len);
 
+       object_update_request_free(dt_update->dur_buf.ub_req,
+                                  dt_update->dur_buf.ub_req_size);
        OBD_FREE_PTR(dt_update);
-       return;
 }
-EXPORT_SYMBOL(out_destroy_update_req);
+EXPORT_SYMBOL(dt_update_request_destroy);
 
-struct dt_update_request *out_create_update_req(struct dt_device *dt)
+/**
+ * Allocate and initialize dt_update_request
+ *
+ * dt_update_request is being used to track updates being executed on
+ * this dt_device(OSD or OSP). The update buffer will be 8k initially,
+ * and increased if needed.
+ *
+ * \param [in] dt      dt device
+ *
+ * \retval             dt_update_request being allocated if succeed
+ * \retval             ERR_PTR(errno) if failed
+ */
+struct dt_update_request *dt_update_request_create(struct dt_device *dt)
 {
        struct dt_update_request *dt_update;
+       struct object_update_request *ourq;
 
        OBD_ALLOC_PTR(dt_update);
        if (!dt_update)
                return ERR_PTR(-ENOMEM);
 
-       OBD_ALLOC_LARGE(dt_update->dur_req, OUT_UPDATE_INIT_BUFFER_SIZE);
-       if (dt_update->dur_req == NULL) {
+       ourq = object_update_request_alloc(OUT_UPDATE_INIT_BUFFER_SIZE);
+       if (IS_ERR(ourq)) {
                OBD_FREE_PTR(dt_update);
-               return ERR_PTR(-ENOMEM);
+               return ERR_CAST(ourq);
        }
 
-       dt_update->dur_req_len = OUT_UPDATE_INIT_BUFFER_SIZE;
+       dt_update->dur_buf.ub_req = ourq;
+       dt_update->dur_buf.ub_req_size = OUT_UPDATE_INIT_BUFFER_SIZE;
+
        INIT_LIST_HEAD(&dt_update->dur_list);
        dt_update->dur_dt = dt;
        dt_update->dur_batchid = 0;
-       dt_update->dur_req->ourq_magic = UPDATE_REQUEST_MAGIC;
-       dt_update->dur_req->ourq_count = 0;
        INIT_LIST_HEAD(&dt_update->dur_cb_items);
 
        return dt_update;
 }
-EXPORT_SYMBOL(out_create_update_req);
+EXPORT_SYMBOL(dt_update_request_create);
 
 /**
+ * Find or create dt_update_request.
+ *
  * Find or create one loc in th_dev/dev_obj_update for the update,
  * Because only one thread can access this thandle, no need
  * lock now.
+ *
+ * \param[in] th       transaction handle
+ * \param[in] dt       lookup update request by dt_object
+ *
+ * \retval             pointer of dt_update_request if it can be created
+ *                      or found.
+ * \retval             ERR_PTR(errno) if it can not be created or found.
  */
-struct dt_update_request *out_find_create_update_loc(struct thandle *th,
-                                                 struct dt_object *dt)
+struct dt_update_request *
+dt_update_request_find_or_create(struct thandle *th, struct dt_object *dt)
 {
        struct dt_device        *dt_dev = lu2dt_dev(dt->do_lu.lo_dev);
        struct thandle_update   *tu = th->th_update;
@@ -116,7 +162,7 @@ struct dt_update_request *out_find_create_update_loc(struct thandle *th,
        if (update != NULL)
                RETURN(update);
 
-       update = out_create_update_req(dt_dev);
+       update = dt_update_request_create(dt_dev);
        if (IS_ERR(update))
                RETURN(update);
 
@@ -127,8 +173,22 @@ struct dt_update_request *out_find_create_update_loc(struct thandle *th,
 
        RETURN(update);
 }
-EXPORT_SYMBOL(out_find_create_update_loc);
+EXPORT_SYMBOL(dt_update_request_find_or_create);
 
+/**
+ * Prepare update request.
+ *
+ * Prepare OUT update ptlrpc request, and the request usually includes
+ * all of updates (stored in \param ureq) from one operation.
+ *
+ * \param[in] env      execution environment
+ * \param[in] imp      import on which ptlrpc request will be sent
+ * \param[in] ureq     hold all of updates which will be packed into the req
+ * \param[in] reqp     request to be created
+ *
+ * \retval             0 if preparation succeeds.
+ * \retval             negative errno if preparation fails.
+ */
 int out_prep_update_req(const struct lu_env *env, struct obd_import *imp,
                        const struct object_update_request *ureq,
                        struct ptlrpc_request **reqp)
@@ -168,6 +228,19 @@ int out_prep_update_req(const struct lu_env *env, struct obd_import *imp,
 }
 EXPORT_SYMBOL(out_prep_update_req);
 
+/**
+ * Send update RPC.
+ *
+ * Send update request to the remote MDT synchronously.
+ *
+ * \param[in] env      execution environment
+ * \param[in] imp      import on which ptlrpc request will be sent
+ * \param[in] dt_update        hold all of updates which will be packed into the req
+ * \param[in] reqp     request to be created
+ *
+ * \retval             0 if RPC succeeds.
+ * \retval             negative errno if RPC fails.
+ */
 int out_remote_sync(const struct lu_env *env, struct obd_import *imp,
                    struct dt_update_request *dt_update,
                    struct ptlrpc_request **reqp)
@@ -176,7 +249,7 @@ int out_remote_sync(const struct lu_env *env, struct obd_import *imp,
        int                     rc;
        ENTRY;
 
-       rc = out_prep_update_req(env, imp, dt_update->dur_req, &req);
+       rc = out_prep_update_req(env, imp, dt_update->dur_buf.ub_req, &req);
        if (rc != 0)
                RETURN(rc);
 
@@ -202,98 +275,373 @@ int out_remote_sync(const struct lu_env *env, struct obd_import *imp,
 }
 EXPORT_SYMBOL(out_remote_sync);
 
-static int out_resize_update_req(struct dt_update_request *dt_update,
-                                int new_size)
+/**
+ * resize update buffer
+ *
+ * Extend the update buffer by new_size.
+ *
+ * \param[in] ubuf     update buffer to be extended
+ * \param[in] new_size  new size of the update buffer
+ *
+ * \retval             0 if extending succeeds.
+ * \retval             negative errno if extending fails.
+ */
+static int update_buffer_resize(struct update_buffer *ubuf, size_t new_size)
 {
        struct object_update_request *ureq;
 
-       LASSERT(new_size > dt_update->dur_req_len);
-
-       CDEBUG(D_INFO, "%s: resize update_size from %d to %d\n",
-              dt_update->dur_dt->dd_lu_dev.ld_obd->obd_name,
-              dt_update->dur_req_len, new_size);
+       if (new_size > ubuf->ub_req_size)
+               return 0;
 
        OBD_ALLOC_LARGE(ureq, new_size);
        if (ureq == NULL)
                return -ENOMEM;
 
-       memcpy(ureq, dt_update->dur_req,
-              object_update_request_size(dt_update->dur_req));
+       memcpy(ureq, ubuf->ub_req, ubuf->ub_req_size);
 
-       OBD_FREE_LARGE(dt_update->dur_req, dt_update->dur_req_len);
+       OBD_FREE_LARGE(ubuf->ub_req, ubuf->ub_req_size);
 
-       dt_update->dur_req = ureq;
-       dt_update->dur_req_len = new_size;
+       ubuf->ub_req = ureq;
+       ubuf->ub_req_size = new_size;
 
        return 0;
 }
 
-#define OUT_UPDATE_BUFFER_SIZE_ADD     4096
-#define OUT_UPDATE_BUFFER_SIZE_MAX     (64 * 4096)  /* 64KB update size now */
 /**
- * Insert the update into the th_bufs for the device.
- */
-
-int out_insert_update(const struct lu_env *env,
-                     struct dt_update_request *update, int op,
-                     const struct lu_fid *fid, int params_count, int *lens,
-                     const char **bufs)
+ * Pack the header of object_update_request
+ *
+ * Packs updates into the update_buffer header, which will either be sent to
+ * the remote MDT or stored in the local update log. The maximum update buffer
+ * size is 1MB for now.
+ *
+ * \param[in] env      execution environment
+ * \param[in] ubuf     update bufer which it will pack the update in
+ * \param[in] op       update operation
+ * \param[in] fid      object FID for this update
+ * \param[in] param_count      parameters count for this update
+ * \param[in] lens     each parameters length of this update
+ * \param[in] batchid  batchid(transaction no) of this update
+ *
+ * \retval             0 pack update succeed.
+ *                      negative errno pack update failed.
+ **/
+static struct object_update*
+out_update_header_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                      enum update_type op, const struct lu_fid *fid,
+                      int params_count, __u16 *param_sizes, __u64 batchid)
 {
-       struct object_update_request    *ureq = update->dur_req;
-       int                             ureq_len;
+       struct object_update_request    *ureq = ubuf->ub_req;
+       size_t                          ureq_size = ubuf->ub_req_size;
        struct object_update            *obj_update;
        struct object_update_param      *param;
-       int                             update_length;
+       size_t                          update_size;
        int                             rc = 0;
-       char                            *ptr;
-       int                             i;
+       unsigned int                    i;
        ENTRY;
 
        /* Check update size to make sure it can fit into the buffer */
-       ureq_len = object_update_request_size(ureq);
-       update_length = offsetof(struct object_update, ou_params[0]);
+       ureq_size = object_update_request_size(ureq);
+       update_size = offsetof(struct object_update, ou_params[0]);
        for (i = 0; i < params_count; i++)
-               update_length += cfs_size_round(lens[i] + sizeof(*param));
+               update_size += cfs_size_round(param_sizes[i] + sizeof(*param));
 
-       if (unlikely(cfs_size_round(ureq_len + update_length) >
-                    update->dur_req_len)) {
-               int new_size = update->dur_req_len;
+       if (unlikely(cfs_size_round(ureq_size + update_size) >
+                    ubuf->ub_req_size)) {
+               size_t new_size = ubuf->ub_req_size;
 
                /* enlarge object update request size */
                while (new_size <
-                      cfs_size_round(ureq_len + update_length))
+                      cfs_size_round(ureq_size + update_size))
                        new_size += OUT_UPDATE_BUFFER_SIZE_ADD;
                if (new_size >= OUT_UPDATE_BUFFER_SIZE_MAX)
-                       RETURN(-E2BIG);
+                       RETURN(ERR_PTR(-E2BIG));
 
-               rc = out_resize_update_req(update, new_size);
-               if (rc != 0)
-                       RETURN(rc);
+               rc = update_buffer_resize(ubuf, new_size);
+               if (rc < 0)
+                       RETURN(ERR_PTR(rc));
 
-               ureq = update->dur_req;
+               ureq = ubuf->ub_req;
        }
 
        /* fill the update into the update buffer */
-       obj_update = (struct object_update *)((char *)ureq + ureq_len);
+       obj_update = (struct object_update *)((char *)ureq + ureq_size);
        obj_update->ou_fid = *fid;
        obj_update->ou_type = op;
        obj_update->ou_params_count = (__u16)params_count;
-       obj_update->ou_batchid = update->dur_batchid;
+       obj_update->ou_batchid = batchid;
        param = &obj_update->ou_params[0];
        for (i = 0; i < params_count; i++) {
-               param->oup_len = lens[i];
-               ptr = &param->oup_buf[0];
-               memcpy(&param->oup_buf[0], bufs[i], lens[i]);
+               param->oup_len = param_sizes[i];
                param = (struct object_update_param *)((char *)param +
                         object_update_param_size(param));
        }
-
        ureq->ourq_count++;
 
-       CDEBUG(D_INFO, "%s: %p "DFID" idx %d: op %d params %d:%d\n",
-              update->dur_dt->dd_lu_dev.ld_obd->obd_name, ureq, PFID(fid),
-              ureq->ourq_count, op, params_count, ureq_len + update_length);
+       CDEBUG(D_INFO, "%p "DFID" idx %u: op %d params %d:%d\n",
+              ureq, PFID(fid), ureq->ourq_count, op, params_count,
+              (int)update_size);
 
-       RETURN(rc);
+       RETURN(obj_update);
+}
+
+/**
+ * Packs one update into the update_buffer.
+ *
+ * \param[in] env      execution environment
+ * \param[in] ubuf     bufer where update will be packed
+ * \param[in] op       update operation (enum update_type)
+ * \param[in] fid      object FID for this update
+ * \param[in] param_count      number of parameters for this update
+ * \param[in] param_sizes      array of parameters length of this update
+ * \param[in] param_bufs       parameter buffers
+ * \param[in] batchid  transaction no of this update, plus mdt_index, which
+ *                      will be globally unique
+ *
+ * \retval             = 0 if updates packing succeeds
+ * \retval             negative errno if updates packing fails
+ **/
+int out_update_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                   enum update_type op, const struct lu_fid *fid,
+                   int params_count, __u16 *param_sizes,
+                   const void **param_bufs, __u64 batchid)
+{
+       struct object_update            *update;
+       struct object_update_param      *param;
+       unsigned int                    i;
+       ENTRY;
+
+       update = out_update_header_pack(env, ubuf, op, fid, params_count,
+                                       param_sizes, batchid);
+       if (IS_ERR(update))
+               RETURN(PTR_ERR(update));
+
+       param = &update->ou_params[0];
+       for (i = 0; i < params_count; i++) {
+               memcpy(&param->oup_buf[0], param_bufs[i], param_sizes[i]);
+               param = (struct object_update_param *)((char *)param +
+                        object_update_param_size(param));
+       }
+
+       RETURN(0);
+}
+EXPORT_SYMBOL(out_update_pack);
+
+/**
+ * Pack various updates into the update_buffer.
+ *
+ * The following functions pack different updates into the update_buffer
+ * So parameters of these API is basically same as its correspondent OSD/OSP
+ * API, for detail description of these parameters see osd_handler.c or
+ * osp_md_object.c.
+ *
+ * \param[in] env      execution environment
+ * \param[in] ubuf     update buffer
+ * \param[in] fid      fid of this object for the update
+ * \param[in] batchid  batch id of this update
+ *
+ * \retval             0 if insertion succeeds.
+ * \retval             negative errno if insertion fails.
+ */
+int out_create_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                   const struct lu_fid *fid, struct lu_attr *attr,
+                   struct dt_allocation_hint *hint,
+                   struct dt_object_format *dof, __u64 batchid)
+{
+       struct obdo             *obdo;
+       __u16                   sizes[2] = {sizeof(*obdo), 0};
+       int                     buf_count = 1;
+       const struct lu_fid     *fid1 = NULL;
+       struct object_update    *update;
+       ENTRY;
+
+       if (hint != NULL && hint->dah_parent) {
+               fid1 = lu_object_fid(&hint->dah_parent->do_lu);
+               sizes[1] = sizeof(*fid1);
+               buf_count++;
+       }
+
+       update = out_update_header_pack(env, ubuf, OUT_CREATE, fid,
+                                       buf_count, sizes, batchid);
+       if (IS_ERR(update))
+               RETURN(PTR_ERR(update));
+
+       obdo = object_update_param_get(update, 0, NULL);
+       obdo->o_valid = 0;
+       obdo_from_la(obdo, attr, attr->la_valid);
+       lustre_set_wire_obdo(NULL, obdo, obdo);
+       if (fid1 != NULL) {
+               struct lu_fid *fid;
+               fid = object_update_param_get(update, 1, NULL);
+               fid_cpu_to_le(fid, fid1);
+       }
+
+       RETURN(0);
+}
+EXPORT_SYMBOL(out_create_pack);
+
+int out_ref_del_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                    const struct lu_fid *fid, __u64 batchid)
+{
+       return out_update_pack(env, ubuf, OUT_REF_DEL, fid, 0, NULL, NULL,
+                              batchid);
+}
+EXPORT_SYMBOL(out_ref_del_pack);
+
+int out_ref_add_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                    const struct lu_fid *fid, __u64 batchid)
+{
+       return out_update_pack(env, ubuf, OUT_REF_ADD, fid, 0, NULL, NULL,
+                              batchid);
+}
+EXPORT_SYMBOL(out_ref_add_pack);
+
+int out_attr_set_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                     const struct lu_fid *fid, const struct lu_attr *attr,
+                     __u64 batchid)
+{
+       struct object_update    *update;
+       struct obdo             *obdo;
+       __u16                   size = sizeof(*obdo);
+       ENTRY;
+
+       update = out_update_header_pack(env, ubuf, OUT_ATTR_SET, fid, 1,
+                                       &size, batchid);
+       if (IS_ERR(update))
+               RETURN(PTR_ERR(update));
+
+       obdo = object_update_param_get(update, 0, NULL);
+       obdo->o_valid = 0;
+       obdo_from_la(obdo, attr, attr->la_valid);
+       lustre_set_wire_obdo(NULL, obdo, obdo);
+
+       RETURN(0);
+}
+EXPORT_SYMBOL(out_attr_set_pack);
+
+int out_xattr_set_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                      const struct lu_fid *fid, const struct lu_buf *buf,
+                      const char *name, int flag, __u64 batchid)
+{
+       __u16   sizes[3] = {strlen(name) + 1, buf->lb_len, sizeof(flag)};
+       const void *bufs[3] = {(char *)name, (char *)buf->lb_buf,
+                              (char *)&flag};
+
+       return out_update_pack(env, ubuf, OUT_XATTR_SET, fid,
+                              ARRAY_SIZE(sizes), sizes, bufs, batchid);
+}
+EXPORT_SYMBOL(out_xattr_set_pack);
+
+int out_xattr_del_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                      const struct lu_fid *fid, const char *name,
+                      __u64 batchid)
+{
+       __u16   size = strlen(name) + 1;
+
+       return out_update_pack(env, ubuf, OUT_XATTR_DEL, fid, 1, &size,
+                              (const void **)&name, batchid);
+}
+EXPORT_SYMBOL(out_xattr_del_pack);
+
+
+int out_index_insert_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                         const struct lu_fid *fid, const struct dt_rec *rec,
+                         const struct dt_key *key, __u64 batchid)
+{
+       struct dt_insert_rec       *rec1 = (struct dt_insert_rec *)rec;
+       struct lu_fid              rec_fid;
+       __u32                       type = cpu_to_le32(rec1->rec_type);
+       __u16                       sizes[3] = { strlen((char *)key) + 1,
+                                               sizeof(rec_fid),
+                                               sizeof(type) };
+       const void                 *bufs[3] = { (char *)key,
+                                               (char *)&rec_fid,
+                                               (char *)&type };
+
+       fid_cpu_to_le(&rec_fid, rec1->rec_fid);
+
+       return out_update_pack(env, ubuf, OUT_INDEX_INSERT, fid,
+                              ARRAY_SIZE(sizes), sizes, bufs, batchid);
+}
+EXPORT_SYMBOL(out_index_insert_pack);
+
+int out_index_delete_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                         const struct lu_fid *fid, const struct dt_key *key,
+                         __u64 batchid)
+{
+       __u16   size = strlen((char *)key) + 1;
+       const void *buf = key;
+
+       return out_update_pack(env, ubuf, OUT_INDEX_DELETE, fid, 1, &size,
+                              &buf, batchid);
+}
+EXPORT_SYMBOL(out_index_delete_pack);
+
+int out_object_destroy_pack(const struct lu_env *env,
+                           struct update_buffer *ubuf,
+                           const struct lu_fid *fid, __u64 batchid)
+{
+       return out_update_pack(env, ubuf, OUT_DESTROY, fid, 0, NULL, NULL,
+                              batchid);
+}
+EXPORT_SYMBOL(out_object_destroy_pack);
+
+int out_write_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                  const struct lu_fid *fid, const struct lu_buf *buf,
+                  loff_t pos, __u64 batchid)
+{
+       __u16           sizes[2] = {buf->lb_len, sizeof(pos)};
+       const void      *bufs[2] = {(char *)buf->lb_buf, (char *)&pos};
+       int             rc;
+
+       pos = cpu_to_le64(pos);
+
+       rc = out_update_pack(env, ubuf, OUT_WRITE, fid, ARRAY_SIZE(sizes),
+                            sizes, bufs, batchid);
+       return rc;
+}
+EXPORT_SYMBOL(out_write_pack);
+
+/**
+ * Pack various readonly updates into the update_buffer.
+ *
+ * The following update funcs are only used by read-only ops, lookup,
+ * getattr etc, so it does not need transaction here. Currently they
+ * are only used by OSP.
+ *
+ * \param[in] env      execution environment
+ * \param[in] fid      fid of this object for the update
+ * \param[in] ubuf     update buffer
+ *
+ * \retval             0 if packing succeeds.
+ * \retval             negative errno if packing fails.
+ */
+int out_index_lookup_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                         const struct lu_fid *fid, struct dt_rec *rec,
+                         const struct dt_key *key)
+{
+       const void      *name = key;
+       __u16           size = strlen((char *)name) + 1;
+
+       return out_update_pack(env, ubuf, OUT_INDEX_LOOKUP, fid, 1, &size,
+                              &name, 0);
+}
+EXPORT_SYMBOL(out_index_lookup_pack);
+
+int out_attr_get_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                     const struct lu_fid *fid)
+{
+       return out_update_pack(env, ubuf, OUT_ATTR_GET, fid, 0, NULL, NULL, 0);
+}
+EXPORT_SYMBOL(out_attr_get_pack);
+
+int out_xattr_get_pack(const struct lu_env *env, struct update_buffer *ubuf,
+                      const struct lu_fid *fid, const char *name)
+{
+       __u16 size;
+
+       LASSERT(name != NULL);
+       size = strlen(name) + 1;
+       return out_update_pack(env, ubuf, OUT_XATTR_GET, fid, 1, &size,
+                              (const void **)&name, 0);
 }
-EXPORT_SYMBOL(out_insert_update);
+EXPORT_SYMBOL(out_xattr_get_pack);