1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/*
* libmowgli: A collection of useful routines for programming.
* vio.c: Virtual I/O subsystem
*
* Copyright (c) 2012 Elizabeth J. Myers. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#include "mowgli.h"
/* How the VIO API works:
*
* - Return 0 in your error callback if you have nothing to report (non-fatal error or no error)
* - Return -1 in your callback if you have a fatal error
* - Return the length of bytes written or read, similar to the semantics of
* the read(3) or write(3) calls, if you are a read/write callback.
*
* These are just default implementations, you can change them to suit your needs.
*/
static mowgli_heap_t *vio_heap = NULL;
/* Change these to suit your needs for new VIO objects */
mowgli_vio_ops_t mowgli_vio_default_ops =
{
.socket = mowgli_vio_default_socket,
.bind = mowgli_vio_default_bind,
.listen = mowgli_vio_default_listen,
.accept = mowgli_vio_default_accept,
.reuseaddr = mowgli_vio_default_reuseaddr,
.connect = mowgli_vio_default_connect,
.read = mowgli_vio_default_read,
.write = mowgli_vio_default_write,
.sendto = mowgli_vio_default_sendto,
.recvfrom = mowgli_vio_default_recvfrom,
.error = mowgli_vio_default_error,
.close = mowgli_vio_default_close,
.seek = mowgli_vio_default_seek,
.tell = mowgli_vio_default_tell,
};
/* Null ops */
mowgli_vio_evops_t mowgli_vio_default_evops =
{
.read_cb = NULL,
.write_cb = NULL
};
/* mowgli_vio_create - create a VIO object on the heap
*
* inputs - userdata for the VIO object
* outputs - a VIO object
*/
mowgli_vio_t *
mowgli_vio_create(void *userdata)
{
mowgli_vio_t *vio;
if (!vio_heap)
vio_heap = mowgli_heap_create(sizeof(mowgli_vio_t), 64, BH_NOW);
vio = mowgli_heap_alloc(vio_heap);
mowgli_vio_init(vio, userdata);
mowgli_vio_setflag(vio, MOWGLI_VIO_FLAGS_ISONHEAP, true);
return vio;
}
/* mowgli_vio_init - initalise a VIO object previously allocated
* only use this if you know what you're doing, otherwise use mowgli_vio_create
*
* inputs - VIO object, userdata
* outputs - None
*/
void
mowgli_vio_init(mowgli_vio_t *vio, void *userdata)
{
return_if_fail(vio);
vio->io.fd = -1;
vio->flags = 0;
/* Default ops */
vio->ops = &mowgli_vio_default_ops;
vio->userdata = userdata;
}
/* mowgli_vio_eventloop_attach - attach a VIO object to an eventloop
*
* inputs - VIO object, eventloop, ops to use for the eventloop (optional but recommended)
* outputs - None
*/
void
mowgli_vio_eventloop_attach(mowgli_vio_t *vio, mowgli_eventloop_t *eventloop, mowgli_vio_evops_t *evops)
{
return_if_fail(vio);
return_if_fail(eventloop);
const int fd = vio->io.fd;
/* Check for previous attachment */
if (vio->eventloop)
{
mowgli_log("VIO object [%p] is already attached to eventloop [%p]; attempted to attach new eventloop [%p]", (void *) vio, (void *) vio->eventloop, (void *) eventloop);
return;
}
if ((vio->io.e = mowgli_pollable_create(eventloop, fd, vio->userdata)) != NULL)
{
vio->eventloop = eventloop;
/* You're probably going to want this */
mowgli_pollable_set_nonblocking(vio->io.e, true);
if (evops)
vio->evops = evops;
else
/* Default NULL ops */
vio->evops = &mowgli_vio_default_evops;
}
else
{
mowgli_log("Unable to create pollable with VIO object [%p], expect problems.", (void *) vio);
vio->io.fd = fd;/* May have been clobbered */
}
}
/* mowgli_vio_eventloop_detach - detach VIO object from eventloop
*
* inputs - VIO object
* output - None
*/
void
mowgli_vio_eventloop_detach(mowgli_vio_t *vio)
{
const int fd = mowgli_vio_getfd(vio);
return_if_fail(fd != -1);
return_if_fail(vio != NULL);
return_if_fail(vio->io.e != NULL);
return_if_fail(vio->eventloop != NULL);
mowgli_pollable_destroy(vio->eventloop, vio->io.e);
vio->eventloop = NULL;
vio->io.fd = fd;
}
/* mowgli_vio_destroy - eliminate a VIO object
*
* inputs - VIO object
* output - None
*/
void
mowgli_vio_destroy(mowgli_vio_t *vio)
{
return_if_fail(vio);
if (vio->eventloop != NULL)
mowgli_vio_eventloop_detach(vio);
if (!MOWGLI_VIO_IS_CLOSED(vio))
mowgli_vio_close(vio);
if (mowgli_vio_hasflag(vio, MOWGLI_VIO_FLAGS_ISONHEAP))
mowgli_heap_free(vio_heap, vio);
}
/* mowgli_vio_err_errcode - Signal an error using the specified char *foo(int err) callback
* Usually the callback can be strerror, but it can use anything else that fits the mould.
*
* inputs - VIO object, callback, error code.
* outputs - Error code from mowgli_vio_error function, any output to terminal/log files/etc.
*/
int
mowgli_vio_err_errcode(mowgli_vio_t *vio, char *(*int_to_error)(int), int errcode)
{
return_val_if_fail(vio, -255);
vio->error.type = MOWGLI_VIO_ERR_ERRCODE;
vio->error.code = errcode;
mowgli_strlcpy(vio->error.string, int_to_error(errcode), sizeof(vio->error.string));
return mowgli_vio_error(vio);
}
/* mowgli_vio_err_sslerrcode - Signal an SSL error
*
* inputs - VIO object, error code
* outputs - Error code from mowgli_vio_error function, any output to terminal/log files/etc.
*/
#ifdef HAVE_OPENSSL
int
mowgli_vio_err_sslerrcode(mowgli_vio_t *vio, unsigned long int errcode)
{
return_val_if_fail(vio, -255);
vio->error.type = MOWGLI_VIO_ERR_ERRCODE;
vio->error.code = errcode;
ERR_error_string_n(errcode, vio->error.string, sizeof(vio->error.string));
return mowgli_vio_error(vio);
}
#else
int
mowgli_vio_err_sslerrcode(mowgli_vio_t *vio, unsigned long int errcode)
{
return_if_fail(vio);
vio->error.type = MOWGLI_VIO_ERR_ERRCODE;
vio->error.code = errcode;
mowgli_strlcpy(vio->error.string, "Unknown SSL error", sizeof(vio->error.string));
return mowgli_vio_error(vio);
}
#endif
|
