[linux-block.git] / include / linux / lockd / xdr.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * linux/include/linux/lockd/xdr.h
 *
 * XDR types for the NLM protocol
 *
 * Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de>
 */

#ifndef LOCKD_XDR_H
#define LOCKD_XDR_H

#include <linux/fs.h>
#include <linux/filelock.h>
#include <linux/nfs.h>
#include <linux/sunrpc/xdr.h>

#define SM_MAXSTRLEN		1024
#define SM_PRIV_SIZE		16

struct nsm_private {
	unsigned char		data[SM_PRIV_SIZE];
};

struct svc_rqst;

#define NLM_MAXCOOKIELEN    	32
#define NLM_MAXSTRLEN		1024

#define	nlm_granted		cpu_to_be32(NLM_LCK_GRANTED)
#define	nlm_lck_denied		cpu_to_be32(NLM_LCK_DENIED)
#define	nlm_lck_denied_nolocks	cpu_to_be32(NLM_LCK_DENIED_NOLOCKS)
#define	nlm_lck_blocked		cpu_to_be32(NLM_LCK_BLOCKED)
#define	nlm_lck_denied_grace_period	cpu_to_be32(NLM_LCK_DENIED_GRACE_PERIOD)

#define nlm_drop_reply		cpu_to_be32(30000)

/* Lock info passed via NLM */
struct nlm_lock {
	char *			caller;
	unsigned int		len; 	/* length of "caller" */
	struct nfs_fh		fh;
	struct xdr_netobj	oh;
	u32			svid;
	u64			lock_start;
	u64			lock_len;
	struct file_lock	fl;
};

/*
 *	NLM cookies. Technically they can be 1K, but Linux only uses 8 bytes.
 *	FreeBSD uses 16, Apple Mac OS X 10.3 uses 20. Therefore we set it to
 *	32 bytes.
 */
 
struct nlm_cookie
{
	unsigned char data[NLM_MAXCOOKIELEN];
	unsigned int len;
};

/*
 * Generic lockd arguments for all but sm_notify
 */
struct nlm_args {
	struct nlm_cookie	cookie;
	struct nlm_lock		lock;
	u32			block;
	u32			reclaim;
	u32			state;
	u32			monitor;
	u32			fsm_access;
	u32			fsm_mode;
};

typedef struct nlm_args nlm_args;

/*
 * Generic lockd result
 */
struct nlm_res {
	struct nlm_cookie	cookie;
	__be32			status;
	struct nlm_lock		lock;
};

/*
 * statd callback when client has rebooted
 */
struct nlm_reboot {
	char			*mon;
	unsigned int		len;
	u32			state;
	struct nsm_private	priv;
};

/*
 * Contents of statd callback when monitored host rebooted
 */
#define NLMSVC_XDRSIZE		sizeof(struct nlm_args)

