fs/afs/afs.h

   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
  26 typedef unsigned                        afs_volid_t;
  27 typedef unsigned                        afs_vnodeid_t;
  28 typedef unsigned long long              afs_dataversion_t;
  29
  30 typedef 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
  36 typedef 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
  43 typedef 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  */
  53 struct 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  */
  62 typedef 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
  69 struct afs_callback {
  70         unsigned                version;        /* Callback version */
  71         unsigned                expiry;         /* Time at which expires */
  72         afs_callback_type_t     type;           /* Type of callback */
  73 };
  74
  75 struct 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
  82 struct 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 information
  93  */
  94 struct 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 mask
 108  */
 109 typedef 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 information
 128  */
 129 struct afs_file_status {
 130         u64                     size;           /* file size */
 131         afs_dataversion_t       data_version;   /* current data version */
 132         time_t                  mtime_client;   /* last time client changed data */
 133         time_t                  mtime_server;   /* last time server changed data */
 134         unsigned                abort_code;     /* Abort if bulk-fetching this failed */
 135
 136         afs_file_type_t         type;           /* file type */
 137         unsigned                nlink;          /* link count */
 138         u32                     author;         /* author ID */
 139         u32                     owner;          /* owner ID */
 140         u32                     group;          /* group ID */
 141         afs_access_t            caller_access;  /* access rights for authenticated caller */
 142         afs_access_t            anon_access;    /* access rights for unauthenticated caller */
 143         umode_t                 mode;           /* UNIX mode */
 144         s32                     lock_count;     /* file lock count (0=UNLK -1=WRLCK +ve=#RDLCK */
 145 };
 146
 147 /*
 148  * AFS file status change request
 149  */
 150
 151 #define AFS_SET_MTIME           0x01            /* set the mtime */
 152 #define AFS_SET_OWNER           0x02            /* set the owner ID */
 153 #define AFS_SET_GROUP           0x04            /* set the group ID (unsupported?) */
 154 #define AFS_SET_MODE            0x08            /* set the UNIX mode */
 155 #define AFS_SET_SEG_SIZE        0x10            /* set the segment size (unsupported) */
 156
 157 /*
 158  * AFS volume synchronisation information
 159  */
 160 struct afs_volsync {
 161         time_t                  creation;       /* volume creation time */
 162 };
 163
 164 /*
 165  * AFS volume status record
 166  */
 167 struct afs_volume_status {
 168         u32                     vid;            /* volume ID */
 169         u32                     parent_id;      /* parent volume ID */
 170         u8                      online;         /* true if volume currently online and available */
 171         u8                      in_service;     /* true if volume currently in service */
 172         u8                      blessed;        /* same as in_service */
 173         u8                      needs_salvage;  /* true if consistency checking required */
 174         u32                     type;           /* volume type (afs_voltype_t) */
 175         u32                     min_quota;      /* minimum space set aside (blocks) */
 176         u32                     max_quota;      /* maximum space this volume may occupy (blocks) */
 177         u32                     blocks_in_use;  /* space this volume currently occupies (blocks) */
 178         u32                     part_blocks_avail; /* space available in volume's partition */
 179         u32                     part_max_blocks; /* size of volume's partition */
 180 };
 181
 182 #define AFS_BLOCK_SIZE  1024
 183
 184 /*
 185  * XDR encoding of UUID in AFS.
 186  */
 187 struct afs_uuid__xdr {
 188         __be32          time_low;
 189         __be32          time_mid;
 190         __be32          time_hi_and_version;
 191         __be32          clock_seq_hi_and_reserved;
 192         __be32          clock_seq_low;
 193         __be32          node[6];
 194 };
 195
 196 #endif /* AFS_H */