Merge tag 'libnfs-1.9.6' of https://github.com/sahlberg/libnfs into upstream
[deb_libnfs.git] / include / libnfs-private.h
... / ...
CommitLineData
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
32extern "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
45struct 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
59struct 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/*
69 * Queue is singly-linked but we hold on to the tail
70 */
71struct rpc_queue {
72 struct rpc_pdu *head, *tail;
73};
74
75#define HASHES 1024
76#define NFS_RA_TIMEOUT 5
77
78struct rpc_context {
79 uint32_t magic;
80 int fd;
81 int is_connected;
82
83 char *error_string;
84
85 rpc_cb connect_cb;
86 void *connect_data;
87
88 struct AUTH *auth;
89 uint32_t xid;
90
91 /* buffer used for encoding RPC PDU */
92 char *encodebuf;
93 int encodebuflen;
94
95 struct rpc_queue outqueue;
96 struct sockaddr_storage udp_src;
97 struct rpc_queue waitpdu[HASHES];
98
99 uint32_t inpos;
100 uint32_t insize;
101 char *inbuf;
102
103 /* special fields for UDP, which can sometimes be BROADCASTed */
104 int is_udp;
105 struct sockaddr *udp_dest;
106 int is_broadcast;
107
108 /* track the address we connect to so we can auto-reconnect on session failure */
109 struct sockaddr_storage s;
110 int auto_reconnect;
111
112 /* fragment reassembly */
113 struct rpc_fragment *fragments;
114
115 /* parameters passable via URL */
116 int tcp_syncnt;
117 int uid;
118 int gid;
119 uint32_t readahead;
120};
121
122struct rpc_pdu {
123 struct rpc_pdu *next;
124
125 uint32_t xid;
126 ZDR zdr;
127
128 uint32_t written;
129 struct rpc_data outdata;
130
131 rpc_cb cb;
132 void *private_data;
133
134 /* function to decode the zdr reply data and buffer to decode into */
135 zdrproc_t zdr_decode_fn;
136 caddr_t zdr_decode_buf;
137 uint32_t zdr_decode_bufsize;
138};
139
140void rpc_reset_queue(struct rpc_queue *q);
141void rpc_enqueue(struct rpc_queue *q, struct rpc_pdu *pdu);
142void rpc_return_to_queue(struct rpc_queue *q, struct rpc_pdu *pdu);
143unsigned int rpc_hash_xid(uint32_t xid);
144
145struct 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);
146void rpc_free_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
147int rpc_queue_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
148int rpc_get_pdu_size(char *buf);
149int rpc_process_pdu(struct rpc_context *rpc, char *buf, int size);
150void rpc_error_all_pdus(struct rpc_context *rpc, char *error);
151
152void rpc_set_error(struct rpc_context *rpc, char *error_string, ...)
153#ifdef __GNUC__
154 __attribute__((format(printf, 2, 3)))
155#endif
156;
157
158void nfs_set_error(struct nfs_context *nfs, char *error_string, ...)
159#ifdef __GNUC__
160 __attribute__((format(printf, 2, 3)))
161#endif
162;
163
164const char *nfs_get_server(struct nfs_context *nfs);
165const char *nfs_get_export(struct nfs_context *nfs);
166
167/* we dont want to expose UDP to normal applications/users this is private to libnfs to use exclusively for broadcast RPC */
168int rpc_bind_udp(struct rpc_context *rpc, char *addr, int port);
169int rpc_set_udp_destination(struct rpc_context *rpc, char *addr, int port, int is_broadcast);
170struct rpc_context *rpc_init_udp_context(void);
171struct sockaddr *rpc_get_recv_sockaddr(struct rpc_context *rpc);
172
173void rpc_set_autoreconnect(struct rpc_context *rpc);
174void rpc_unset_autoreconnect(struct rpc_context *rpc);
175
176void rpc_set_tcp_syncnt(struct rpc_context *rpc, int v);
177void rpc_set_uid(struct rpc_context *rpc, int uid);
178void rpc_set_gid(struct rpc_context *rpc, int gid);
179void rpc_set_readahead(struct rpc_context *rpc, uint32_t v);
180
181int rpc_add_fragment(struct rpc_context *rpc, char *data, uint64_t size);
182void rpc_free_all_fragments(struct rpc_context *rpc);
183
184const struct nfs_fh3 *nfs_get_rootfh(struct nfs_context *nfs);
185
186#ifdef __cplusplus
187}
188#endif
189
190#endif /* !_LIBNFS_PRIVATE_H_ */