1/* 2 * GPL HEADER START 3 * 4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License version 2 only, 8 * as published by the Free Software Foundation. 9 * 10 * This program is distributed in the hope that it will be useful, but 11 * WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 * General Public License version 2 for more details (a copy is included 14 * in the LICENSE file that accompanied this code). 15 * 16 * You should have received a copy of the GNU General Public License 17 * version 2 along with this program; If not, see 18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf 19 * 20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 21 * CA 95054 USA or visit www.sun.com if you need additional information or 22 * have any questions. 23 * 24 * GPL HEADER END 25 */ 26/* 27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved. 28 * Use is subject to license terms. 29 * 30 * Copyright (c) 2010, 2012, Intel Corporation. 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_user.h 37 * 38 * Lustre public user-space interface definitions. 39 */ 40 41#ifndef _LUSTRE_USER_H 42#define _LUSTRE_USER_H 43 44/** \defgroup lustreuser lustreuser 45 * 46 * @{ 47 */ 48 49#include "ll_fiemap.h" 50#include "../linux/lustre_user.h" 51 52/* for statfs() */ 53#define LL_SUPER_MAGIC 0x0BD00BD0 54 55#ifndef FSFILT_IOC_GETFLAGS 56#define FSFILT_IOC_GETFLAGS _IOR('f', 1, long) 57#define FSFILT_IOC_SETFLAGS _IOW('f', 2, long) 58#define FSFILT_IOC_GETVERSION _IOR('f', 3, long) 59#define FSFILT_IOC_SETVERSION _IOW('f', 4, long) 60#define FSFILT_IOC_GETVERSION_OLD _IOR('v', 1, long) 61#define FSFILT_IOC_SETVERSION_OLD _IOW('v', 2, long) 62#define FSFILT_IOC_FIEMAP _IOWR('f', 11, struct ll_user_fiemap) 63#endif 64 65/* FIEMAP flags supported by Lustre */ 66#define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER) 67 68enum obd_statfs_state { 69 OS_STATE_DEGRADED = 0x00000001, /**< RAID degraded/rebuilding */ 70 OS_STATE_READONLY = 0x00000002, /**< filesystem is read-only */ 71 OS_STATE_RDONLY_1 = 0x00000004, /**< obsolete 1.6, was EROFS=30 */ 72 OS_STATE_RDONLY_2 = 0x00000008, /**< obsolete 1.6, was EROFS=30 */ 73 OS_STATE_RDONLY_3 = 0x00000010, /**< obsolete 1.6, was EROFS=30 */ 74}; 75 76struct obd_statfs { 77 __u64 os_type; 78 __u64 os_blocks; 79 __u64 os_bfree; 80 __u64 os_bavail; 81 __u64 os_files; 82 __u64 os_ffree; 83 __u8 os_fsid[40]; 84 __u32 os_bsize; 85 __u32 os_namelen; 86 __u64 os_maxbytes; 87 __u32 os_state; /**< obd_statfs_state OS_STATE_* flag */ 88 __u32 os_fprecreated; /* objs available now to the caller */ 89 /* used in QoS code to find preferred 90 * OSTs */ 91 __u32 os_spare2; 92 __u32 os_spare3; 93 __u32 os_spare4; 94 __u32 os_spare5; 95 __u32 os_spare6; 96 __u32 os_spare7; 97 __u32 os_spare8; 98 __u32 os_spare9; 99}; 100 101/** 102 * File IDentifier. 103 * 104 * FID is a cluster-wide unique identifier of a file or an object (stripe). 105 * FIDs are never reused. 106 **/ 107struct lu_fid { 108 /** 109 * FID sequence. Sequence is a unit of migration: all files (objects) 110 * with FIDs from a given sequence are stored on the same server. 111 * Lustre should support 2^64 objects, so even if each sequence 112 * has only a single object we can still enumerate 2^64 objects. 113 **/ 114 __u64 f_seq; 115 /* FID number within sequence. */ 116 __u32 f_oid; 117 /** 118 * FID version, used to distinguish different versions (in the sense 119 * of snapshots, etc.) of the same file system object. Not currently 120 * used. 121 **/ 122 __u32 f_ver; 123}; 124 125struct filter_fid { 126 struct lu_fid ff_parent; /* ff_parent.f_ver == file stripe number */ 127}; 128 129/* keep this one for compatibility */ 130struct filter_fid_old { 131 struct lu_fid ff_parent; 132 __u64 ff_objid; 133 __u64 ff_seq; 134}; 135 136/* Userspace should treat lu_fid as opaque, and only use the following methods 137 * to print or parse them. Other functions (e.g. compare, swab) could be moved 138 * here from lustre_idl.h if needed. */ 139typedef struct lu_fid lustre_fid; 140 141/** 142 * Following struct for object attributes, that will be kept inode's EA. 143 * Introduced in 2.0 release (please see b15993, for details) 144 * Added to all objects since Lustre 2.4 as contains self FID 145 */ 146struct lustre_mdt_attrs { 147 /** 148 * Bitfield for supported data in this structure. From enum lma_compat. 149 * lma_self_fid and lma_flags are always available. 150 */ 151 __u32 lma_compat; 152 /** 153 * Per-file incompat feature list. Lustre version should support all 154 * flags set in this field. The supported feature mask is available in 155 * LMA_INCOMPAT_SUPP. 156 */ 157 __u32 lma_incompat; 158 /** FID of this inode */ 159 struct lu_fid lma_self_fid; 160}; 161 162/** 163 * Prior to 2.4, the LMA structure also included SOM attributes which has since 164 * been moved to a dedicated xattr 165 * lma_flags was also removed because of lma_compat/incompat fields. 166 */ 167#define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64)) 168 169/** 170 * OST object IDentifier. 171 */ 172struct ost_id { 173 union { 174 struct ostid { 175 __u64 oi_id; 176 __u64 oi_seq; 177 } oi; 178 struct lu_fid oi_fid; 179 }; 180}; 181 182#define DOSTID "%#llx:%llu" 183#define POSTID(oi) ostid_seq(oi), ostid_id(oi) 184 185/* 186 * The ioctl naming rules: 187 * LL_* - works on the currently opened filehandle instead of parent dir 188 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly) 189 * *_MDC_* - gets/sets data related to MDC 190 * *_LOV_* - gets/sets data related to OSC/LOV 191 * *FILE* - called on parent dir and passes in a filename 192 * *STRIPE* - set/get lov_user_md 193 * *INFO - set/get lov_user_mds_data 194 */ 195/* see <lustre_lib.h> for ioctl numberss 101-150 */ 196#define LL_IOC_GETFLAGS _IOR ('f', 151, long) 197#define LL_IOC_SETFLAGS _IOW ('f', 152, long) 198#define LL_IOC_CLRFLAGS _IOW ('f', 153, long) 199/* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */ 200#define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long) 201/* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */ 202#define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long) 203/* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */ 204#define LL_IOC_LOV_SETEA _IOW ('f', 156, long) 205#define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long) 206#define LL_IOC_RECREATE_FID _IOW ('f', 157, struct lu_fid) 207#define LL_IOC_GROUP_LOCK _IOW ('f', 158, long) 208#define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long) 209/* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */ 210#define LL_IOC_QUOTACHECK _IOW ('f', 160, int) 211/* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */ 212#define LL_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *) 213/* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */ 214#define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl) 215#define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *) 216#define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *) 217#define LL_IOC_FLUSHCTX _IOW ('f', 166, long) 218#define LL_IOC_RMTACL _IOW ('f', 167, long) 219#define LL_IOC_GETOBDCOUNT _IOR ('f', 168, long) 220#define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long) 221#define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long) 222#define LL_IOC_LLOOP_INFO _IOWR('f', 171, struct lu_fid) 223#define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long) 224#define LL_IOC_PATH2FID _IOR ('f', 173, long) 225#define LL_IOC_GET_CONNECT_FLAGS _IOWR('f', 174, __u64 *) 226#define LL_IOC_GET_MDTIDX _IOR ('f', 175, int) 227 228/* see <lustre_lib.h> for ioctl numbers 177-210 */ 229 230#define LL_IOC_HSM_STATE_GET _IOR('f', 211, struct hsm_user_state) 231#define LL_IOC_HSM_STATE_SET _IOW('f', 212, struct hsm_state_set) 232#define LL_IOC_HSM_CT_START _IOW('f', 213, struct lustre_kernelcomm) 233#define LL_IOC_HSM_COPY_START _IOW('f', 214, struct hsm_copy *) 234#define LL_IOC_HSM_COPY_END _IOW('f', 215, struct hsm_copy *) 235#define LL_IOC_HSM_PROGRESS _IOW('f', 216, struct hsm_user_request) 236#define LL_IOC_HSM_REQUEST _IOW('f', 217, struct hsm_user_request) 237#define LL_IOC_DATA_VERSION _IOR('f', 218, struct ioc_data_version) 238#define LL_IOC_LOV_SWAP_LAYOUTS _IOW('f', 219, \ 239 struct lustre_swap_layouts) 240#define LL_IOC_HSM_ACTION _IOR('f', 220, \ 241 struct hsm_current_action) 242/* see <lustre_lib.h> for ioctl numbers 221-232 */ 243 244#define LL_IOC_LMV_SETSTRIPE _IOWR('f', 240, struct lmv_user_md) 245#define LL_IOC_LMV_GETSTRIPE _IOWR('f', 241, struct lmv_user_md) 246#define LL_IOC_REMOVE_ENTRY _IOWR('f', 242, __u64) 247#define LL_IOC_SET_LEASE _IOWR('f', 243, long) 248#define LL_IOC_GET_LEASE _IO('f', 244) 249#define LL_IOC_HSM_IMPORT _IOWR('f', 245, struct hsm_user_import) 250 251#define LL_STATFS_LMV 1 252#define LL_STATFS_LOV 2 253#define LL_STATFS_NODELAY 4 254 255#define IOC_MDC_TYPE 'i' 256#define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *) 257#define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *) 258#define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *) 259#define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *) 260 261/* Keep these for backward compartability. */ 262#define LL_IOC_OBD_STATFS IOC_OBD_STATFS 263#define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE 264 265 266#define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */ 267 268/* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular 269 * files, but are unlikely to be used in practice and are not harmful if 270 * used incorrectly. O_NOCTTY and FASYNC are only meaningful for character 271 * devices and are safe for use on new files (See LU-812, LU-4209). */ 272#define O_LOV_DELAY_CREATE (O_NOCTTY | FASYNC) 273 274#define LL_FILE_IGNORE_LOCK 0x00000001 275#define LL_FILE_GROUP_LOCKED 0x00000002 276#define LL_FILE_READAHEA 0x00000004 277#define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */ 278#define LL_FILE_LOCKLESS_IO 0x00000010 /* server-side locks with cio */ 279#define LL_FILE_RMTACL 0x00000020 280 281#define LOV_USER_MAGIC_V1 0x0BD10BD0 282#define LOV_USER_MAGIC LOV_USER_MAGIC_V1 283#define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0 284#define LOV_USER_MAGIC_V3 0x0BD30BD0 285 286#define LMV_MAGIC_V1 0x0CD10CD0 /*normal stripe lmv magic */ 287#define LMV_USER_MAGIC 0x0CD20CD0 /*default lmv magic*/ 288 289#define LOV_PATTERN_RAID0 0x001 290#define LOV_PATTERN_RAID1 0x002 291#define LOV_PATTERN_FIRST 0x100 292 293#define LOV_MAXPOOLNAME 16 294#define LOV_POOLNAMEF "%.16s" 295 296#define LOV_MIN_STRIPE_BITS 16 /* maximum PAGE_SIZE (ia64), power of 2 */ 297#define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS) 298#define LOV_MAX_STRIPE_COUNT_OLD 160 299/* This calculation is crafted so that input of 4096 will result in 160 300 * which in turn is equal to old maximal stripe count. 301 * XXX: In fact this is too simplified for now, what it also need is to get 302 * ea_type argument to clearly know how much space each stripe consumes. 303 * 304 * The limit of 12 pages is somewhat arbitrary, but is a reasonably large 305 * allocation that is sufficient for the current generation of systems. 306 * 307 * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */ 308#define LOV_MAX_STRIPE_COUNT 2000 /* ((12 * 4096 - 256) / 24) */ 309#define LOV_ALL_STRIPES 0xffff /* only valid for directories */ 310#define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */ 311 312#define lov_user_ost_data lov_user_ost_data_v1 313struct lov_user_ost_data_v1 { /* per-stripe data structure */ 314 struct ost_id l_ost_oi; /* OST object ID */ 315 __u32 l_ost_gen; /* generation of this OST index */ 316 __u32 l_ost_idx; /* OST index in LOV */ 317} __attribute__((packed)); 318 319#define lov_user_md lov_user_md_v1 320struct lov_user_md_v1 { /* LOV EA user data (host-endian) */ 321 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */ 322 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */ 323 struct ost_id lmm_oi; /* LOV object ID */ 324 __u32 lmm_stripe_size; /* size of stripe in bytes */ 325 __u16 lmm_stripe_count; /* num stripes in use for this object */ 326 union { 327 __u16 lmm_stripe_offset; /* starting stripe offset in 328 * lmm_objects, use when writing */ 329 __u16 lmm_layout_gen; /* layout generation number 330 * used when reading */ 331 }; 332 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */ 333} __attribute__((packed, __may_alias__)); 334 335struct lov_user_md_v3 { /* LOV EA user data (host-endian) */ 336 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V3 */ 337 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */ 338 struct ost_id lmm_oi; /* LOV object ID */ 339 __u32 lmm_stripe_size; /* size of stripe in bytes */ 340 __u16 lmm_stripe_count; /* num stripes in use for this object */ 341 union { 342 __u16 lmm_stripe_offset; /* starting stripe offset in 343 * lmm_objects, use when writing */ 344 __u16 lmm_layout_gen; /* layout generation number 345 * used when reading */ 346 }; 347 char lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */ 348 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */ 349} __attribute__((packed)); 350 351static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic) 352{ 353 if (lmm_magic == LOV_USER_MAGIC_V3) 354 return sizeof(struct lov_user_md_v3) + 355 stripes * sizeof(struct lov_user_ost_data_v1); 356 else 357 return sizeof(struct lov_user_md_v1) + 358 stripes * sizeof(struct lov_user_ost_data_v1); 359} 360 361/* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to 362 * use this. It is unsafe to #define those values in this header as it 363 * is possible the application has already #included <sys/stat.h>. */ 364#ifdef HAVE_LOV_USER_MDS_DATA 365#define lov_user_mds_data lov_user_mds_data_v1 366struct lov_user_mds_data_v1 { 367 lstat_t lmd_st; /* MDS stat struct */ 368 struct lov_user_md_v1 lmd_lmm; /* LOV EA V1 user data */ 369} __attribute__((packed)); 370 371struct lov_user_mds_data_v3 { 372 lstat_t lmd_st; /* MDS stat struct */ 373 struct lov_user_md_v3 lmd_lmm; /* LOV EA V3 user data */ 374} __attribute__((packed)); 375#endif 376 377/* keep this to be the same size as lov_user_ost_data_v1 */ 378struct lmv_user_mds_data { 379 struct lu_fid lum_fid; 380 __u32 lum_padding; 381 __u32 lum_mds; 382}; 383 384/* lum_type */ 385enum { 386 LMV_STRIPE_TYPE = 0, 387 LMV_DEFAULT_TYPE = 1, 388}; 389 390#define lmv_user_md lmv_user_md_v1 391struct lmv_user_md_v1 { 392 __u32 lum_magic; /* must be the first field */ 393 __u32 lum_stripe_count; /* dirstripe count */ 394 __u32 lum_stripe_offset; /* MDT idx for default dirstripe */ 395 __u32 lum_hash_type; /* Dir stripe policy */ 396 __u32 lum_type; /* LMV type: default or normal */ 397 __u32 lum_padding1; 398 __u32 lum_padding2; 399 __u32 lum_padding3; 400 char lum_pool_name[LOV_MAXPOOLNAME]; 401 struct lmv_user_mds_data lum_objects[0]; 402}; 403 404static inline int lmv_user_md_size(int stripes, int lmm_magic) 405{ 406 return sizeof(struct lmv_user_md) + 407 stripes * sizeof(struct lmv_user_mds_data); 408} 409 410extern void lustre_swab_lmv_user_md(struct lmv_user_md *lum); 411 412struct ll_recreate_obj { 413 __u64 lrc_id; 414 __u32 lrc_ost_idx; 415}; 416 417struct ll_fid { 418 __u64 id; /* holds object id */ 419 __u32 generation; /* holds object generation */ 420 __u32 f_type; /* holds object type or stripe idx when passing it to 421 * OST for saving into EA. */ 422}; 423 424#define UUID_MAX 40 425struct obd_uuid { 426 char uuid[UUID_MAX]; 427}; 428 429static inline bool obd_uuid_equals(const struct obd_uuid *u1, 430 const struct obd_uuid *u2) 431{ 432 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0; 433} 434 435static inline int obd_uuid_empty(struct obd_uuid *uuid) 436{ 437 return uuid->uuid[0] == '\0'; 438} 439 440static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp) 441{ 442 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid)); 443 uuid->uuid[sizeof(*uuid) - 1] = '\0'; 444} 445 446/* For printf's only, make sure uuid is terminated */ 447static inline char *obd_uuid2str(const struct obd_uuid *uuid) 448{ 449 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') { 450 /* Obviously not safe, but for printfs, no real harm done... 451 we're always null-terminated, even in a race. */ 452 static char temp[sizeof(*uuid)]; 453 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1); 454 temp[sizeof(*uuid) - 1] = '\0'; 455 return temp; 456 } 457 return (char *)(uuid->uuid); 458} 459 460/* Extract fsname from uuid (or target name) of a target 461 e.g. (myfs-OST0007_UUID -> myfs) 462 see also deuuidify. */ 463static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen) 464{ 465 char *p; 466 467 strncpy(buf, uuid, buflen - 1); 468 buf[buflen - 1] = '\0'; 469 p = strrchr(buf, '-'); 470 if (p) 471 *p = '\0'; 472} 473 474/* printf display format 475 e.g. printf("file FID is "DFID"\n", PFID(fid)); */ 476#define FID_NOBRACE_LEN 40 477#define FID_LEN (FID_NOBRACE_LEN + 2) 478#define DFID_NOBRACE "%#llx:0x%x:0x%x" 479#define DFID "["DFID_NOBRACE"]" 480#define PFID(fid) \ 481 (fid)->f_seq, \ 482 (fid)->f_oid, \ 483 (fid)->f_ver 484 485/* scanf input parse format -- strip '[' first. 486 e.g. sscanf(fidstr, SFID, RFID(&fid)); */ 487#define SFID "0x%llx:0x%x:0x%x" 488#define RFID(fid) \ 489 &((fid)->f_seq), \ 490 &((fid)->f_oid), \ 491 &((fid)->f_ver) 492 493 494/********* Quotas **********/ 495 496/* these must be explicitly translated into linux Q_* in ll_dir_ioctl */ 497#define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */ 498#define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */ 499#define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */ 500#define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */ 501#define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */ 502#define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */ 503/* lustre-specific control commands */ 504#define LUSTRE_Q_INVALIDATE 0x80000b /* invalidate quota data */ 505#define LUSTRE_Q_FINVALIDATE 0x80000c /* invalidate filter quota data */ 506 507#define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */ 508 509struct if_quotacheck { 510 char obd_type[16]; 511 struct obd_uuid obd_uuid; 512}; 513 514#define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629 515 516/* permission */ 517#define N_PERMS_MAX 64 518 519struct perm_downcall_data { 520 __u64 pdd_nid; 521 __u32 pdd_perm; 522 __u32 pdd_padding; 523}; 524 525struct identity_downcall_data { 526 __u32 idd_magic; 527 __u32 idd_err; 528 __u32 idd_uid; 529 __u32 idd_gid; 530 __u32 idd_nperms; 531 __u32 idd_ngroups; 532 struct perm_downcall_data idd_perms[N_PERMS_MAX]; 533 __u32 idd_groups[0]; 534}; 535 536/* for non-mapped uid/gid */ 537#define NOBODY_UID 99 538#define NOBODY_GID 99 539 540#define INVALID_ID (-1) 541 542enum { 543 RMT_LSETFACL = 1, 544 RMT_LGETFACL = 2, 545 RMT_RSETFACL = 3, 546 RMT_RGETFACL = 4 547}; 548 549#ifdef NEED_QUOTA_DEFS 550#ifndef QIF_BLIMITS 551#define QIF_BLIMITS 1 552#define QIF_SPACE 2 553#define QIF_ILIMITS 4 554#define QIF_INODES 8 555#define QIF_BTIME 16 556#define QIF_ITIME 32 557#define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS) 558#define QIF_USAGE (QIF_SPACE | QIF_INODES) 559#define QIF_TIMES (QIF_BTIME | QIF_ITIME) 560#define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES) 561#endif 562 563#endif /* !__KERNEL__ */ 564 565/* lustre volatile file support 566 * file name header: .^L^S^T^R:volatile" 567 */ 568#define LUSTRE_VOLATILE_HDR ".\x0c\x13\x14\x12:VOLATILE" 569#define LUSTRE_VOLATILE_HDR_LEN 14 570/* hdr + MDT index */ 571#define LUSTRE_VOLATILE_IDX LUSTRE_VOLATILE_HDR":%.4X:" 572 573typedef enum lustre_quota_version { 574 LUSTRE_QUOTA_V2 = 1 575} lustre_quota_version_t; 576 577/* XXX: same as if_dqinfo struct in kernel */ 578struct obd_dqinfo { 579 __u64 dqi_bgrace; 580 __u64 dqi_igrace; 581 __u32 dqi_flags; 582 __u32 dqi_valid; 583}; 584 585/* XXX: same as if_dqblk struct in kernel, plus one padding */ 586struct obd_dqblk { 587 __u64 dqb_bhardlimit; 588 __u64 dqb_bsoftlimit; 589 __u64 dqb_curspace; 590 __u64 dqb_ihardlimit; 591 __u64 dqb_isoftlimit; 592 __u64 dqb_curinodes; 593 __u64 dqb_btime; 594 __u64 dqb_itime; 595 __u32 dqb_valid; 596 __u32 dqb_padding; 597}; 598 599enum { 600 QC_GENERAL = 0, 601 QC_MDTIDX = 1, 602 QC_OSTIDX = 2, 603 QC_UUID = 3 604}; 605 606struct if_quotactl { 607 __u32 qc_cmd; 608 __u32 qc_type; 609 __u32 qc_id; 610 __u32 qc_stat; 611 __u32 qc_valid; 612 __u32 qc_idx; 613 struct obd_dqinfo qc_dqinfo; 614 struct obd_dqblk qc_dqblk; 615 char obd_type[16]; 616 struct obd_uuid obd_uuid; 617}; 618 619/* swap layout flags */ 620#define SWAP_LAYOUTS_CHECK_DV1 (1 << 0) 621#define SWAP_LAYOUTS_CHECK_DV2 (1 << 1) 622#define SWAP_LAYOUTS_KEEP_MTIME (1 << 2) 623#define SWAP_LAYOUTS_KEEP_ATIME (1 << 3) 624 625/* Swap XATTR_NAME_HSM as well, only on the MDT so far */ 626#define SWAP_LAYOUTS_MDS_HSM (1 << 31) 627struct lustre_swap_layouts { 628 __u64 sl_flags; 629 __u32 sl_fd; 630 __u32 sl_gid; 631 __u64 sl_dv1; 632 __u64 sl_dv2; 633}; 634 635 636/********* Changelogs **********/ 637/** Changelog record types */ 638enum changelog_rec_type { 639 CL_MARK = 0, 640 CL_CREATE = 1, /* namespace */ 641 CL_MKDIR = 2, /* namespace */ 642 CL_HARDLINK = 3, /* namespace */ 643 CL_SOFTLINK = 4, /* namespace */ 644 CL_MKNOD = 5, /* namespace */ 645 CL_UNLINK = 6, /* namespace */ 646 CL_RMDIR = 7, /* namespace */ 647 CL_RENAME = 8, /* namespace */ 648 CL_EXT = 9, /* namespace extended record (2nd half of rename) */ 649 CL_OPEN = 10, /* not currently used */ 650 CL_CLOSE = 11, /* may be written to log only with mtime change */ 651 CL_LAYOUT = 12, /* file layout/striping modified */ 652 CL_TRUNC = 13, 653 CL_SETATTR = 14, 654 CL_XATTR = 15, 655 CL_HSM = 16, /* HSM specific events, see flags */ 656 CL_MTIME = 17, /* Precedence: setattr > mtime > ctime > atime */ 657 CL_CTIME = 18, 658 CL_ATIME = 19, 659 CL_LAST 660}; 661 662static inline const char *changelog_type2str(int type) { 663 static const char *changelog_str[] = { 664 "MARK", "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK", 665 "RMDIR", "RENME", "RNMTO", "OPEN", "CLOSE", "LYOUT", "TRUNC", 666 "SATTR", "XATTR", "HSM", "MTIME", "CTIME", "ATIME", 667 }; 668 669 if (type >= 0 && type < CL_LAST) 670 return changelog_str[type]; 671 return NULL; 672} 673 674/* per-record flags */ 675#define CLF_VERSION 0x1000 676#define CLF_EXT_VERSION 0x2000 677#define CLF_FLAGSHIFT 12 678#define CLF_FLAGMASK ((1U << CLF_FLAGSHIFT) - 1) 679#define CLF_VERMASK (~CLF_FLAGMASK) 680/* Anything under the flagmask may be per-type (if desired) */ 681/* Flags for unlink */ 682#define CLF_UNLINK_LAST 0x0001 /* Unlink of last hardlink */ 683#define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */ 684 /* HSM cleaning needed */ 685/* Flags for rename */ 686#define CLF_RENAME_LAST 0x0001 /* rename unlink last hardlink of target */ 687 688/* Flags for HSM */ 689/* 12b used (from high weight to low weight): 690 * 2b for flags 691 * 3b for event 692 * 7b for error code 693 */ 694#define CLF_HSM_ERR_L 0 /* HSM return code, 7 bits */ 695#define CLF_HSM_ERR_H 6 696#define CLF_HSM_EVENT_L 7 /* HSM event, 3 bits, see enum hsm_event */ 697#define CLF_HSM_EVENT_H 9 698#define CLF_HSM_FLAG_L 10 /* HSM flags, 2 bits, 1 used, 1 spare */ 699#define CLF_HSM_FLAG_H 11 700#define CLF_HSM_SPARE_L 12 /* 4 spare bits */ 701#define CLF_HSM_SPARE_H 15 702#define CLF_HSM_LAST 15 703 704/* Remove bits higher than _h, then extract the value 705 * between _h and _l by shifting lower weigth to bit 0. */ 706#define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \ 707 >> (CLF_HSM_LAST - _h + _l)) 708 709#define CLF_HSM_SUCCESS 0x00 710#define CLF_HSM_MAXERROR 0x7E 711#define CLF_HSM_ERROVERFLOW 0x7F 712 713#define CLF_HSM_DIRTY 1 /* file is dirty after HSM request end */ 714 715/* 3 bits field => 8 values allowed */ 716enum hsm_event { 717 HE_ARCHIVE = 0, 718 HE_RESTORE = 1, 719 HE_CANCEL = 2, 720 HE_RELEASE = 3, 721 HE_REMOVE = 4, 722 HE_STATE = 5, 723 HE_SPARE1 = 6, 724 HE_SPARE2 = 7, 725}; 726 727static inline enum hsm_event hsm_get_cl_event(__u16 flags) 728{ 729 return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L); 730} 731 732static inline void hsm_set_cl_event(int *flags, enum hsm_event he) 733{ 734 *flags |= (he << CLF_HSM_EVENT_L); 735} 736 737static inline __u16 hsm_get_cl_flags(int flags) 738{ 739 return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L); 740} 741 742static inline void hsm_set_cl_flags(int *flags, int bits) 743{ 744 *flags |= (bits << CLF_HSM_FLAG_L); 745} 746 747static inline int hsm_get_cl_error(int flags) 748{ 749 return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L); 750} 751 752static inline void hsm_set_cl_error(int *flags, int error) 753{ 754 *flags |= (error << CLF_HSM_ERR_L); 755} 756 757#define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + \ 758 sizeof(struct changelog_ext_rec)) 759 760struct changelog_rec { 761 __u16 cr_namelen; 762 __u16 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */ 763 __u32 cr_type; /**< \a changelog_rec_type */ 764 __u64 cr_index; /**< changelog record number */ 765 __u64 cr_prev; /**< last index for this target fid */ 766 __u64 cr_time; 767 union { 768 lustre_fid cr_tfid; /**< target fid */ 769 __u32 cr_markerflags; /**< CL_MARK flags */ 770 }; 771 lustre_fid cr_pfid; /**< parent fid */ 772 char cr_name[0]; /**< last element */ 773} __attribute__((packed)); 774 775/* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save 776 * space, only rename uses changelog_ext_rec, while others use changelog_rec to 777 * store records. 778 */ 779struct changelog_ext_rec { 780 __u16 cr_namelen; 781 __u16 cr_flags; /**< (flags & CLF_FLAGMASK) | 782 CLF_EXT_VERSION */ 783 __u32 cr_type; /**< \a changelog_rec_type */ 784 __u64 cr_index; /**< changelog record number */ 785 __u64 cr_prev; /**< last index for this target fid */ 786 __u64 cr_time; 787 union { 788 lustre_fid cr_tfid; /**< target fid */ 789 __u32 cr_markerflags; /**< CL_MARK flags */ 790 }; 791 lustre_fid cr_pfid; /**< target parent fid */ 792 lustre_fid cr_sfid; /**< source fid, or zero */ 793 lustre_fid cr_spfid; /**< source parent fid, or zero */ 794 char cr_name[0]; /**< last element */ 795} __attribute__((packed)); 796 797#define CHANGELOG_REC_EXTENDED(rec) \ 798 (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION) 799 800static inline int changelog_rec_size(struct changelog_rec *rec) 801{ 802 return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec): 803 sizeof(*rec); 804} 805 806static inline char *changelog_rec_name(struct changelog_rec *rec) 807{ 808 return CHANGELOG_REC_EXTENDED(rec) ? 809 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name; 810} 811 812static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec) 813{ 814 return rec->cr_namelen - strlen(rec->cr_name) - 1; 815} 816 817static inline char *changelog_rec_sname(struct changelog_ext_rec *rec) 818{ 819 return rec->cr_name + strlen(rec->cr_name) + 1; 820} 821 822struct ioc_changelog { 823 __u64 icc_recno; 824 __u32 icc_mdtindex; 825 __u32 icc_id; 826 __u32 icc_flags; 827}; 828 829enum changelog_message_type { 830 CL_RECORD = 10, /* message is a changelog_rec */ 831 CL_EOF = 11, /* at end of current changelog */ 832}; 833 834/********* Misc **********/ 835 836struct ioc_data_version { 837 __u64 idv_version; 838 __u64 idv_flags; /* See LL_DV_xxx */ 839}; 840#define LL_DV_NOFLUSH 0x01 /* Do not take READ EXTENT LOCK before sampling 841 version. Dirty caches are left unchanged. */ 842 843#ifndef offsetof 844# define offsetof(typ, memb) ((unsigned long)((char *)&(((typ *)0)->memb))) 845#endif 846 847#define dot_lustre_name ".lustre" 848 849 850/********* HSM **********/ 851 852/** HSM per-file state 853 * See HSM_FLAGS below. 854 */ 855enum hsm_states { 856 HS_EXISTS = 0x00000001, 857 HS_DIRTY = 0x00000002, 858 HS_RELEASED = 0x00000004, 859 HS_ARCHIVED = 0x00000008, 860 HS_NORELEASE = 0x00000010, 861 HS_NOARCHIVE = 0x00000020, 862 HS_LOST = 0x00000040, 863}; 864 865/* HSM user-setable flags. */ 866#define HSM_USER_MASK (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY) 867 868/* Other HSM flags. */ 869#define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED) 870 871/* 872 * All HSM-related possible flags that could be applied to a file. 873 * This should be kept in sync with hsm_states. 874 */ 875#define HSM_FLAGS_MASK (HSM_USER_MASK | HSM_STATUS_MASK) 876 877/** 878 * HSM request progress state 879 */ 880enum hsm_progress_states { 881 HPS_WAITING = 1, 882 HPS_RUNNING = 2, 883 HPS_DONE = 3, 884}; 885#define HPS_NONE 0 886 887static inline char *hsm_progress_state2name(enum hsm_progress_states s) 888{ 889 switch (s) { 890 case HPS_WAITING: return "waiting"; 891 case HPS_RUNNING: return "running"; 892 case HPS_DONE: return "done"; 893 default: return "unknown"; 894 } 895} 896 897struct hsm_extent { 898 __u64 offset; 899 __u64 length; 900} __attribute__((packed)); 901 902/** 903 * Current HSM states of a Lustre file. 904 * 905 * This structure purpose is to be sent to user-space mainly. It describes the 906 * current HSM flags and in-progress action. 907 */ 908struct hsm_user_state { 909 /** Current HSM states, from enum hsm_states. */ 910 __u32 hus_states; 911 __u32 hus_archive_id; 912 /** The current undergoing action, if there is one */ 913 __u32 hus_in_progress_state; 914 __u32 hus_in_progress_action; 915 struct hsm_extent hus_in_progress_location; 916 char hus_extended_info[]; 917}; 918 919struct hsm_state_set_ioc { 920 struct lu_fid hssi_fid; 921 __u64 hssi_setmask; 922 __u64 hssi_clearmask; 923}; 924 925/* 926 * This structure describes the current in-progress action for a file. 927 * it is returned to user space and send over the wire 928 */ 929struct hsm_current_action { 930 /** The current undergoing action, if there is one */ 931 /* state is one of hsm_progress_states */ 932 __u32 hca_state; 933 /* action is one of hsm_user_action */ 934 __u32 hca_action; 935 struct hsm_extent hca_location; 936}; 937 938/***** HSM user requests ******/ 939/* User-generated (lfs/ioctl) request types */ 940enum hsm_user_action { 941 HUA_NONE = 1, /* no action (noop) */ 942 HUA_ARCHIVE = 10, /* copy to hsm */ 943 HUA_RESTORE = 11, /* prestage */ 944 HUA_RELEASE = 12, /* drop ost objects */ 945 HUA_REMOVE = 13, /* remove from archive */ 946 HUA_CANCEL = 14 /* cancel a request */ 947}; 948 949static inline char *hsm_user_action2name(enum hsm_user_action a) 950{ 951 switch (a) { 952 case HUA_NONE: return "NOOP"; 953 case HUA_ARCHIVE: return "ARCHIVE"; 954 case HUA_RESTORE: return "RESTORE"; 955 case HUA_RELEASE: return "RELEASE"; 956 case HUA_REMOVE: return "REMOVE"; 957 case HUA_CANCEL: return "CANCEL"; 958 default: return "UNKNOWN"; 959 } 960} 961 962/* 963 * List of hr_flags (bit field) 964 */ 965#define HSM_FORCE_ACTION 0x0001 966/* used by CT, connot be set by user */ 967#define HSM_GHOST_COPY 0x0002 968 969/** 970 * Contains all the fixed part of struct hsm_user_request. 971 * 972 */ 973struct hsm_request { 974 __u32 hr_action; /* enum hsm_user_action */ 975 __u32 hr_archive_id; /* archive id, used only with HUA_ARCHIVE */ 976 __u64 hr_flags; /* request flags */ 977 __u32 hr_itemcount; /* item count in hur_user_item vector */ 978 __u32 hr_data_len; 979}; 980 981struct hsm_user_item { 982 lustre_fid hui_fid; 983 struct hsm_extent hui_extent; 984} __attribute__((packed)); 985 986struct hsm_user_request { 987 struct hsm_request hur_request; 988 struct hsm_user_item hur_user_item[0]; 989 /* extra data blob at end of struct (after all 990 * hur_user_items), only use helpers to access it 991 */ 992} __attribute__((packed)); 993 994/** Return pointer to data field in a hsm user request */ 995static inline void *hur_data(struct hsm_user_request *hur) 996{ 997 return &(hur->hur_user_item[hur->hur_request.hr_itemcount]); 998} 999 1000/** 1001 * Compute the current length of the provided hsm_user_request. This returns -1 1002 * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ] 1003 * 1004 * return -1 on bounds check error. 1005 */ 1006static inline ssize_t hur_len(struct hsm_user_request *hur) 1007{ 1008 __u64 size; 1009 1010 /* can't overflow a __u64 since hr_itemcount is only __u32 */ 1011 size = offsetof(struct hsm_user_request, hur_user_item[0]) + 1012 (__u64)hur->hur_request.hr_itemcount * 1013 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len; 1014 1015 if (size != (ssize_t)size) 1016 return -1; 1017 1018 return size; 1019} 1020 1021/****** HSM RPCs to copytool *****/ 1022/* Message types the copytool may receive */ 1023enum hsm_message_type { 1024 HMT_ACTION_LIST = 100, /* message is a hsm_action_list */ 1025}; 1026 1027/* Actions the copytool may be instructed to take for a given action_item */ 1028enum hsm_copytool_action { 1029 HSMA_NONE = 10, /* no action */ 1030 HSMA_ARCHIVE = 20, /* arbitrary offset */ 1031 HSMA_RESTORE = 21, 1032 HSMA_REMOVE = 22, 1033 HSMA_CANCEL = 23 1034}; 1035 1036static inline char *hsm_copytool_action2name(enum hsm_copytool_action a) 1037{ 1038 switch (a) { 1039 case HSMA_NONE: return "NOOP"; 1040 case HSMA_ARCHIVE: return "ARCHIVE"; 1041 case HSMA_RESTORE: return "RESTORE"; 1042 case HSMA_REMOVE: return "REMOVE"; 1043 case HSMA_CANCEL: return "CANCEL"; 1044 default: return "UNKNOWN"; 1045 } 1046} 1047 1048/* Copytool item action description */ 1049struct hsm_action_item { 1050 __u32 hai_len; /* valid size of this struct */ 1051 __u32 hai_action; /* hsm_copytool_action, but use known size */ 1052 lustre_fid hai_fid; /* Lustre FID to operated on */ 1053 lustre_fid hai_dfid; /* fid used for data access */ 1054 struct hsm_extent hai_extent; /* byte range to operate on */ 1055 __u64 hai_cookie; /* action cookie from coordinator */ 1056 __u64 hai_gid; /* grouplock id */ 1057 char hai_data[0]; /* variable length */ 1058} __attribute__((packed)); 1059 1060/* 1061 * helper function which print in hexa the first bytes of 1062 * hai opaque field 1063 * \param hai [IN] record to print 1064 * \param buffer [OUT] output buffer 1065 * \param len [IN] max buffer len 1066 * \retval buffer 1067 */ 1068static inline char *hai_dump_data_field(struct hsm_action_item *hai, 1069 char *buffer, int len) 1070{ 1071 int i, sz, data_len; 1072 char *ptr; 1073 1074 ptr = buffer; 1075 sz = len; 1076 data_len = hai->hai_len - sizeof(*hai); 1077 for (i = 0 ; (i < data_len) && (sz > 0) ; i++) { 1078 int cnt; 1079 1080 cnt = snprintf(ptr, sz, "%.2X", 1081 (unsigned char)hai->hai_data[i]); 1082 ptr += cnt; 1083 sz -= cnt; 1084 } 1085 *ptr = '\0'; 1086 return buffer; 1087} 1088 1089/* Copytool action list */ 1090#define HAL_VERSION 1 1091#define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */ 1092struct hsm_action_list { 1093 __u32 hal_version; 1094 __u32 hal_count; /* number of hai's to follow */ 1095 __u64 hal_compound_id; /* returned by coordinator */ 1096 __u64 hal_flags; 1097 __u32 hal_archive_id; /* which archive backend */ 1098 __u32 padding1; 1099 char hal_fsname[0]; /* null-terminated */ 1100 /* struct hsm_action_item[hal_count] follows, aligned on 8-byte 1101 boundaries. See hai_zero */ 1102} __attribute__((packed)); 1103 1104#ifndef HAVE_CFS_SIZE_ROUND 1105static inline int cfs_size_round (int val) 1106{ 1107 return (val + 7) & (~0x7); 1108} 1109#define HAVE_CFS_SIZE_ROUND 1110#endif 1111 1112/* Return pointer to first hai in action list */ 1113static inline struct hsm_action_item *hai_zero(struct hsm_action_list *hal) 1114{ 1115 return (struct hsm_action_item *)(hal->hal_fsname + 1116 cfs_size_round(strlen(hal-> \ 1117 hal_fsname) 1118 + 1)); 1119} 1120/* Return pointer to next hai */ 1121static inline struct hsm_action_item *hai_next(struct hsm_action_item *hai) 1122{ 1123 return (struct hsm_action_item *)((char *)hai + 1124 cfs_size_round(hai->hai_len)); 1125} 1126 1127/* Return size of an hsm_action_list */ 1128static inline int hal_size(struct hsm_action_list *hal) 1129{ 1130 int i, sz; 1131 struct hsm_action_item *hai; 1132 1133 sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1); 1134 hai = hai_zero(hal); 1135 for (i = 0; i < hal->hal_count; i++, hai = hai_next(hai)) 1136 sz += cfs_size_round(hai->hai_len); 1137 1138 return sz; 1139} 1140 1141/* HSM file import 1142 * describe the attributes to be set on imported file 1143 */ 1144struct hsm_user_import { 1145 __u64 hui_size; 1146 __u64 hui_atime; 1147 __u64 hui_mtime; 1148 __u32 hui_atime_ns; 1149 __u32 hui_mtime_ns; 1150 __u32 hui_uid; 1151 __u32 hui_gid; 1152 __u32 hui_mode; 1153 __u32 hui_archive_id; 1154}; 1155 1156/* Copytool progress reporting */ 1157#define HP_FLAG_COMPLETED 0x01 1158#define HP_FLAG_RETRY 0x02 1159 1160struct hsm_progress { 1161 lustre_fid hp_fid; 1162 __u64 hp_cookie; 1163 struct hsm_extent hp_extent; 1164 __u16 hp_flags; 1165 __u16 hp_errval; /* positive val */ 1166 __u32 padding; 1167}; 1168 1169struct hsm_copy { 1170 __u64 hc_data_version; 1171 __u16 hc_flags; 1172 __u16 hc_errval; /* positive val */ 1173 __u32 padding; 1174 struct hsm_action_item hc_hai; 1175}; 1176 1177/** @} lustreuser */ 1178 1179#endif /* _LUSTRE_USER_H */ 1180