lustre/include/lustre/lustre_idl.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/include/lustre/lustre_idl.h
  37  *
  38  * Lustre wire protocol definitions.
  39  */
  40
  41 /** \defgroup lustreidl lustreidl
  42  *
  43  * Lustre wire protocol definitions.
  44  *
  45  * We assume all nodes are either little-endian or big-endian, and we
  46  * always send messages in the sender's native format.  The receiver
  47  * detects the message format by checking the 'magic' field of the message
  48  * (see lustre_msg_swabbed() below).
  49  * ALL structs passing over the wire should be declared here.  Structs
  50  * that are used in interfaces with userspace should go in lustre_user.h.
  51  *
  52  * All structs being declared here should be built from simple fixed-size
  53  * types (__u8, __u16, __u32, __u64) or be built from other types or
  54  * structs also declared in this file.  Similarly, all flags and magic
  55  * values in those structs should also be declared here.  This ensures
  56  * that the Lustre wire protocol is not influenced by external dependencies.
  57  *
  58  * The only other acceptable items in this file are VERY SIMPLE accessor
  59  * functions to avoid callers grubbing inside the structures, and the
  60  * prototypes of the swabber functions for each struct.  Nothing that
  61  * depends on external functions or definitions should be in here.
  62  *
  63  * Structs must be properly aligned to put 64-bit values on an 8-byte
  64  * boundary.  Any structs being added here must also be added to
  65  * utils/wirecheck.c and "make newwiretest" run to regenerate the
  66  * utils/wiretest.c sources.  This allows us to verify that wire structs
  67  * have the proper alignment/size on all architectures.
  68  *
  69  * DO NOT CHANGE any of the structs, flags, values declared here and used
  70  * in released Lustre versions.  Some structs may have padding fields that
  71  * can be used.  Some structs might allow addition at the end (verify this
  72  * in the code to ensure that new/old clients that see this larger struct
  73  * do not fail, otherwise you need to implement protocol compatibility).
  74  *
  75  * Each wire type has corresponding 'lustre_swab_xxxtypexxx()' routines,
  76  * implemented either here, inline (trivial implementations) or in
  77  * ptlrpc/pack_generic.c.  These 'swabbers' convert the type from "other"
  78  * endian, in-place in the message buffer.
  79  *
  80  * A swabber takes a single pointer argument.  The caller must already have
  81  * verified that the length of the message buffer >= sizeof (type).
  82  *
  83  * For variable length types, a second 'lustre_swab_v_xxxtypexxx()' routine
  84  * may be defined that swabs just the variable part, after the caller has
  85  * verified that the message buffer is large enough.
  86  *
  87  * @{
  88  */
  89
  90 #ifndef _LUSTRE_IDL_H_
  91 #define _LUSTRE_IDL_H_
  92
  93 #include <libcfs/libcfs.h>
  94
  95 /* Defn's shared with user-space. */
  96 #include <lustre/lustre_user.h>
  97 #include <lustre/ll_fiemap.h>
  98
  99 /*
 100  *  GENERAL STUFF
 101  */
 102 /* FOO_REQUEST_PORTAL is for incoming requests on the FOO
 103  * FOO_REPLY_PORTAL   is for incoming replies on the FOO
 104  * FOO_BULK_PORTAL    is for incoming bulk on the FOO
 105  */
 106
 107 #define CONNMGR_REQUEST_PORTAL          1
 108 #define CONNMGR_REPLY_PORTAL            2
 109 //#define OSC_REQUEST_PORTAL            3
 110 #define OSC_REPLY_PORTAL                4
 111 //#define OSC_BULK_PORTAL               5
 112 #define OST_IO_PORTAL                   6
 113 #define OST_CREATE_PORTAL               7
 114 #define OST_BULK_PORTAL                 8
 115 //#define MDC_REQUEST_PORTAL            9
 116 #define MDC_REPLY_PORTAL               10
 117 //#define MDC_BULK_PORTAL              11
 118 #define MDS_REQUEST_PORTAL             12
 119 //#define MDS_REPLY_PORTAL             13
 120 #define MDS_BULK_PORTAL                14
 121 #define LDLM_CB_REQUEST_PORTAL         15
 122 #define LDLM_CB_REPLY_PORTAL           16
 123 #define LDLM_CANCEL_REQUEST_PORTAL     17
 124 #define LDLM_CANCEL_REPLY_PORTAL       18
 125 //#define PTLBD_REQUEST_PORTAL           19
 126 //#define PTLBD_REPLY_PORTAL             20
 127 //#define PTLBD_BULK_PORTAL              21
 128 #define MDS_SETATTR_PORTAL             22
 129 #define MDS_READPAGE_PORTAL            23
 130 #define MDS_MDS_PORTAL                 24
 131
 132 #define MGC_REPLY_PORTAL               25
 133 #define MGS_REQUEST_PORTAL             26
 134 #define MGS_REPLY_PORTAL               27
 135 #define OST_REQUEST_PORTAL             28
 136 #define FLD_REQUEST_PORTAL             29
 137 #define SEQ_METADATA_PORTAL            30
 138 #define SEQ_DATA_PORTAL                31
 139 #define SEQ_CONTROLLER_PORTAL          32
 140
 141 #define SVC_KILLED               1
 142 #define SVC_EVENT                2
 143 #define SVC_SIGNAL               4
 144 #define SVC_RUNNING              8
 145 #define SVC_STOPPING            16
 146 #define SVC_STOPPED             32
 147
 148 /* packet types */
 149 #define PTL_RPC_MSG_REQUEST 4711
 150 #define PTL_RPC_MSG_ERR     4712
 151 #define PTL_RPC_MSG_REPLY   4713
 152
 153 /* DON'T use swabbed values of MAGIC as magic! */
 154 #define LUSTRE_MSG_MAGIC_V1 0x0BD00BD0
 155 #define LUSTRE_MSG_MAGIC_V2 0x0BD00BD3
 156
 157 #define LUSTRE_MSG_MAGIC_V1_SWABBED 0xD00BD00B
 158 #define LUSTRE_MSG_MAGIC_V2_SWABBED 0xD30BD00B
 159
 160 #define LUSTRE_MSG_MAGIC LUSTRE_MSG_MAGIC_V2
 161
 162 #define PTLRPC_MSG_VERSION  0x00000003
 163 #define LUSTRE_VERSION_MASK 0xffff0000
 164 #define LUSTRE_OBD_VERSION  0x00010000
 165 #define LUSTRE_MDS_VERSION  0x00020000
 166 #define LUSTRE_OST_VERSION  0x00030000
 167 #define LUSTRE_DLM_VERSION  0x00040000
 168 #define LUSTRE_LOG_VERSION  0x00050000
 169 #define LUSTRE_MGS_VERSION  0x00060000
 170
 171 typedef __u64 mdsno_t;
 172 typedef __u64 seqno_t;
 173
 174 struct lu_range {
 175         __u64 lr_start;
 176         __u64 lr_end;
 177         /** stub for compact fld work. */
 178         __u64 lr_padding;
 179 };
 180
 181 /**
 182  * returns  width of given range \a r
 183  */
 184
 185 static inline __u64 range_space(const struct lu_range *range)
 186 {
 187         return range->lr_end - range->lr_start;
 188 }
 189
 190 /**
 191  * initialize range to zero
 192  */
 193 static inline void range_init(struct lu_range *range)
 194 {
 195         range->lr_start = range->lr_end = 0;
 196 }
 197
 198 /**
 199  * check if given seq id \a s is within given range \a r
 200  */
 201 static inline int range_within(struct lu_range *range,
 202                                __u64 s)
 203 {
 204         return s >= range->lr_start && s < range->lr_end;
 205 }
 206
 207 /**
 208  * allocate \a w units of sequence from range \a from.
 209  */
 210 static inline void range_alloc(struct lu_range *to,
 211                                struct lu_range *from,
 212                                __u64 width)
 213 {
 214         to->lr_start = from->lr_start;
 215         to->lr_end = from->lr_start + width;
 216         from->lr_start += width;
 217 }
 218
 219 static inline int range_is_sane(const struct lu_range *range)
 220 {
 221         return (range->lr_end >= range->lr_start);
 222 }
 223
 224 static inline int range_is_zero(const struct lu_range *range)
 225 {
 226         return (range->lr_start == 0 && range->lr_end == 0);
 227 }
 228
 229 static inline int range_is_exhausted(const struct lu_range *range)
 230 {
 231         return range_space(range) == 0;
 232 }
 233
 234 #define DRANGE "[%#16.16"LPF64"x-%#16.16"LPF64"x]"
 235
 236 #define PRANGE(range)      \
 237         (range)->lr_start, \
 238         (range)->lr_end
 239
 240 /** \defgroup lu_fid lu_fid
 241  * @{ */
 242
 243 /**
 244  * File identifier.
 245  *
 246  * Fid is a cluster-wide unique identifier of a file or an object
 247  * (stripe). Fids are never reused. Fids are transmitted across network (in
 248  * the sender byte-ordering), and stored on disk in a packed form (struct
 249  * lu_fid_pack) in a big-endian order.
 250  */
 251 struct lu_fid {
 252         /**
 253          * fid sequence. Sequence is a unit of migration: all files (objects)
 254          * with fids from a given sequence are stored on the same
 255          * server.
 256          *
 257          * Lustre should support 2 ^ 64 objects, thus even if one
 258          * sequence has one object we will never reach this value.
 259          */
 260         __u64 f_seq;
 261         /** fid number within sequence. */
 262         __u32 f_oid;
 263         /**
 264          * fid version, used to distinguish different versions (in the sense
 265          * of snapshots, etc.) of the same file system object. Not currently
 266          * used.
 267          */
 268         __u32 f_ver;
 269 };
 270
 271 /**
 272  * Following struct for MDT attributes, that will be kept inode's EA.
 273  * Introduced in 2.0 release (please see b15993, for details)
 274  */
 275 struct lustre_mdt_attrs {
 276         /** FID of this inode */
 277         struct lu_fid  lma_self_fid;
 278         /** SOM state, mdt/ost type, others */
 279         __u64   lma_flags;
 280         /** total sectors in objects */
 281         __u64   lma_som_sectors;
 282 };
 283
 284
 285 /**
 286  * fid constants
 287  */
 288 enum {
 289         /** initial fid id value */
 290         LUSTRE_FID_INIT_OID  = 1UL
 291 };
 292
 293 /** returns fid object sequence */
 294 static inline __u64 fid_seq(const struct lu_fid *fid)
 295 {
 296         return fid->f_seq;
 297 }
 298
 299 /** returns fid object id */
 300 static inline __u32 fid_oid(const struct lu_fid *fid)
 301 {
 302         return fid->f_oid;
 303 }
 304
 305 /** returns fid object version */
 306 static inline __u32 fid_ver(const struct lu_fid *fid)
 307 {
 308         return fid->f_ver;
 309 }
 310
 311 static inline void fid_zero(struct lu_fid *fid)
 312 {
 313         memset(fid, 0, sizeof(*fid));
 314 }
 315
 316 /* Normal FID sequence starts from this value, i.e. 1<<33 */
 317 #define FID_SEQ_START  0x200000000ULL
 318
 319 /* IDIF sequence starts from this value, i.e. 1<<32 */
 320 #define IDIF_SEQ_START 0x100000000ULL
 321
 322 /**
 323  * Check if a fid is igif or not.
 324  * \param fid the fid to be tested.
 325  * \return true if the fid is a igif; otherwise false.
 326  */
 327 static inline int fid_is_igif(const struct lu_fid *fid)
 328 {
 329         return fid_seq(fid) > 0 && fid_seq(fid) < IDIF_SEQ_START;
 330 }
 331
 332 /**
 333  * Check if a fid is idif or not.
 334  * \param fid the fid to be tested.
 335  * \return true if the fid is a idif; otherwise false.
 336  */
 337 static inline int fid_is_idif(const struct lu_fid *fid)
 338 {
 339         return fid_seq(fid) >= IDIF_SEQ_START  && fid_seq(fid) < FID_SEQ_START;
 340 }
 341
 342 /**
 343  * Get inode number from a igif.
 344  * \param fid a igif to get inode number from.
 345  * \return inode number for the igif.
 346  */
 347 static inline ino_t lu_igif_ino(const struct lu_fid *fid)
 348 {
 349         return fid_seq(fid);
 350 }
 351
 352 /**
 353  * Get inode generation from a igif.
 354  * \param fid a igif to get inode generation from.
 355  * \return inode generation for the igif.
 356  */
 357 static inline __u32 lu_igif_gen(const struct lu_fid *fid)
 358 {
 359         return fid_oid(fid);
 360 }
 361
 362 #define DFID "[0x%16.16"LPF64"x/0x%8.8x:0x%8.8x]"
 363
 364 #define PFID(fid)     \
 365         fid_seq(fid), \
 366         fid_oid(fid), \
 367         fid_ver(fid)
 368
 369 static inline void fid_cpu_to_le(struct lu_fid *dst, const struct lu_fid *src)
 370 {
 371         /* check that all fields are converted */
 372         CLASSERT(sizeof *src ==
 373                  sizeof fid_seq(src) +
 374                  sizeof fid_oid(src) + sizeof fid_ver(src));
 375         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
 376         dst->f_seq = cpu_to_le64(fid_seq(src));
 377         dst->f_oid = cpu_to_le32(fid_oid(src));
 378         dst->f_ver = cpu_to_le32(fid_ver(src));
 379 }
 380
 381 static inline void fid_le_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
 382 {
 383         /* check that all fields are converted */
 384         CLASSERT(sizeof *src ==
 385                  sizeof fid_seq(src) +
 386                  sizeof fid_oid(src) + sizeof fid_ver(src));
 387         dst->f_seq = le64_to_cpu(fid_seq(src));
 388         dst->f_oid = le32_to_cpu(fid_oid(src));
 389         dst->f_ver = le32_to_cpu(fid_ver(src));
 390         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
 391 }
 392
 393 static inline void fid_cpu_to_be(struct lu_fid *dst, const struct lu_fid *src)
 394 {
 395         /* check that all fields are converted */
 396         CLASSERT(sizeof *src ==
 397                  sizeof fid_seq(src) +
 398                  sizeof fid_oid(src) + sizeof fid_ver(src));
 399         LASSERTF(fid_is_igif(src) || fid_ver(src) == 0, DFID"\n", PFID(src));
 400         dst->f_seq = cpu_to_be64(fid_seq(src));
 401         dst->f_oid = cpu_to_be32(fid_oid(src));
 402         dst->f_ver = cpu_to_be32(fid_ver(src));
 403 }
 404
 405 static inline void fid_be_to_cpu(struct lu_fid *dst, const struct lu_fid *src)
 406 {
 407         /* check that all fields are converted */
 408         CLASSERT(sizeof *src ==
 409                  sizeof fid_seq(src) +
 410                  sizeof fid_oid(src) + sizeof fid_ver(src));
 411         dst->f_seq = be64_to_cpu(fid_seq(src));
 412         dst->f_oid = be32_to_cpu(fid_oid(src));
 413         dst->f_ver = be32_to_cpu(fid_ver(src));
 414         LASSERTF(fid_is_igif(dst) || fid_ver(dst) == 0, DFID"\n", PFID(dst));
 415 }
 416
 417 /**
 418  * Storage representation for fids.
 419  *
 420  * Variable size, first byte contains the length of the whole record.
 421  */
 422 struct lu_fid_pack {
 423         char fp_len;
 424         char fp_area[sizeof(struct lu_fid)];
 425 };
 426
 427 void fid_pack(struct lu_fid_pack *pack, const struct lu_fid *fid,
 428               struct lu_fid *befider);
 429 int  fid_unpack(const struct lu_fid_pack *pack, struct lu_fid *fid);
 430
 431 static inline int fid_is_sane(const struct lu_fid *fid)
 432 {
 433         return
 434                 fid != NULL &&
 435                 ((fid_seq(fid) >= FID_SEQ_START && fid_oid(fid) != 0
 436                                                 && fid_ver(fid) == 0) ||
 437                 fid_is_igif(fid));
 438 }
 439
 440 static inline int fid_is_zero(const struct lu_fid *fid)
 441 {
 442         return fid_seq(fid) == 0 && fid_oid(fid) == 0;
 443 }
 444
 445 extern void lustre_swab_lu_fid(struct lu_fid *fid);
 446 extern void lustre_swab_lu_range(struct lu_range *range);
 447
 448 static inline int lu_fid_eq(const struct lu_fid *f0,
 449                             const struct lu_fid *f1)
 450 {
 451         /* Check that there is no alignment padding. */
 452         CLASSERT(sizeof *f0 ==
 453                  sizeof f0->f_seq + sizeof f0->f_oid + sizeof f0->f_ver);
 454         LASSERTF(fid_is_igif(f0) || fid_ver(f0) == 0, DFID, PFID(f0));
 455         LASSERTF(fid_is_igif(f1) || fid_ver(f1) == 0, DFID, PFID(f1));
 456         return memcmp(f0, f1, sizeof *f0) == 0;
 457 }
 458
 459 #define __diff_normalize(val0, val1)                            \
 460 ({                                                              \
 461         typeof(val0) __val0 = (val0);                           \
 462         typeof(val1) __val1 = (val1);                           \
 463                                                                 \
 464         (__val0 == __val1 ? 0 : __val0 > __val1 ? +1 : -1);     \
 465 })
 466
 467 static inline int lu_fid_cmp(const struct lu_fid *f0,
 468                              const struct lu_fid *f1)
 469 {
 470         return
 471                 __diff_normalize(fid_seq(f0), fid_seq(f1)) ?:
 472                 __diff_normalize(fid_oid(f0), fid_oid(f1)) ?:
 473                 __diff_normalize(fid_ver(f0), fid_ver(f1));
 474 }
 475
 476 /** @} lu_fid */
 477
 478 /** \defgroup lu_dir lu_dir
 479  * @{ */
 480 /**
 481  * Layout of readdir pages, as transmitted on wire.
 482  */
 483 struct lu_dirent {
 484         struct lu_fid lde_fid;
 485         __u64         lde_hash;
 486         __u16         lde_reclen;
 487         __u16         lde_namelen;
 488         __u32         lde_pad0;
 489         char          lde_name[0];
 490 };
 491
 492 struct lu_dirpage {
 493         __u64            ldp_hash_start;
 494         __u64            ldp_hash_end;
 495         __u32            ldp_flags;
 496         __u32            ldp_pad0;
 497         struct lu_dirent ldp_entries[0];
 498 };
 499
 500 enum lu_dirpage_flags {
 501         LDF_EMPTY = 1 << 0
 502 };
 503
 504 static inline struct lu_dirent *lu_dirent_start(struct lu_dirpage *dp)
 505 {
 506         if (le32_to_cpu(dp->ldp_flags) & LDF_EMPTY)
 507                 return NULL;
 508         else
 509                 return dp->ldp_entries;
 510 }
 511
 512 static inline struct lu_dirent *lu_dirent_next(struct lu_dirent *ent)
 513 {
 514         struct lu_dirent *next;
 515
 516         if (le16_to_cpu(ent->lde_reclen) != 0)
 517                 next = ((void *)ent) + le16_to_cpu(ent->lde_reclen);
 518         else
 519                 next = NULL;
 520
 521         return next;
 522 }
 523
 524 static inline int lu_dirent_size(struct lu_dirent *ent)
 525 {
 526         if (le16_to_cpu(ent->lde_reclen) == 0) {
 527                 return (sizeof(*ent) +
 528                         le16_to_cpu(ent->lde_namelen) + 7) & ~7;
 529         }
 530         return le16_to_cpu(ent->lde_reclen);
 531 }
 532
 533 #define DIR_END_OFF              0xfffffffffffffffeULL
 534
 535 /** @} lu_dir */
 536
 537 struct lustre_handle {
 538         __u64 cookie;
 539 };
 540 #define DEAD_HANDLE_MAGIC 0xdeadbeefcafebabeULL
 541
 542 static inline int lustre_handle_is_used(struct lustre_handle *lh)
 543 {
 544         return lh->cookie != 0ull;
 545 }
 546
 547 static inline int lustre_handle_equal(struct lustre_handle *lh1,
 548                                       struct lustre_handle *lh2)
 549 {
 550         return lh1->cookie == lh2->cookie;
 551 }
 552
 553 static inline void lustre_handle_copy(struct lustre_handle *tgt,
 554                                       struct lustre_handle *src)
 555 {
 556         tgt->cookie = src->cookie;
 557 }
 558
 559 /* flags for lm_flags */
 560 #define MSGHDR_AT_SUPPORT               0x1
 561
 562 #define lustre_msg lustre_msg_v2
 563 /* we depend on this structure to be 8-byte aligned */
 564 /* this type is only endian-adjusted in lustre_unpack_msg() */
 565 struct lustre_msg_v2 {
 566         __u32 lm_bufcount;
 567         __u32 lm_secflvr;
 568         __u32 lm_magic;
 569         __u32 lm_repsize;
 570         __u32 lm_cksum;
 571         __u32 lm_flags;
 572         __u32 lm_padding_2;
 573         __u32 lm_padding_3;
 574         __u32 lm_buflens[0];
 575 };
 576
 577 /* without gss, ptlrpc_body is put at the first buffer. */
 578 #define PTLRPC_NUM_VERSIONS     4
 579 struct ptlrpc_body {
 580         struct lustre_handle pb_handle;
 581         __u32 pb_type;
 582         __u32 pb_version;
 583         __u32 pb_opc;
 584         __u32 pb_status;
 585         __u64 pb_last_xid;
 586         __u64 pb_last_seen;
 587         __u64 pb_last_committed;
 588         __u64 pb_transno;
 589         __u32 pb_flags;
 590         __u32 pb_op_flags;
 591         __u32 pb_conn_cnt;
 592         __u32 pb_timeout;  /* for req, the deadline, for rep, the service est */
 593         __u32 pb_service_time; /* for rep, actual service time */
 594         __u32 pb_limit;
 595         __u64 pb_slv;
 596         /* VBR: pre-versions */
 597         __u64 pb_pre_versions[PTLRPC_NUM_VERSIONS];
 598         /* padding for future needs */
 599         __u64 pb_padding[4];
 600 };
 601
 602 extern void lustre_swab_ptlrpc_body(struct ptlrpc_body *pb);
 603
 604 /* message body offset for lustre_msg_v2 */
 605 /* ptlrpc body offset in all request/reply messages */
 606 #define MSG_PTLRPC_BODY_OFF             0
 607
 608 /* normal request/reply message record offset */
 609 #define REQ_REC_OFF                     1
 610 #define REPLY_REC_OFF                   1
 611
 612 /* ldlm request message body offset */
 613 #define DLM_LOCKREQ_OFF                 1 /* lockreq offset */
 614 #define DLM_REQ_REC_OFF                 2 /* normal dlm request record offset */
 615
 616 /* ldlm intent lock message body offset */
 617 #define DLM_INTENT_IT_OFF               2 /* intent lock it offset */
 618 #define DLM_INTENT_REC_OFF              3 /* intent lock record offset */
 619
 620 /* ldlm reply message body offset */
 621 #define DLM_LOCKREPLY_OFF               1 /* lockrep offset */
 622 #define DLM_REPLY_REC_OFF               2 /* reply record offset */
 623
 624 /* Flags that are operation-specific go in the top 16 bits. */
 625 #define MSG_OP_FLAG_MASK   0xffff0000
 626 #define MSG_OP_FLAG_SHIFT  16
 627
 628 /* Flags that apply to all requests are in the bottom 16 bits */
 629 #define MSG_GEN_FLAG_MASK     0x0000ffff
 630 #define MSG_LAST_REPLAY           0x0001
 631 #define MSG_RESENT                0x0002
 632 #define MSG_REPLAY                0x0004
 633 /* #define MSG_AT_SUPPORT         0x0008
 634  * This was used in early prototypes of adaptive timeouts, and while there
 635  * shouldn't be any users of that code there also isn't a need for using this
 636  * bits. Defer usage until at least 1.10 to avoid potential conflict. */
 637 #define MSG_DELAY_REPLAY          0x0010
 638 #define MSG_VERSION_REPLAY        0x0020
 639 #define MSG_REQ_REPLAY_DONE       0x0040
 640 #define MSG_LOCK_REPLAY_DONE      0x0080
 641
 642 /*
 643  * Flags for all connect opcodes (MDS_CONNECT, OST_CONNECT)
 644  */
 645
 646 #define MSG_CONNECT_RECOVERING  0x1
 647 #define MSG_CONNECT_RECONNECT   0x2
 648 #define MSG_CONNECT_REPLAYABLE  0x4
 649 //#define MSG_CONNECT_PEER        0x8
 650 #define MSG_CONNECT_LIBCLIENT   0x10
 651 #define MSG_CONNECT_INITIAL     0x20
 652 #define MSG_CONNECT_ASYNC       0x40
 653 #define MSG_CONNECT_NEXT_VER    0x80  /* use next version of lustre_msg */
 654 #define MSG_CONNECT_TRANSNO     0x100 /* report transno */
 655
 656 /* Connect flags */
 657 #define OBD_CONNECT_RDONLY     0x00000001ULL /* client allowed read-only access */
 658 #define OBD_CONNECT_INDEX      0x00000002ULL /* connect to specific LOV idx */
 659 #define OBD_CONNECT_GRANT      0x00000008ULL /* OSC acquires grant at connect */
 660 #define OBD_CONNECT_SRVLOCK    0x00000010ULL /* server takes locks for client */
 661 #define OBD_CONNECT_VERSION    0x00000020ULL /* Server supports versions in ocd */
 662 #define OBD_CONNECT_REQPORTAL  0x00000040ULL /* Separate portal for non-IO reqs */
 663 #define OBD_CONNECT_ACL        0x00000080ULL /* client uses access control lists */
 664 #define OBD_CONNECT_XATTR      0x00000100ULL /* client using extended attributes*/
 665 #define OBD_CONNECT_TRUNCLOCK  0x00000400ULL /* locks on server for punch b=9528 */
 666 #define OBD_CONNECT_IBITS      0x00001000ULL /* support for inodebits locks */
 667 #define OBD_CONNECT_JOIN       0x00002000ULL /* files can be concatenated */
 668 #define OBD_CONNECT_ATTRFID    0x00004000ULL /* Server supports GetAttr By Fid */
 669 #define OBD_CONNECT_NODEVOH    0x00008000ULL /* No open handle for special nodes */
 670 #define OBD_CONNECT_RMT_CLIENT 0x00010000ULL /* Remote client */
 671 #define OBD_CONNECT_RMT_CLIENT_FORCE 0x00020000ULL /* Remote client by force */
 672 #define OBD_CONNECT_BRW_SIZE   0x00040000ULL /* Max bytes per rpc */
 673 #define OBD_CONNECT_QUOTA64    0x00080000ULL /* 64bit qunit_data.qd_count b=10707*/
 674 #define OBD_CONNECT_MDS_CAPA   0x00100000ULL /* MDS capability */
 675 #define OBD_CONNECT_OSS_CAPA   0x00200000ULL /* OSS capability */
 676 #define OBD_CONNECT_CANCELSET  0x00400000ULL /* Early batched cancels. */
 677 #define OBD_CONNECT_SOM        0x00800000ULL /* SOM feature */
 678 #define OBD_CONNECT_AT         0x01000000ULL /* client uses adaptive timeouts */
 679 #define OBD_CONNECT_LRU_RESIZE 0x02000000ULL /* Lru resize feature. */
 680 #define OBD_CONNECT_MDS_MDS    0x04000000ULL /* MDS-MDS connection*/
 681 #define OBD_CONNECT_REAL       0x08000000ULL /* real connection */
 682 #define OBD_CONNECT_CHANGE_QS  0x10000000ULL /* shrink/enlarge qunit b=10600 */
 683 #define OBD_CONNECT_CKSUM      0x20000000ULL /* support several cksum algos */
 684 #define OBD_CONNECT_FID        0x40000000ULL /* FID is supported by server */
 685 #define OBD_CONNECT_LOV_V3    0x100000000ULL /* client supports lov v3 ea */
 686
 687 /* also update obd_connect_names[] for lprocfs_rd_connect_flags()
 688  * and lustre/utils/wirecheck.c */
 689
 690 #ifdef HAVE_LRU_RESIZE_SUPPORT
 691 #define LRU_RESIZE_CONNECT_FLAG OBD_CONNECT_LRU_RESIZE
 692 #else
 693 #define LRU_RESIZE_CONNECT_FLAG 0
 694 #endif
 695
 696 #define MDT_CONNECT_SUPPORTED  (OBD_CONNECT_RDONLY | OBD_CONNECT_VERSION | \
 697                                 OBD_CONNECT_ACL | OBD_CONNECT_XATTR | \
 698                                 OBD_CONNECT_IBITS | OBD_CONNECT_JOIN | \
 699                                 OBD_CONNECT_NODEVOH |/* OBD_CONNECT_ATTRFID |*/\
 700                                 OBD_CONNECT_RMT_CLIENT | \
 701                                 OBD_CONNECT_RMT_CLIENT_FORCE | \
 702                                 OBD_CONNECT_MDS_CAPA | OBD_CONNECT_OSS_CAPA | \
 703                                 OBD_CONNECT_MDS_MDS | OBD_CONNECT_CANCELSET | \
 704                                 OBD_CONNECT_FID | \
 705                                 LRU_RESIZE_CONNECT_FLAG | OBD_CONNECT_AT | \
 706                                 OBD_CONNECT_LOV_V3)
 707 #define OST_CONNECT_SUPPORTED  (OBD_CONNECT_SRVLOCK | OBD_CONNECT_GRANT | \
 708                                 OBD_CONNECT_REQPORTAL | OBD_CONNECT_VERSION | \
 709                                 OBD_CONNECT_TRUNCLOCK | OBD_CONNECT_INDEX | \
 710                                 OBD_CONNECT_BRW_SIZE | OBD_CONNECT_QUOTA64 | \
 711                                 OBD_CONNECT_OSS_CAPA | OBD_CONNECT_CANCELSET | \
 712                                 OBD_CONNECT_CKSUM | LRU_RESIZE_CONNECT_FLAG | \
 713                                 OBD_CONNECT_AT | OBD_CONNECT_CHANGE_QS | \
 714                                 OBD_CONNECT_RMT_CLIENT | \
 715                                 OBD_CONNECT_RMT_CLIENT_FORCE)
 716 #define ECHO_CONNECT_SUPPORTED (0)
 717 #define MGS_CONNECT_SUPPORTED  (OBD_CONNECT_VERSION | OBD_CONNECT_AT)
 718
 719 #define MAX_QUOTA_COUNT32 (0xffffffffULL)
 720
 721 #define OBD_OCD_VERSION(major,minor,patch,fix) (((major)<<24) + ((minor)<<16) +\
 722                                                 ((patch)<<8) + (fix))
 723 #define OBD_OCD_VERSION_MAJOR(version) ((int)((version)>>24)&255)
 724 #define OBD_OCD_VERSION_MINOR(version) ((int)((version)>>16)&255)
 725 #define OBD_OCD_VERSION_PATCH(version) ((int)((version)>>8)&255)
 726 #define OBD_OCD_VERSION_FIX(version)   ((int)(version)&255)
 727
 728 /* This structure is used for both request and reply.
 729  *
 730  * If we eventually have separate connect data for different types, which we
 731  * almost certainly will, then perhaps we stick a union in here. */
 732 struct obd_connect_data {
 733         __u64 ocd_connect_flags; /* OBD_CONNECT_* per above */
 734         __u32 ocd_version;       /* lustre release version number */
 735         __u32 ocd_grant;         /* initial cache grant amount (bytes) */
 736         __u32 ocd_index;         /* LOV index to connect to */
 737         __u32 ocd_brw_size;      /* Maximum BRW size in bytes */
 738         __u64 ocd_ibits_known;   /* inode bits this client understands */
 739         __u32 ocd_nllu;          /* non-local-lustre-user */
 740         __u32 ocd_nllg;          /* non-local-lustre-group */
 741         __u64 ocd_transno;       /* first transno from client to be replayed */
 742         __u32 ocd_group;         /* MDS group on OST */
 743         __u32 ocd_cksum_types;   /* supported checksum algorithms */
 744         __u64 padding1;          /* also fix lustre_swab_connect */
 745         __u64 padding2;          /* also fix lustre_swab_connect */
 746 };
 747
 748 extern void lustre_swab_connect(struct obd_connect_data *ocd);
 749
 750 /*
 751  * Supported checksum algorithms. Up to 32 checksum types are supported.
 752  * (32-bit mask stored in obd_connect_data::ocd_cksum_types)
 753  * Please update DECLARE_CKSUM_NAME/OBD_CKSUM_ALL in obd.h when adding a new
 754  * algorithm and also the OBD_FL_CKSUM* flags.
 755  */
 756 typedef enum {
 757         OBD_CKSUM_CRC32 = 0x00000001,
 758         OBD_CKSUM_ADLER = 0x00000002,
 759 } cksum_type_t;
 760
 761 /*
 762  *   OST requests: OBDO & OBD request records
 763  */
 764
 765 /* opcodes */
 766 typedef enum {
 767         OST_REPLY      =  0,       /* reply ? */
 768         OST_GETATTR    =  1,
 769         OST_SETATTR    =  2,
 770         OST_READ       =  3,
 771         OST_WRITE      =  4,
 772         OST_CREATE     =  5,
 773         OST_DESTROY    =  6,
 774         OST_GET_INFO   =  7,
 775         OST_CONNECT    =  8,
 776         OST_DISCONNECT =  9,
 777         OST_PUNCH      = 10,
 778         OST_OPEN       = 11,
 779         OST_CLOSE      = 12,
 780         OST_STATFS     = 13,
 781         OST_SYNC       = 16,
 782         OST_SET_INFO   = 17,
 783         OST_QUOTACHECK = 18,
 784         OST_QUOTACTL   = 19,
 785         OST_QUOTA_ADJUST_QUNIT = 20,
 786         OST_LAST_OPC
 787 } ost_cmd_t;
 788 #define OST_FIRST_OPC  OST_REPLY
 789
 790 typedef __u64 obd_id;
 791 typedef __u64 obd_gr;
 792 typedef __u64 obd_time;
 793 typedef __u64 obd_size;
 794 typedef __u64 obd_off;
 795 typedef __u64 obd_blocks;
 796 typedef __u32 obd_blksize;
 797 typedef __u32 obd_mode;
 798 typedef __u32 obd_uid;
 799 typedef __u32 obd_gid;
 800 typedef __u32 obd_flag;
 801 typedef __u64 obd_valid;
 802 typedef __u32 obd_count;
 803
 804 #define OBD_FL_INLINEDATA    (0x00000001)
 805 #define OBD_FL_OBDMDEXISTS   (0x00000002)
 806 #define OBD_FL_DELORPHAN     (0x00000004) /* if set in o_flags delete orphans */
 807 #define OBD_FL_NORPC         (0x00000008) /* set in o_flags do in OSC not OST */
 808 #define OBD_FL_IDONLY        (0x00000010) /* set in o_flags only adjust obj id*/
 809 #define OBD_FL_RECREATE_OBJS (0x00000020) /* recreate missing obj */
 810 #define OBD_FL_DEBUG_CHECK   (0x00000040) /* echo client/server debug check */
 811 #define OBD_FL_NO_USRQUOTA   (0x00000100) /* the object's owner is over quota */
 812 #define OBD_FL_NO_GRPQUOTA   (0x00000200) /* the object's group is over quota */
 813
 814 /**
 815  * Set this to delegate DLM locking during obd_punch() to the OSTs. Only OSTs
 816  * that declared OBD_CONNECT_TRUNCLOCK in their connect flags support this
 817  * functionality.
 818  */
 819 #define OBD_FL_TRUNCLOCK     (0x00000800)
 820
 821 /*
 822  * Checksum types
 823  */
 824 #define OBD_FL_CKSUM_CRC32    (0x00001000)
 825 #define OBD_FL_CKSUM_ADLER    (0x00002000)
 826 #define OBD_FL_CKSUM_ALL      (OBD_FL_CKSUM_CRC32 | OBD_FL_CKSUM_ADLER)
 827
 828 #define LOV_MAGIC_V1      0x0BD10BD0
 829 #define LOV_MAGIC         LOV_MAGIC_V1
 830 #define LOV_MAGIC_JOIN    0x0BD20BD0
 831 #define LOV_MAGIC_V3      0x0BD30BD0
 832
 833 #define LOV_PATTERN_RAID0 0x001   /* stripes are used round-robin */
 834 #define LOV_PATTERN_RAID1 0x002   /* stripes are mirrors of each other */
 835 #define LOV_PATTERN_FIRST 0x100   /* first stripe is not in round-robin */
 836 #define LOV_PATTERN_CMOBD 0x200
 837
 838 #define LOV_OBJECT_GROUP_DEFAULT ~0ULL
 839 #define LOV_OBJECT_GROUP_CLEAR 0ULL
 840
 841 #define lov_ost_data lov_ost_data_v1
 842 struct lov_ost_data_v1 {          /* per-stripe data structure (little-endian)*/
 843         __u64 l_object_id;        /* OST object ID */
 844         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 845         __u32 l_ost_gen;          /* generation of this l_ost_idx */
 846         __u32 l_ost_idx;          /* OST index in LOV (lov_tgt_desc->tgts) */
 847 };
 848
 849 #define lov_mds_md lov_mds_md_v1
 850 struct lov_mds_md_v1 {            /* LOV EA mds/wire data (little-endian) */
 851         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V1 */
 852         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 853         __u64 lmm_object_id;      /* LOV object ID */
 854         __u64 lmm_object_gr;      /* LOV object group */
 855         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 856         __u32 lmm_stripe_count;   /* num stripes in use for this object */
 857         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 858 };
 859
 860 /* extern void lustre_swab_lov_mds_md(struct lov_mds_md *llm); */
 861
 862 #define MAX_MD_SIZE (sizeof(struct lov_mds_md) + 4 * sizeof(struct lov_ost_data))
 863 #define MIN_MD_SIZE (sizeof(struct lov_mds_md) + 1 * sizeof(struct lov_ost_data))
 864
 865 #define XATTR_NAME_ACL_ACCESS   "system.posix_acl_access"
 866 #define XATTR_NAME_ACL_DEFAULT  "system.posix_acl_default"
 867 #define XATTR_NAME_LOV          "trusted.lov"
 868
 869 struct lov_mds_md_v3 {            /* LOV EA mds/wire data (little-endian) */
 870         __u32 lmm_magic;          /* magic number = LOV_MAGIC_V3 */
 871         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 872         __u64 lmm_object_id;      /* LOV object ID */
 873         __u64 lmm_object_gr;      /* LOV object group */
 874         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 875         __u32 lmm_stripe_count;   /* num stripes in use for this object */
 876         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* must be 32bit aligned */
 877         struct lov_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 878 };
 879
 880
 881 #define OBD_MD_FLID        (0x00000001ULL) /* object ID */
 882 #define OBD_MD_FLATIME     (0x00000002ULL) /* access time */
 883 #define OBD_MD_FLMTIME     (0x00000004ULL) /* data modification time */
 884 #define OBD_MD_FLCTIME     (0x00000008ULL) /* change time */
 885 #define OBD_MD_FLSIZE      (0x00000010ULL) /* size */
 886 #define OBD_MD_FLBLOCKS    (0x00000020ULL) /* allocated blocks count */
 887 #define OBD_MD_FLBLKSZ     (0x00000040ULL) /* block size */
 888 #define OBD_MD_FLMODE      (0x00000080ULL) /* access bits (mode & ~S_IFMT) */
 889 #define OBD_MD_FLTYPE      (0x00000100ULL) /* object type (mode & S_IFMT) */
 890 #define OBD_MD_FLUID       (0x00000200ULL) /* user ID */
 891 #define OBD_MD_FLGID       (0x00000400ULL) /* group ID */
 892 #define OBD_MD_FLFLAGS     (0x00000800ULL) /* flags word */
 893 #define OBD_MD_FLNLINK     (0x00002000ULL) /* link count */
 894 #define OBD_MD_FLGENER     (0x00004000ULL) /* generation number */
 895 /*#define OBD_MD_FLINLINE    (0x00008000ULL)  inline data. used until 1.6.5 */
 896 #define OBD_MD_FLRDEV      (0x00010000ULL) /* device number */
 897 #define OBD_MD_FLEASIZE    (0x00020000ULL) /* extended attribute data */
 898 #define OBD_MD_LINKNAME    (0x00040000ULL) /* symbolic link target */
 899 #define OBD_MD_FLHANDLE    (0x00080000ULL) /* file/lock handle */
 900 #define OBD_MD_FLCKSUM     (0x00100000ULL) /* bulk data checksum */
 901 #define OBD_MD_FLQOS       (0x00200000ULL) /* quality of service stats */
 902 #define OBD_MD_FLOSCOPQ    (0x00400000ULL) /* osc opaque data */
 903 #define OBD_MD_FLCOOKIE    (0x00800000ULL) /* log cancellation cookie */
 904 #define OBD_MD_FLGROUP     (0x01000000ULL) /* group */
 905 #define OBD_MD_FLFID       (0x02000000ULL) /* ->ost write inline fid */
 906 #define OBD_MD_FLEPOCH     (0x04000000ULL) /* ->ost write easize is epoch */
 907                                            /* ->mds if epoch opens or closes */
 908 #define OBD_MD_FLGRANT     (0x08000000ULL) /* ost preallocation space grant */
 909 #define OBD_MD_FLDIREA     (0x10000000ULL) /* dir's extended attribute data */
 910 #define OBD_MD_FLUSRQUOTA  (0x20000000ULL) /* over quota flags sent from ost */
 911 #define OBD_MD_FLGRPQUOTA  (0x40000000ULL) /* over quota flags sent from ost */
 912 #define OBD_MD_FLMODEASIZE (0x80000000ULL) /* EA size will be changed */
 913
 914 #define OBD_MD_MDS         (0x0000000100000000ULL) /* where an inode lives on */
 915 #define OBD_MD_REINT       (0x0000000200000000ULL) /* reintegrate oa */
 916 #define OBD_MD_MEA         (0x0000000400000000ULL) /* CMD split EA  */
 917
 918 #define OBD_MD_FLXATTR     (0x0000001000000000ULL) /* xattr */
 919 #define OBD_MD_FLXATTRLS   (0x0000002000000000ULL) /* xattr list */
 920 #define OBD_MD_FLXATTRRM   (0x0000004000000000ULL) /* xattr remove */
 921 #define OBD_MD_FLACL       (0x0000008000000000ULL) /* ACL */
 922 #define OBD_MD_FLRMTPERM   (0x0000010000000000ULL) /* remote permission */
 923 #define OBD_MD_FLMDSCAPA   (0x0000020000000000ULL) /* MDS capability */
 924 #define OBD_MD_FLOSSCAPA   (0x0000040000000000ULL) /* OSS capability */
 925 #define OBD_MD_FLCKSPLIT   (0x0000080000000000ULL) /* Check split on server */
 926 #define OBD_MD_FLCROSSREF  (0x0000100000000000ULL) /* Cross-ref case */
 927
 928 #define OBD_FL_TRUNC       (0x0000200000000000ULL) /* for filter_truncate */
 929
 930 #define OBD_MD_FLRMTLSETFACL    (0x0001000000000000ULL) /* lfs lsetfacl case */
 931 #define OBD_MD_FLRMTLGETFACL    (0x0002000000000000ULL) /* lfs lgetfacl case */
 932 #define OBD_MD_FLRMTRSETFACL    (0x0004000000000000ULL) /* lfs rsetfacl case */
 933 #define OBD_MD_FLRMTRGETFACL    (0x0008000000000000ULL) /* lfs rgetfacl case */
 934
 935 #define OBD_MD_FLGETATTR (OBD_MD_FLID    | OBD_MD_FLATIME | OBD_MD_FLMTIME | \
 936                           OBD_MD_FLCTIME | OBD_MD_FLSIZE  | OBD_MD_FLBLKSZ | \
 937                           OBD_MD_FLMODE  | OBD_MD_FLTYPE  | OBD_MD_FLUID   | \
 938                           OBD_MD_FLGID   | OBD_MD_FLFLAGS | OBD_MD_FLNLINK | \
 939                           OBD_MD_FLGENER | OBD_MD_FLRDEV  | OBD_MD_FLGROUP)
 940
 941 /* don't forget obdo_fid which is way down at the bottom so it can
 942  * come after the definition of llog_cookie */
 943
 944 struct obd_statfs {
 945         __u64           os_type;
 946         __u64           os_blocks;
 947         __u64           os_bfree;
 948         __u64           os_bavail;
 949         __u64           os_files;
 950         __u64           os_ffree;
 951         __u8            os_fsid[40];
 952         __u32           os_bsize;
 953         __u32           os_namelen;
 954         __u64           os_maxbytes;
 955         __u32           os_state;       /* positive error code on server */
 956         __u32           os_spare1;
 957         __u32           os_spare2;
 958         __u32           os_spare3;
 959         __u32           os_spare4;
 960         __u32           os_spare5;
 961         __u32           os_spare6;
 962         __u32           os_spare7;
 963         __u32           os_spare8;
 964         __u32           os_spare9;
 965 };
 966
 967 extern void lustre_swab_obd_statfs (struct obd_statfs *os);
 968 #define OBD_STATFS_NODELAY      0x0001  /* requests should be send without delay
 969                                          * and resends for avoid deadlocks */
 970
 971 #define OBD_STATFS_FROM_CACHE   0x0002  /* the statfs callback should not update
 972                                          * obd_osfs_age */
 973
 974 /* ost_body.data values for OST_BRW */
 975
 976 #define OBD_BRW_READ            0x01
 977 #define OBD_BRW_WRITE           0x02
 978 #define OBD_BRW_RWMASK          (OBD_BRW_READ | OBD_BRW_WRITE)
 979 #define OBD_BRW_SYNC            0x08
 980 #define OBD_BRW_CHECK           0x10
 981 #define OBD_BRW_FROM_GRANT      0x20 /* the osc manages this under llite */
 982 #define OBD_BRW_GRANTED         0x40 /* the ost manages this */
 983 #define OBD_BRW_NOCACHE         0x80 /* this page is a part of non-cached IO */
 984 #define OBD_BRW_NOQUOTA        0x100
 985 #define OBD_BRW_SRVLOCK        0x200 /* Client holds no lock over this page */
 986
 987 #define OBD_OBJECT_EOF 0xffffffffffffffffULL
 988
 989 #define OST_MIN_PRECREATE 32
 990 #define OST_MAX_PRECREATE 20000
 991
 992 struct obd_ioobj {
 993         obd_id               ioo_id;
 994         obd_gr               ioo_gr;
 995         __u32                ioo_type;
 996         __u32                ioo_bufcnt;
 997 };
 998
 999 extern void lustre_swab_obd_ioobj (struct obd_ioobj *ioo);
