xdr.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  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>
 14#include <linux/filelock.h>
 15#include <linux/nfs.h>
 16#include <linux/sunrpc/xdr.h>
 17
 18#define SM_MAXSTRLEN		1024
 19#define SM_PRIV_SIZE		16
 20
 21struct nsm_private {
 22	unsigned char		data[SM_PRIV_SIZE];
 23};
 24
 25struct svc_rqst;
 26
 27#define NLM_MAXCOOKIELEN    	32
 28#define NLM_MAXSTRLEN		1024
 29
 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)
 35
 36#define nlm_drop_reply		cpu_to_be32(30000)
 37
 38/* Lock info passed via NLM */
 39struct nlm_lock {
 40	char *			caller;
 41	unsigned int		len; 	/* length of "caller" */
 42	struct nfs_fh		fh;
 43	struct xdr_netobj	oh;
 44	u32			svid;
 45	u64			lock_start;
 46	u64			lock_len;
 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
 56struct 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 */
 65struct 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/*
 77 * Generic lockd result
 78 */
 79struct nlm_res {
 80	struct nlm_cookie	cookie;
 81	__be32			status;
 82	struct nlm_lock		lock;
 83};
 84
 85/*
 86 * statd callback when client has rebooted
 87 */
 88struct nlm_reboot {
 89	char			*mon;
 90	unsigned int		len;
 91	u32			state;
 92	struct nsm_private	priv;
 93};
 94
 95/*
 96 * Contents of statd callback when monitored host rebooted
 97 */
 98#define NLMSVC_XDRSIZE		sizeof(struct nlm_args)
 99
100bool	nlmsvc_decode_void(struct svc_rqst *rqstp, struct xdr_stream *xdr);
101bool	nlmsvc_decode_testargs(struct svc_rqst *rqstp, struct xdr_stream *xdr);
102bool	nlmsvc_decode_lockargs(struct svc_rqst *rqstp, struct xdr_stream *xdr);
103bool	nlmsvc_decode_cancargs(struct svc_rqst *rqstp, struct xdr_stream *xdr);
104bool	nlmsvc_decode_unlockargs(struct svc_rqst *rqstp, struct xdr_stream *xdr);
105bool	nlmsvc_decode_res(struct svc_rqst *rqstp, struct xdr_stream *xdr);
106bool	nlmsvc_decode_reboot(struct svc_rqst *rqstp, struct xdr_stream *xdr);
107bool	nlmsvc_decode_shareargs(struct svc_rqst *rqstp, struct xdr_stream *xdr);
108bool	nlmsvc_decode_notify(struct svc_rqst *rqstp, struct xdr_stream *xdr);
109
110bool	nlmsvc_encode_testres(struct svc_rqst *rqstp, struct xdr_stream *xdr);
111bool	nlmsvc_encode_res(struct svc_rqst *rqstp, struct xdr_stream *xdr);
112bool	nlmsvc_encode_void(struct svc_rqst *rqstp, struct xdr_stream *xdr);
113bool	nlmsvc_encode_shareres(struct svc_rqst *rqstp, struct xdr_stream *xdr);
114
115#endif /* LOCKD_XDR_H */