1/* SPDX-License-Identifier: MIT */
2/*
3 * libslirp
4 *
5 * Copyright (c) 2004-2008 Fabrice Bellard
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
25#include "slirp.h"
26#include "vmstate.h"
27#include "stream.h"
28
29static int slirp_tcp_post_load(void *opaque, int version)
30{
31 tcp_template((struct tcpcb *)opaque);
32
33 return 0;
34}
35
36static const VMStateDescription vmstate_slirp_tcp = {
37 .name = "slirp-tcp",
38 .version_id = 0,
39 .post_load = slirp_tcp_post_load,
40 .fields = (VMStateField[]){ VMSTATE_INT16(t_state, struct tcpcb),
41 VMSTATE_INT16_ARRAY(t_timer, struct tcpcb,
42 TCPT_NTIMERS),
43 VMSTATE_INT16(t_rxtshift, struct tcpcb),
44 VMSTATE_INT16(t_rxtcur, struct tcpcb),
45 VMSTATE_INT16(t_dupacks, struct tcpcb),
46 VMSTATE_UINT16(t_maxseg, struct tcpcb),
47 VMSTATE_UINT8(t_force, struct tcpcb),
48 VMSTATE_UINT16(t_flags, struct tcpcb),
49 VMSTATE_UINT32(snd_una, struct tcpcb),
50 VMSTATE_UINT32(snd_nxt, struct tcpcb),
51 VMSTATE_UINT32(snd_up, struct tcpcb),
52 VMSTATE_UINT32(snd_wl1, struct tcpcb),
53 VMSTATE_UINT32(snd_wl2, struct tcpcb),
54 VMSTATE_UINT32(iss, struct tcpcb),
55 VMSTATE_UINT32(snd_wnd, struct tcpcb),
56 VMSTATE_UINT32(rcv_wnd, struct tcpcb),
57 VMSTATE_UINT32(rcv_nxt, struct tcpcb),
58 VMSTATE_UINT32(rcv_up, struct tcpcb),
59 VMSTATE_UINT32(irs, struct tcpcb),
60 VMSTATE_UINT32(rcv_adv, struct tcpcb),
61 VMSTATE_UINT32(snd_max, struct tcpcb),
62 VMSTATE_UINT32(snd_cwnd, struct tcpcb),
63 VMSTATE_UINT32(snd_ssthresh, struct tcpcb),
64 VMSTATE_INT16(t_idle, struct tcpcb),
65 VMSTATE_INT16(t_rtt, struct tcpcb),
66 VMSTATE_UINT32(t_rtseq, struct tcpcb),
67 VMSTATE_INT16(t_srtt, struct tcpcb),
68 VMSTATE_INT16(t_rttvar, struct tcpcb),
69 VMSTATE_UINT16(t_rttmin, struct tcpcb),
70 VMSTATE_UINT32(max_sndwnd, struct tcpcb),
71 VMSTATE_UINT8(t_oobflags, struct tcpcb),
72 VMSTATE_UINT8(t_iobc, struct tcpcb),
73 VMSTATE_INT16(t_softerror, struct tcpcb),
74 VMSTATE_UINT8(snd_scale, struct tcpcb),
75 VMSTATE_UINT8(rcv_scale, struct tcpcb),
76 VMSTATE_UINT8(request_r_scale, struct tcpcb),
77 VMSTATE_UINT8(requested_s_scale, struct tcpcb),
78 VMSTATE_UINT32(ts_recent, struct tcpcb),
79 VMSTATE_UINT32(ts_recent_age, struct tcpcb),
80 VMSTATE_UINT32(last_ack_sent, struct tcpcb),
81 VMSTATE_END_OF_LIST() }
82};
83
84/* The sbuf has a pair of pointers that are migrated as offsets;
85 * we calculate the offsets and restore the pointers using
86 * pre_save/post_load on a tmp structure.
87 */
88struct sbuf_tmp {
89 struct sbuf *parent;
90 uint32_t roff, woff;
91};
92
93static int sbuf_tmp_pre_save(void *opaque)
94{
95 struct sbuf_tmp *tmp = opaque;
96 tmp->woff = tmp->parent->sb_wptr - tmp->parent->sb_data;
97 tmp->roff = tmp->parent->sb_rptr - tmp->parent->sb_data;
98
99 return 0;
100}
101
102static int sbuf_tmp_post_load(void *opaque, int version)
103{
104 struct sbuf_tmp *tmp = opaque;
105 uint32_t requested_len = tmp->parent->sb_datalen;
106
107 /* Allocate the buffer space used by the field after the tmp */
108 sbreserve(tmp->parent, tmp->parent->sb_datalen);
109
110 if (tmp->parent->sb_datalen != requested_len) {
111 return -ENOMEM;
112 }
113 if (tmp->woff >= requested_len || tmp->roff >= requested_len) {
114 g_critical("invalid sbuf offsets r/w=%u/%u len=%u", tmp->roff,
115 tmp->woff, requested_len);
116 return -EINVAL;
117 }
118
119 tmp->parent->sb_wptr = tmp->parent->sb_data + tmp->woff;
120 tmp->parent->sb_rptr = tmp->parent->sb_data + tmp->roff;
121
122 return 0;
123}
124
125
126static const VMStateDescription vmstate_slirp_sbuf_tmp = {
127 .name = "slirp-sbuf-tmp",
128 .post_load = sbuf_tmp_post_load,
129 .pre_save = sbuf_tmp_pre_save,
130 .version_id = 0,
131 .fields = (VMStateField[]){ VMSTATE_UINT32(woff, struct sbuf_tmp),
132 VMSTATE_UINT32(roff, struct sbuf_tmp),
133 VMSTATE_END_OF_LIST() }
134};
135
136static const VMStateDescription vmstate_slirp_sbuf = {
137 .name = "slirp-sbuf",
138 .version_id = 0,
139 .fields = (VMStateField[]){ VMSTATE_UINT32(sb_cc, struct sbuf),
140 VMSTATE_UINT32(sb_datalen, struct sbuf),
141 VMSTATE_WITH_TMP(struct sbuf, struct sbuf_tmp,
142 vmstate_slirp_sbuf_tmp),
143 VMSTATE_VBUFFER_UINT32(sb_data, struct sbuf, 0,
144 NULL, sb_datalen),
145 VMSTATE_END_OF_LIST() }
146};
147
148static bool slirp_older_than_v4(void *opaque, int version_id)
149{
150 return version_id < 4;
151}
152
153static bool slirp_family_inet(void *opaque, int version_id)
154{
155 union slirp_sockaddr *ssa = (union slirp_sockaddr *)opaque;
156 return ssa->ss.ss_family == AF_INET;
157}
158
159static int slirp_socket_pre_load(void *opaque)
160{
161 struct socket *so = opaque;
162 if (tcp_attach(so) < 0) {
163 return -ENOMEM;
164 }
165 /* Older versions don't load these fields */
166 so->so_ffamily = AF_INET;
167 so->so_lfamily = AF_INET;
168 return 0;
169}
170
171#ifndef _WIN32
172#define VMSTATE_SIN4_ADDR(f, s, t) VMSTATE_UINT32_TEST(f, s, t)
173#else
174/* Win uses u_long rather than uint32_t - but it's still 32bits long */
175#define VMSTATE_SIN4_ADDR(f, s, t) \
176 VMSTATE_SINGLE_TEST(f, s, t, 0, slirp_vmstate_info_uint32, u_long)
177#endif
178
179/* The OS provided ss_family field isn't that portable; it's size
180 * and type varies (16/8 bit, signed, unsigned)
181 * and the values it contains aren't fully portable.
182 */
183typedef struct SS_FamilyTmpStruct {
184 union slirp_sockaddr *parent;
185 uint16_t portable_family;
186} SS_FamilyTmpStruct;
187
188#define SS_FAMILY_MIG_IPV4 2 /* Linux, BSD, Win... */
189#define SS_FAMILY_MIG_IPV6 10 /* Linux */
190#define SS_FAMILY_MIG_OTHER 0xffff
191
192static int ss_family_pre_save(void *opaque)
193{
194 SS_FamilyTmpStruct *tss = opaque;
195
196 tss->portable_family = SS_FAMILY_MIG_OTHER;
197
198 if (tss->parent->ss.ss_family == AF_INET) {
199 tss->portable_family = SS_FAMILY_MIG_IPV4;
200 } else if (tss->parent->ss.ss_family == AF_INET6) {
201 tss->portable_family = SS_FAMILY_MIG_IPV6;
202 }
203
204 return 0;
205}
206
207static int ss_family_post_load(void *opaque, int version_id)
208{
209 SS_FamilyTmpStruct *tss = opaque;
210
211 switch (tss->portable_family) {
212 case SS_FAMILY_MIG_IPV4:
213 tss->parent->ss.ss_family = AF_INET;
214 break;
215 case SS_FAMILY_MIG_IPV6:
216 case 23: /* compatibility: AF_INET6 from mingw */
217 case 28: /* compatibility: AF_INET6 from FreeBSD sys/socket.h */
218 tss->parent->ss.ss_family = AF_INET6;
219 break;
220 default:
221 g_critical("invalid ss_family type %x", tss->portable_family);
222 return -EINVAL;
223 }
224
225 return 0;
226}
227
228static const VMStateDescription vmstate_slirp_ss_family = {
229 .name = "slirp-socket-addr/ss_family",
230 .pre_save = ss_family_pre_save,
231 .post_load = ss_family_post_load,
232 .fields =
233 (VMStateField[]){ VMSTATE_UINT16(portable_family, SS_FamilyTmpStruct),
234 VMSTATE_END_OF_LIST() }
235};
236
237static const VMStateDescription vmstate_slirp_socket_addr = {
238 .name = "slirp-socket-addr",
239 .version_id = 4,
240 .fields =
241 (VMStateField[]){
242 VMSTATE_WITH_TMP(union slirp_sockaddr, SS_FamilyTmpStruct,
243 vmstate_slirp_ss_family),
244 VMSTATE_SIN4_ADDR(sin.sin_addr.s_addr, union slirp_sockaddr,
245 slirp_family_inet),
246 VMSTATE_UINT16_TEST(sin.sin_port, union slirp_sockaddr,
247 slirp_family_inet),
248
249#if 0
250 /* Untested: Needs checking by someone with IPv6 test */
251 VMSTATE_BUFFER_TEST(sin6.sin6_addr, union slirp_sockaddr,
252 slirp_family_inet6),
253 VMSTATE_UINT16_TEST(sin6.sin6_port, union slirp_sockaddr,
254 slirp_family_inet6),
255 VMSTATE_UINT32_TEST(sin6.sin6_flowinfo, union slirp_sockaddr,
256 slirp_family_inet6),
257 VMSTATE_UINT32_TEST(sin6.sin6_scope_id, union slirp_sockaddr,
258 slirp_family_inet6),
259#endif
260
261 VMSTATE_END_OF_LIST() }
262};
263
264static const VMStateDescription vmstate_slirp_socket = {
265 .name = "slirp-socket",
266 .version_id = 4,
267 .pre_load = slirp_socket_pre_load,
268 .fields =
269 (VMStateField[]){
270 VMSTATE_UINT32(so_urgc, struct socket),
271 /* Pre-v4 versions */
272 VMSTATE_SIN4_ADDR(so_faddr.s_addr, struct socket,
273 slirp_older_than_v4),
274 VMSTATE_SIN4_ADDR(so_laddr.s_addr, struct socket,
275 slirp_older_than_v4),
276 VMSTATE_UINT16_TEST(so_fport, struct socket, slirp_older_than_v4),
277 VMSTATE_UINT16_TEST(so_lport, struct socket, slirp_older_than_v4),
278 /* v4 and newer */
279 VMSTATE_STRUCT(fhost, struct socket, 4, vmstate_slirp_socket_addr,
280 union slirp_sockaddr),
281 VMSTATE_STRUCT(lhost, struct socket, 4, vmstate_slirp_socket_addr,
282 union slirp_sockaddr),
283
284 VMSTATE_UINT8(so_iptos, struct socket),
285 VMSTATE_UINT8(so_emu, struct socket),
286 VMSTATE_UINT8(so_type, struct socket),
287 VMSTATE_INT32(so_state, struct socket),
288 VMSTATE_STRUCT(so_rcv, struct socket, 0, vmstate_slirp_sbuf,
289 struct sbuf),
290 VMSTATE_STRUCT(so_snd, struct socket, 0, vmstate_slirp_sbuf,
291 struct sbuf),
292 VMSTATE_STRUCT_POINTER(so_tcpcb, struct socket, vmstate_slirp_tcp,
293 struct tcpcb),
294 VMSTATE_END_OF_LIST() }
295};
296
297static const VMStateDescription vmstate_slirp_bootp_client = {
298 .name = "slirp_bootpclient",
299 .fields = (VMStateField[]){ VMSTATE_UINT16(allocated, BOOTPClient),
300 VMSTATE_BUFFER(macaddr, BOOTPClient),
301 VMSTATE_END_OF_LIST() }
302};
303
304static const VMStateDescription vmstate_slirp = {
305 .name = "slirp",
306 .version_id = 4,
307 .fields = (VMStateField[]){ VMSTATE_UINT16_V(ip_id, Slirp, 2),
308 VMSTATE_STRUCT_ARRAY(
309 bootp_clients, Slirp, NB_BOOTP_CLIENTS, 3,
310 vmstate_slirp_bootp_client, BOOTPClient),
311 VMSTATE_END_OF_LIST() }
312};
313
314void slirp_state_save(Slirp *slirp, SlirpWriteCb write_cb, void *opaque)
315{
316 struct gfwd_list *ex_ptr;
317 SlirpOStream f = {
318 .write_cb = write_cb,
319 .opaque = opaque,
320 };
321
322 for (ex_ptr = slirp->guestfwd_list; ex_ptr; ex_ptr = ex_ptr->ex_next)
323 if (ex_ptr->write_cb) {
324 struct socket *so;
325 so = slirp_find_ctl_socket(slirp, ex_ptr->ex_addr,
326 ntohs(ex_ptr->ex_fport));
327 if (!so) {
328 continue;
329 }
330
331 slirp_ostream_write_u8(&f, 42);
332 slirp_vmstate_save_state(&f, &vmstate_slirp_socket, so);
333 }
334 slirp_ostream_write_u8(&f, 0);
335
336 slirp_vmstate_save_state(&f, &vmstate_slirp, slirp);
337}
338
339
340int slirp_state_load(Slirp *slirp, int version_id, SlirpReadCb read_cb,
341 void *opaque)
342{
343 struct gfwd_list *ex_ptr;
344 SlirpIStream f = {
345 .read_cb = read_cb,
346 .opaque = opaque,
347 };
348
349 while (slirp_istream_read_u8(&f)) {
350 int ret;
351 struct socket *so = socreate(slirp);
352
353 ret =
354 slirp_vmstate_load_state(&f, &vmstate_slirp_socket, so, version_id);
355 if (ret < 0) {
356 return ret;
357 }
358
359 if ((so->so_faddr.s_addr & slirp->vnetwork_mask.s_addr) !=
360 slirp->vnetwork_addr.s_addr) {
361 return -EINVAL;
362 }
363 for (ex_ptr = slirp->guestfwd_list; ex_ptr; ex_ptr = ex_ptr->ex_next) {
364 if (ex_ptr->write_cb &&
365 so->so_faddr.s_addr == ex_ptr->ex_addr.s_addr &&
366 so->so_fport == ex_ptr->ex_fport) {
367 break;
368 }
369 }
370 if (!ex_ptr) {
371 return -EINVAL;
372 }
373 }
374
375 return slirp_vmstate_load_state(&f, &vmstate_slirp, slirp, version_id);
376}
377
378int slirp_state_version(void)
379{
380 return 4;
381}
382