[linux.git] / fs / afs / afs.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/* AFS common types
 *
 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells ([email protected])
 */

#ifndef AFS_H
#define AFS_H

#include <linux/in.h>

#define AFS_MAXCELLNAME		256  	/* Maximum length of a cell name */
#define AFS_MAXVOLNAME		64  	/* Maximum length of a volume name */
#define AFS_MAXNSERVERS		8   	/* Maximum servers in a basic volume record */
#define AFS_NMAXNSERVERS	13  	/* Maximum servers in a N/U-class volume record */
#define AFS_MAXTYPES		3	/* Maximum number of volume types */
#define AFSNAMEMAX		256 	/* Maximum length of a filename plus NUL */
#define AFSPATHMAX		1024	/* Maximum length of a pathname plus NUL */
#define AFSOPAQUEMAX		1024	/* Maximum length of an opaque field */

#define AFS_VL_MAX_LIFESPAN	(120 * HZ)
#define AFS_PROBE_MAX_LIFESPAN	(30 * HZ)

typedef u64			afs_volid_t;
typedef u64			afs_vnodeid_t;
typedef u64			afs_dataversion_t;

typedef enum {
	AFSVL_RWVOL,			/* read/write volume */
	AFSVL_ROVOL,			/* read-only volume */
	AFSVL_BACKVOL,			/* backup volume */
} __attribute__((packed)) afs_voltype_t;

typedef enum {
	AFS_FTYPE_INVALID	= 0,
	AFS_FTYPE_FILE		= 1,
	AFS_FTYPE_DIR		= 2,
	AFS_FTYPE_SYMLINK	= 3,
} afs_file_type_t;

typedef enum {
	AFS_LOCK_READ		= 0,	/* read lock request */
	AFS_LOCK_WRITE		= 1,	/* write lock request */
} afs_lock_type_t;

#define AFS_LOCKWAIT		(5 * 60) /* time until a lock times out (seconds) */

/*
 * AFS file identifier
 */
struct afs_fid {
	afs_volid_t	vid;		/* volume ID */
	afs_vnodeid_t	vnode;		/* Lower 64-bits of file index within volume */
	u32		vnode_hi;	/* Upper 32-bits of file index */
	u32		unique;		/* unique ID number (file index version) */
};

/*
 * AFS callback notification
 */
typedef enum {
	AFSCM_CB_UNTYPED	= 0,	/* no type set on CB break */
	AFSCM_CB_EXCLUSIVE	= 1,	/* CB exclusive to CM [not implemented] */
	AFSCM_CB_SHARED		= 2,	/* CB shared by other CM's */
	AFSCM_CB_DROPPED	= 3,	/* CB promise cancelled by file server */
} afs_callback_type_t;

struct afs_callback {
	time64_t		expires_at;	/* Time at which expires */
	//unsigned		version;	/* Callback version */
	//afs_callback_type_t	type;		/* Type of callback */
};

struct afs_callback_break {
	struct afs_fid		fid;		/* File identifier */
	//struct afs_callback	cb;		/* Callback details */
};

#define AFSCBMAX 50	/* maximum callbacks transferred per bulk op */

struct afs_uuid {
	__be32		time_low;			/* low part of timestamp */
	__be16		time_mid;			/* mid part of timestamp */
	__be16		time_hi_and_version;		/* high part of timestamp and version  */
	__s8		clock_seq_hi_and_reserved;	/* clock seq hi and variant */
	__s8		clock_seq_low;			/* clock seq low */
	__s8		node[6];			/* spatially unique node ID (MAC addr) */
};

/*
 * AFS volume information
 */
struct afs_volume_info {
	afs_volid_t		vid;		/* volume ID */
	afs_voltype_t		type;		/* type of this volume */
	afs_volid_t		type_vids[5];	/* volume ID's for possible types for this vol */

	/* list of fileservers serving this volume */
	size_t			nservers;	/* number of entries used in servers[] */
	struct {
		struct in_addr	addr;		/* fileserver address */
	} servers[8];
};

/*
 * AFS security ACE access mask
 */
