add uid and gid URL param to specify alternate uid and/or gid
[deb_libnfs.git] / include / libnfs-private.h
CommitLineData
84004dbf
RS
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*/
d7c6e9aa
RS
17#ifdef HAVE_CONFIG_H
18#include "config.h" /* HAVE_SOCKADDR_STORAGE ? */
19#endif
20
67a9f57e 21#ifndef WIN32
763cd6e3 22#include <sys/socket.h> /* struct sockaddr_storage */
67a9f57e 23#endif
763cd6e3
RS
24
25#include "libnfs-zdr.h"
84004dbf 26
67a9f57e
RS
27
28#if !defined(HAVE_SOCKADDR_STORAGE) && !defined(WIN32)
d7c6e9aa
RS
29/*
30 * RFC 2553: protocol-independent placeholder for socket addresses
31 */
32#define _SS_MAXSIZE 128
33#define _SS_ALIGNSIZE (sizeof(double))
34#define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) * 2)
35#define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) * 2 - \
36 _SS_PAD1SIZE - _SS_ALIGNSIZE)
37
38struct sockaddr_storage {
0f9fe7c6 39#ifdef HAVE_SOCKADDR_LEN
d7c6e9aa
RS
40 unsigned char ss_len; /* address length */
41 unsigned char ss_family; /* address family */
42#else
43 unsigned short ss_family;
44#endif
45 char __ss_pad1[_SS_PAD1SIZE];
46 double __ss_align; /* force desired structure storage alignment */
47 char __ss_pad2[_SS_PAD2SIZE];
48};
49#endif
50
51
d678b73e
RS
52struct rpc_fragment {
53 struct rpc_fragment *next;
183451cf 54 uint64_t size;
d678b73e
RS
55 char *data;
56};
57
f3a75078 58#define RPC_CONTEXT_MAGIC 0xc6e46435
1c8b4547 59#define RPC_PARAM_UNDEFINED -1
f3a75078 60
84004dbf 61struct rpc_context {
1c8b4547 62 uint32_t magic;
84004dbf
RS
63 int fd;
64 int is_connected;
65
66 char *error_string;
67
68 rpc_cb connect_cb;
69 void *connect_data;
70
67ba2239 71 struct AUTH *auth;
b93082da 72 uint32_t xid;
84004dbf 73
1c8b4547
PL
74 /* buffer used for encoding RPC PDU */
75 char *encodebuf;
76 int encodebuflen;
84004dbf 77
1c8b4547
PL
78 struct rpc_pdu *outqueue;
79 struct sockaddr_storage udp_src;
80 struct rpc_pdu *waitpdu;
84004dbf 81
1c8b4547
PL
82 uint32_t inpos;
83 uint32_t insize;
84 char *inbuf;
d16a3ca4 85
1c8b4547
PL
86 /* special fields for UDP, which can sometimes be BROADCASTed */
87 int is_udp;
88 struct sockaddr *udp_dest;
89 int is_broadcast;
1744ef90 90
1c8b4547
PL
91 /* track the address we connect to so we can auto-reconnect on session failure */
92 struct sockaddr_storage s;
93 int auto_reconnect;
d678b73e
RS
94
95 /* fragment reassembly */
96 struct rpc_fragment *fragments;
1c8b4547
PL
97
98 /* parameters passable via URL */
99 int tcp_syncnt;
9126c9c0
PL
100 int uid;
101 int gid;
84004dbf
RS
102};
103
104struct rpc_pdu {
105 struct rpc_pdu *next;
106
b93082da 107 uint32_t xid;
763cd6e3 108 ZDR zdr;
84004dbf 109
d14e2838 110 uint32_t written;
84004dbf
RS
111 struct rpc_data outdata;
112
113 rpc_cb cb;
114 void *private_data;
115
763cd6e3
RS
116 /* function to decode the zdr reply data and buffer to decode into */
117 zdrproc_t zdr_decode_fn;
118 caddr_t zdr_decode_buf;
d14e2838 119 uint32_t zdr_decode_bufsize;
84004dbf
RS
120};
121
763cd6e3 122struct 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);
84004dbf
RS
123void rpc_free_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
124int rpc_queue_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
125int rpc_get_pdu_size(char *buf);
126int rpc_process_pdu(struct rpc_context *rpc, char *buf, int size);
127void rpc_error_all_pdus(struct rpc_context *rpc, char *error);
128
1896d37b
RS
129void rpc_set_error(struct rpc_context *rpc, char *error_string, ...);
130void nfs_set_error(struct nfs_context *nfs, char *error_string, ...);
131
b077fdeb
RS
132const char *nfs_get_server(struct nfs_context *nfs);
133const char *nfs_get_export(struct nfs_context *nfs);
1896d37b 134
485bc9b9
RS
135/* we dont want to expose UDP to normal applications/users this is private to libnfs to use exclusively for broadcast RPC */
136int rpc_bind_udp(struct rpc_context *rpc, char *addr, int port);
5bf60dc6 137int rpc_set_udp_destination(struct rpc_context *rpc, char *addr, int port, int is_broadcast);
9e00b8c6 138struct rpc_context *rpc_init_udp_context(void);
c481da67
RS
139struct sockaddr *rpc_get_recv_sockaddr(struct rpc_context *rpc);
140
1744ef90
RS
141void rpc_set_autoreconnect(struct rpc_context *rpc);
142void rpc_unset_autoreconnect(struct rpc_context *rpc);
143
1c8b4547 144void rpc_set_tcp_syncnt(struct rpc_context *rpc, int v);
9126c9c0
PL
145void rpc_set_uid(struct rpc_context *rpc, int uid);
146void rpc_set_gid(struct rpc_context *rpc, int gid);
1c8b4547 147
183451cf 148int rpc_add_fragment(struct rpc_context *rpc, char *data, uint64_t size);
d678b73e
RS
149void rpc_free_all_fragments(struct rpc_context *rpc);
150
8724c833 151const struct nfs_fh3 *nfs_get_rootfh(struct nfs_context *nfs);