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