bool	nlmsvc_decode_void(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_decode_testargs(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_decode_lockargs(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_decode_cancargs(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_decode_unlockargs(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_decode_res(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_decode_reboot(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_decode_shareargs(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_decode_notify(struct svc_rqst *rqstp, struct xdr_stream *xdr);

bool	nlmsvc_encode_testres(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_encode_res(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_encode_void(struct svc_rqst *rqstp, struct xdr_stream *xdr);
bool	nlmsvc_encode_shareres(struct svc_rqst *rqstp, struct xdr_stream *xdr);

#endif /* LOCKD_XDR_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	* linux/include/linux/lockd/xdr.h
	4	*
	5	* XDR types for the NLM protocol
	6	*
	7	* Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de>
	8	*/
	9
	10	#ifndef LOCKD_XDR_H
	11	#define LOCKD_XDR_H
	12
	13	#include <linux/fs.h>
5970e15d	14	#include <linux/filelock.h>
1da177e4 LT	15	#include <linux/nfs.h>
	16	#include <linux/sunrpc/xdr.h>
	17
e6765b83	18	#define SM_MAXSTRLEN 1024
7e44d3be CL	19	#define SM_PRIV_SIZE 16
	20
	21	struct nsm_private {
	22	unsigned char data[SM_PRIV_SIZE];
	23	};
	24
d343fce1 N	25	struct svc_rqst;
d343fce1 N	26
1da177e4 LT	27	#define NLM_MAXCOOKIELEN 32
	28	#define NLM_MAXSTRLEN 1024
	29
77f18f5e HH	30	#define nlm_granted cpu_to_be32(NLM_LCK_GRANTED)
	31	#define nlm_lck_denied cpu_to_be32(NLM_LCK_DENIED)
	32	#define nlm_lck_denied_nolocks cpu_to_be32(NLM_LCK_DENIED_NOLOCKS)
	33	#define nlm_lck_blocked cpu_to_be32(NLM_LCK_BLOCKED)
	34	#define nlm_lck_denied_grace_period cpu_to_be32(NLM_LCK_DENIED_GRACE_PERIOD)
1da177e4	35
77f18f5e	36	#define nlm_drop_reply cpu_to_be32(30000)
d343fce1	37
1da177e4 LT	38	/* Lock info passed via NLM */
	39	struct nlm_lock {
	40	char * caller;
48df020a	41	unsigned int len; /* length of "caller" */
1da177e4 LT	42	struct nfs_fh fh;
1da177e4 LT	43	struct xdr_netobj oh;
7bab377f	44	u32 svid;
6930bcbf JL	45	u64 lock_start;
6930bcbf JL	46	u64 lock_len;
1da177e4 LT	47	struct file_lock fl;
	48	};
	49
	50	/*
	51	* NLM cookies. Technically they can be 1K, but Linux only uses 8 bytes.
	52	* FreeBSD uses 16, Apple Mac OS X 10.3 uses 20. Therefore we set it to
	53	* 32 bytes.
	54	*/
	55
	56	struct nlm_cookie
	57	{
	58	unsigned char data[NLM_MAXCOOKIELEN];
	59	unsigned int len;
	60	};
	61
	62	/*
	63	* Generic lockd arguments for all but sm_notify
	64	*/
	65	struct nlm_args {
	66	struct nlm_cookie cookie;
	67	struct nlm_lock lock;
	68	u32 block;
	69	u32 reclaim;
	70	u32 state;
	71	u32 monitor;
	72	u32 fsm_access;
	73	u32 fsm_mode;
	74	};
	75
	76	typedef struct nlm_args nlm_args;
	77
	78	/*
	79	* Generic lockd result
	80	*/
	81	struct nlm_res {
	82	struct nlm_cookie cookie;
e8c5c045	83	__be32 status;
1da177e4 LT	84	struct nlm_lock lock;
	85	};
	86
	87	/*
	88	* statd callback when client has rebooted
	89	*/
	90	struct nlm_reboot {
576df463 CL	91	char *mon;
	92	unsigned int len;
	93	u32 state;
	94	struct nsm_private priv;
1da177e4 LT	95	};
	96
	97	/*
	98	* Contents of statd callback when monitored host rebooted
	99	*/
	100	#define NLMSVC_XDRSIZE sizeof(struct nlm_args)
	101
c44b31c2 CL	102	bool nlmsvc_decode_void(struct svc_rqst rqstp, struct xdr_stream xdr);
	103	bool nlmsvc_decode_testargs(struct svc_rqst rqstp, struct xdr_stream xdr);
	104	bool nlmsvc_decode_lockargs(struct svc_rqst rqstp, struct xdr_stream xdr);
	105	bool nlmsvc_decode_cancargs(struct svc_rqst rqstp, struct xdr_stream xdr);
	106	bool nlmsvc_decode_unlockargs(struct svc_rqst rqstp, struct xdr_stream xdr);
	107	bool nlmsvc_decode_res(struct svc_rqst rqstp, struct xdr_stream xdr);
	108	bool nlmsvc_decode_reboot(struct svc_rqst rqstp, struct xdr_stream xdr);
	109	bool nlmsvc_decode_shareargs(struct svc_rqst rqstp, struct xdr_stream xdr);
	110	bool nlmsvc_decode_notify(struct svc_rqst rqstp, struct xdr_stream xdr);
16c66364	111
130e2054 CL	112	bool nlmsvc_encode_testres(struct svc_rqst rqstp, struct xdr_stream xdr);
	113	bool nlmsvc_encode_res(struct svc_rqst rqstp, struct xdr_stream xdr);
	114	bool nlmsvc_encode_void(struct svc_rqst rqstp, struct xdr_stream xdr);
	115	bool nlmsvc_encode_shareres(struct svc_rqst rqstp, struct xdr_stream xdr);
1da177e4 LT	116
1da177e4 LT	117	#endif /* LOCKD_XDR_H */