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

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

#ifndef AFS_VL_H
#define AFS_VL_H

#include "afs.h"

#define AFS_VL_PORT		7003	/* volume location service port */
#define VL_SERVICE		52	/* RxRPC service ID for the Volume Location service */
#define YFS_VL_SERVICE		2503	/* Service ID for AuriStor upgraded VL service */

enum AFSVL_Operations {
	VLGETENTRYBYID		= 503,	/* AFS Get VLDB entry by ID */
	VLGETENTRYBYNAME	= 504,	/* AFS Get VLDB entry by name */
	VLPROBE			= 514,	/* AFS probe VL service */
	VLGETENTRYBYIDU		= 526,	/* AFS Get VLDB entry by ID (UUID-variant) */
	VLGETENTRYBYNAMEU	= 527,	/* AFS Get VLDB entry by name (UUID-variant) */
	VLGETADDRSU		= 533,	/* AFS Get addrs for fileserver */
	YVLGETENDPOINTS		= 64002, /* YFS Get endpoints for file/volume server */
	VLGETCAPABILITIES	= 65537, /* AFS Get server capabilities */
};

enum AFSVL_Errors {
	AFSVL_IDEXIST 		= 363520,	/* Volume Id entry exists in vl database */
	AFSVL_IO 		= 363521,	/* I/O related error */
	AFSVL_NAMEEXIST 	= 363522,	/* Volume name entry exists in vl database */
	AFSVL_CREATEFAIL 	= 363523,	/* Internal creation failure */
	AFSVL_NOENT 		= 363524,	/* No such entry */
	AFSVL_EMPTY 		= 363525,	/* Vl database is empty */
	AFSVL_ENTDELETED 	= 363526,	/* Entry is deleted (soft delete) */
	AFSVL_BADNAME 		= 363527,	/* Volume name is illegal */
	AFSVL_BADINDEX 		= 363528,	/* Index is out of range */
	AFSVL_BADVOLTYPE 	= 363529,	/* Bad volume type */
	AFSVL_BADSERVER 	= 363530,	/* Illegal server number (out of range) */
	AFSVL_BADPARTITION 	= 363531,	/* Bad partition number */
	AFSVL_REPSFULL 		= 363532,	/* Run out of space for Replication sites */
	AFSVL_NOREPSERVER 	= 363533,	/* No such Replication server site exists */
	AFSVL_DUPREPSERVER 	= 363534,	/* Replication site already exists */
	AFSVL_RWNOTFOUND 	= 363535,	/* Parent R/W entry not found */
	AFSVL_BADREFCOUNT 	= 363536,	/* Illegal Reference Count number */
	AFSVL_SIZEEXCEEDED 	= 363537,	/* Vl size for attributes exceeded */
	AFSVL_BADENTRY 		= 363538,	/* Bad incoming vl entry */
	AFSVL_BADVOLIDBUMP 	= 363539,	/* Illegal max volid increment */
	AFSVL_IDALREADYHASHED 	= 363540,	/* RO/BACK id already hashed */
	AFSVL_ENTRYLOCKED 	= 363541,	/* Vl entry is already locked */
	AFSVL_BADVOLOPER 	= 363542,	/* Bad volume operation code */
	AFSVL_BADRELLOCKTYPE 	= 363543,	/* Bad release lock type */
	AFSVL_RERELEASE 	= 363544,	/* Status report: last release was aborted */
	AFSVL_BADSERVERFLAG 	= 363545,	/* Invalid replication site server flag */
	AFSVL_PERM 		= 363546,	/* No permission access */
	AFSVL_NOMEM 		= 363547,	/* malloc/realloc failed to alloc enough memory */
};

enum {
	YFS_SERVER_INDEX	= 0,
	YFS_SERVER_UUID		= 1,
	YFS_SERVER_ENDPOINT	= 2,
};

enum {
	YFS_ENDPOINT_IPV4	= 0,
	YFS_ENDPOINT_IPV6	= 1,
};

#define YFS_MAXENDPOINTS	16

/*
 * maps to "struct vldbentry" in vvl-spec.pdf
 */
struct afs_vldbentry {
	char		name[65];		/* name of volume (with NUL char) */
	afs_voltype_t	type;			/* volume type */
	unsigned	num_servers;		/* num servers that hold instances of this vol */
	unsigned	clone_id;		/* cloning ID */

	unsigned	flags;
#define AFS_VLF_RWEXISTS	0x1000		/* R/W volume exists */
#define AFS_VLF_ROEXISTS	0x2000		/* R/O volume exists */
#define AFS_VLF_BACKEXISTS	0x4000		/* backup volume exists */

	afs_volid_t	volume_ids[3];		/* volume IDs */

