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