1000
1001 /* multiple of 8 bytes => can array */
1002 struct niobuf_remote {
1003         __u64 offset;
1004         __u32 len;
1005         __u32 flags;
1006 };
1007
1008 extern void lustre_swab_niobuf_remote (struct niobuf_remote *nbr);
1009
1010 /* lock value block communicated between the filter and llite */
1011
1012 /* OST_LVB_ERR_INIT is needed because the return code in rc is
1013  * negative, i.e. because ((MASK + rc) & MASK) != MASK. */
1014 #define OST_LVB_ERR_INIT 0xffbadbad80000000ULL
1015 #define OST_LVB_ERR_MASK 0xffbadbad00000000ULL
1016 #define OST_LVB_IS_ERR(blocks)                                          \
1017         ((blocks & OST_LVB_ERR_MASK) == OST_LVB_ERR_MASK)
1018 #define OST_LVB_SET_ERR(blocks, rc)                                     \
1019         do { blocks = OST_LVB_ERR_INIT + rc; } while (0)
1020 #define OST_LVB_GET_ERR(blocks)    (int)(blocks - OST_LVB_ERR_INIT)
1021
1022 struct ost_lvb {
1023         __u64 lvb_size;
1024         __u64 lvb_mtime;
1025         __u64 lvb_atime;
1026         __u64 lvb_ctime;
1027         __u64 lvb_blocks;
1028 };
1029
1030 extern void lustre_swab_ost_lvb(struct ost_lvb *);
1031
1032 /*
1033  *   MDS REQ RECORDS
1034  */
1035
1036 /* opcodes */
1037 typedef enum {
1038         MDS_GETATTR      = 33,
1039         MDS_GETATTR_NAME = 34,
1040         MDS_CLOSE        = 35,
1041         MDS_REINT        = 36,
1042         MDS_READPAGE     = 37,
1043         MDS_CONNECT      = 38,
1044         MDS_DISCONNECT   = 39,
1045         MDS_GETSTATUS    = 40,
1046         MDS_STATFS       = 41,
1047         MDS_PIN          = 42,
1048         MDS_UNPIN        = 43,
1049         MDS_SYNC         = 44,
1050         MDS_DONE_WRITING = 45,
1051         MDS_SET_INFO     = 46,
1052         MDS_QUOTACHECK   = 47,
1053         MDS_QUOTACTL     = 48,
1054         MDS_GETXATTR     = 49,
1055         MDS_SETXATTR     = 50, /* obsolete, now it's MDS_REINT op */
1056         MDS_WRITEPAGE    = 51,
1057         MDS_IS_SUBDIR    = 52,
1058         MDS_LAST_OPC
1059 } mds_cmd_t;
1060
1061 #define MDS_FIRST_OPC    MDS_GETATTR
1062
1063 /*
1064  * Do not exceed 63
1065  */
1066
1067 typedef enum {
1068         REINT_SETATTR  = 1,
1069         REINT_CREATE   = 2,
1070         REINT_LINK     = 3,
1071         REINT_UNLINK   = 4,
1072         REINT_RENAME   = 5,
1073         REINT_OPEN     = 6,
1074         REINT_SETXATTR = 7,
1075 //      REINT_CLOSE    = 8,
1076 //      REINT_WRITE    = 9,
1077         REINT_MAX
1078 } mds_reint_t, mdt_reint_t;
1079
1080 extern void lustre_swab_generic_32s (__u32 *val);
1081
1082 /* the disposition of the intent outlines what was executed */
1083 #define DISP_IT_EXECD        0x00000001
1084 #define DISP_LOOKUP_EXECD    0x00000002
1085 #define DISP_LOOKUP_NEG      0x00000004
1086 #define DISP_LOOKUP_POS      0x00000008
1087 #define DISP_OPEN_CREATE     0x00000010
1088 #define DISP_OPEN_OPEN       0x00000020
1089 #define DISP_ENQ_COMPLETE    0x00400000
1090 #define DISP_ENQ_OPEN_REF    0x00800000
1091 #define DISP_ENQ_CREATE_REF  0x01000000
1092 #define DISP_OPEN_LOCK       0x02000000
1093
1094 /* INODE LOCK PARTS */
1095 #define MDS_INODELOCK_LOOKUP 0x000001       /* dentry, mode, owner, group */
1096 #define MDS_INODELOCK_UPDATE 0x000002       /* size, links, timestamps */
1097 #define MDS_INODELOCK_OPEN   0x000004       /* For opened files */
1098
1099 /* Do not forget to increase MDS_INODELOCK_MAXSHIFT when adding new bits */
1100 #define MDS_INODELOCK_MAXSHIFT 2
1101 /* This FULL lock is useful to take on unlink sort of operations */
1102 #define MDS_INODELOCK_FULL ((1<<(MDS_INODELOCK_MAXSHIFT+1))-1)
1103
1104 struct ll_fid {
1105         __u64 id;         /* holds object id */
1106         __u32 generation; /* holds object generation */
1107
1108         __u32 f_type;     /* holds object type or stripe idx when passing it to
1109                            * OST for saving into EA. */
1110 };
1111
1112 extern void lustre_swab_ll_fid (struct ll_fid *fid);
1113
1114 #define MDS_STATUS_CONN 1
1115 #define MDS_STATUS_LOV 2
1116
1117 struct mds_status_req {
1118         __u32  flags;
1119         __u32  repbuf;
1120 };
1121
1122 extern void lustre_swab_mds_status_req (struct mds_status_req *r);
1123
1124 /* mdt_thread_info.mti_flags. */
1125 enum md_op_flags {
1126         /* The flag indicates Size-on-MDS attributes are changed. */
1127         MF_SOM_CHANGE           = (1 << 0),
1128         /* Flags indicates an epoch opens or closes. */
1129         MF_EPOCH_OPEN           = (1 << 1),
1130         MF_EPOCH_CLOSE          = (1 << 2),
1131         MF_MDC_CANCEL_FID1      = (1 << 3),
1132         MF_MDC_CANCEL_FID2      = (1 << 4),
1133         MF_MDC_CANCEL_FID3      = (1 << 5),
1134         MF_MDC_CANCEL_FID4      = (1 << 6),
1135 };
1136
1137 #define MF_SOM_LOCAL_FLAGS (MF_MDC_CANCEL_FID1 | MF_MDC_CANCEL_FID2 | \
1138                             MF_MDC_CANCEL_FID3 | MF_MDC_CANCEL_FID4)
1139
1140 #define MDS_BFLAG_UNCOMMITTED_WRITES   0x1
1141 #define MDS_BFLAG_EXT_FLAGS     0x80000000 /* == EXT3_RESERVED_FL */
1142
1143 /* these should be identical to their EXT3_*_FL counterparts, and are
1144  * redefined here only to avoid dragging in ext3_fs.h */
1145 #define MDS_SYNC_FL             0x00000008 /* Synchronous updates */
1146 #define MDS_IMMUTABLE_FL        0x00000010 /* Immutable file */
1147 #define MDS_APPEND_FL           0x00000020 /* writes to file may only append */
1148 #define MDS_NOATIME_FL          0x00000080 /* do not update atime */
1149 #define MDS_DIRSYNC_FL          0x00010000 /* dirsync behaviour (dir only) */
1150
1151 #ifdef __KERNEL__
1152 /* If MDS_BFLAG_IOC_FLAGS is set it means we requested EXT3_*_FL inode flags
1153  * and we need to decode these into local S_* flags in the inode.  Otherwise
1154  * we pass flags straight through (see bug 9486). */
1155 static inline int ll_ext_to_inode_flags(int flags)
1156 {
1157         return (flags & MDS_BFLAG_EXT_FLAGS) ?
1158                (((flags & MDS_SYNC_FL)      ? S_SYNC      : 0) |
1159                 ((flags & MDS_NOATIME_FL)   ? S_NOATIME   : 0) |
1160                 ((flags & MDS_APPEND_FL)    ? S_APPEND    : 0) |
1161 #if defined(S_DIRSYNC)
1162                 ((flags & MDS_DIRSYNC_FL)   ? S_DIRSYNC   : 0) |
1163 #endif
1164                 ((flags & MDS_IMMUTABLE_FL) ? S_IMMUTABLE : 0)) :
1165                (flags & ~MDS_BFLAG_EXT_FLAGS);
1166 }
1167
1168 /* If MDS_BFLAG_EXT_FLAGS is set it means we requested EXT3_*_FL inode flags
1169  * and we pass these straight through.  Otherwise we need to convert from
1170  * S_* flags to their EXT3_*_FL equivalents (see bug 9486). */
1171 static inline int ll_inode_to_ext_flags(int oflags, int iflags)
1172 {
1173         return (oflags & MDS_BFLAG_EXT_FLAGS) ? (oflags & ~MDS_BFLAG_EXT_FLAGS):
1174                (((iflags & S_SYNC)      ? MDS_SYNC_FL      : 0) |
1175                 ((iflags & S_NOATIME)   ? MDS_NOATIME_FL   : 0) |
1176                 ((iflags & S_APPEND)    ? MDS_APPEND_FL    : 0) |
1177 #if defined(S_DIRSYNC)
1178                 ((iflags & S_DIRSYNC)   ? MDS_DIRSYNC_FL   : 0) |
1179 #endif
1180                 ((iflags & S_IMMUTABLE) ? MDS_IMMUTABLE_FL : 0));
1181 }
1182 #endif
1183
1184 struct mdt_body {
1185         struct lu_fid  fid1;
1186         struct lu_fid  fid2;
1187         struct lustre_handle handle;
1188         __u64          valid;
1189         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1190         __u64          mtime;
1191         __u64          atime;
1192         __u64          ctime;
1193         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1194         __u64          ioepoch;
1195         __u64          ino;    /* for 1.6 compatibility */
1196         __u32          fsuid;
1197         __u32          fsgid;
1198         __u32          capability;
1199         __u32          mode;
1200         __u32          uid;
1201         __u32          gid;
1202         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1203         __u32          rdev;
1204         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1205         __u32          generation; /* for 1.6 compatibility */
1206         __u32          suppgid;
1207         __u32          eadatasize;
1208         __u32          aclsize;
1209         __u32          max_mdsize;
1210         __u32          max_cookiesize;
1211         __u32          padding_4; /* also fix lustre_swab_mdt_body */
1212         __u64          padding_5;
1213         __u64          padding_6;
1214         __u64          padding_7;
1215         __u64          padding_8;
1216         __u64          padding_9;
1217         __u64          padding_10;
1218 };
1219
1220 struct mds_body {
1221         struct ll_fid  fid1;
1222         struct ll_fid  fid2;
1223         struct lustre_handle handle;
1224         __u64          valid;
1225         __u64          size;   /* Offset, in the case of MDS_READPAGE */
1226         __u64          mtime;
1227         __u64          atime;
1228         __u64          ctime;
1229         __u64          blocks; /* XID, in the case of MDS_READPAGE */
1230         __u64          io_epoch;
1231         __u64          ino;
1232         __u32          fsuid;
1233         __u32          fsgid;
1234         __u32          capability;
1235         __u32          mode;
1236         __u32          uid;
1237         __u32          gid;
1238         __u32          flags; /* from vfs for pin/unpin, MDS_BFLAG for close */
1239         __u32          rdev;
1240         __u32          nlink; /* #bytes to read in the case of MDS_READPAGE */
1241         __u32          generation;
1242         __u32          suppgid;
1243         __u32          eadatasize;
1244         __u32          aclsize;
1245         __u32          max_mdsize;
1246         __u32          max_cookiesize;
1247         __u32          padding_4; /* also fix lustre_swab_mds_body */
1248 };
1249
1250 extern void lustre_swab_mds_body (struct mds_body *b);
1251 extern void lustre_swab_mdt_body (struct mdt_body *b);
1252
1253 struct mdt_epoch {
1254         struct lustre_handle handle;
1255         __u64  ioepoch;
1256         __u32  flags;
1257         __u32  padding;
1258 };
1259
1260 extern void lustre_swab_mdt_epoch (struct mdt_epoch *b);
1261
1262 #define Q_QUOTACHECK    0x800100
1263 #define Q_INITQUOTA     0x800101        /* init slave limits */
1264 #define Q_GETOINFO      0x800102        /* get obd quota info */
1265 #define Q_GETOQUOTA     0x800103        /* get obd quotas */
1266 #define Q_FINVALIDATE   0x800104        /* invalidate operational quotas */
1267
1268 #define Q_TYPEMATCH(id, type) \
1269         ((id) == (type) || (id) == UGQUOTA)
1270
1271 #define Q_TYPESET(oqc, type) Q_TYPEMATCH((oqc)->qc_type, type)
1272
1273 #define Q_GETOCMD(oqc) \
1274         ((oqc)->qc_cmd == Q_GETOINFO || (oqc)->qc_cmd == Q_GETOQUOTA)
1275
1276 #define QCTL_COPY(out, in)              \
1277 do {                                    \
1278         Q_COPY(out, in, qc_cmd);        \
1279         Q_COPY(out, in, qc_type);       \
1280         Q_COPY(out, in, qc_id);         \
1281         Q_COPY(out, in, qc_stat);       \
1282         Q_COPY(out, in, qc_dqinfo);     \
1283         Q_COPY(out, in, qc_dqblk);      \
1284 } while (0)
1285
1286 struct obd_quotactl {
1287         __u32                   qc_cmd;
1288         __u32                   qc_type;
1289         __u32                   qc_id;
1290         __u32                   qc_stat;
1291         struct obd_dqinfo       qc_dqinfo;
1292         struct obd_dqblk        qc_dqblk;
1293 };
1294
1295 extern void lustre_swab_obd_quotactl(struct obd_quotactl *q);
1296
1297 struct quota_adjust_qunit {
1298         __u32 qaq_flags;
1299         __u32 qaq_id;
1300         __u64 qaq_bunit_sz;
1301         __u64 qaq_iunit_sz;
1302         __u64 padding1;
1303 };
1304 extern void lustre_swab_quota_adjust_qunit(struct quota_adjust_qunit *q);
1305
1306 /* flags in qunit_data and quota_adjust_qunit will use macroes below */
1307 #define LQUOTA_FLAGS_GRP       1UL   /* 0 is user, 1 is group */
1308 #define LQUOTA_FLAGS_BLK       2UL   /* 0 is inode, 1 is block */
1309 #define LQUOTA_FLAGS_ADJBLK    4UL   /* adjust the block qunit size */
1310 #define LQUOTA_FLAGS_ADJINO    8UL   /* adjust the inode qunit size */
1311 #define LQUOTA_FLAGS_CHG_QS   16UL   /* indicate whether it has capability of
1312                                       * OBD_CONNECT_CHANGE_QS */
1313
1314 /* the status of lqsk_flags in struct lustre_qunit_size_key */
1315 #define LQUOTA_QUNIT_FLAGS (LQUOTA_FLAGS_GRP | LQUOTA_FLAGS_BLK)
1316
1317 #define QAQ_IS_GRP(qaq)    ((qaq)->qaq_flags & LQUOTA_FLAGS_GRP)
1318 #define QAQ_IS_ADJBLK(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJBLK)
1319 #define QAQ_IS_ADJINO(qaq) ((qaq)->qaq_flags & LQUOTA_FLAGS_ADJINO)
1320
1321 #define QAQ_SET_GRP(qaq)    ((qaq)->qaq_flags |= LQUOTA_FLAGS_GRP)
1322 #define QAQ_SET_ADJBLK(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJBLK)
1323 #define QAQ_SET_ADJINO(qaq) ((qaq)->qaq_flags |= LQUOTA_FLAGS_ADJINO)
1324
1325 /* inode access permission for remote user, the inode info are omitted,
1326  * for client knows them. */
1327 struct mds_remote_perm {
1328         __u32           rp_uid;
1329         __u32           rp_gid;
1330         __u32           rp_fsuid;
1331         __u32           rp_fsgid;
1332         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1333 };
1334
1335 /* permissions for md_perm.mp_perm */
1336 enum {
1337         CFS_SETUID_PERM = 0x01,
1338         CFS_SETGID_PERM = 0x02,
1339         CFS_SETGRP_PERM = 0x04,
1340         CFS_RMTACL_PERM = 0x08,
1341         CFS_RMTOWN_PERM = 0x10
1342 };
1343
1344 extern void lustre_swab_mds_remote_perm(struct mds_remote_perm *p);
1345
1346 struct mdt_remote_perm {
1347         __u32           rp_uid;
1348         __u32           rp_gid;
1349         __u32           rp_fsuid;
1350         __u32           rp_fsgid;
1351         __u32           rp_access_perm; /* MAY_READ/WRITE/EXEC */
1352 };
1353
1354 extern void lustre_swab_mdt_remote_perm(struct mdt_remote_perm *p);
1355
1356 struct mds_rec_setattr {
1357         __u32           sa_opcode;
1358         __u32           sa_fsuid;
1359         __u32           sa_fsgid;
1360         __u32           sa_cap;
1361         __u32           sa_suppgid;
1362         __u32           sa_mode;
1363         struct ll_fid   sa_fid;
1364         __u64           sa_valid; /* MDS_ATTR_* attributes */
1365         __u64           sa_size;
1366         __u64           sa_mtime;
1367         __u64           sa_atime;
1368         __u64           sa_ctime;
1369         __u32           sa_uid;
1370         __u32           sa_gid;
1371         __u32           sa_attr_flags;
1372         __u32           sa_padding; /* also fix lustre_swab_mds_rec_setattr */
1373 };
1374
1375 extern void lustre_swab_mds_rec_setattr (struct mds_rec_setattr *sa);
1376
1377 struct mdt_rec_setattr {
1378         __u32           sa_opcode;
1379         __u32           sa_cap;
1380         __u32           sa_fsuid;
1381         __u32           sa_fsuid_h;
1382         __u32           sa_fsgid;
1383         __u32           sa_fsgid_h;
1384         __u32           sa_suppgid;
1385         __u32           sa_suppgid_h;
1386         __u32           sa_padding_1;
1387         __u32           sa_padding_1_h;
1388         struct lu_fid   sa_fid;
1389         __u64           sa_valid;
1390         __u32           sa_uid;
1391         __u32           sa_gid;
1392         __u64           sa_size;
1393         __u64           sa_blocks;
1394         __u64           sa_mtime;
1395         __u64           sa_atime;
1396         __u64           sa_ctime;
1397         __u32           sa_attr_flags;
1398         __u32           sa_mode;
1399         __u32           sa_padding_2;
1400         __u32           sa_padding_3;
1401         __u32           sa_padding_4;
1402         __u32           sa_padding_5;
1403 };
1404
1405 extern void lustre_swab_mdt_rec_setattr (struct mdt_rec_setattr *sa);
1406
1407 /*
1408  * Attribute flags used in mds_rec_setattr::sa_valid.
1409  * The kernel's #defines for ATTR_* should not be used over the network
1410  * since the client and MDS may run different kernels (see bug 13828)
1411  * Therefore, we should only use MDS_ATTR_* attributes for sa_valid.
1412  */
1413 #define MDS_ATTR_MODE          0x1ULL /* = 1 */
1414 #define MDS_ATTR_UID           0x2ULL /* = 2 */
1415 #define MDS_ATTR_GID           0x4ULL /* = 4 */
1416 #define MDS_ATTR_SIZE          0x8ULL /* = 8 */
1417 #define MDS_ATTR_ATIME        0x10ULL /* = 16 */
1418 #define MDS_ATTR_MTIME        0x20ULL /* = 32 */
1419 #define MDS_ATTR_CTIME        0x40ULL /* = 64 */
1420 #define MDS_ATTR_ATIME_SET    0x80ULL /* = 128 */
1421 #define MDS_ATTR_MTIME_SET   0x100ULL /* = 256 */
1422 #define MDS_ATTR_FORCE       0x200ULL /* = 512, Not a change, but a change it */
1423 #define MDS_ATTR_ATTR_FLAG   0x400ULL /* = 1024 */
1424 #define MDS_ATTR_KILL_SUID   0x800ULL /* = 2048 */
1425 #define MDS_ATTR_KILL_SGID  0x1000ULL /* = 4096 */
1426 #define MDS_ATTR_CTIME_SET  0x2000ULL /* = 8192 */
1427 #define MDS_ATTR_FROM_OPEN  0x4000ULL /* = 16384, called from open path, ie O_TRUNC */
1428 #define MDS_ATTR_BLOCKS     0x8000ULL /* = 32768 */
1429
1430 #ifndef FMODE_READ
1431 #define FMODE_READ               00000001
1432 #define FMODE_WRITE              00000002
1433 #endif
1434
1435 #define FMODE_EPOCH              01000000
1436 #define FMODE_EPOCHLCK           02000000
1437 #define FMODE_SOM                04000000
1438 #define FMODE_CLOSED             0
1439
1440 #define MDS_OPEN_CREATED         00000010
1441 #define MDS_OPEN_CROSS           00000020
1442
1443 #define MDS_FMODE_EXEC           00000004
1444 #define MDS_OPEN_CREAT           00000100
1445 #define MDS_OPEN_EXCL            00000200
1446 #define MDS_OPEN_TRUNC           00001000
1447 #define MDS_OPEN_APPEND          00002000
1448 #define MDS_OPEN_SYNC            00010000
1449 #define MDS_OPEN_DIRECTORY       00200000
1450
1451 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1452 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1453 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file*/
1454 #define MDS_CREATE_RMT_ACL    01000000000 /* indicate create on remote server
1455                                            * with default ACL */
1456 #define MDS_CREATE_SLAVE_OBJ  02000000000 /* indicate create slave object
1457                                            * actually, this is for create, not
1458                                            * conflict with other open flags */
1459 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1460 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1461 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1462
1463 /* permission for create non-directory file */
1464 #define MAY_CREATE      (1 << 7)
1465 /* permission for create directory file */
1466 #define MAY_LINK        (1 << 8)
1467 /* permission for delete from the directory */
1468 #define MAY_UNLINK      (1 << 9)
1469 /* source's permission for rename */
1470 #define MAY_RENAME_SRC  (1 << 10)
1471 /* target's permission for rename */
1472 #define MAY_RENAME_TAR  (1 << 11)
1473 /* part (parent's) VTX permission check */
1474 #define MAY_VTX_PART    (1 << 12)
1475 /* full VTX permission check */
1476 #define MAY_VTX_FULL    (1 << 13)
1477 /* lfs rgetfacl permission check */
1478 #define MAY_RGETFACL    (1 << 14)
1479
1480 enum {
1481         MDS_CHECK_SPLIT  = 1 << 0,
1482         MDS_CROSS_REF    = 1 << 1,
1483         MDS_VTX_BYPASS   = 1 << 2,
1484         MDS_PERM_BYPASS  = 1 << 3,
1485         MDS_SOM          = 1 << 4,
1486         MDS_QUOTA_IGNORE = 1 << 5
1487 };
1488
1489 struct mds_rec_join {
1490         struct ll_fid  jr_fid;
1491         __u64          jr_headsize;
1492 };
1493
1494 extern void lustre_swab_mds_rec_join (struct mds_rec_join *jr);
1495
1496 struct mdt_rec_join {
1497         struct lu_fid  jr_fid;
1498         __u64          jr_headsize;
1499 };
1500
1501 extern void lustre_swab_mdt_rec_join (struct mdt_rec_join *jr);
1502
1503 struct mds_rec_create {
1504         __u32           cr_opcode;
1505         __u32           cr_fsuid;
1506         __u32           cr_fsgid;
1507         __u32           cr_cap;
1508         __u32           cr_flags; /* for use with open */
1509         __u32           cr_mode;
1510         struct ll_fid   cr_fid;
1511         struct ll_fid   cr_replayfid;
1512         __u64           cr_time;
1513         __u64           cr_rdev;
1514         __u32           cr_suppgid;
1515         __u32           cr_padding_1; /* also fix lustre_swab_mds_rec_create */
1516         __u32           cr_padding_2; /* also fix lustre_swab_mds_rec_create */
1517         __u32           cr_padding_3; /* also fix lustre_swab_mds_rec_create */
1518         __u32           cr_padding_4; /* also fix lustre_swab_mds_rec_create */
1519         __u32           cr_padding_5; /* also fix lustre_swab_mds_rec_create */
1520 };
1521
1522 extern void lustre_swab_mds_rec_create (struct mds_rec_create *cr);
1523
1524 struct mdt_rec_create {
1525         __u32           cr_opcode;
1526         __u32           cr_cap;
1527         __u32           cr_fsuid;
1528         __u32           cr_fsuid_h;
1529         __u32           cr_fsgid;
1530         __u32           cr_fsgid_h;
1531         __u32           cr_suppgid1;
1532         __u32           cr_suppgid1_h;
1533         __u32           cr_suppgid2;
1534         __u32           cr_suppgid2_h;
1535         struct lu_fid   cr_fid1;
1536         struct lu_fid   cr_fid2;
1537         struct lustre_handle cr_old_handle; /* u64 handle in case of open replay */
1538         __u64           cr_time;
1539         __u64           cr_rdev;
1540         __u64           cr_ioepoch;
1541         __u64           cr_padding_1; /* pad for 64 bits*/
1542         __u32           cr_mode;
1543         __u32           cr_bias;
1544         __u32           cr_flags;     /* for use with open */
1545         __u32           cr_padding_2;
1546         __u32           cr_padding_3;
1547         __u32           cr_padding_4;
1548 };
1549
1550 extern void lustre_swab_mdt_rec_create (struct mdt_rec_create *cr);
1551
1552 struct mds_rec_link {
1553         __u32           lk_opcode;
1554         __u32           lk_fsuid;
1555         __u32           lk_fsgid;
1556         __u32           lk_cap;
1557         __u32           lk_suppgid1;
1558         __u32           lk_suppgid2;
1559         struct ll_fid   lk_fid1;
1560         struct ll_fid   lk_fid2;
1561         __u64           lk_time;
1562         __u32           lk_padding_1;  /* also fix lustre_swab_mds_rec_link */
1563         __u32           lk_padding_2;  /* also fix lustre_swab_mds_rec_link */
1564         __u32           lk_padding_3;  /* also fix lustre_swab_mds_rec_link */
1565         __u32           lk_padding_4;  /* also fix lustre_swab_mds_rec_link */
1566 };
1567
1568 extern void lustre_swab_mds_rec_link (struct mds_rec_link *lk);
1569
1570 struct mdt_rec_link {
1571         __u32           lk_opcode;
1572         __u32           lk_cap;
1573         __u32           lk_fsuid;
1574         __u32           lk_fsuid_h;
1575         __u32           lk_fsgid;
1576         __u32           lk_fsgid_h;
1577         __u32           lk_suppgid1;
1578         __u32           lk_suppgid1_h;
1579         __u32           lk_suppgid2;
1580         __u32           lk_suppgid2_h;
1581         struct lu_fid   lk_fid1;
1582         struct lu_fid   lk_fid2;
1583         __u64           lk_time;
1584         __u64           lk_padding_1;
1585         __u64           lk_padding_2;
1586         __u64           lk_padding_3;
1587         __u64           lk_padding_4;
1588         __u32           lk_bias;
1589         __u32           lk_padding_5;
1590         __u32           lk_padding_6;
1591         __u32           lk_padding_7;
1592         __u32           lk_padding_8;
1593         __u32           lk_padding_9;
1594 };
1595
1596 struct mds_rec_unlink {
1597         __u32           ul_opcode;
1598         __u32           ul_fsuid;
1599         __u32           ul_fsgid;
1600         __u32           ul_cap;
1601         __u32           ul_suppgid;
1602         __u32           ul_mode;
1603         struct ll_fid   ul_fid1;
1604         struct ll_fid   ul_fid2;
1605         __u64           ul_time;
1606         __u32           ul_padding_1; /* also fix lustre_swab_mds_rec_unlink */
1607         __u32           ul_padding_2; /* also fix lustre_swab_mds_rec_unlink */
1608         __u32           ul_padding_3; /* also fix lustre_swab_mds_rec_unlink */
1609         __u32           ul_padding_4; /* also fix lustre_swab_mds_rec_unlink */
1610 };
1611
1612 extern void lustre_swab_mds_rec_unlink (struct mds_rec_unlink *ul);
1613
1614 struct mdt_rec_unlink {
1615         __u32           ul_opcode;
1616         __u32           ul_cap;
1617         __u32           ul_fsuid;
1618         __u32           ul_fsuid_h;
1619         __u32           ul_fsgid;
1620         __u32           ul_fsgid_h;
1621         __u32           ul_suppgid1;
1622         __u32           ul_suppgid1_h;
1623         __u32           ul_suppgid2;
1624         __u32           ul_suppgid2_h;
1625         struct lu_fid   ul_fid1;
1626         struct lu_fid   ul_fid2;
1627         __u64           ul_time;
1628         __u64           ul_padding_2;
1629         __u64           ul_padding_3;
1630         __u64           ul_padding_4;
1631         __u64           ul_padding_5;
1632         __u32           ul_bias;
1633         __u32           ul_mode;
1634         __u32           ul_padding_6;
1635         __u32           ul_padding_7;
1636         __u32           ul_padding_8;
1637         __u32           ul_padding_9;
1638 };
1639
1640 struct mds_rec_rename {
1641         __u32           rn_opcode;
1642         __u32           rn_fsuid;
1643         __u32           rn_fsgid;
1644         __u32           rn_cap;
1645         __u32           rn_suppgid1;
1646         __u32           rn_suppgid2;
1647         struct ll_fid   rn_fid1;
1648         struct ll_fid   rn_fid2;
1649         __u64           rn_time;
1650         __u32           rn_padding_1; /* also fix lustre_swab_mds_rec_rename */
1651         __u32           rn_padding_2; /* also fix lustre_swab_mds_rec_rename */
1652         __u32           rn_padding_3; /* also fix lustre_swab_mds_rec_rename */
1653         __u32           rn_padding_4; /* also fix lustre_swab_mds_rec_rename */
1654 };
1655
1656 extern void lustre_swab_mds_rec_rename (struct mds_rec_rename *rn);
1657
1658 struct mdt_rec_rename {
1659         __u32           rn_opcode;
1660         __u32           rn_cap;
1661         __u32           rn_fsuid;
1662         __u32           rn_fsuid_h;
1663         __u32           rn_fsgid;
1664         __u32           rn_fsgid_h;
1665         __u32           rn_suppgid1;
1666         __u32           rn_suppgid1_h;
1667         __u32           rn_suppgid2;
1668         __u32           rn_suppgid2_h;
1669         struct lu_fid   rn_fid1;
1670         struct lu_fid   rn_fid2;
1671         __u64           rn_time;
1672         __u64           rn_padding_1;
1673         __u64           rn_padding_2;
1674         __u64           rn_padding_3;
1675         __u64           rn_padding_4;
1676         __u32           rn_bias;      /* some operation flags */
1677         __u32           rn_mode;      /* cross-ref rename has mode */
1678         __u32           rn_padding_5;
1679         __u32           rn_padding_6;
1680         __u32           rn_padding_7;
1681         __u32           rn_padding_8;
1682 };
1683
1684 struct mdt_rec_setxattr {
1685         __u32           sx_opcode;
1686         __u32           sx_cap;
1687         __u32           sx_fsuid;
1688         __u32           sx_fsuid_h;
1689         __u32           sx_fsgid;
1690         __u32           sx_fsgid_h;
1691         __u32           sx_suppgid1;
1692         __u32           sx_suppgid1_h;
1693         __u32           sx_suppgid2;
1694         __u32           sx_suppgid2_h;
1695         struct lu_fid   sx_fid;
1696         __u64           sx_padding_1; /* These three members are lu_fid size */
1697         __u32           sx_padding_2;
1698         __u32           sx_padding_3;
1699         __u64           sx_valid;
1700         __u64           sx_time;
1701         __u64           sx_padding_5;
1702         __u64           sx_padding_6;
1703         __u64           sx_padding_7;
1704         __u32           sx_size;
1705         __u32           sx_flags;
1706         __u32           sx_padding_8;
1707         __u32           sx_padding_9;
1708         __u32           sx_padding_10;
1709         __u32           sx_padding_11;
1710 };
1711
1712 struct mdt_rec_reint {
1713         __u32           rr_opcode;
1714         __u32           rr_cap;
1715         __u32           rr_fsuid;
1716         __u32           rr_fsuid_h;
1717         __u32           rr_fsgid;
1718         __u32           rr_fsgid_h;
1719         __u32           rr_suppgid1;
1720         __u32           rr_suppgid1_h;
1721         __u32           rr_suppgid2;
1722         __u32           rr_suppgid2_h;
1723         struct lu_fid   rr_fid1;
1724         struct lu_fid   rr_fid2;
1725         __u64           rr_mtime;
1726         __u64           rr_atime;
1727         __u64           rr_ctime;
1728         __u64           rr_size;
1729         __u64           rr_blocks;
1730         __u32           rr_bias;
1731         __u32           rr_mode;
1732         __u32           rr_padding_1; /* also fix lustre_swab_mdt_rec_reint */
1733         __u32           rr_padding_2; /* also fix lustre_swab_mdt_rec_reint */
1734         __u32           rr_padding_3; /* also fix lustre_swab_mdt_rec_reint */
1735         __u32           rr_padding_4; /* also fix lustre_swab_mdt_rec_reint */
1736 };
1737
1738 extern void lustre_swab_mdt_rec_reint(struct mdt_rec_reint *rr);
1739
1740 struct lmv_desc {
1741         __u32 ld_tgt_count;                /* how many MDS's */
1742         __u32 ld_active_tgt_count;         /* how many active */
1743         struct obd_uuid ld_uuid;
1744 };
1745
1746 extern void lustre_swab_lmv_desc (struct lmv_desc *ld);
1747
1748 struct md_fld {
1749         seqno_t mf_seq;
1750         mdsno_t mf_mds;
1751 };
1752
1753 extern void lustre_swab_md_fld (struct md_fld *mf);
1754
1755 enum fld_rpc_opc {
1756         FLD_QUERY                       = 600,
1757         FLD_LAST_OPC,
1758         FLD_FIRST_OPC                   = FLD_QUERY
1759 };
1760
1761 enum seq_rpc_opc {
1762         SEQ_QUERY                       = 700,
1763         SEQ_LAST_OPC,
1764         SEQ_FIRST_OPC                   = SEQ_QUERY
1765 };
1766
1767 enum seq_op {
1768         SEQ_ALLOC_SUPER = 0,
1769         SEQ_ALLOC_META = 1
1770 };
1771
1772 /*
1773  *  LOV data structures
1774  */
1775
1776 #define LOV_MIN_STRIPE_SIZE 65536   /* maximum PAGE_SIZE (ia64), power of 2 */
1777 #define LOV_MAX_STRIPE_COUNT  160   /* until bug 4424 is fixed */
1778 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
1779
1780 #define LOV_MAX_UUID_BUFFER_SIZE  8192
1781 /* The size of the buffer the lov/mdc reserves for the
1782  * array of UUIDs returned by the MDS.  With the current
1783  * protocol, this will limit the max number of OSTs per LOV */
1784
1785 #define LOV_DESC_MAGIC 0xB0CCDE5C
1786
1787 /* LOV settings descriptor (should only contain static info) */
1788 struct lov_desc {
1789         __u32 ld_tgt_count;                /* how many OBD's */
1790         __u32 ld_active_tgt_count;         /* how many active */
1791         __u32 ld_default_stripe_count;     /* how many objects are used */
1792         __u32 ld_pattern;                  /* default PATTERN_RAID0 */
1793         __u64 ld_default_stripe_size;      /* in bytes */
1794         __u64 ld_default_stripe_offset;    /* in bytes */
1795         __u32 ld_padding_0;                /* unused */
1796         __u32 ld_qos_maxage;               /* in second */
1797         __u32 ld_padding_1;                /* also fix lustre_swab_lov_desc */
1798         __u32 ld_padding_2;                /* also fix lustre_swab_lov_desc */
1799         struct obd_uuid ld_uuid;
1800 };
1801
1802 #define ld_magic ld_active_tgt_count       /* for swabbing from llogs */
1803
1804 extern void lustre_swab_lov_desc (struct lov_desc *ld);
1805
1806 /*
1807  *   LDLM requests:
1808  */
1809 /* opcodes -- MUST be distinct from OST/MDS opcodes */
1810 typedef enum {
1811         LDLM_ENQUEUE     = 101,
1812         LDLM_CONVERT     = 102,
1813         LDLM_CANCEL      = 103,
1814         LDLM_BL_CALLBACK = 104,
1815         LDLM_CP_CALLBACK = 105,
1816         LDLM_GL_CALLBACK = 106,
1817         LDLM_LAST_OPC
1818 } ldlm_cmd_t;
1819 #define LDLM_FIRST_OPC LDLM_ENQUEUE
1820
1821 #define RES_NAME_SIZE 4
1822 struct ldlm_res_id {
1823         __u64 name[RES_NAME_SIZE];
1824 };
1825
1826 extern void lustre_swab_ldlm_res_id (struct ldlm_res_id *id);
1827
1828 /* lock types */
1829 typedef enum {
1830         LCK_MINMODE = 0,
1831         LCK_EX      = 1,
1832         LCK_PW      = 2,
1833         LCK_PR      = 4,
1834         LCK_CW      = 8,
1835         LCK_CR      = 16,
1836         LCK_NL      = 32,
1837         LCK_GROUP   = 64,
1838         LCK_COS     = 128,
1839         LCK_MAXMODE
1840 } ldlm_mode_t;
1841
1842 #define LCK_MODE_NUM    8
1843
1844 typedef enum {
1845         LDLM_PLAIN     = 10,
1846         LDLM_EXTENT    = 11,
1847         LDLM_FLOCK     = 12,
1848         LDLM_IBITS     = 13,
1849         LDLM_MAX_TYPE
1850 } ldlm_type_t;
1851
1852 #define LDLM_MIN_TYPE LDLM_PLAIN
1853
1854 struct ldlm_extent {
1855         __u64 start;
1856         __u64 end;
1857         __u64 gid;
1858 };
1859
1860 static inline int ldlm_extent_overlap(struct ldlm_extent *ex1,
1861                                       struct ldlm_extent *ex2)
1862 {
1863         return (ex1->start <= ex2->end) && (ex2->start <= ex1->end);
1864 }
1865
1866 struct ldlm_inodebits {
1867         __u64 bits;
1868 };
1869
1870 struct ldlm_flock {
1871         __u64 start;
1872         __u64 end;
1873         __u64 blocking_export;  /* not actually used over the wire */
1874         __u32 blocking_pid;     /* not actually used over the wire */
1875         __u32 pid;
1876 };
1877
1878 /* it's important that the fields of the ldlm_extent structure match
1879  * the first fields of the ldlm_flock structure because there is only
1880  * one ldlm_swab routine to process the ldlm_policy_data_t union. if
1881  * this ever changes we will need to swab the union differently based
1882  * on the resource type. */
1883
1884 typedef union {
1885         struct ldlm_extent l_extent;
1886         struct ldlm_flock  l_flock;
1887         struct ldlm_inodebits l_inodebits;
1888 } ldlm_policy_data_t;
1889
1890 extern void lustre_swab_ldlm_policy_data (ldlm_policy_data_t *d);
1891
1892 struct ldlm_intent {
1893         __u64 opc;
1894 };
1895
1896 extern void lustre_swab_ldlm_intent (struct ldlm_intent *i);
1897
1898 struct ldlm_resource_desc {
1899         ldlm_type_t lr_type;
1900         __u32 lr_padding;       /* also fix lustre_swab_ldlm_resource_desc */
1901         struct ldlm_res_id lr_name;
1902 };
1903
1904 extern void lustre_swab_ldlm_resource_desc (struct ldlm_resource_desc *r);
1905
1906 struct ldlm_lock_desc {
1907         struct ldlm_resource_desc l_resource;
1908         ldlm_mode_t l_req_mode;
1909         ldlm_mode_t l_granted_mode;
1910         ldlm_policy_data_t l_policy_data;
1911 };
1912
1913 extern void lustre_swab_ldlm_lock_desc (struct ldlm_lock_desc *l);
1914
1915 #define LDLM_LOCKREQ_HANDLES 2
1916 #define LDLM_ENQUEUE_CANCEL_OFF 1
1917
1918 struct ldlm_request {
1919         __u32 lock_flags;
1920         __u32 lock_count;
1921         struct ldlm_lock_desc lock_desc;
1922         struct lustre_handle lock_handle[LDLM_LOCKREQ_HANDLES];
1923 };
1924
1925 extern void lustre_swab_ldlm_request (struct ldlm_request *rq);
1926
1927 /* If LDLM_ENQUEUE, 1 slot is already occupied, 1 is available.
1928  * Otherwise, 2 are available. */
1929 #define ldlm_request_bufsize(count,type)                                \
1930 ({                                                                      \
1931         int _avail = LDLM_LOCKREQ_HANDLES;                              \
1932         _avail -= (type == LDLM_ENQUEUE ? LDLM_ENQUEUE_CANCEL_OFF : 0); \
1933         sizeof(struct ldlm_request) +                                   \
1934         (count > _avail ? count - _avail : 0) *                         \
1935         sizeof(struct lustre_handle);                                   \
1936 })
1937
1938 struct ldlm_reply {
1939         __u32 lock_flags;
1940         __u32 lock_padding;     /* also fix lustre_swab_ldlm_reply */
1941         struct ldlm_lock_desc lock_desc;
1942         struct lustre_handle lock_handle;
1943         __u64  lock_policy_res1;
1944         __u64  lock_policy_res2;
1945 };
1946
1947 extern void lustre_swab_ldlm_reply (struct ldlm_reply *r);
1948
1949 /*
1950  * Opcodes for mountconf (mgs and mgc)
1951  */
1952 typedef enum {
1953         MGS_CONNECT = 250,
1954         MGS_DISCONNECT,
1955         MGS_EXCEPTION,         /* node died, etc. */
1956         MGS_TARGET_REG,        /* whenever target starts up */
1957         MGS_TARGET_DEL,
1958         MGS_SET_INFO,
1959         MGS_LAST_OPC
1960 } mgs_cmd_t;
1961 #define MGS_FIRST_OPC MGS_CONNECT
1962
1963 #define MGS_PARAM_MAXLEN 1024
1964 #define KEY_SET_INFO "set_info"
1965
1966 struct mgs_send_param {
1967         char             mgs_param[MGS_PARAM_MAXLEN];
1968 };
1969
1970 /* We pass this info to the MGS so it can write config logs */
1971 #define MTI_NAME_MAXLEN 64
1972 #define MTI_PARAM_MAXLEN 4096
1973 #define MTI_NIDS_MAX 32
1974 struct mgs_target_info {
1975         __u32            mti_lustre_ver;
1976         __u32            mti_stripe_index;
1977         __u32            mti_config_ver;
1978         __u32            mti_flags;
1979         __u32            mti_nid_count;
1980         __u32            padding;                    /* 64 bit align */
1981         char             mti_fsname[MTI_NAME_MAXLEN];
1982         char             mti_svname[MTI_NAME_MAXLEN];
1983         char             mti_uuid[sizeof(struct obd_uuid)];
1984         __u64            mti_nids[MTI_NIDS_MAX];     /* host nids (lnet_nid_t)*/
1985         char             mti_params[MTI_PARAM_MAXLEN];
1986 };
1987
1988 extern void lustre_swab_mgs_target_info(struct mgs_target_info *oinfo);
1989
1990 /* Config marker flags (in config log) */
1991 #define CM_START       0x01
1992 #define CM_END         0x02
1993 #define CM_SKIP        0x04
1994 #define CM_UPGRADE146  0x08
1995 #define CM_EXCLUDE     0x10
1996 #define CM_START_SKIP (CM_START | CM_SKIP)
1997
1998 struct cfg_marker {
1999         __u32             cm_step;       /* aka config version */
2000         __u32             cm_flags;
2001         __u32             cm_vers;       /* lustre release version number */
2002         __u32             padding;       /* 64 bit align */
2003         __u64             cm_createtime; /*when this record was first created */
2004         __u64             cm_canceltime; /*when this record is no longer valid*/
2005         char              cm_tgtname[MTI_NAME_MAXLEN];
2006         char              cm_comment[MTI_NAME_MAXLEN];
2007 };
2008
2009 extern void lustre_swab_cfg_marker(struct cfg_marker *marker,
2010                                    int swab, int size);
2011
2012 /*
2013  * Opcodes for multiple servers.
2014  */
2015
2016 typedef enum {
2017         OBD_PING = 400,
2018         OBD_LOG_CANCEL,
2019         OBD_QC_CALLBACK,
2020         OBD_LAST_OPC
2021 } obd_cmd_t;
2022 #define OBD_FIRST_OPC OBD_PING
2023
2024 /* catalog of log objects */
2025
2026 /** Identifier for a single log object */
2027 struct llog_logid {
2028         __u64                   lgl_oid;
2029         __u64                   lgl_ogr;
2030         __u32                   lgl_ogen;
2031 } __attribute__((packed));
2032
2033 /** Records written to the CATALOGS list */
2034 #define CATLIST "CATALOGS"
2035 struct llog_catid {
2036         struct llog_logid       lci_logid;
2037         __u32                   lci_padding1;
2038         __u32                   lci_padding2;
2039         __u32                   lci_padding3;
2040 } __attribute__((packed));
2041
2042 /** join file lov mds md*/
2043 struct lov_mds_md_join {
2044         struct lov_mds_md lmmj_md;
2045         /*join private info*/
2046         struct llog_logid lmmj_array_id; /*array object id*/
2047         __u32  lmmj_extent_count;        /*array extent count*/
2048 };
2049
2050 /* Log data record types - there is no specific reason that these need to
2051  * be related to the RPC opcodes, but no reason not to (may be handy later?)
2052  */
2053 #define LLOG_OP_MAGIC 0x10600000
2054 #define LLOG_OP_MASK  0xfff00000
2055
2056 typedef enum {
2057         LLOG_PAD_MAGIC   = LLOG_OP_MAGIC | 0x00000,
2058         OST_SZ_REC       = LLOG_OP_MAGIC | 0x00f00,
2059         OST_RAID1_REC    = LLOG_OP_MAGIC | 0x01000,
2060         MDS_UNLINK_REC   = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_UNLINK,
2061         MDS_SETATTR_REC  = LLOG_OP_MAGIC | 0x10000 | (MDS_REINT << 8) | REINT_SETATTR,
2062         MDS_SETATTR64_REC= LLOG_OP_MAGIC | 0x90000 | (MDS_REINT << 8) | REINT_SETATTR,
2063         OBD_CFG_REC      = LLOG_OP_MAGIC | 0x20000,
2064         PTL_CFG_REC      = LLOG_OP_MAGIC | 0x30000, /* obsolete */
2065         LLOG_GEN_REC     = LLOG_OP_MAGIC | 0x40000,
2066         LLOG_JOIN_REC    = LLOG_OP_MAGIC | 0x50000,
2067         LLOG_HDR_MAGIC   = LLOG_OP_MAGIC | 0x45539,
2068         LLOG_LOGID_MAGIC = LLOG_OP_MAGIC | 0x4553b,
2069 } llog_op_type;
2070
2071 /*
2072  * for now, continue to support old pad records which have 0 for their
2073  * type but still need to be swabbed for their length
2074  */
2075 #define LLOG_REC_HDR_NEEDS_SWABBING(r)                                  \
2076         (((r)->lrh_type & __swab32(LLOG_OP_MASK)) ==                    \
2077          __swab32(LLOG_OP_MAGIC) ||                                     \
2078          (((r)->lrh_type == 0) && ((r)->lrh_len > LLOG_CHUNK_SIZE)))
2079
2080 /** Log record header - stored in little endian order.
2081  * Each record must start with this struct, end with a llog_rec_tail,
2082  * and be a multiple of 256 bits in size.
2083  */
2084 struct llog_rec_hdr {
2085         __u32                   lrh_len;
2086         __u32                   lrh_index;
2087         __u32                   lrh_type;
2088         __u32                   padding;
2089 };
2090
2091 struct llog_rec_tail {
2092         __u32 lrt_len;
2093         __u32 lrt_index;
2094 };
2095
2096 struct llog_logid_rec {
2097         struct llog_rec_hdr     lid_hdr;
2098         struct llog_logid       lid_id;
2099         __u32                   padding1;
2100         __u32                   padding2;
2101         __u32                   padding3;
2102         __u32                   padding4;
2103         __u32                   padding5;
2104         struct llog_rec_tail    lid_tail;
2105 } __attribute__((packed));
2106
2107 /** MDS extent description
2108  * It is for joined file extent info, each extent info for joined file
2109  * just like (start, end, lmm).
2110  */
2111 struct mds_extent_desc {
2112         __u64                   med_start; /* extent start */
2113         __u64                   med_len;   /* extent length */
2114         struct lov_mds_md       med_lmm;   /* extent's lmm  */
2115 };
2116
2117 /** Joined file array extent log record*/
2118 struct llog_array_rec {
2119         struct llog_rec_hdr     lmr_hdr;
2120         struct mds_extent_desc  lmr_med;
2121         struct llog_rec_tail    lmr_tail;
2122 };
2123
2124 struct llog_create_rec {
2125         struct llog_rec_hdr     lcr_hdr;
2126         struct ll_fid           lcr_fid;
2127         obd_id                  lcr_oid;
2128         obd_count               lcr_ogen;
2129         __u32                   padding;
2130         struct llog_rec_tail    lcr_tail;
2131 } __attribute__((packed));
2132
2133 struct llog_orphan_rec {
2134         struct llog_rec_hdr     lor_hdr;
2135         obd_id                  lor_oid;
2136         obd_count               lor_ogen;
2137         __u32                   padding;
2138         struct llog_rec_tail    lor_tail;
2139 } __attribute__((packed));
2140
2141 struct llog_unlink_rec {
2142         struct llog_rec_hdr     lur_hdr;
2143         obd_id                  lur_oid;
2144         obd_count               lur_ogen;
2145         __u32                   padding;
2146         struct llog_rec_tail    lur_tail;
2147 } __attribute__((packed));
2148
2149 struct llog_setattr_rec {
2150         struct llog_rec_hdr     lsr_hdr;
2151         obd_id                  lsr_oid;
2152         obd_count               lsr_ogen;
2153         __u32                   lsr_uid;
2154         __u32                   lsr_gid;
2155         __u32                   padding;
2156         struct llog_rec_tail    lsr_tail;
2157 } __attribute__((packed));
2158
2159 struct llog_setattr64_rec {
2160         struct llog_rec_hdr     lsr_hdr;
2161         obd_id                  lsr_oid;
2162         obd_count               lsr_ogen;
2163         __u32                   padding;
2164         __u32                   lsr_uid;
2165         __u32                   lsr_uid_h;
2166         __u32                   lsr_gid;
2167         __u32                   lsr_gid_h;
2168         struct llog_rec_tail    lsr_tail;
2169 } __attribute__((packed));
2170
2171 struct llog_size_change_rec {
2172         struct llog_rec_hdr     lsc_hdr;
2173         struct ll_fid           lsc_fid;
2174         __u32                   lsc_ioepoch;
2175         __u32                   padding;
2176         struct llog_rec_tail    lsc_tail;
2177 } __attribute__((packed));
2178
2179 struct llog_gen {
2180         __u64 mnt_cnt;
2181         __u64 conn_cnt;
2182 } __attribute__((packed));
2183
2184 struct llog_gen_rec {
2185         struct llog_rec_hdr     lgr_hdr;
2186         struct llog_gen         lgr_gen;
2187         struct llog_rec_tail    lgr_tail;
2188 };
2189 /* On-disk header structure of each log object, stored in little endian order */
2190 #define LLOG_CHUNK_SIZE         8192
2191 #define LLOG_HEADER_SIZE        (96)
2192 #define LLOG_BITMAP_BYTES       (LLOG_CHUNK_SIZE - LLOG_HEADER_SIZE)
2193
2194 #define LLOG_MIN_REC_SIZE       (24) /* round(llog_rec_hdr + llog_rec_tail) */
2195
2196 /* flags for the logs */
2197 #define LLOG_F_ZAP_WHEN_EMPTY   0x1
2198 #define LLOG_F_IS_CAT           0x2
2199 #define LLOG_F_IS_PLAIN         0x4
2200
2201 struct llog_log_hdr {
2202         struct llog_rec_hdr     llh_hdr;
2203         __u64                   llh_timestamp;
2204         __u32                   llh_count;
2205         __u32                   llh_bitmap_offset;
2206         __u32                   llh_size;
2207         __u32                   llh_flags;
2208         __u32                   llh_cat_idx;
2209         /* for a catalog the first plain slot is next to it */
2210         struct obd_uuid         llh_tgtuuid;
2211         __u32                   llh_reserved[LLOG_HEADER_SIZE/sizeof(__u32) - 23];
2212         __u32                   llh_bitmap[LLOG_BITMAP_BYTES/sizeof(__u32)];
2213         struct llog_rec_tail    llh_tail;
2214 } __attribute__((packed));
2215
2216 #define LLOG_BITMAP_SIZE(llh)  ((llh->llh_hdr.lrh_len -         \
2217                                  llh->llh_bitmap_offset -       \
2218                                  sizeof(llh->llh_tail)) * 8)
2219
2220 /** log cookies are used to reference a specific log file and a record therein */
2221 struct llog_cookie {
2222         struct llog_logid       lgc_lgl;
2223         __u32                   lgc_subsys;
2224         __u32                   lgc_index;
2225         __u32                   lgc_padding;
2226 } __attribute__((packed));
2227
2228 /** llog protocol */
2229 enum llogd_rpc_ops {
2230         LLOG_ORIGIN_HANDLE_CREATE       = 501,
2231         LLOG_ORIGIN_HANDLE_NEXT_BLOCK   = 502,
2232         LLOG_ORIGIN_HANDLE_READ_HEADER  = 503,
2233         LLOG_ORIGIN_HANDLE_WRITE_REC    = 504,
2234         LLOG_ORIGIN_HANDLE_CLOSE        = 505,
2235         LLOG_ORIGIN_CONNECT             = 506,
2236         LLOG_CATINFO                    = 507,  /* for lfs catinfo */
2237         LLOG_ORIGIN_HANDLE_PREV_BLOCK   = 508,
2238         LLOG_ORIGIN_HANDLE_DESTROY      = 509,  /* for destroy llog object*/
2239         LLOG_LAST_OPC,
2240         LLOG_FIRST_OPC                  = LLOG_ORIGIN_HANDLE_CREATE
2241 };
2242
2243 struct llogd_body {
2244         struct llog_logid  lgd_logid;
2245         __u32 lgd_ctxt_idx;
2246         __u32 lgd_llh_flags;
2247         __u32 lgd_index;
2248         __u32 lgd_saved_index;
2249         __u32 lgd_len;
2250         __u64 lgd_cur_offset;
2251 } __attribute__((packed));
2252
2253 struct llogd_conn_body {
2254         struct llog_gen         lgdc_gen;
2255         struct llog_logid       lgdc_logid;
2256         __u32                   lgdc_ctxt_idx;
2257 } __attribute__((packed));
2258
2259 struct lov_user_ost_data_join {   /* per-stripe data structure */
2260         __u64 l_extent_start;     /* extent start*/
2261         __u64 l_extent_end;       /* extent end*/
2262         __u64 l_object_id;        /* OST object ID */
2263         __u64 l_object_gr;        /* OST object group (creating MDS number) */
2264         __u32 l_ost_gen;          /* generation of this OST index */
2265         __u32 l_ost_idx;          /* OST index in LOV */
2266 } __attribute__((packed));
2267
2268 struct lov_user_md_join {         /* LOV EA user data (host-endian) */
2269         __u32 lmm_magic;          /* magic number = LOV_MAGIC_JOIN */
2270         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
2271         __u64 lmm_object_id;      /* LOV object ID */
2272         __u64 lmm_object_gr;      /* LOV object group */
2273         __u32 lmm_stripe_size;    /* size of stripe in bytes */
2274         __u32 lmm_stripe_count;   /* num stripes in use for this object */
2275         __u32 lmm_extent_count;   /* extent count of lmm*/
2276         __u64 lmm_tree_id;        /* mds tree object id */
2277         __u64 lmm_tree_gen;       /* mds tree object gen */
2278         struct llog_logid lmm_array_id; /* mds extent desc llog object id */
2279         struct lov_user_ost_data_join lmm_objects[0]; /* per-stripe data */
2280 } __attribute__((packed));
2281
2282 /* Note: 64-bit types are 64-bit aligned in structure */
2283 struct obdo {
2284         obd_valid               o_valid;        /* hot fields in this obdo */
2285         obd_id                  o_id;
2286         obd_gr                  o_gr;
2287         obd_id                  o_fid;
2288         obd_size                o_size;         /* o_size-o_blocks == ost_lvb */
2289         obd_time                o_mtime;
2290         obd_time                o_atime;
2291         obd_time                o_ctime;
2292         obd_blocks              o_blocks;       /* brw: cli sent cached bytes */
2293         obd_size                o_grant;
2294
2295         /* 32-bit fields start here: keep an even number of them via padding */
2296         obd_blksize             o_blksize;      /* optimal IO blocksize */
2297         obd_mode                o_mode;         /* brw: cli sent cache remain */
2298         obd_uid                 o_uid;
2299         obd_gid                 o_gid;
2300         obd_flag                o_flags;
2301         obd_count               o_nlink;        /* brw: checksum */
2302         obd_count               o_generation;
2303         obd_count               o_misc;         /* brw: o_dropped */
2304         __u32                   o_easize;       /* epoch in ost writes */
2305         __u32                   o_mds;
2306         __u32                   o_stripe_idx;   /* holds stripe idx */
2307         __u32                   o_padding_1;
2308         struct lustre_handle    o_handle;       /* brw: lock handle to prolong locks */
2309         struct llog_cookie      o_lcookie;      /* destroy: unlink cookie from MDS */
2310
2311         __u64                   o_padding_2;
2312         __u64                   o_padding_3;
2313         __u64                   o_padding_4;
2314         __u64                   o_padding_5;
2315         __u64                   o_padding_6;
2316 };
2317
2318 #define o_dirty   o_blocks
2319 #define o_undirty o_mode
2320 #define o_dropped o_misc
2321 #define o_cksum   o_nlink
2322
2323 extern void lustre_swab_obdo (struct obdo *o);
2324
2325 /* request structure for OST's */
2326 struct ost_body {
2327         struct  obdo oa;
2328 };
2329
2330 /* Key for FIEMAP to be used in get_info calls */
2331 struct ll_fiemap_info_key {
2332         char    name[8];
2333         struct  obdo oa;
2334         struct  ll_user_fiemap fiemap;
2335 };
2336
2337 extern void lustre_swab_ost_body (struct ost_body *b);
2338 extern void lustre_swab_ost_last_id(obd_id *id);
2339 extern void lustre_swab_fiemap(struct ll_user_fiemap *fiemap);
2340
2341 extern void lustre_swab_lov_user_md_v1(struct lov_user_md_v1 *lum);
2342 extern void lustre_swab_lov_user_md_v3(struct lov_user_md_v3 *lum);
2343 extern void lustre_swab_lov_user_md_objects(struct lov_user_ost_data *lod,
2344                                             int stripe_count);
2345 extern void lustre_swab_lov_user_md_join(struct lov_user_md_join *lumj);
2346
2347 /* llog_swab.c */
2348 extern void lustre_swab_llogd_body (struct llogd_body *d);
2349 extern void lustre_swab_llog_hdr (struct llog_log_hdr *h);
2350 extern void lustre_swab_llogd_conn_body (struct llogd_conn_body *d);
2351 extern void lustre_swab_llog_rec(struct llog_rec_hdr  *rec,
2352                                  struct llog_rec_tail *tail);
2353
2354 struct lustre_cfg;
2355 extern void lustre_swab_lustre_cfg(struct lustre_cfg *lcfg);
2356
2357 /* this will be used when OBD_CONNECT_CHANGE_QS is set */
2358 struct qunit_data {
2359         /**
2360          * ID appiles to (uid, gid)
2361          */
2362         __u32 qd_id;
2363         /**
2364          * LQUOTA_FLAGS_* affect the responding bits
2365          */
2366         __u32 qd_flags;
2367         /**
2368          * acquire/release count (bytes for block quota)
2369          */
2370         __u64 qd_count;
2371         /**
2372          * when a master returns the reply to a slave, it will
2373          * contain the current corresponding qunit size
2374          */
2375         __u64 qd_qunit;
2376         __u64 padding;
2377 };
2378
2379 #define QDATA_IS_GRP(qdata)    ((qdata)->qd_flags & LQUOTA_FLAGS_GRP)
2380 #define QDATA_IS_BLK(qdata)    ((qdata)->qd_flags & LQUOTA_FLAGS_BLK)
2381 #define QDATA_IS_ADJBLK(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJBLK)
2382 #define QDATA_IS_ADJINO(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_ADJINO)
2383 #define QDATA_IS_CHANGE_QS(qdata) ((qdata)->qd_flags & LQUOTA_FLAGS_CHG_QS)
2384
2385 #define QDATA_SET_GRP(qdata)    ((qdata)->qd_flags |= LQUOTA_FLAGS_GRP)
2386 #define QDATA_SET_BLK(qdata)    ((qdata)->qd_flags |= LQUOTA_FLAGS_BLK)
2387 #define QDATA_SET_ADJBLK(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJBLK)
2388 #define QDATA_SET_ADJINO(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_ADJINO)
2389 #define QDATA_SET_CHANGE_QS(qdata) ((qdata)->qd_flags |= LQUOTA_FLAGS_CHG_QS)
2390
2391 #define QDATA_CLR_GRP(qdata)        ((qdata)->qd_flags &= ~LQUOTA_FLAGS_GRP)
2392 #define QDATA_CLR_CHANGE_QS(qdata)  ((qdata)->qd_flags &= ~LQUOTA_FLAGS_CHG_QS)
2393
2394 extern void lustre_swab_qdata(struct qunit_data *d);
2395 extern int quota_get_qdata(void*req, struct qunit_data *qdata,
2396                            int is_req, int is_exp);
2397 extern int quota_copy_qdata(void *request, struct qunit_data *qdata,
2398                             int is_req, int is_exp);
2399
2400 typedef enum {
2401         QUOTA_DQACQ     = 901,
2402         QUOTA_DQREL     = 902,
2403         QUOTA_LAST_OPC
2404 } quota_cmd_t;
2405 #define QUOTA_FIRST_OPC QUOTA_DQACQ
2406
2407 #define JOIN_FILE_ALIGN 4096
2408
2409 #define QUOTA_REQUEST   1
2410 #define QUOTA_REPLY     0
2411 #define QUOTA_EXPORT    1
2412 #define QUOTA_IMPORT    0
2413
2414 /* quota check function */
2415 #define QUOTA_RET_OK           0 /**< return successfully */
2416 #define QUOTA_RET_NOQUOTA      1 /**< not support quota */
2417 #define QUOTA_RET_NOLIMIT      2 /**< quota limit isn't set */
2418 #define QUOTA_RET_ACQUOTA      4 /**< need to acquire extra quota */
2419 #define QUOTA_RET_INC_PENDING  8 /**< pending value is increased */
2420
2421 /* security opcodes */
2422 typedef enum {
2423         SEC_CTX_INIT            = 801,
2424         SEC_CTX_INIT_CONT       = 802,
2425         SEC_CTX_FINI            = 803,
2426         SEC_LAST_OPC,
2427         SEC_FIRST_OPC           = SEC_CTX_INIT
2428 } sec_cmd_t;
2429
2430 /*
2431  * capa related definitions
2432  */
2433 #define CAPA_HMAC_MAX_LEN       64
2434 #define CAPA_HMAC_KEY_MAX_LEN   56
2435
2436 /* NB take care when changing the sequence of elements this struct,
2437  * because the offset info is used in find_capa() */
2438 struct lustre_capa {
2439         struct lu_fid   lc_fid;         /** fid */
2440         __u64           lc_opc;         /** operations allowed */
2441         __u64           lc_uid;         /** file owner */
2442         __u64           lc_gid;         /** file group */
2443         __u32           lc_flags;       /** HMAC algorithm & flags */
2444         __u32           lc_keyid;       /** key# used for the capability */
2445         __u32           lc_timeout;     /** capa timeout value (sec) */
2446         __u32           lc_expiry;      /** expiry time (sec) */
2447         __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /** HMAC */
2448 } __attribute__((packed));
2449
2450 extern void lustre_swab_lustre_capa(struct lustre_capa *c);
2451
2452 /** lustre_capa::lc_opc */
2453 enum {
2454         CAPA_OPC_BODY_WRITE   = 1<<0,  /**< write object data */
2455         CAPA_OPC_BODY_READ    = 1<<1,  /**< read object data */
2456         CAPA_OPC_INDEX_LOOKUP = 1<<2,  /**< lookup object fid */
2457         CAPA_OPC_INDEX_INSERT = 1<<3,  /**< insert object fid */
2458         CAPA_OPC_INDEX_DELETE = 1<<4,  /**< delete object fid */
2459         CAPA_OPC_OSS_WRITE    = 1<<5,  /**< write oss object data */
2460         CAPA_OPC_OSS_READ     = 1<<6,  /**< read oss object data */
2461         CAPA_OPC_OSS_TRUNC    = 1<<7,  /**< truncate oss object */
2462         CAPA_OPC_OSS_DESTROY  = 1<<8,  /**< destroy oss object */
2463         CAPA_OPC_META_WRITE   = 1<<9,  /**< write object meta data */
2464         CAPA_OPC_META_READ    = 1<<10, /**< read object meta data */
2465 };
2466
2467 #define CAPA_OPC_OSS_RW (CAPA_OPC_OSS_READ | CAPA_OPC_OSS_WRITE)
2468 #define CAPA_OPC_MDS_ONLY                                                   \
2469         (CAPA_OPC_BODY_WRITE | CAPA_OPC_BODY_READ | CAPA_OPC_INDEX_LOOKUP | \
2470          CAPA_OPC_INDEX_INSERT | CAPA_OPC_INDEX_DELETE)
2471 #define CAPA_OPC_OSS_ONLY                                                   \
2472         (CAPA_OPC_OSS_WRITE | CAPA_OPC_OSS_READ | CAPA_OPC_OSS_TRUNC |      \
2473          CAPA_OPC_OSS_DESTROY)
2474 #define CAPA_OPC_MDS_DEFAULT ~CAPA_OPC_OSS_ONLY
2475 #define CAPA_OPC_OSS_DEFAULT ~(CAPA_OPC_MDS_ONLY | CAPA_OPC_OSS_ONLY)
2476
2477 /* MDS capability covers object capability for operations of body r/w
2478  * (dir readpage/sendpage), index lookup/insert/delete and meta data r/w,
2479  * while OSS capability only covers object capability for operations of
2480  * oss data(file content) r/w/truncate.
2481  */
2482 static inline int capa_for_mds(struct lustre_capa *c)
2483 {
2484         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) != 0;
2485 }
2486
2487 static inline int capa_for_oss(struct lustre_capa *c)
2488 {
2489         return (c->lc_opc & CAPA_OPC_INDEX_LOOKUP) == 0;
2490 }
2491
2492 /* lustre_capa::lc_hmac_alg */
2493 enum {
2494         CAPA_HMAC_ALG_SHA1 = 1, /**< sha1 algorithm */
2495         CAPA_HMAC_ALG_MAX,
2496 };
2497
2498 #define CAPA_FL_MASK            0x00ffffff
2499 #define CAPA_HMAC_ALG_MASK      0xff000000
2500
2501 struct lustre_capa_key {
2502         __u64   lk_mdsid;     /**< mds# */
2503         __u32   lk_keyid;     /**< key# */
2504         __u32   lk_padding;
2505         __u8    lk_key[CAPA_HMAC_KEY_MAX_LEN];    /**< key */
2506 } __attribute__((packed));
2507
2508 extern void lustre_swab_lustre_capa_key(struct lustre_capa_key *k);
2509
2510 #endif
2511
2512 /** @} lustreidl */