typedef u32 afs_access_t;
#define AFS_ACE_READ		0x00000001U	/* - permission to read a file/dir */
#define AFS_ACE_WRITE		0x00000002U	/* - permission to write/chmod a file */
#define AFS_ACE_INSERT		0x00000004U	/* - permission to create dirent in a dir */
#define AFS_ACE_LOOKUP		0x00000008U	/* - permission to lookup a file/dir in a dir */
#define AFS_ACE_DELETE		0x00000010U	/* - permission to delete a dirent from a dir */
#define AFS_ACE_LOCK		0x00000020U	/* - permission to lock a file */
#define AFS_ACE_ADMINISTER	0x00000040U	/* - permission to change ACL */
#define AFS_ACE_USER_A		0x01000000U	/* - 'A' user-defined permission */
#define AFS_ACE_USER_B		0x02000000U	/* - 'B' user-defined permission */
#define AFS_ACE_USER_C		0x04000000U	/* - 'C' user-defined permission */
#define AFS_ACE_USER_D		0x08000000U	/* - 'D' user-defined permission */
#define AFS_ACE_USER_E		0x10000000U	/* - 'E' user-defined permission */
#define AFS_ACE_USER_F		0x20000000U	/* - 'F' user-defined permission */
#define AFS_ACE_USER_G		0x40000000U	/* - 'G' user-defined permission */
#define AFS_ACE_USER_H		0x80000000U	/* - 'H' user-defined permission */

/*
 * AFS file status information
 */
struct afs_file_status {
	u64			size;		/* file size */
	afs_dataversion_t	data_version;	/* current data version */
	struct timespec64	mtime_client;	/* Last time client changed data */
	struct timespec64	mtime_server;	/* Last time server changed data */
	s64			author;		/* author ID */
	s64			owner;		/* owner ID */
	s64			group;		/* group ID */
	afs_access_t		caller_access;	/* access rights for authenticated caller */
	afs_access_t		anon_access;	/* access rights for unauthenticated caller */
	umode_t			mode;		/* UNIX mode */
	afs_file_type_t		type;		/* file type */
	u32			nlink;		/* link count */
	s32			lock_count;	/* file lock count (0=UNLK -1=WRLCK +ve=#RDLCK */
	u32			abort_code;	/* Abort if bulk-fetching this failed */
};

struct afs_status_cb {
	struct afs_file_status	status;
	struct afs_callback	callback;
	bool			have_status;	/* True if status record was retrieved */
	bool			have_cb;	/* True if cb record was retrieved */
	bool			have_error;	/* True if status.abort_code indicates an error */
};

/*
 * AFS file status change request
 */

#define AFS_SET_MTIME		0x01		/* set the mtime */
#define AFS_SET_OWNER		0x02		/* set the owner ID */
#define AFS_SET_GROUP		0x04		/* set the group ID (unsupported?) */
#define AFS_SET_MODE		0x08		/* set the UNIX mode */
#define AFS_SET_SEG_SIZE	0x10		/* set the segment size (unsupported) */

/*
 * AFS volume synchronisation information
 */
struct afs_volsync {
	time64_t		creation;	/* volume creation time */
};

/*
 * AFS volume status record
 */
struct afs_volume_status {
	afs_volid_t		vid;		/* volume ID */
	afs_volid_t		parent_id;	/* parent volume ID */
	u8			online;		/* true if volume currently online and available */
	u8			in_service;	/* true if volume currently in service */
	u8			blessed;	/* same as in_service */
	u8			needs_salvage;	/* true if consistency checking required */
	u32			type;		/* volume type (afs_voltype_t) */
	u64			min_quota;	/* minimum space set aside (blocks) */
	u64			max_quota;	/* maximum space this volume may occupy (blocks) */
	u64			blocks_in_use;	/* space this volume currently occupies (blocks) */
	u64			part_blocks_avail; /* space available in volume's partition */
	u64			part_max_blocks; /* size of volume's partition */
	s64			vol_copy_date;
	s64			vol_backup_date;
};

#define AFS_BLOCK_SIZE	1024

/*
 * XDR encoding of UUID in AFS.
 */
struct afs_uuid__xdr {
	__be32		time_low;
	__be32		time_mid;
	__be32		time_hi_and_version;
	__be32		clock_seq_hi_and_reserved;
	__be32		clock_seq_low;
	__be32		node[6];
};

#endif /* AFS_H */
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
08e0e7c8	2	/* AFS common types
1da177e4	3	*
08e0e7c8	4	* Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
1da177e4	5	* Written by David Howells ([email protected])
1da177e4 LT	6	*/
1da177e4 LT	7
08e0e7c8 DH	8	#ifndef AFS_H
08e0e7c8 DH	9	#define AFS_H
1da177e4	10
08e0e7c8	11	#include <linux/in.h>
1da177e4	12
c3e9f888	13	#define AFS_MAXCELLNAME 256 /* Maximum length of a cell name */
91a90380 DH	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 */
00d3b7a4	21
94f699c9 DH	22	#define AFS_VL_MAX_LIFESPAN (120 * HZ)
	23	#define AFS_PROBE_MAX_LIFESPAN (30 * HZ)
	24
3b6492df DH	25	typedef u64 afs_volid_t;
	26	typedef u64 afs_vnodeid_t;
	27	typedef u64 afs_dataversion_t;