	struct {
		struct in_addr	addr;		/* server address */
		unsigned	partition;	/* partition ID on this server */
		unsigned	flags;		/* server specific flags */
#define AFS_VLSF_NEWREPSITE	0x0001	/* Ignore all 'non-new' servers */
#define AFS_VLSF_ROVOL		0x0002	/* this server holds a R/O instance of the volume */
#define AFS_VLSF_RWVOL		0x0004	/* this server holds a R/W instance of the volume */
#define AFS_VLSF_BACKVOL	0x0008	/* this server holds a backup instance of the volume */
#define AFS_VLSF_UUID		0x0010	/* This server is referred to by its UUID */
#define AFS_VLSF_DONTUSE	0x0020	/* This server ref should be ignored */
	} servers[8];
};

#define AFS_VLDB_MAXNAMELEN 65


struct afs_ListAddrByAttributes__xdr {
	__be32			Mask;
#define AFS_VLADDR_IPADDR	0x1	/* Match by ->ipaddr */
#define AFS_VLADDR_INDEX	0x2	/* Match by ->index */
#define AFS_VLADDR_UUID		0x4	/* Match by ->uuid */
	__be32			ipaddr;
	__be32			index;
	__be32			spare;
	struct afs_uuid__xdr	uuid;
};

struct afs_uvldbentry__xdr {
	__be32			name[AFS_VLDB_MAXNAMELEN];
	__be32			nServers;
	struct afs_uuid__xdr	serverNumber[AFS_NMAXNSERVERS];
	__be32			serverUnique[AFS_NMAXNSERVERS];
	__be32			serverPartition[AFS_NMAXNSERVERS];
	__be32			serverFlags[AFS_NMAXNSERVERS];
	__be32			volumeId[AFS_MAXTYPES];
	__be32			cloneId;
	__be32			flags;
	__be32			spares1;
	__be32			spares2;
	__be32			spares3;
	__be32			spares4;
	__be32			spares5;
	__be32			spares6;
	__be32			spares7;
	__be32			spares8;
	__be32			spares9;
};

struct afs_address_list {
	refcount_t		usage;
	unsigned int		version;
	unsigned int		nr_addrs;
	struct sockaddr_rxrpc	addrs[];
};

extern void afs_put_address_list(struct afs_address_list *alist);

#endif /* AFS_VL_H */
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
08e0e7c8	2	/* AFS Volume Location Service client interface
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_VL_H
08e0e7c8 DH	9	#define AFS_VL_H
1da177e4	10
08e0e7c8 DH	11	#include "afs.h"
	12
	13	#define AFS_VL_PORT 7003 /* volume location service port */
	14	#define VL_SERVICE 52 /* RxRPC service ID for the Volume Location service */
bf99a53c	15	#define YFS_VL_SERVICE 2503 /* Service ID for AuriStor upgraded VL service */
08e0e7c8 DH	16
08e0e7c8 DH	17	enum AFSVL_Operations {
91a90380 DH	18	VLGETENTRYBYID = 503, /* AFS Get VLDB entry by ID */
	19	VLGETENTRYBYNAME = 504, /* AFS Get VLDB entry by name */
	20	VLPROBE = 514, /* AFS probe VL service */
	21	VLGETENTRYBYIDU = 526, /* AFS Get VLDB entry by ID (UUID-variant) */
	22	VLGETENTRYBYNAMEU = 527, /* AFS Get VLDB entry by name (UUID-variant) */
	23	VLGETADDRSU = 533, /* AFS Get addrs for fileserver */
bf99a53c DH	24	YVLGETENDPOINTS = 64002, /* YFS Get endpoints for file/volume server */
bf99a53c DH	25	VLGETCAPABILITIES = 65537, /* AFS Get server capabilities */
08e0e7c8	26	};
1da177e4 LT	27
	28	enum AFSVL_Errors {
	29	AFSVL_IDEXIST = 363520, /* Volume Id entry exists in vl database */
	30	AFSVL_IO = 363521, /* I/O related error */
	31	AFSVL_NAMEEXIST = 363522, /* Volume name entry exists in vl database */
	32	AFSVL_CREATEFAIL = 363523, /* Internal creation failure */
	33	AFSVL_NOENT = 363524, /* No such entry */
	34	AFSVL_EMPTY = 363525, /* Vl database is empty */
	35	AFSVL_ENTDELETED = 363526, /* Entry is deleted (soft delete) */
	36	AFSVL_BADNAME = 363527, /* Volume name is illegal */
	37	AFSVL_BADINDEX = 363528, /* Index is out of range */
	38	AFSVL_BADVOLTYPE = 363529, /* Bad volume type */
	39	AFSVL_BADSERVER = 363530, /* Illegal server number (out of range) */
	40	AFSVL_BADPARTITION = 363531, /* Bad partition number */
	41	AFSVL_REPSFULL = 363532, /* Run out of space for Replication sites */
	42	AFSVL_NOREPSERVER = 363533, /* No such Replication server site exists */
	43	AFSVL_DUPREPSERVER = 363534, /* Replication site already exists */
	44	AFSVL_RWNOTFOUND = 363535, /* Parent R/W entry not found */
	45	AFSVL_BADREFCOUNT = 363536, /* Illegal Reference Count number */
	46	AFSVL_SIZEEXCEEDED = 363537, /* Vl size for attributes exceeded */
	47	AFSVL_BADENTRY = 363538, /* Bad incoming vl entry */
	48	AFSVL_BADVOLIDBUMP = 363539, /* Illegal max volid increment */
	49	AFSVL_IDALREADYHASHED = 363540, /* RO/BACK id already hashed */
	50	AFSVL_ENTRYLOCKED = 363541, /* Vl entry is already locked */
	51	AFSVL_BADVOLOPER = 363542, /* Bad volume operation code */
	52	AFSVL_BADRELLOCKTYPE = 363543, /* Bad release lock type */
	53	AFSVL_RERELEASE = 363544, /* Status report: last release was aborted */
e4b9f005	54	AFSVL_BADSERVERFLAG = 363545, /* Invalid replication site server flag */
1da177e4 LT	55	AFSVL_PERM = 363546, /* No permission access */
	56	AFSVL_NOMEM = 363547, /* malloc/realloc failed to alloc enough memory */
	57	};
	58
