lustre/include/lustre_req_layout.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  lustre/include/linux/lustre_req_layout.h
   5  *  Lustre Metadata Target (mdt) request handler
   6  *
   7  *  Copyright (c) 2006 Cluster File Systems, Inc.
   8  *   Author: Nikita Danilov <nikita@clusterfs.com>
   9  *
  10  *   This file is part of the Lustre file system, http://www.lustre.org
  11  *   Lustre is a trademark of Cluster File Systems, Inc.
  12  *
  13  *   You may have signed or agreed to another license before downloading
  14  *   this software.  If so, you are bound by the terms and conditions
  15  *   of that agreement, and the following does not apply to you.  See the
  16  *   LICENSE file included with this distribution for more information.
  17  *
  18  *   If you did not agree to a different license, then this copy of Lustre
  19  *   is open source software; you can redistribute it and/or modify it
  20  *   under the terms of version 2 of the GNU General Public License as
  21  *   published by the Free Software Foundation.
  22  *
  23  *   In either case, Lustre is distributed in the hope that it will be
  24  *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  25  *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *   license text for more details.
  27  */
  28
  29 #ifndef _LUSTRE_REQ_LAYOUT_H__
  30 #define _LUSTRE_REQ_LAYOUT_H__
  31
  32 struct req_msg_field;
  33 struct req_format;
  34 struct req_capsule;
  35
  36 struct ptlrpc_request;
  37
  38 enum req_location {
  39         RCL_CLIENT,
  40         RCL_SERVER,
  41         RCL_NR
  42 };
  43
  44 struct req_capsule {
  45         struct ptlrpc_request   *rc_req;
  46         const struct req_format *rc_fmt;
  47         __u32                    rc_swabbed;
  48         enum req_location        rc_loc;
  49         int                     *rc_area;
  50 };
  51
  52 enum {
  53         /*
  54          * Maximal number of fields (buffers) in a request message.
  55          */
  56         REQ_MAX_FIELD_NR = 8
  57 };
  58
  59 #if !defined(__REQ_LAYOUT_USER__)
  60
  61 /* struct ptlrpc_request, lustre_msg* */
  62 #include <lustre_net.h>
  63
  64 void req_capsule_init(struct req_capsule *pill, struct ptlrpc_request *req,
  65                       enum req_location location, int *area);
  66 void req_capsule_fini(struct req_capsule *pill);
  67
  68 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt);
  69 int  req_capsule_pack(struct req_capsule *pill);
  70
  71 void *req_capsule_client_get(struct req_capsule *pill,
  72                              const struct req_msg_field *field);
  73 void *req_capsule_server_get(struct req_capsule *pill,
  74                              const struct req_msg_field *field);
  75 const void *req_capsule_other_get(struct req_capsule *pill,
  76                                   const struct req_msg_field *field);
  77
  78 void req_capsule_set_size(const struct req_capsule *pill,
  79                           const struct req_msg_field *field,
  80                           enum req_location loc, int size);
  81 int req_capsule_get_size(const struct req_capsule *pill,
  82                           const struct req_msg_field *field,
  83                           enum req_location loc);
  84 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt);
  85
  86 int req_capsule_has_field(const struct req_capsule *pill,
  87                           const struct req_msg_field *field,
  88                           enum req_location loc);
  89 int req_capsule_field_present(const struct req_capsule *pill,
  90                               const struct req_msg_field *field,
  91                               enum req_location loc);
  92
  93 int  req_layout_init(void);
  94 void req_layout_fini(void);
  95
  96 /* __REQ_LAYOUT_USER__ */
  97 #endif
  98
  99 extern const struct req_format RQF_SEQ_QUERY;
 100 extern const struct req_format RQF_FLD_QUERY;
 101 extern const struct req_format RQF_MDS_GETSTATUS;
 102 extern const struct req_format RQF_MDS_STATFS;
 103 extern const struct req_format RQF_MDS_SYNC;
 104 extern const struct req_format RQF_MDS_GETXATTR;
 105 extern const struct req_format RQF_MDS_SETXATTR;
 106 extern const struct req_format RQF_MDS_GETATTR;
 107 extern const struct req_format RQF_MDS_CLOSE;
 108 extern const struct req_format RQF_MDS_PIN;
 109 extern const struct req_format RQF_MDS_CONNECT;
 110 extern const struct req_format RQF_MDS_DISCONNECT;
 111 extern const struct req_format RQF_MDS_READPAGE;
 112 extern const struct req_format RQF_MDS_WRITEPAGE;
 113 extern const struct req_format RQF_MDS_DONE_WRITING;
 114
 115 /*
 116  * This is format of direct (non-intent) MDS_GETATTR_NAME request.
 117  */
 118 extern const struct req_format RQF_MDS_GETATTR_NAME;
 119 extern const struct req_format RQF_MDS_REINT;
 120 extern const struct req_format RQF_MDS_REINT_CREATE;
 121 extern const struct req_format RQF_MDS_REINT_OPEN;
 122 extern const struct req_format RQF_MDS_REINT_UNLINK;
 123 extern const struct req_format RQF_MDS_REINT_LINK;
 124 extern const struct req_format RQF_MDS_REINT_RENAME;
 125 extern const struct req_format RQF_MDS_REINT_SETATTR;
 126 extern const struct req_format RQF_LDLM_ENQUEUE;
 127 extern const struct req_format RQF_LDLM_INTENT;
 128 extern const struct req_format RQF_LDLM_INTENT_GETATTR;
 129 extern const struct req_format RQF_LDLM_INTENT_OPEN;
 130 extern const struct req_format RQF_LDLM_INTENT_CREATE;
 131 extern const struct req_format RQF_LDLM_INTENT_UNLINK;
 132
 133 extern const struct req_msg_field RMF_PTLRPC_BODY;
 134 extern const struct req_msg_field RMF_MDT_BODY;
 135 extern const struct req_msg_field RMF_OBD_STATFS;
 136 extern const struct req_msg_field RMF_NAME;
 137 extern const struct req_msg_field RMF_SYMTGT;
 138 extern const struct req_msg_field RMF_TGTUUID;
 139 extern const struct req_msg_field RMF_CLUUID;
 140 /*
 141  * connection handle received in MDS_CONNECT request.
 142  */
 143 extern const struct req_msg_field RMF_CONN;
 144 extern const struct req_msg_field RMF_CONNECT_DATA;
 145 extern const struct req_msg_field RMF_DLM_REQ;
 146 extern const struct req_msg_field RMF_DLM_REP;
 147 extern const struct req_msg_field RMF_LDLM_INTENT;
 148 extern const struct req_msg_field RMF_MDT_MD;
 149 extern const struct req_msg_field RMF_REC_CREATE;
 150 extern const struct req_msg_field RMF_REC_LINK;
 151 extern const struct req_msg_field RMF_REC_UNLINK;
 152 extern const struct req_msg_field RMF_REC_RENAME;
 153 extern const struct req_msg_field RMF_REC_SETATTR;
 154 extern const struct req_msg_field RMF_EADATA;
 155 extern const struct req_msg_field RMF_ACL;
 156 extern const struct req_msg_field RMF_LOGCOOKIES;
 157 extern const struct req_msg_field RMF_REINT_OPC;
 158
 159 /* seq-mgr fields */
 160 extern const struct req_msg_field RMF_SEQ_OPC;
 161 extern const struct req_msg_field RMF_SEQ_RANGE;
 162
 163 /* FLD fields */
 164 extern const struct req_msg_field RMF_FLD_OPC;
 165 extern const struct req_msg_field RMF_FLD_MDFLD;
 166
 167 #endif /* _LUSTRE_REQ_LAYOUT_H__ */