lustre/include/lustre_req_layout.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) 2011, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  *
  31  * lustre/include/lustre_req_layout.h
  32  *
  33  * Lustre Metadata Target (mdt) request handler
  34  *
  35  * Author: Nikita Danilov <nikita@clusterfs.com>
  36  */
  37
  38 #ifndef _LUSTRE_REQ_LAYOUT_H__
  39 #define _LUSTRE_REQ_LAYOUT_H__
  40
  41 #include <linux/types.h>
  42
  43 /** \defgroup req_layout req_layout
  44  *
  45  * @{
  46  */
  47
  48 struct req_msg_field;
  49 struct req_format;
  50 struct req_capsule;
  51
  52 struct ptlrpc_request;
  53
  54 enum req_location {
  55         RCL_CLIENT,
  56         RCL_SERVER,
  57         RCL_NR
  58 };
  59
  60 /* Maximal number of fields (buffers) in a request message. */
  61 #define REQ_MAX_FIELD_NR 12
  62
  63 struct req_capsule {
  64         struct ptlrpc_request   *rc_req;
  65         /** Request message - what client sent */
  66         struct lustre_msg       *rc_reqmsg;
  67         /** Reply message - server response */
  68         struct lustre_msg       *rc_repmsg;
  69         /** Fields that help to see if request and reply were swabved or not */
  70         __u32                    rc_req_swab_mask;
  71         __u32                    rc_rep_swab_mask;
  72         const struct req_format *rc_fmt;
  73         enum req_location        rc_loc;
  74         __u32                    rc_area[RCL_NR][REQ_MAX_FIELD_NR];
  75 };
  76
  77 void req_capsule_init(struct req_capsule *pill, struct ptlrpc_request *req,
  78                       enum req_location location);
  79 void req_capsule_fini(struct req_capsule *pill);
  80
  81 void req_capsule_set(struct req_capsule *pill, const struct req_format *fmt);
  82 void req_capsule_client_dump(struct req_capsule *pill);
  83 void req_capsule_server_dump(struct req_capsule *pill);
  84 void req_capsule_init_area(struct req_capsule *pill);
  85 size_t req_capsule_filled_sizes(struct req_capsule *pill,
  86                                 enum req_location loc);
  87 int  req_capsule_server_pack(struct req_capsule *pill);
  88
  89 void *req_capsule_client_get(struct req_capsule *pill,
  90                              const struct req_msg_field *field);
  91 void *req_capsule_client_swab_get(struct req_capsule *pill,
  92                                   const struct req_msg_field *field,
  93                                   void *swabber);
  94 void *req_capsule_client_sized_get(struct req_capsule *pill,
  95                                    const struct req_msg_field *field,
  96                                    __u32 len);
  97 void *req_capsule_server_get(struct req_capsule *pill,
  98                              const struct req_msg_field *field);
  99 void *req_capsule_server_sized_get(struct req_capsule *pill,
 100                                    const struct req_msg_field *field,
 101                                    __u32 len);
 102 void *req_capsule_server_swab_get(struct req_capsule *pill,
 103                                   const struct req_msg_field *field,
 104                                   void *swabber);
 105 void *req_capsule_server_sized_swab_get(struct req_capsule *pill,
 106                                         const struct req_msg_field *field,
 107                                         __u32 len, void *swabber);
 108 const void *req_capsule_other_get(struct req_capsule *pill,
 109                                   const struct req_msg_field *field);
 110
 111 void req_capsule_set_size(struct req_capsule *pill,
 112                           const struct req_msg_field *field,
 113                           enum req_location loc, __u32 size);
 114 __u32 req_capsule_get_size(const struct req_capsule *pill,
 115                            const struct req_msg_field *field,
 116                            enum req_location loc);
 117 __u32 req_capsule_msg_size(struct req_capsule *pill, enum req_location loc);
 118 __u32 req_capsule_fmt_size(__u32 magic, const struct req_format *fmt,
 119                          enum req_location loc);
 120 void req_capsule_extend(struct req_capsule *pill, const struct req_format *fmt);
 121
 122 int req_capsule_has_field(const struct req_capsule *pill,
 123                           const struct req_msg_field *field,
 124                           enum req_location loc);
 125 int req_capsule_field_present(const struct req_capsule *pill,
 126                               const struct req_msg_field *field,
 127                               enum req_location loc);
 128 void req_capsule_shrink(struct req_capsule *pill,
 129                         const struct req_msg_field *field,
 130                         __u32 newlen,
 131                         enum req_location loc);
 132 int req_capsule_server_grow(struct req_capsule *pill,
 133                             const struct req_msg_field *field,
 134                             __u32 newlen);
 135 bool req_capsule_need_swab(struct req_capsule *pill, enum req_location loc,
 136                            __u32 index);
 137 void req_capsule_set_swabbed(struct req_capsule *pill, enum req_location loc,
 138                              __u32 index);
 139
 140 /**
 141  * Returns true if request buffer at offset \a index was already swabbed
 142  */
 143 static inline bool req_capsule_req_swabbed(struct req_capsule *pill,
 144                                            size_t index)
 145 {
 146         LASSERT(index < sizeof(pill->rc_req_swab_mask) * 8);
 147         return pill->rc_req_swab_mask & BIT(index);
 148 }
 149
 150 /**
 151  * Returns true if request reply buffer at offset \a index was already swabbed
 152  */
 153 static inline bool req_capsule_rep_swabbed(struct req_capsule *pill,
 154                                            size_t index)
 155 {
 156         LASSERT(index < sizeof(pill->rc_rep_swab_mask) * 8);
 157         return pill->rc_rep_swab_mask & BIT(index);
 158 }
 159
 160 /**
 161  * Returns true if request needs to be swabbed into local cpu byteorder
 162  */
 163 static inline bool req_capsule_req_need_swab(struct req_capsule *pill)
 164 {
 165         return req_capsule_req_swabbed(pill, MSG_PTLRPC_HEADER_OFF);
 166 }
 167
 168 /**
 169  * Returns true if request reply needs to be swabbed into local cpu byteorder
 170  */
 171 static inline bool req_capsule_rep_need_swab(struct req_capsule *pill)
 172 {
 173         return req_capsule_rep_swabbed(pill, MSG_PTLRPC_HEADER_OFF);
 174 }
 175
 176 /**
 177  * Mark request buffer at offset \a index that it was already swabbed
 178  */
 179 static inline void req_capsule_set_req_swabbed(struct req_capsule *pill,
 180                                                size_t index)
 181 {
 182         LASSERT(index < sizeof(pill->rc_req_swab_mask) * 8);
 183         LASSERT((pill->rc_req_swab_mask & BIT(index)) == 0);
 184         pill->rc_req_swab_mask |= BIT(index);
 185 }
 186
 187 /**
 188  * Mark request reply buffer at offset \a index that it was already swabbed
 189  */
 190 static inline void req_capsule_set_rep_swabbed(struct req_capsule *pill,
 191                                                size_t index)
 192 {
 193         LASSERT(index < sizeof(pill->rc_rep_swab_mask) * 8);
 194         LASSERT((pill->rc_rep_swab_mask & BIT(index)) == 0);
 195         pill->rc_rep_swab_mask |= BIT(index);
 196 }
 197
 198 int  req_layout_init(void);
 199 void req_layout_fini(void);
 200 #ifdef HAVE_SERVER_SUPPORT
 201 int req_check_sepol(struct req_capsule *pill);
 202 #else
 203 static inline int req_check_sepol(struct req_capsule *pill)
 204 {
 205         return 0;
 206 }
 207 #endif
 208
 209 extern struct req_format RQF_OBD_PING;
 210 extern struct req_format RQF_OBD_SET_INFO;
 211 extern struct req_format RQF_MDT_SET_INFO;
 212 extern struct req_format RQF_SEC_CTX;
 213 extern struct req_format RQF_OBD_IDX_READ;
 214 /* MGS req_format */
 215 extern struct req_format RQF_MGS_TARGET_REG;
 216 extern struct req_format RQF_MGS_SET_INFO;
 217 extern struct req_format RQF_MGS_CONFIG_READ;
 218 /* fid/fld req_format */
 219 extern struct req_format RQF_SEQ_QUERY;
 220 extern struct req_format RQF_FLD_QUERY;
 221 extern struct req_format RQF_FLD_READ;
 222 /* MDS req_format */
 223 extern struct req_format RQF_MDS_CONNECT;
 224 extern struct req_format RQF_MDS_DISCONNECT;
 225 extern struct req_format RQF_MDS_STATFS;
 226 extern struct req_format RQF_MDS_STATFS_NEW;
 227 extern struct req_format RQF_MDS_GET_ROOT;
 228 extern struct req_format RQF_MDS_SYNC;
 229 extern struct req_format RQF_MDS_GETXATTR;
 230 extern struct req_format RQF_MDS_GETATTR;
 231 extern struct req_format RQF_OUT_UPDATE;
 232
 233 /*
 234  * This is format of direct (non-intent) MDS_GETATTR_NAME request.
 235  */
 236 extern struct req_format RQF_MDS_GETATTR_NAME;
 237 extern struct req_format RQF_MDS_CLOSE;
 238 extern struct req_format RQF_MDS_CLOSE_INTENT;
 239 extern struct req_format RQF_MDS_CONNECT;
 240 extern struct req_format RQF_MDS_DISCONNECT;
 241 extern struct req_format RQF_MDS_GET_INFO;
 242 extern struct req_format RQF_MDS_READPAGE;
 243 extern struct req_format RQF_MDS_REINT;
 244 extern struct req_format RQF_MDS_REINT_CREATE;
 245 extern struct req_format RQF_MDS_REINT_CREATE_ACL;
 246 extern struct req_format RQF_MDS_REINT_CREATE_SLAVE;
 247 extern struct req_format RQF_MDS_REINT_CREATE_SYM;
 248 extern struct req_format RQF_MDS_REINT_OPEN;
 249 extern struct req_format RQF_MDS_REINT_UNLINK;
 250 extern struct req_format RQF_MDS_REINT_LINK;
 251 extern struct req_format RQF_MDS_REINT_RENAME;
 252 extern struct req_format RQF_MDS_REINT_SETATTR;
 253 extern struct req_format RQF_MDS_REINT_SETXATTR;
 254 extern struct req_format RQF_MDS_QUOTACTL;
 255 extern struct req_format RQF_QUOTA_DQACQ;
 256 extern struct req_format RQF_MDS_SWAP_LAYOUTS;
 257 extern struct req_format RQF_MDS_REINT_MIGRATE;
 258 extern struct req_format RQF_MDS_REINT_RESYNC;
 259 extern struct req_format RQF_MDS_RMFID;
 260 /* MDS hsm formats */
 261 extern struct req_format RQF_MDS_HSM_STATE_GET;
 262 extern struct req_format RQF_MDS_HSM_STATE_SET;
 263 extern struct req_format RQF_MDS_HSM_ACTION;
 264 extern struct req_format RQF_MDS_HSM_PROGRESS;
 265 extern struct req_format RQF_MDS_HSM_CT_REGISTER;
 266 extern struct req_format RQF_MDS_HSM_CT_UNREGISTER;
 267 extern struct req_format RQF_MDS_HSM_REQUEST;
 268 /* OST req_format */
 269 extern struct req_format RQF_OST_CONNECT;
 270 extern struct req_format RQF_OST_DISCONNECT;
 271 extern struct req_format RQF_OST_QUOTACTL;
 272 extern struct req_format RQF_OST_GETATTR;
 273 extern struct req_format RQF_OST_SETATTR;
 274 extern struct req_format RQF_OST_CREATE;
 275 extern struct req_format RQF_OST_PUNCH;
 276 extern struct req_format RQF_OST_FALLOCATE;
 277 extern struct req_format RQF_OST_SYNC;
 278 extern struct req_format RQF_OST_DESTROY;
 279 extern struct req_format RQF_OST_BRW_READ;
 280 extern struct req_format RQF_OST_BRW_WRITE;
 281 extern struct req_format RQF_OST_STATFS;
 282 extern struct req_format RQF_OST_SET_GRANT_INFO;
 283 extern struct req_format RQF_OST_GET_INFO;
 284 extern struct req_format RQF_OST_GET_INFO_LAST_ID;
 285 extern struct req_format RQF_OST_GET_INFO_LAST_FID;
 286 extern struct req_format RQF_OST_SET_INFO_LAST_FID;
 287 extern struct req_format RQF_OST_GET_INFO_FIEMAP;
 288 extern struct req_format RQF_OST_LADVISE;
 289 extern struct req_format RQF_OST_SEEK;
 290
 291 /* LDLM req_format */
 292 extern struct req_format RQF_LDLM_ENQUEUE;
 293 extern struct req_format RQF_LDLM_ENQUEUE_LVB;
 294 extern struct req_format RQF_LDLM_CONVERT;
 295 extern struct req_format RQF_LDLM_INTENT;
 296 extern struct req_format RQF_LDLM_INTENT_BASIC;
 297 extern struct req_format RQF_LDLM_INTENT_LAYOUT;
 298 extern struct req_format RQF_LDLM_INTENT_GETATTR;
 299 extern struct req_format RQF_LDLM_INTENT_OPEN;
 300 extern struct req_format RQF_LDLM_INTENT_CREATE;
 301 extern struct req_format RQF_LDLM_INTENT_GETXATTR;
 302 extern struct req_format RQF_LDLM_INTENT_QUOTA;
 303 extern struct req_format RQF_LDLM_CANCEL;
 304 extern struct req_format RQF_LDLM_CALLBACK;
 305 extern struct req_format RQF_LDLM_CP_CALLBACK;
 306 extern struct req_format RQF_LDLM_BL_CALLBACK;
 307 extern struct req_format RQF_LDLM_GL_CALLBACK;
 308 extern struct req_format RQF_LDLM_GL_CALLBACK_DESC;
 309 /* LOG req_format */
 310 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_CREATE;
 311 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_NEXT_BLOCK;
 312 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_PREV_BLOCK;
 313 extern struct req_format RQF_LLOG_ORIGIN_HANDLE_READ_HEADER;
 314
 315 extern struct req_format RQF_CONNECT;
 316
 317 /* LFSCK req_format */
 318 extern struct req_format RQF_LFSCK_NOTIFY;
 319 extern struct req_format RQF_LFSCK_QUERY;
 320
 321 extern struct req_msg_field RMF_GENERIC_DATA;
 322 extern struct req_msg_field RMF_PTLRPC_BODY;
 323 extern struct req_msg_field RMF_MDT_BODY;
 324 extern struct req_msg_field RMF_MDT_EPOCH;
 325 extern struct req_msg_field RMF_OBD_STATFS;
 326 extern struct req_msg_field RMF_NAME;
 327 extern struct req_msg_field RMF_SYMTGT;
 328 extern struct req_msg_field RMF_TGTUUID;
 329 extern struct req_msg_field RMF_CLUUID;
 330 extern struct req_msg_field RMF_SETINFO_VAL;
 331 extern struct req_msg_field RMF_SETINFO_KEY;
 332 extern struct req_msg_field RMF_GETINFO_VAL;
 333 extern struct req_msg_field RMF_GETINFO_VALLEN;
 334 extern struct req_msg_field RMF_GETINFO_KEY;
 335 extern struct req_msg_field RMF_IDX_INFO;
 336 extern struct req_msg_field RMF_CLOSE_DATA;
 337 extern struct req_msg_field RMF_FILE_SECCTX_NAME;
 338 extern struct req_msg_field RMF_FILE_SECCTX;
 339 extern struct req_msg_field RMF_FID_ARRAY;
 340 extern struct req_msg_field RMF_FILE_ENCCTX;
 341
 342 /*
 343  * connection handle received in MDS_CONNECT request.
 344  */
 345 extern struct req_msg_field RMF_CONN;
 346 extern struct req_msg_field RMF_CONNECT_DATA;
 347 extern struct req_msg_field RMF_DLM_REQ;
 348 extern struct req_msg_field RMF_DLM_REP;
 349 extern struct req_msg_field RMF_DLM_LVB;
 350 extern struct req_msg_field RMF_DLM_GL_DESC;
 351 extern struct req_msg_field RMF_LDLM_INTENT;
 352 extern struct req_msg_field RMF_LAYOUT_INTENT;
 353 extern struct req_msg_field RMF_MDT_MD;
 354 extern struct req_msg_field RMF_DEFAULT_MDT_MD;
 355 extern struct req_msg_field RMF_REC_REINT;
 356 extern struct req_msg_field RMF_EADATA;
 357 extern struct req_msg_field RMF_EAVALS;
 358 extern struct req_msg_field RMF_EAVALS_LENS;
 359 extern struct req_msg_field RMF_ACL;
 360 extern struct req_msg_field RMF_LOGCOOKIES;
 361 extern struct req_msg_field RMF_CAPA1;
 362 extern struct req_msg_field RMF_CAPA2;
 363 extern struct req_msg_field RMF_OBD_QUOTACHECK;
 364 extern struct req_msg_field RMF_OBD_QUOTACTL;
 365 extern struct req_msg_field RMF_OBD_QUOTACTL_POOL;
 366 extern struct req_msg_field RMF_QUOTA_BODY;
 367 extern struct req_msg_field RMF_STRING;
 368 extern struct req_msg_field RMF_SWAP_LAYOUTS;
 369 extern struct req_msg_field RMF_MDS_HSM_PROGRESS;
 370 extern struct req_msg_field RMF_MDS_HSM_REQUEST;
 371 extern struct req_msg_field RMF_MDS_HSM_USER_ITEM;
 372 extern struct req_msg_field RMF_MDS_HSM_ARCHIVE;
 373 extern struct req_msg_field RMF_HSM_USER_STATE;
 374 extern struct req_msg_field RMF_HSM_STATE_SET;
 375 extern struct req_msg_field RMF_MDS_HSM_CURRENT_ACTION;
 376 extern struct req_msg_field RMF_MDS_HSM_REQUEST;
 377 extern struct req_msg_field RMF_SELINUX_POL;
 378
 379 /* seq-mgr fields */
 380 extern struct req_msg_field RMF_SEQ_OPC;
 381 extern struct req_msg_field RMF_SEQ_RANGE;
 382 extern struct req_msg_field RMF_FID_SPACE;
 383
 384 /* FLD fields */
 385 extern struct req_msg_field RMF_FLD_OPC;
 386 extern struct req_msg_field RMF_FLD_MDFLD;
 387
 388 extern struct req_msg_field RMF_LLOGD_BODY;
 389 extern struct req_msg_field RMF_LLOG_LOG_HDR;
 390 extern struct req_msg_field RMF_LLOGD_CONN_BODY;
 391
 392 extern struct req_msg_field RMF_MGS_TARGET_INFO;
 393 extern struct req_msg_field RMF_MGS_SEND_PARAM;
 394
 395 extern struct req_msg_field RMF_OST_BODY;
 396 extern struct req_msg_field RMF_OBD_IOOBJ;
 397 extern struct req_msg_field RMF_OBD_ID;
 398 extern struct req_msg_field RMF_FID;
 399 extern struct req_msg_field RMF_NIOBUF_REMOTE;
 400 extern struct req_msg_field RMF_NIOBUF_INLINE;
 401 extern struct req_msg_field RMF_RCS;
 402 extern struct req_msg_field RMF_FIEMAP_KEY;
 403 extern struct req_msg_field RMF_FIEMAP_VAL;
 404 extern struct req_msg_field RMF_OST_ID;
 405 extern struct req_msg_field RMF_SHORT_IO;
 406
 407 /* MGS config read message format */
 408 extern struct req_msg_field RMF_MGS_CONFIG_BODY;
 409 extern struct req_msg_field RMF_MGS_CONFIG_RES;
 410
 411 /* generic uint32 */
 412 extern struct req_msg_field RMF_U32;
 413
 414 /* OBJ update format */
 415 extern struct req_msg_field RMF_OUT_UPDATE;
 416 extern struct req_msg_field RMF_OUT_UPDATE_REPLY;
 417 extern struct req_msg_field RMF_OUT_UPDATE_HEADER;
 418 extern struct req_msg_field RMF_OUT_UPDATE_BUF;
 419
 420 /* LFSCK format */
 421 extern struct req_msg_field RMF_LFSCK_REQUEST;
 422 extern struct req_msg_field RMF_LFSCK_REPLY;
 423
 424 extern struct req_msg_field RMF_OST_LADVISE_HDR;
 425 extern struct req_msg_field RMF_OST_LADVISE;
 426 /** @} req_layout */
 427
 428 #endif /* _LUSTRE_REQ_LAYOUT_H__ */