bf99a53c DH	59	enum {
	60	YFS_SERVER_INDEX = 0,
	61	YFS_SERVER_UUID = 1,
	62	YFS_SERVER_ENDPOINT = 2,
	63	};
	64
	65	enum {
	66	YFS_ENDPOINT_IPV4 = 0,
	67	YFS_ENDPOINT_IPV6 = 1,
	68	};
	69
	70	#define YFS_MAXENDPOINTS 16
	71
08e0e7c8 DH	72	/*
	73	* maps to "struct vldbentry" in vvl-spec.pdf
	74	*/
1da177e4	75	struct afs_vldbentry {
08e0e7c8	76	char name[65]; /* name of volume (with NUL char) */
1da177e4 LT	77	afs_voltype_t type; /* volume type */
	78	unsigned num_servers; /* num servers that hold instances of this vol */
	79	unsigned clone_id; /* cloning ID */
	80
	81	unsigned flags;
	82	#define AFS_VLF_RWEXISTS 0x1000 /* R/W volume exists */
	83	#define AFS_VLF_ROEXISTS 0x2000 /* R/O volume exists */
	84	#define AFS_VLF_BACKEXISTS 0x4000 /* backup volume exists */
	85
	86	afs_volid_t volume_ids[3]; /* volume IDs */
	87
	88	struct {
	89	struct in_addr addr; /* server address */
	90	unsigned partition; /* partition ID on this server */
	91	unsigned flags; /* server specific flags */
91a90380	92	#define AFS_VLSF_NEWREPSITE 0x0001 /* Ignore all 'non-new' servers */
1da177e4 LT	93	#define AFS_VLSF_ROVOL 0x0002 /* this server holds a R/O instance of the volume */
	94	#define AFS_VLSF_RWVOL 0x0004 /* this server holds a R/W instance of the volume */
	95	#define AFS_VLSF_BACKVOL 0x0008 /* this server holds a backup instance of the volume */
91a90380 DH	96	#define AFS_VLSF_UUID 0x0010 /* This server is referred to by its UUID */
91a90380 DH	97	#define AFS_VLSF_DONTUSE 0x0020 /* This server ref should be ignored */
1da177e4	98	} servers[8];
1da177e4 LT	99	};
1da177e4 LT	100
91a90380 DH	101	#define AFS_VLDB_MAXNAMELEN 65
91a90380 DH	102
d2ddc776 DH	103
	104	struct afs_ListAddrByAttributes__xdr {
	105	__be32 Mask;
	106	#define AFS_VLADDR_IPADDR 0x1 /* Match by ->ipaddr */
	107	#define AFS_VLADDR_INDEX 0x2 /* Match by ->index */
	108	#define AFS_VLADDR_UUID 0x4 /* Match by ->uuid */
	109	__be32 ipaddr;
	110	__be32 index;
	111	__be32 spare;
	112	struct afs_uuid__xdr uuid;
	113	};
	114
	115	struct afs_uvldbentry__xdr {
	116	__be32 name[AFS_VLDB_MAXNAMELEN];
	117	__be32 nServers;
	118	struct afs_uuid__xdr serverNumber[AFS_NMAXNSERVERS];
	119	__be32 serverUnique[AFS_NMAXNSERVERS];
	120	__be32 serverPartition[AFS_NMAXNSERVERS];
	121	__be32 serverFlags[AFS_NMAXNSERVERS];
	122	__be32 volumeId[AFS_MAXTYPES];
	123	__be32 cloneId;
	124	__be32 flags;
	125	__be32 spares1;
	126	__be32 spares2;
	127	__be32 spares3;
	128	__be32 spares4;
	129	__be32 spares5;
	130	__be32 spares6;
	131	__be32 spares7;
	132	__be32 spares8;
	133	__be32 spares9;
	134	};
	135
	136	struct afs_address_list {
	137	refcount_t usage;
	138	unsigned int version;
	139	unsigned int nr_addrs;
	140	struct sockaddr_rxrpc addrs[];
	141	};
	142
	143	extern void afs_put_address_list(struct afs_address_list *alist);
	144
08e0e7c8	145	#endif /* AFS_VL_H */