1da177e4 LT	28
	29	typedef 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
	35	typedef 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
e8d6c554 DH	42	typedef 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
1da177e4 LT	49	/*
	50	* AFS file identifier
	51	*/
ec26815a	52	struct afs_fid {
1da177e4	53	afs_volid_t vid; /* volume ID */
3b6492df DH	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) */
1da177e4 LT	57	};
1da177e4 LT	58
1da177e4 LT	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
ec26815a	69	struct afs_callback {
12d8e95a	70	time64_t expires_at; /* Time at which expires */
7c712458 DH	71	//unsigned version; /* Callback version */
7c712458 DH	72	//afs_callback_type_t type; /* Type of callback */
5cf9dd55 DH	73	};
	74
	75	struct afs_callback_break {
	76	struct afs_fid fid; /* File identifier */
06aeb297	77	//struct afs_callback cb; /* Callback details */
1da177e4 LT	78	};
1da177e4 LT	79
08e0e7c8	80	#define AFSCBMAX 50 /* maximum callbacks transferred per bulk op */
1da177e4	81
f044c884 DH	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 */
03dc2cfc DH	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) */
f044c884 DH	89	};
f044c884 DH	90
1da177e4 LT	91	/*
	92	* AFS volume information
	93	*/
ec26815a	94	struct afs_volume_info {
1da177e4 LT	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 */
08e0e7c8	98
1da177e4 LT	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
00d3b7a4 DH	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
1da177e4 LT	126	/*
	127	* AFS file status information
	128	*/
ec26815a	129	struct afs_file_status {
5cf9dd55 DH	130	u64 size; /* file size */
5cf9dd55 DH	131	afs_dataversion_t data_version; /* current data version */
d4936803 DH	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 */
00d3b7a4 DH	137	afs_access_t caller_access; /* access rights for authenticated caller */
00d3b7a4 DH	138	afs_access_t anon_access; /* access rights for unauthenticated caller */
1da177e4	139	umode_t mode; /* UNIX mode */
d4936803 DH	140	afs_file_type_t type; /* file type */
d4936803 DH	141	u32 nlink; /* link count */
e8d6c554	142	s32 lock_count; /* file lock count (0=UNLK -1=WRLCK +ve=#RDLCK */
d4936803	143	u32 abort_code; /* Abort if bulk-fetching this failed */
1da177e4 LT	144	};
1da177e4 LT	145
87182759 DH	146	struct afs_status_cb {
	147	struct afs_file_status status;
	148	struct afs_callback callback;
a38a7558	149	bool have_status; /* True if status record was retrieved */
87182759	150	bool have_cb; /* True if cb record was retrieved */
a38a7558	151	bool have_error; /* True if status.abort_code indicates an error */
87182759 DH	152	};
87182759 DH	153
260a9803 DH	154	/*
	155	* AFS file status change request
	156	*/
260a9803 DH	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
1da177e4 LT	164	/*
	165	* AFS volume synchronisation information
	166	*/
ec26815a	167	struct afs_volsync {
d4936803	168	time64_t creation; /* volume creation time */
1da177e4 LT	169	};
1da177e4 LT	170
45222b9e DH	171	/*
	172	* AFS volume status record
	173	*/
	174	struct afs_volume_status {
d4936803 DH	175	afs_volid_t vid; /* volume ID */
d4936803 DH	176	afs_volid_t parent_id; /* parent volume ID */
45222b9e DH	177	u8 online; /* true if volume currently online and available */
	178	u8 in_service; /* true if volume currently in service */
	179	u8 blessed; /* same as in_service */
	180	u8 needs_salvage; /* true if consistency checking required */
	181	u32 type; /* volume type (afs_voltype_t) */
d4936803 DH	182	u64 min_quota; /* minimum space set aside (blocks) */
	183	u64 max_quota; /* maximum space this volume may occupy (blocks) */
	184	u64 blocks_in_use; /* space this volume currently occupies (blocks) */
	185	u64 part_blocks_avail; /* space available in volume's partition */
	186	u64 part_max_blocks; /* size of volume's partition */
	187	s64 vol_copy_date;
	188	s64 vol_backup_date;
45222b9e DH	189	};
	190
	191	#define AFS_BLOCK_SIZE 1024
	192
91a90380 DH	193	/*
	194	* XDR encoding of UUID in AFS.
	195	*/
	196	struct afs_uuid__xdr {
	197	__be32 time_low;
	198	__be32 time_mid;
	199	__be32 time_hi_and_version;
	200	__be32 clock_seq_hi_and_reserved;
	201	__be32 clock_seq_low;
	202	__be32 node[6];
	203	};
	204
08e0e7c8	205	#endif /* AFS_H */