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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
|
/* $Id: proxy_pollmgr.c $ */
/** @file
* NAT Network - poll manager.
*/
/*
* Copyright (C) 2013-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* 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
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#define LOG_GROUP LOG_GROUP_NAT_SERVICE
#include "winutils.h"
#include "proxy_pollmgr.h"
#include "proxy.h"
#ifndef RT_OS_WINDOWS
#include <sys/socket.h>
#include <netinet/in.h>
#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <poll.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#else
#include <iprt/errcore.h>
#include <stdlib.h>
#include <string.h>
#include "winpoll.h"
#endif
#include <iprt/req.h>
#include <iprt/errcore.h>
#define POLLMGR_GARBAGE (-1)
enum {
POLLMGR_QUEUE = 0,
POLLMGR_SLOT_STATIC_COUNT,
POLLMGR_SLOT_FIRST_DYNAMIC = POLLMGR_SLOT_STATIC_COUNT
};
struct pollmgr_chan {
struct pollmgr_handler *handler;
void *arg;
bool arg_valid;
};
struct pollmgr {
struct pollfd *fds;
struct pollmgr_handler **handlers;
nfds_t capacity; /* allocated size of the arrays */
nfds_t nfds; /* part of the arrays in use */
/* channels (socketpair) for static slots */
SOCKET chan[POLLMGR_SLOT_STATIC_COUNT][2];
#define POLLMGR_CHFD_RD 0 /* - pollmgr side */
#define POLLMGR_CHFD_WR 1 /* - client side */
/* emulate channels with request queue */
RTREQQUEUE queue;
struct pollmgr_handler queue_handler;
struct pollmgr_chan chan_handlers[POLLMGR_CHAN_COUNT];
} pollmgr;
static int pollmgr_queue_callback(struct pollmgr_handler *, SOCKET, int);
static void pollmgr_chan_call_handler(int, void *);
static void pollmgr_loop(void);
static void pollmgr_add_at(int, struct pollmgr_handler *, SOCKET, int);
static void pollmgr_refptr_delete(struct pollmgr_refptr *);
/*
* We cannot portably peek at the length of the incoming datagram and
* pre-allocate pbuf chain to recvmsg() directly to it. On Linux it's
* possible to recv with MSG_PEEK|MSG_TRUC, but extra syscall is
* probably more expensive (haven't measured) than doing an extra copy
* of data, since typical UDP datagrams are small enough to avoid
* fragmentation.
*
* We can use shared buffer here since we read from sockets
* sequentially in a loop over pollfd.
*/
u8_t pollmgr_udpbuf[64 * 1024];
int
pollmgr_init(void)
{
struct pollfd *newfds;
struct pollmgr_handler **newhdls;
nfds_t newcap;
int rc, status;
nfds_t i;
rc = RTReqQueueCreate(&pollmgr.queue);
if (RT_FAILURE(rc))
return -1;
pollmgr.fds = NULL;
pollmgr.handlers = NULL;
pollmgr.capacity = 0;
pollmgr.nfds = 0;
for (i = 0; i < POLLMGR_SLOT_STATIC_COUNT; ++i) {
pollmgr.chan[i][POLLMGR_CHFD_RD] = INVALID_SOCKET;
pollmgr.chan[i][POLLMGR_CHFD_WR] = INVALID_SOCKET;
}
for (i = 0; i < POLLMGR_SLOT_STATIC_COUNT; ++i) {
#ifndef RT_OS_WINDOWS
int j;
status = socketpair(PF_LOCAL, SOCK_DGRAM, 0, pollmgr.chan[i]);
if (status < 0) {
DPRINTF(("socketpair: %R[sockerr]\n", SOCKERRNO()));
goto cleanup_close;
}
/* now manually make them O_NONBLOCK */
for (j = 0; j < 2; ++j) {
int s = pollmgr.chan[i][j];
int sflags;
sflags = fcntl(s, F_GETFL, 0);
if (sflags < 0) {
DPRINTF0(("F_GETFL: %R[sockerr]\n", errno));
goto cleanup_close;
}
status = fcntl(s, F_SETFL, sflags | O_NONBLOCK);
if (status < 0) {
DPRINTF0(("O_NONBLOCK: %R[sockerr]\n", errno));
goto cleanup_close;
}
}
#else
status = RTWinSocketPair(PF_INET, SOCK_DGRAM, 0, pollmgr.chan[i]);
if (RT_FAILURE(status)) {
goto cleanup_close;
}
#endif
}
newcap = 16; /* XXX: magic */
LWIP_ASSERT1(newcap >= POLLMGR_SLOT_STATIC_COUNT);
newfds = (struct pollfd *)
malloc(newcap * sizeof(*pollmgr.fds));
if (newfds == NULL) {
DPRINTF(("%s: Failed to allocate fds array\n", __func__));
goto cleanup_close;
}
newhdls = (struct pollmgr_handler **)
malloc(newcap * sizeof(*pollmgr.handlers));
if (newhdls == NULL) {
DPRINTF(("%s: Failed to allocate handlers array\n", __func__));
free(newfds);
goto cleanup_close;
}
pollmgr.capacity = newcap;
pollmgr.fds = newfds;
pollmgr.handlers = newhdls;
pollmgr.nfds = POLLMGR_SLOT_STATIC_COUNT;
for (i = 0; i < pollmgr.capacity; ++i) {
pollmgr.fds[i].fd = INVALID_SOCKET;
pollmgr.fds[i].events = 0;
pollmgr.fds[i].revents = 0;
}
/* add request queue notification */
pollmgr.queue_handler.callback = pollmgr_queue_callback;
pollmgr.queue_handler.data = NULL;
pollmgr.queue_handler.slot = -1;
pollmgr_add_at(POLLMGR_QUEUE, &pollmgr.queue_handler,
pollmgr.chan[POLLMGR_QUEUE][POLLMGR_CHFD_RD],
POLLIN);
return 0;
cleanup_close:
for (i = 0; i < POLLMGR_SLOT_STATIC_COUNT; ++i) {
SOCKET *chan = pollmgr.chan[i];
if (chan[POLLMGR_CHFD_RD] != INVALID_SOCKET) {
closesocket(chan[POLLMGR_CHFD_RD]);
closesocket(chan[POLLMGR_CHFD_WR]);
}
}
return -1;
}
/*
* Add new channel. We now implement channels with request queue, so
* all channels get the same socket that triggers queue processing.
*
* Must be called before pollmgr loop is started, so no locking.
*/
SOCKET
pollmgr_add_chan(int slot, struct pollmgr_handler *handler)
{
AssertReturn(0 <= slot && slot < POLLMGR_CHAN_COUNT, INVALID_SOCKET);
AssertReturn(handler != NULL && handler->callback != NULL, INVALID_SOCKET);
handler->slot = slot;
pollmgr.chan_handlers[slot].handler = handler;
return pollmgr.chan[POLLMGR_QUEUE][POLLMGR_CHFD_WR];
}
/*
* This used to actually send data over the channel's socket. Now we
* queue a request and send single byte notification over shared
* POLLMGR_QUEUE socket.
*/
ssize_t
pollmgr_chan_send(int slot, void *buf, size_t nbytes)
{
static const char notification = 0x5a;
void *ptr;
SOCKET fd;
ssize_t nsent;
int rc;
AssertReturn(0 <= slot && slot < POLLMGR_CHAN_COUNT, -1);
/*
* XXX: Hack alert. We only ever "sent" single pointer which was
* simultaneously both the wakeup event for the poll and the
* argument for the channel handler that it read from the channel.
* So now we pass this pointer to the request and arrange for the
* handler to "read" it when it asks for it.
*/
if (nbytes != sizeof(void *)) {
return -1;
}
ptr = *(void **)buf;
rc = RTReqQueueCallEx(pollmgr.queue, NULL, 0,
RTREQFLAGS_VOID | RTREQFLAGS_NO_WAIT,
(PFNRT)pollmgr_chan_call_handler, 2,
slot, ptr);
fd = pollmgr.chan[POLLMGR_QUEUE][POLLMGR_CHFD_WR];
nsent = send(fd, ¬ification, 1, 0);
if (nsent == SOCKET_ERROR) {
DPRINTF(("send on chan %d: %R[sockerr]\n", slot, SOCKERRNO()));
return -1;
}
else if ((size_t)nsent != 1) {
DPRINTF(("send on chan %d: datagram truncated to %u bytes",
slot, (unsigned int)nsent));
return -1;
}
/* caller thinks it's sending the pointer */
return sizeof(void *);
}
/*
* pollmgr_chan_send() sent us a notification, process the queue.
*/
static int
pollmgr_queue_callback(struct pollmgr_handler *handler, SOCKET fd, int revents)
{
ssize_t nread;
int sockerr;
int rc;
RT_NOREF(handler, revents);
Assert(pollmgr.queue != NIL_RTREQQUEUE);
nread = recv(fd, (char *)pollmgr_udpbuf, sizeof(pollmgr_udpbuf), 0);
sockerr = SOCKERRNO(); /* save now, may be clobbered */
if (nread == SOCKET_ERROR) {
DPRINTF0(("%s: recv: %R[sockerr]\n", __func__, sockerr));
return POLLIN;
}
DPRINTF2(("%s: read %zd\n", __func__, nread));
if (nread == 0) {
return POLLIN;
}
rc = RTReqQueueProcess(pollmgr.queue, 0);
if (RT_UNLIKELY(rc != VERR_TIMEOUT && RT_FAILURE_NP(rc))) {
DPRINTF0(("%s: RTReqQueueProcess: %Rrc\n", __func__, rc));
}
return POLLIN;
}
/*
* Queued requests use this function to emulate the call to the
* handler's callback.
*/
static void
pollmgr_chan_call_handler(int slot, void *arg)
{
struct pollmgr_handler *handler;
int nevents;
AssertReturnVoid(0 <= slot && slot < POLLMGR_CHAN_COUNT);
handler = pollmgr.chan_handlers[slot].handler;
AssertReturnVoid(handler != NULL && handler->callback != NULL);
/* arrange for pollmgr_chan_recv_ptr() to "receive" the arg */
pollmgr.chan_handlers[slot].arg = arg;
pollmgr.chan_handlers[slot].arg_valid = true;
nevents = handler->callback(handler, INVALID_SOCKET, POLLIN);
if (nevents != POLLIN) {
DPRINTF2(("%s: nevents=0x%x!\n", __func__, nevents));
}
}
/*
* "Receive" a pointer "sent" over poll manager channel.
*/
void *
pollmgr_chan_recv_ptr(struct pollmgr_handler *handler, SOCKET fd, int revents)
{
int slot;
void *ptr;
RT_NOREF(fd);
slot = handler->slot;
Assert(0 <= slot && slot < POLLMGR_CHAN_COUNT);
if (revents & POLLNVAL) {
errx(EXIT_FAILURE, "chan %d: fd invalid", (int)handler->slot);
/* NOTREACHED */
}
if (revents & (POLLERR | POLLHUP)) {
errx(EXIT_FAILURE, "chan %d: fd error", (int)handler->slot);
/* NOTREACHED */
}
LWIP_ASSERT1(revents & POLLIN);
if (!pollmgr.chan_handlers[slot].arg_valid) {
err(EXIT_FAILURE, "chan %d: recv", (int)handler->slot);
/* NOTREACHED */
}
ptr = pollmgr.chan_handlers[slot].arg;
pollmgr.chan_handlers[slot].arg_valid = false;
return ptr;
}
/*
* Must be called from pollmgr loop (via callbacks), so no locking.
*/
int
pollmgr_add(struct pollmgr_handler *handler, SOCKET fd, int events)
{
int slot;
DPRINTF2(("%s: new fd %d\n", __func__, fd));
if (pollmgr.nfds == pollmgr.capacity) {
struct pollfd *newfds;
struct pollmgr_handler **newhdls;
nfds_t newcap;
nfds_t i;
newcap = pollmgr.capacity * 2;
newfds = (struct pollfd *)
realloc(pollmgr.fds, newcap * sizeof(*pollmgr.fds));
if (newfds == NULL) {
DPRINTF(("%s: Failed to reallocate fds array\n", __func__));
handler->slot = -1;
return -1;
}
pollmgr.fds = newfds; /* don't crash/leak if realloc(handlers) fails */
/* but don't update capacity yet! */
newhdls = (struct pollmgr_handler **)
realloc(pollmgr.handlers, newcap * sizeof(*pollmgr.handlers));
if (newhdls == NULL) {
DPRINTF(("%s: Failed to reallocate handlers array\n", __func__));
/* if we failed to realloc here, then fds points to the
* new array, but we pretend we still has old capacity */
handler->slot = -1;
return -1;
}
pollmgr.handlers = newhdls;
pollmgr.capacity = newcap;
for (i = pollmgr.nfds; i < newcap; ++i) {
newfds[i].fd = INVALID_SOCKET;
newfds[i].events = 0;
newfds[i].revents = 0;
newhdls[i] = NULL;
}
}
slot = pollmgr.nfds;
++pollmgr.nfds;
pollmgr_add_at(slot, handler, fd, events);
return slot;
}
static void
pollmgr_add_at(int slot, struct pollmgr_handler *handler, SOCKET fd, int events)
{
pollmgr.fds[slot].fd = fd;
pollmgr.fds[slot].events = events;
pollmgr.fds[slot].revents = 0;
pollmgr.handlers[slot] = handler;
handler->slot = slot;
}
void
pollmgr_update_events(int slot, int events)
{
LWIP_ASSERT1(slot >= POLLMGR_SLOT_FIRST_DYNAMIC);
LWIP_ASSERT1((nfds_t)slot < pollmgr.nfds);
pollmgr.fds[slot].events = events;
}
void
pollmgr_del_slot(int slot)
{
LWIP_ASSERT1(slot >= POLLMGR_SLOT_FIRST_DYNAMIC);
DPRINTF2(("%s(%d): fd %d ! DELETED\n",
__func__, slot, pollmgr.fds[slot].fd));
pollmgr.fds[slot].fd = INVALID_SOCKET; /* see poll loop */
}
void
pollmgr_thread(void *ignored)
{
LWIP_UNUSED_ARG(ignored);
pollmgr_loop();
}
static void
pollmgr_loop(void)
{
int nready;
SOCKET delfirst;
SOCKET *pdelprev;
int i;
for (;;) {
#ifndef RT_OS_WINDOWS
nready = poll(pollmgr.fds, pollmgr.nfds, -1);
#else
int rc = RTWinPoll(pollmgr.fds, pollmgr.nfds,RT_INDEFINITE_WAIT, &nready);
if (RT_FAILURE(rc)) {
err(EXIT_FAILURE, "poll"); /* XXX: what to do on error? */
/* NOTREACHED*/
}
#endif
DPRINTF2(("%s: ready %d fd%s\n",
__func__, nready, (nready == 1 ? "" : "s")));
if (nready < 0) {
if (errno == EINTR) {
continue;
}
err(EXIT_FAILURE, "poll"); /* XXX: what to do on error? */
/* NOTREACHED*/
}
else if (nready == 0) { /* cannot happen, we wait forever (-1) */
continue; /* - but be defensive */
}
delfirst = INVALID_SOCKET;
pdelprev = &delfirst;
for (i = 0; (nfds_t)i < pollmgr.nfds && nready > 0; ++i) {
struct pollmgr_handler *handler;
SOCKET fd;
int revents, nevents;
fd = pollmgr.fds[i].fd;
revents = pollmgr.fds[i].revents;
/*
* Channel handlers can request deletion of dynamic slots
* by calling pollmgr_del_slot() that clobbers slot's fd.
*/
if (fd == INVALID_SOCKET && i >= POLLMGR_SLOT_FIRST_DYNAMIC) {
/* adjust count if events were pending for that slot */
if (revents != 0) {
--nready;
}
/* pretend that slot handler requested deletion */
nevents = -1;
goto update_events;
}
if (revents == 0) {
continue; /* next fd */
}
--nready;
handler = pollmgr.handlers[i];
if (handler != NULL && handler->callback != NULL) {
#ifdef LWIP_PROXY_DEBUG
# if LWIP_PROXY_DEBUG /* DEBUG */
if (i < POLLMGR_SLOT_FIRST_DYNAMIC) {
if (revents == POLLIN) {
DPRINTF2(("%s: ch %d\n", __func__, i));
}
else {
DPRINTF2(("%s: ch %d @ revents 0x%x!\n",
__func__, i, revents));
}
}
else {
DPRINTF2(("%s: fd %d @ revents 0x%x\n",
__func__, fd, revents));
}
# endif /* LWIP_PROXY_DEBUG / DEBUG */
#endif
nevents = (*handler->callback)(handler, fd, revents);
}
else {
DPRINTF0(("%s: invalid handler for fd %d: ", __func__, fd));
if (handler == NULL) {
DPRINTF0(("NULL\n"));
}
else {
DPRINTF0(("%p (callback = NULL)\n", (void *)handler));
}
nevents = -1; /* delete it */
}
update_events:
if (nevents >= 0) {
if (nevents != pollmgr.fds[i].events) {
DPRINTF2(("%s: fd %d ! nevents 0x%x\n",
__func__, fd, nevents));
}
pollmgr.fds[i].events = nevents;
}
else if (i < POLLMGR_SLOT_FIRST_DYNAMIC) {
/* Don't garbage-collect channels. */
DPRINTF2(("%s: fd %d ! DELETED (channel %d)\n",
__func__, fd, i));
pollmgr.fds[i].fd = INVALID_SOCKET;
pollmgr.fds[i].events = 0;
pollmgr.fds[i].revents = 0;
pollmgr.handlers[i] = NULL;
}
else {
DPRINTF2(("%s: fd %d ! DELETED\n", __func__, fd));
/* schedule for deletion (see g/c loop for details) */
*pdelprev = i; /* make previous entry point to us */
pdelprev = &pollmgr.fds[i].fd;
pollmgr.fds[i].fd = INVALID_SOCKET; /* end of list (for now) */
pollmgr.fds[i].events = POLLMGR_GARBAGE;
pollmgr.fds[i].revents = 0;
pollmgr.handlers[i] = NULL;
}
} /* processing loop */
/*
* Garbage collect and compact the array.
*
* We overload pollfd::fd of garbage entries to store the
* index of the next garbage entry. The garbage list is
* co-directional with the fds array. The index of the first
* entry is in "delfirst", the last entry "points to"
* INVALID_SOCKET.
*
* See update_events code for nevents < 0 at the end of the
* processing loop above.
*/
while (delfirst != INVALID_SOCKET) {
const int last = pollmgr.nfds - 1;
/*
* We want a live entry in the last slot to swap into the
* freed slot, so make sure we have one.
*/
if (pollmgr.fds[last].events == POLLMGR_GARBAGE /* garbage */
|| pollmgr.fds[last].fd == INVALID_SOCKET) /* or killed */
{
/* drop garbage entry at the end of the array */
--pollmgr.nfds;
if (delfirst == (SOCKET)last) {
/* congruent to delnext >= pollmgr.nfds test below */
delfirst = INVALID_SOCKET; /* done */
}
}
else {
const SOCKET delnext = pollmgr.fds[delfirst].fd;
/* copy live entry at the end to the first slot being freed */
pollmgr.fds[delfirst] = pollmgr.fds[last]; /* struct copy */
pollmgr.handlers[delfirst] = pollmgr.handlers[last];
pollmgr.handlers[delfirst]->slot = (int)delfirst;
--pollmgr.nfds;
if ((nfds_t)delnext >= pollmgr.nfds) {
delfirst = INVALID_SOCKET; /* done */
}
else {
delfirst = delnext;
}
}
pollmgr.fds[last].fd = INVALID_SOCKET;
pollmgr.fds[last].events = 0;
pollmgr.fds[last].revents = 0;
pollmgr.handlers[last] = NULL;
}
} /* poll loop */
}
/**
* Create strongly held refptr.
*/
struct pollmgr_refptr *
pollmgr_refptr_create(struct pollmgr_handler *ptr)
{
struct pollmgr_refptr *rp;
LWIP_ASSERT1(ptr != NULL);
rp = (struct pollmgr_refptr *)malloc(sizeof (*rp));
if (rp == NULL) {
return NULL;
}
sys_mutex_new(&rp->lock);
rp->ptr = ptr;
rp->strong = 1;
rp->weak = 0;
return rp;
}
static void
pollmgr_refptr_delete(struct pollmgr_refptr *rp)
{
if (rp == NULL) {
return;
}
LWIP_ASSERT1(rp->strong == 0);
LWIP_ASSERT1(rp->weak == 0);
sys_mutex_free(&rp->lock);
free(rp);
}
/**
* Add weak reference before "rp" is sent over a poll manager channel.
*/
void
pollmgr_refptr_weak_ref(struct pollmgr_refptr *rp)
{
sys_mutex_lock(&rp->lock);
LWIP_ASSERT1(rp->ptr != NULL);
LWIP_ASSERT1(rp->strong > 0);
++rp->weak;
sys_mutex_unlock(&rp->lock);
}
/**
* Try to get the pointer from implicitely weak reference we've got
* from a channel.
*
* If we detect that the object is still strongly referenced, but no
* longer registered with the poll manager we abort strengthening
* conversion here b/c lwip thread callback is already scheduled to
* destruct the object.
*/
struct pollmgr_handler *
pollmgr_refptr_get(struct pollmgr_refptr *rp)
{
struct pollmgr_handler *handler;
size_t weak;
sys_mutex_lock(&rp->lock);
LWIP_ASSERT1(rp->weak > 0);
weak = --rp->weak;
handler = rp->ptr;
if (handler == NULL) {
LWIP_ASSERT1(rp->strong == 0);
sys_mutex_unlock(&rp->lock);
if (weak == 0) {
pollmgr_refptr_delete(rp);
}
return NULL;
}
LWIP_ASSERT1(rp->strong == 1);
/*
* Here we woild do:
*
* ++rp->strong;
*
* and then, after channel handler is done, we would decrement it
* back.
*
* Instead we check that the object is still registered with poll
* manager. If it is, there's no race with lwip thread trying to
* drop its strong reference, as lwip thread callback to destruct
* the object is always scheduled by its poll manager callback.
*
* Conversly, if we detect that the object is no longer registered
* with poll manager, we immediately abort. Since channel handler
* can't do anything useful anyway and would have to return
* immediately.
*
* Since channel handler would always find rp->strong as it had
* left it, just elide extra strong reference creation to avoid
* the whole back-and-forth.
*/
if (handler->slot < 0) { /* no longer polling */
sys_mutex_unlock(&rp->lock);
return NULL;
}
sys_mutex_unlock(&rp->lock);
return handler;
}
/**
* Remove (the only) strong reference.
*
* If it were real strong/weak pointers, we should also call
* destructor for the referenced object, but
*/
void
pollmgr_refptr_unref(struct pollmgr_refptr *rp)
{
sys_mutex_lock(&rp->lock);
LWIP_ASSERT1(rp->strong == 1);
--rp->strong;
if (rp->strong > 0) {
sys_mutex_unlock(&rp->lock);
}
else {
size_t weak;
/* void *ptr = rp->ptr; */
rp->ptr = NULL;
/* delete ptr; // see doc comment */
weak = rp->weak;
sys_mutex_unlock(&rp->lock);
if (weak == 0) {
pollmgr_refptr_delete(rp);
}
}
}
|