[deb_libnfs.git] / include / libnfs-private.h

/*
   Copyright (C) 2010 by Ronnie Sahlberg <ronniesahlberg@gmail.com>

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as published by
   the Free Software Foundation; either version 2.1 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License
   along with this program; if not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _LIBNFS_PRIVATE_H_
#define _LIBNFS_PRIVATE_H_

#ifdef HAVE_CONFIG_H
#include "config.h"  /* HAVE_SOCKADDR_STORAGE ? */
#endif

#ifndef WIN32
#include <sys/socket.h>  /* struct sockaddr_storage */
#endif

#include "libnfs-zdr.h"

#ifdef __cplusplus
extern "C" {
#endif

#if !defined(HAVE_SOCKADDR_STORAGE) && !defined(WIN32)
/*
 * RFC 2553: protocol-independent placeholder for socket addresses
 */
#define _SS_MAXSIZE	128
#define _SS_ALIGNSIZE	(sizeof(double))
#define _SS_PAD1SIZE	(_SS_ALIGNSIZE - sizeof(unsigned char) * 2)
#define _SS_PAD2SIZE	(_SS_MAXSIZE - sizeof(unsigned char) * 2 - \
				_SS_PAD1SIZE - _SS_ALIGNSIZE)

struct sockaddr_storage {
#ifdef HAVE_SOCKADDR_LEN
	unsigned char ss_len;		/* address length */
	unsigned char ss_family;	/* address family */
#else
	unsigned short ss_family;
#endif
	char	__ss_pad1[_SS_PAD1SIZE];
	double	__ss_align;	/* force desired structure storage alignment */
	char	__ss_pad2[_SS_PAD2SIZE];
};
#endif


struct rpc_fragment {
	struct rpc_fragment *next;
	uint64_t size;
	char *data;
};

#define RPC_CONTEXT_MAGIC 0xc6e46435
#define RPC_PARAM_UNDEFINED -1

struct rpc_context {
	uint32_t magic;
	int fd;
	int is_connected;

	char *error_string;

	rpc_cb connect_cb;
	void *connect_data;

	struct AUTH *auth;
	uint32_t xid;

	/* buffer used for encoding RPC PDU */
	char *encodebuf;
	int encodebuflen;

	struct rpc_pdu *outqueue;
	struct sockaddr_storage udp_src;
	struct rpc_pdu *waitpdu;

	uint32_t inpos;
	uint32_t insize;
	char *inbuf;

	/* special fields for UDP, which can sometimes be BROADCASTed */
	int is_udp;
	struct sockaddr *udp_dest;
	int is_broadcast;

	/* track the address we connect to so we can auto-reconnect on session failure */
	struct sockaddr_storage s;
	int auto_reconnect;

	/* fragment reassembly */
	struct rpc_fragment *fragments;

	/* parameters passable via URL */
	int tcp_syncnt;
	int uid;
	int gid;
};

struct rpc_pdu {
	struct rpc_pdu *next;

	uint32_t xid;
	ZDR zdr;

	uint32_t written;
	struct rpc_data outdata;

	rpc_cb cb;
	void *private_data;

	/* function to decode the zdr reply data and buffer to decode into */
	zdrproc_t zdr_decode_fn;
	caddr_t zdr_decode_buf;
	uint32_t zdr_decode_bufsize;
};

struct rpc_pdu *rpc_allocate_pdu(struct rpc_context *rpc, int program, int version, int procedure, rpc_cb cb, void *private_data, zdrproc_t zdr_decode_fn, int zdr_bufsize);
void rpc_free_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
int rpc_queue_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
int rpc_get_pdu_size(char *buf);
int rpc_process_pdu(struct rpc_context *rpc, char *buf, int size);
void rpc_error_all_pdus(struct rpc_context *rpc, char *error);

void rpc_set_error(struct rpc_context *rpc, char *error_string, ...)
#ifdef __GNUC__
 __attribute__((format(printf, 2, 3)))
#endif
;

