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