1 /*
2  * Upcall description for nfsdcld communication
3  *
4  * Copyright (c) 2012 Red Hat, Inc.
5  * Author(s): Jeff Layton <jlayton@redhat.com>
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2 of the License, or
10  *  (at your option) any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; if not, write to the Free Software
19  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  */
21 
22 #ifndef _NFSD_CLD_H
23 #define _NFSD_CLD_H
24 
25 /* latest upcall version available */
26 #define CLD_UPCALL_VERSION 1
27 
28 /* defined by RFC3530 */
29 #define NFS4_OPAQUE_LIMIT 1024
30 
31 enum cld_command {
32 	Cld_Create,		/* create a record for this cm_id */
33 	Cld_Remove,		/* remove record of this cm_id */
34 	Cld_Check,		/* is this cm_id allowed? */
35 	Cld_GraceDone,		/* grace period is complete */
36 };
37 
38 /* representation of long-form NFSv4 client ID */
39 struct cld_name {
40 	uint16_t	cn_len;				/* length of cm_id */
41 	unsigned char	cn_id[NFS4_OPAQUE_LIMIT];	/* client-provided */
42 } __attribute__((packed));
43 
44 /* message struct for communication with userspace */
45 struct cld_msg {
46 	uint8_t		cm_vers;		/* upcall version */
47 	uint8_t		cm_cmd;			/* upcall command */
48 	int16_t		cm_status;		/* return code */
49 	uint32_t	cm_xid;			/* transaction id */
50 	union {
51 		int64_t		cm_gracetime;	/* grace period start time */
52 		struct cld_name	cm_name;
53 	} __attribute__((packed)) cm_u;
54 } __attribute__((packed));
55 
56 #endif /* !_NFSD_CLD_H */
57