void nfs_set_error(struct nfs_context *nfs, char *error_string, ...)
#ifdef __GNUC__
 __attribute__((format(printf, 2, 3)))
#endif
;

const char *nfs_get_server(struct nfs_context *nfs);
const char *nfs_get_export(struct nfs_context *nfs);

/* we dont want to expose UDP to normal applications/users  this is private to libnfs to use exclusively for broadcast RPC */
int rpc_bind_udp(struct rpc_context *rpc, char *addr, int port);
int rpc_set_udp_destination(struct rpc_context *rpc, char *addr, int port, int is_broadcast);
struct rpc_context *rpc_init_udp_context(void);
struct sockaddr *rpc_get_recv_sockaddr(struct rpc_context *rpc);

void rpc_set_autoreconnect(struct rpc_context *rpc);
void rpc_unset_autoreconnect(struct rpc_context *rpc);

void rpc_set_tcp_syncnt(struct rpc_context *rpc, int v);
void rpc_set_uid(struct rpc_context *rpc, int uid);
void rpc_set_gid(struct rpc_context *rpc, int gid);

int rpc_add_fragment(struct rpc_context *rpc, char *data, uint64_t size);
void rpc_free_all_fragments(struct rpc_context *rpc);

const struct nfs_fh3 *nfs_get_rootfh(struct nfs_context *nfs);

#ifdef __cplusplus
}
#endif

