^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-or-later */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /* AFS common types
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Written by David Howells (dhowells@redhat.com)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #ifndef AFS_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #define AFS_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #include <linux/in.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #define AFS_MAXCELLNAME 256 /* Maximum length of a cell name */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #define AFS_MAXVOLNAME 64 /* Maximum length of a volume name */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #define AFS_MAXNSERVERS 8 /* Maximum servers in a basic volume record */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #define AFS_NMAXNSERVERS 13 /* Maximum servers in a N/U-class volume record */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #define AFS_MAXTYPES 3 /* Maximum number of volume types */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #define AFSNAMEMAX 256 /* Maximum length of a filename plus NUL */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #define AFSPATHMAX 1024 /* Maximum length of a pathname plus NUL */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #define AFSOPAQUEMAX 1024 /* Maximum length of an opaque field */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define AFS_VL_MAX_LIFESPAN (120 * HZ)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define AFS_PROBE_MAX_LIFESPAN (30 * HZ)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) typedef u64 afs_volid_t;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) typedef u64 afs_vnodeid_t;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) typedef u64 afs_dataversion_t;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) typedef enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) AFSVL_RWVOL, /* read/write volume */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) AFSVL_ROVOL, /* read-only volume */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) AFSVL_BACKVOL, /* backup volume */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) } __attribute__((packed)) afs_voltype_t;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) typedef enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) AFS_FTYPE_INVALID = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) AFS_FTYPE_FILE = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) AFS_FTYPE_DIR = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) AFS_FTYPE_SYMLINK = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) } afs_file_type_t;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) typedef enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) AFS_LOCK_READ = 0, /* read lock request */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) AFS_LOCK_WRITE = 1, /* write lock request */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) } afs_lock_type_t;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) #define AFS_LOCKWAIT (5 * 60) /* time until a lock times out (seconds) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) * AFS file identifier
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) struct afs_fid {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) afs_volid_t vid; /* volume ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) afs_vnodeid_t vnode; /* Lower 64-bits of file index within volume */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) u32 vnode_hi; /* Upper 32-bits of file index */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) u32 unique; /* unique ID number (file index version) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) * AFS callback notification
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) typedef enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) AFSCM_CB_UNTYPED = 0, /* no type set on CB break */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) AFSCM_CB_EXCLUSIVE = 1, /* CB exclusive to CM [not implemented] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) AFSCM_CB_SHARED = 2, /* CB shared by other CM's */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) AFSCM_CB_DROPPED = 3, /* CB promise cancelled by file server */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) } afs_callback_type_t;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) struct afs_callback {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) time64_t expires_at; /* Time at which expires */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) //unsigned version; /* Callback version */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) //afs_callback_type_t type; /* Type of callback */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) struct afs_callback_break {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) struct afs_fid fid; /* File identifier */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) //struct afs_callback cb; /* Callback details */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) #define AFSCBMAX 50 /* maximum callbacks transferred per bulk op */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) struct afs_uuid {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) __be32 time_low; /* low part of timestamp */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) __be16 time_mid; /* mid part of timestamp */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) __be16 time_hi_and_version; /* high part of timestamp and version */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) __s8 clock_seq_hi_and_reserved; /* clock seq hi and variant */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) __s8 clock_seq_low; /* clock seq low */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) __s8 node[6]; /* spatially unique node ID (MAC addr) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) * AFS volume information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) struct afs_volume_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) afs_volid_t vid; /* volume ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) afs_voltype_t type; /* type of this volume */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) afs_volid_t type_vids[5]; /* volume ID's for possible types for this vol */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) /* list of fileservers serving this volume */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) size_t nservers; /* number of entries used in servers[] */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) struct {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) struct in_addr addr; /* fileserver address */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) } servers[8];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) * AFS security ACE access mask
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) typedef u32 afs_access_t;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) #define AFS_ACE_READ 0x00000001U /* - permission to read a file/dir */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) #define AFS_ACE_WRITE 0x00000002U /* - permission to write/chmod a file */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) #define AFS_ACE_INSERT 0x00000004U /* - permission to create dirent in a dir */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) #define AFS_ACE_LOOKUP 0x00000008U /* - permission to lookup a file/dir in a dir */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) #define AFS_ACE_DELETE 0x00000010U /* - permission to delete a dirent from a dir */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) #define AFS_ACE_LOCK 0x00000020U /* - permission to lock a file */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) #define AFS_ACE_ADMINISTER 0x00000040U /* - permission to change ACL */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) #define AFS_ACE_USER_A 0x01000000U /* - 'A' user-defined permission */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) #define AFS_ACE_USER_B 0x02000000U /* - 'B' user-defined permission */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) #define AFS_ACE_USER_C 0x04000000U /* - 'C' user-defined permission */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) #define AFS_ACE_USER_D 0x08000000U /* - 'D' user-defined permission */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) #define AFS_ACE_USER_E 0x10000000U /* - 'E' user-defined permission */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) #define AFS_ACE_USER_F 0x20000000U /* - 'F' user-defined permission */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) #define AFS_ACE_USER_G 0x40000000U /* - 'G' user-defined permission */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) #define AFS_ACE_USER_H 0x80000000U /* - 'H' user-defined permission */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) * AFS file status information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) struct afs_file_status {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) u64 size; /* file size */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) afs_dataversion_t data_version; /* current data version */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) struct timespec64 mtime_client; /* Last time client changed data */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) struct timespec64 mtime_server; /* Last time server changed data */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) s64 author; /* author ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) s64 owner; /* owner ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) s64 group; /* group ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) afs_access_t caller_access; /* access rights for authenticated caller */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) afs_access_t anon_access; /* access rights for unauthenticated caller */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) umode_t mode; /* UNIX mode */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) afs_file_type_t type; /* file type */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) u32 nlink; /* link count */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) s32 lock_count; /* file lock count (0=UNLK -1=WRLCK +ve=#RDLCK */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) u32 abort_code; /* Abort if bulk-fetching this failed */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) struct afs_status_cb {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) struct afs_file_status status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) struct afs_callback callback;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) bool have_status; /* True if status record was retrieved */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) bool have_cb; /* True if cb record was retrieved */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) bool have_error; /* True if status.abort_code indicates an error */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) * AFS file status change request
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) #define AFS_SET_MTIME 0x01 /* set the mtime */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) #define AFS_SET_OWNER 0x02 /* set the owner ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) #define AFS_SET_GROUP 0x04 /* set the group ID (unsupported?) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) #define AFS_SET_MODE 0x08 /* set the UNIX mode */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) #define AFS_SET_SEG_SIZE 0x10 /* set the segment size (unsupported) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) * AFS volume synchronisation information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) struct afs_volsync {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) time64_t creation; /* volume creation time */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) * AFS volume status record
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) struct afs_volume_status {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) afs_volid_t vid; /* volume ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) afs_volid_t parent_id; /* parent volume ID */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) u8 online; /* true if volume currently online and available */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) u8 in_service; /* true if volume currently in service */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) u8 blessed; /* same as in_service */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) u8 needs_salvage; /* true if consistency checking required */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) u32 type; /* volume type (afs_voltype_t) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) u64 min_quota; /* minimum space set aside (blocks) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) u64 max_quota; /* maximum space this volume may occupy (blocks) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) u64 blocks_in_use; /* space this volume currently occupies (blocks) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) u64 part_blocks_avail; /* space available in volume's partition */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) u64 part_max_blocks; /* size of volume's partition */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) s64 vol_copy_date;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) s64 vol_backup_date;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) #define AFS_BLOCK_SIZE 1024
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) * XDR encoding of UUID in AFS.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) struct afs_uuid__xdr {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) __be32 time_low;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) __be32 time_mid;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) __be32 time_hi_and_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) __be32 clock_seq_hi_and_reserved;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) __be32 clock_seq_low;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) __be32 node[6];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) #endif /* AFS_H */