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