#endif /* !_LIBNFS_PRIVATE_H_ */
Commit	Line	Data
	1	/*
	2	Copyright (C) 2010 by Ronnie Sahlberg <ronniesahlberg@gmail.com>
	3
	4	This program is free software; you can redistribute it and/or modify
	5	it under the terms of the GNU Lesser General Public License as published by
	6	the Free Software Foundation; either version 2.1 of the License, or
	7	(at your option) any later version.
	8
	9	This program is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	GNU Lesser General Public License for more details.
	13
	14	You should have received a copy of the GNU Lesser General Public License
	15	along with this program; if not, see <http://www.gnu.org/licenses/>.
	16	*/
	17
	18	#ifndef _LIBNFS_PRIVATE_H_
	19	#define _LIBNFS_PRIVATE_H_
	20
	21	#ifdef HAVE_CONFIG_H
	22	#include "config.h" /* HAVE_SOCKADDR_STORAGE ? */
	23	#endif
	24
	25	#ifndef WIN32
	26	#include <sys/socket.h> /* struct sockaddr_storage */
	27	#endif
	28
	29	#include "libnfs-zdr.h"
	30
	31	#ifdef __cplusplus
	32	extern "C" {
	33	#endif
	34
	35	#if !defined(HAVE_SOCKADDR_STORAGE) && !defined(WIN32)
	36	/*
	37	* RFC 2553: protocol-independent placeholder for socket addresses
	38	*/
	39	#define _SS_MAXSIZE 128
	40	#define _SS_ALIGNSIZE (sizeof(double))
	41	#define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) * 2)
	42	#define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) * 2 - \
	43	_SS_PAD1SIZE - _SS_ALIGNSIZE)
	44
	45	struct sockaddr_storage {
	46	#ifdef HAVE_SOCKADDR_LEN
	47	unsigned char ss_len; /* address length */
	48	unsigned char ss_family; /* address family */
	49	#else
	50	unsigned short ss_family;
	51	#endif
	52	char __ss_pad1[_SS_PAD1SIZE];
	53	double __ss_align; /* force desired structure storage alignment */
	54	char __ss_pad2[_SS_PAD2SIZE];
	55	};
	56	#endif
	57
	58
	59	struct rpc_fragment {
	60	struct rpc_fragment *next;
	61	uint64_t size;
	62	char *data;
	63	};
	64
	65	#define RPC_CONTEXT_MAGIC 0xc6e46435
	66	#define RPC_PARAM_UNDEFINED -1
	67
	68	struct rpc_context {
	69	uint32_t magic;
	70	int fd;
	71	int is_connected;
	72
	73	char *error_string;
	74
	75	rpc_cb connect_cb;
	76	void *connect_data;
	77
	78	struct AUTH *auth;
	79	uint32_t xid;
	80
	81	/* buffer used for encoding RPC PDU */
	82	char *encodebuf;
	83	int encodebuflen;
	84
	85	struct rpc_pdu *outqueue;
	86	struct sockaddr_storage udp_src;
	87	struct rpc_pdu *waitpdu;
	88
	89	uint32_t inpos;
	90	uint32_t insize;
	91	char *inbuf;
	92
	93	/* special fields for UDP, which can sometimes be BROADCASTed */
	94	int is_udp;
	95	struct sockaddr *udp_dest;
	96	int is_broadcast;
	97
	98	/* track the address we connect to so we can auto-reconnect on session failure */
	99	struct sockaddr_storage s;
	100	int auto_reconnect;
	101
	102	/* fragment reassembly */
	103	struct rpc_fragment *fragments;
	104
	105	/* parameters passable via URL */
	106	int tcp_syncnt;
	107	int uid;
	108	int gid;
	109	};
	110
	111	struct rpc_pdu {
	112	struct rpc_pdu *next;
	113
	114	uint32_t xid;
	115	ZDR zdr;
	116
	117	uint32_t written;
	118	struct rpc_data outdata;
	119
	120	rpc_cb cb;
	121	void *private_data;
	122
	123	/* function to decode the zdr reply data and buffer to decode into */
	124	zdrproc_t zdr_decode_fn;
	125	caddr_t zdr_decode_buf;
	126	uint32_t zdr_decode_bufsize;
	127	};
	128
	129	struct rpc_pdu rpc_allocate_pdu(struct rpc_context rpc, int program, int version, int procedure, rpc_cb cb, void *private_data, zdrproc_t zdr_decode_fn, int zdr_bufsize);
	130	void rpc_free_pdu(struct rpc_context rpc, struct rpc_pdu pdu);
	131	int rpc_queue_pdu(struct rpc_context rpc, struct rpc_pdu pdu);
	132	int rpc_get_pdu_size(char *buf);
	133	int rpc_process_pdu(struct rpc_context rpc, char buf, int size);
	134	void rpc_error_all_pdus(struct rpc_context rpc, char error);
	135
	136	void rpc_set_error(struct rpc_context rpc, char error_string, ...)
	137	#ifdef __GNUC__
	138	__attribute__((format(printf, 2, 3)))
	139	#endif
	140	;
	141
	142	void nfs_set_error(struct nfs_context nfs, char error_string, ...)
	143	#ifdef __GNUC__
	144	__attribute__((format(printf, 2, 3)))
	145	#endif
	146	;
	147
	148	const char nfs_get_server(struct nfs_context nfs);
	149	const char nfs_get_export(struct nfs_context nfs);
	150
	151	/* we dont want to expose UDP to normal applications/users this is private to libnfs to use exclusively for broadcast RPC */
	152	int rpc_bind_udp(struct rpc_context rpc, char addr, int port);
	153	int rpc_set_udp_destination(struct rpc_context rpc, char addr, int port, int is_broadcast);
	154	struct rpc_context *rpc_init_udp_context(void);
	155	struct sockaddr rpc_get_recv_sockaddr(struct rpc_context rpc);
	156
	157	void rpc_set_autoreconnect(struct rpc_context *rpc);
	158	void rpc_unset_autoreconnect(struct rpc_context *rpc);
	159
	160	void rpc_set_tcp_syncnt(struct rpc_context *rpc, int v);
	161	void rpc_set_uid(struct rpc_context *rpc, int uid);
	162	void rpc_set_gid(struct rpc_context *rpc, int gid);
	163
	164	int rpc_add_fragment(struct rpc_context rpc, char data, uint64_t size);
	165	void rpc_free_all_fragments(struct rpc_context *rpc);
	166
	167	const struct nfs_fh3 nfs_get_rootfh(struct nfs_context nfs);
	168
	169	#ifdef __cplusplus
	170	}
	171	#endif
	172
	173	#endif /* !_LIBNFS_PRIVATE_H_ */