lustre/include/lustre_swab.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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2017, Intel Corporation.
  27  *
  28  * Copyright 2015 Cray Inc, all rights reserved.
  29  * Author: Ben Evans.
  30  *
  31  * We assume all nodes are either little-endian or big-endian, and we
  32  * always send messages in the sender's native format.  The receiver
  33  * detects the message format by checking the 'magic' field of the message
  34  * (see lustre_msg_swabbed() below).
  35  *
  36  * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines
  37  * are implemented in ptlrpc/lustre_swab.c.  These 'swabbers' convert the
  38  * type from "other" endian, in-place in the message buffer.
  39  *
  40  * A swabber takes a single pointer argument.  The caller must already have
  41  * verified that the length of the message buffer >= sizeof (type).
  42  *
  43  * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
  44  * may be defined that swabs just the variable part, after the caller has
  45  * verified that the message buffer is large enough.
  46  */
  47
  48 #ifndef _LUSTRE_SWAB_H_
  49 #define _LUSTRE_SWAB_H_
  50
  51 #include <uapi/linux/lustre/lustre_idl.h>
  52
  53 void lustre_swab_orphan_ent(struct lu_orphan_ent *ent);
  54 void lustre_swab_orphan_ent_v2(struct lu_orphan_ent_v2 *ent);
  55 void lustre_swab_orphan_ent_v3(struct lu_orphan_ent_v3 *ent);
  56 void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
  57 void lustre_swab_connect(struct obd_connect_data *ocd);
  58 void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
  59 void lustre_swab_hsm_state_set(struct hsm_state_set *hss);
  60 void lustre_swab_obd_statfs(struct obd_statfs *os);
  61 void lustre_swab_obd_ioobj(struct obd_ioobj *ioo);
  62 void lustre_swab_niobuf_remote(struct niobuf_remote *nbr);
  63 void lustre_swab_ost_lvb_v1(struct ost_lvb_v1 *lvb);
  64 void lustre_swab_ost_lvb(struct ost_lvb *lvb);
  65 int lustre_swab_obd_quotactl(struct obd_quotactl *q, __u32 len);
  66 void lustre_swab_quota_body(struct quota_body *b);
  67 void lustre_swab_lquota_lvb(struct lquota_lvb *lvb);
  68 void lustre_swab_barrier_lvb(struct barrier_lvb *lvb);
  69 void lustre_swab_generic_32s(__u32 *val);
  70 void lustre_swab_mdt_body(struct mdt_body *b);
  71 void lustre_swab_mdt_ioepoch(struct mdt_ioepoch *b);
  72 void lustre_swab_mdt_rec_setattr(struct mdt_rec_setattr *sa);
  73 void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
  74 void lustre_swab_lmv_desc(struct lmv_desc *ld);
  75 void lustre_swab_lmv_mds_md(union lmv_mds_md *lmm);
  76 void lustre_swab_lov_desc(struct lov_desc *ld);
  77 void lustre_swab_ldlm_res_id(struct ldlm_res_id *id);
  78 void lustre_swab_ldlm_policy_data(union ldlm_wire_policy_data *d);
  79 void lustre_swab_gl_lquota_desc(struct ldlm_gl_lquota_desc *);
  80 void lustre_swab_gl_barrier_desc(struct ldlm_gl_barrier_desc *);
  81 void lustre_swab_ldlm_intent(struct ldlm_intent *i);
  82 void lustre_swab_ldlm_resource_desc(struct ldlm_resource_desc *r);
  83 void lustre_swab_ldlm_lock_desc(struct ldlm_lock_desc *l);
  84 void lustre_swab_ldlm_request(struct ldlm_request *rq);
  85 void lustre_swab_ldlm_reply(struct ldlm_reply *r);
  86 void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
  87 void lustre_swab_mgs_nidtbl_entry(struct mgs_nidtbl_entry *oinfo);
  88 void lustre_swab_mgs_config_body(struct mgs_config_body *body);
  89 void lustre_swab_mgs_config_res(struct mgs_config_res *body);
  90 void lustre_swab_lfsck_request(struct lfsck_request *lr);
  91 void lustre_swab_lfsck_reply(struct lfsck_reply *lr);
  92 void lustre_swab_obdo(struct obdo *o);
  93 void lustre_swab_ost_body(struct ost_body *b);
  94 void lustre_swab_ost_last_id(__u64 *id);
  95 int lustre_swab_fiemap(struct fiemap *fiemap, __u32 len);
  96 void lustre_swab_fiemap_info_key(struct ll_fiemap_info_key *fiemap_info);
  97 void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
  98 void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
  99 void lustre_swab_lov_comp_md_v1(struct lov_comp_md_v1 *lum);
 100 void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
 101                                      int stripe_count);
 102 void lustre_swab_lov_user_md(struct lov_user_md *lum, size_t size);
 103 void lustre_swab_lov_mds_md(struct lov_mds_md *lmm);
 104 void lustre_swab_idx_info(struct idx_info *ii);
 105 void lustre_swab_lip_header(struct lu_idxpage *lip);
 106 void lustre_swab_fid2path(struct getinfo_fid2path *gf);
 107 void lustre_swab_layout_intent(struct layout_intent *li);
 108 void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
 109 void lustre_swab_hsm_current_action(struct hsm_current_action *action);
 110 void lustre_swab_hsm_progress_kernel(struct hsm_progress_kernel *hpk);
 111 void lustre_swab_hsm_user_state(struct hsm_user_state *hus);
 112 void lustre_swab_hsm_user_item(struct hsm_user_item *hui);
 113 void lustre_swab_hsm_request(struct hsm_request *hr);
 114 void lustre_swab_object_update(struct object_update *ou);
 115 int lustre_swab_object_update_request(struct object_update_request *our,
 116                                       __u32 len);
 117 void lustre_swab_out_update_header(struct out_update_header *ouh);
 118 void lustre_swab_out_update_buffer(struct out_update_buffer *oub);
 119 void lustre_swab_object_update_result(struct object_update_result *our);
 120 int lustre_swab_object_update_reply(struct object_update_reply *our, __u32 len);
 121 void lustre_swab_swap_layouts(struct mdc_swap_layouts *msl);
 122 void lustre_swab_close_data(struct close_data *data);
 123 void lustre_swab_close_data_resync_done(struct close_data_resync_done *resync);
 124 void lustre_swab_lmv_user_md(struct lmv_user_md *lum);
 125 void lustre_swab_ladvise(struct lu_ladvise *ladvise);
 126 void lustre_swab_ladvise_hdr(struct ladvise_hdr *ladvise_hdr);
 127
 128 /* Functions for dumping PTLRPC fields */
 129 void dump_rniobuf(struct niobuf_remote *rnb);
 130 void dump_ioo(struct obd_ioobj *nb);
 131 void dump_ost_body(struct ost_body *ob);
 132 void dump_rcs(__u32 *rc);
 133
 134 void lustre_print_user_md(unsigned int level, struct lov_user_md *lum,
 135                           const char *msg);
 136
 137 #endif