2 * winhandl.c: Module to give Windows front ends the general
3 * ability to deal with consoles, pipes, serial ports, or any other
4 * type of data stream accessed through a Windows API HANDLE rather
5 * than a WinSock SOCKET.
7 * We do this by spawning a subthread to continuously try to read
8 * from the handle. Every time a read successfully returns some
9 * data, the subthread sets an event object which is picked up by
10 * the main thread, and the main thread then sets an event in
11 * return to instruct the subthread to resume reading.
13 * Output works precisely the other way round, in a second
14 * subthread. The output subthread should not be attempting to
15 * write all the time, because it hasn't always got data _to_
16 * write; so the output thread waits for an event object notifying
17 * it to _attempt_ a write, and then it sets an event in return
20 * (It's terribly annoying having to spawn a subthread for each
21 * direction of each handle. Technically it isn't necessary for
22 * serial ports, since we could use overlapped I/O within the main
23 * thread and wait directly on the event objects in the OVERLAPPED
24 * structures. However, we can't use this trick for some types of
25 * file handle at all - for some reason Windows restricts use of
26 * OVERLAPPED to files which were opened with the overlapped flag -
27 * and so we must use threads for those. This being the case, it's
28 * simplest just to use threads for everything rather than trying
29 * to keep track of multiple completely separate mechanisms.)
36 /* ----------------------------------------------------------------------
37 * Generic definitions.
41 * Maximum amount of backlog we will allow to build up on an input
42 * handle before we stop reading from it.
44 #define MAX_BACKLOG 32768
46 struct handle_generic
{
48 * Initial fields common to both handle_input and handle_output
51 * The three HANDLEs are set up at initialisation time and are
52 * thereafter read-only to both main thread and subthread.
53 * `moribund' is only used by the main thread; `done' is
54 * written by the main thread before signalling to the
55 * subthread. `defunct' and `busy' are used only by the main
58 HANDLE h
; /* the handle itself */
59 HANDLE ev_to_main
; /* event used to signal main thread */
60 HANDLE ev_from_main
; /* event used to signal back to us */
61 int moribund
; /* are we going to kill this soon? */
62 int done
; /* request subthread to terminate */
63 int defunct
; /* has the subthread already gone? */
64 int busy
; /* operation currently in progress? */
65 void *privdata
; /* for client to remember who they are */
68 /* ----------------------------------------------------------------------
73 * Data required by an input thread.
77 * Copy of the handle_generic structure.
79 HANDLE h
; /* the handle itself */
80 HANDLE ev_to_main
; /* event used to signal main thread */
81 HANDLE ev_from_main
; /* event used to signal back to us */
82 int moribund
; /* are we going to kill this soon? */
83 int done
; /* request subthread to terminate */
84 int defunct
; /* has the subthread already gone? */
85 int busy
; /* operation currently in progress? */
86 void *privdata
; /* for client to remember who they are */
89 * Data set at initialisation and then read-only.
94 * Data set by the input thread before signalling ev_to_main,
95 * and read by the main thread after receiving that signal.
97 char buffer
[4096]; /* the data read from the handle */
98 DWORD len
; /* how much data that was */
99 int readerr
; /* lets us know about read errors */
102 * Callback function called by this module when data arrives on
105 handle_inputfn_t gotdata
;
109 * The actual thread procedure for an input thread.
111 static DWORD WINAPI
handle_input_threadfunc(void *param
)
113 struct handle_input
*ctx
= (struct handle_input
*) param
;
114 OVERLAPPED ovl
, *povl
;
116 int readret
, readlen
;
118 if (ctx
->flags
& HANDLE_FLAG_OVERLAPPED
) {
120 oev
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
125 if (ctx
->flags
& HANDLE_FLAG_UNITBUFFER
)
128 readlen
= sizeof(ctx
->buffer
);
132 memset(povl
, 0, sizeof(OVERLAPPED
));
135 readret
= ReadFile(ctx
->h
, ctx
->buffer
,readlen
, &ctx
->len
, povl
);
137 ctx
->readerr
= GetLastError();
140 if (povl
&& !readret
&& ctx
->readerr
== ERROR_IO_PENDING
) {
141 WaitForSingleObject(povl
->hEvent
, INFINITE
);
142 readret
= GetOverlappedResult(ctx
->h
, povl
, &ctx
->len
, FALSE
);
144 ctx
->readerr
= GetLastError();
151 * Windows apparently sends ERROR_BROKEN_PIPE when a
152 * pipe we're reading from is closed normally from the
153 * writing end. This is ludicrous; if that situation
154 * isn't a natural EOF, _nothing_ is. So if we get that
155 * particular error, we pretend it's EOF.
157 if (ctx
->readerr
== ERROR_BROKEN_PIPE
)
162 if (readret
&& ctx
->len
== 0 &&
163 (ctx
->flags
& HANDLE_FLAG_IGNOREEOF
))
166 SetEvent(ctx
->ev_to_main
);
171 WaitForSingleObject(ctx
->ev_from_main
, INFINITE
);
173 break; /* main thread told us to shut down */
183 * This is called after a succcessful read, or from the
184 * `unthrottle' function. It decides whether or not to begin a new
187 static void handle_throttle(struct handle_input
*ctx
, int backlog
)
193 * If there's a read operation already in progress, do nothing:
194 * when that completes, we'll come back here and be in a
195 * position to make a better decision.
201 * Otherwise, we must decide whether to start a new read based
202 * on the size of the backlog.
204 if (backlog
< MAX_BACKLOG
) {
205 SetEvent(ctx
->ev_from_main
);
210 /* ----------------------------------------------------------------------
215 * Data required by an output thread.
217 struct handle_output
{
219 * Copy of the handle_generic structure.
221 HANDLE h
; /* the handle itself */
222 HANDLE ev_to_main
; /* event used to signal main thread */
223 HANDLE ev_from_main
; /* event used to signal back to us */
224 int moribund
; /* are we going to kill this soon? */
225 int done
; /* request subthread to terminate */
226 int defunct
; /* has the subthread already gone? */
227 int busy
; /* operation currently in progress? */
228 void *privdata
; /* for client to remember who they are */
231 * Data set at initialisation and then read-only.
236 * Data set by the main thread before signalling ev_from_main,
237 * and read by the input thread after receiving that signal.
239 char *buffer
; /* the data to write */
240 DWORD len
; /* how much data there is */
243 * Data set by the input thread before signalling ev_to_main,
244 * and read by the main thread after receiving that signal.
246 DWORD lenwritten
; /* how much data we actually wrote */
247 int writeerr
; /* return value from WriteFile */
250 * Data only ever read or written by the main thread.
252 bufchain queued_data
; /* data still waiting to be written */
253 enum { EOF_NO
, EOF_PENDING
, EOF_SENT
} outgoingeof
;
256 * Callback function called when the backlog in the bufchain
259 handle_outputfn_t sentdata
;
262 static DWORD WINAPI
handle_output_threadfunc(void *param
)
264 struct handle_output
*ctx
= (struct handle_output
*) param
;
265 OVERLAPPED ovl
, *povl
;
269 if (ctx
->flags
& HANDLE_FLAG_OVERLAPPED
) {
271 oev
= CreateEvent(NULL
, TRUE
, FALSE
, NULL
);
277 WaitForSingleObject(ctx
->ev_from_main
, INFINITE
);
279 SetEvent(ctx
->ev_to_main
);
283 memset(povl
, 0, sizeof(OVERLAPPED
));
287 writeret
= WriteFile(ctx
->h
, ctx
->buffer
, ctx
->len
,
288 &ctx
->lenwritten
, povl
);
290 ctx
->writeerr
= GetLastError();
293 if (povl
&& !writeret
&& GetLastError() == ERROR_IO_PENDING
) {
294 writeret
= GetOverlappedResult(ctx
->h
, povl
,
295 &ctx
->lenwritten
, TRUE
);
297 ctx
->writeerr
= GetLastError();
302 SetEvent(ctx
->ev_to_main
);
313 static void handle_try_output(struct handle_output
*ctx
)
318 if (!ctx
->busy
&& bufchain_size(&ctx
->queued_data
)) {
319 bufchain_prefix(&ctx
->queued_data
, &senddata
, &sendlen
);
320 ctx
->buffer
= senddata
;
322 SetEvent(ctx
->ev_from_main
);
324 } else if (!ctx
->busy
&& bufchain_size(&ctx
->queued_data
) == 0 &&
325 ctx
->outgoingeof
== EOF_PENDING
) {
327 ctx
->h
= INVALID_HANDLE_VALUE
;
328 ctx
->outgoingeof
= EOF_SENT
;
332 /* ----------------------------------------------------------------------
333 * Unified code handling both input and output threads.
339 struct handle_generic g
;
340 struct handle_input i
;
341 struct handle_output o
;
345 static tree234
*handles_by_evtomain
;
347 static int handle_cmp_evtomain(void *av
, void *bv
)
349 struct handle
*a
= (struct handle
*)av
;
350 struct handle
*b
= (struct handle
*)bv
;
352 if ((unsigned)a
->u
.g
.ev_to_main
< (unsigned)b
->u
.g
.ev_to_main
)
354 else if ((unsigned)a
->u
.g
.ev_to_main
> (unsigned)b
->u
.g
.ev_to_main
)
360 static int handle_find_evtomain(void *av
, void *bv
)
362 HANDLE
*a
= (HANDLE
*)av
;
363 struct handle
*b
= (struct handle
*)bv
;
365 if ((unsigned)*a
< (unsigned)b
->u
.g
.ev_to_main
)
367 else if ((unsigned)*a
> (unsigned)b
->u
.g
.ev_to_main
)
373 struct handle
*handle_input_new(HANDLE handle
, handle_inputfn_t gotdata
,
374 void *privdata
, int flags
)
376 struct handle
*h
= snew(struct handle
);
377 DWORD in_threadid
; /* required for Win9x */
381 h
->u
.i
.ev_to_main
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
382 h
->u
.i
.ev_from_main
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
383 h
->u
.i
.gotdata
= gotdata
;
384 h
->u
.i
.defunct
= FALSE
;
385 h
->u
.i
.moribund
= FALSE
;
387 h
->u
.i
.privdata
= privdata
;
388 h
->u
.i
.flags
= flags
;
390 if (!handles_by_evtomain
)
391 handles_by_evtomain
= newtree234(handle_cmp_evtomain
);
392 add234(handles_by_evtomain
, h
);
394 CreateThread(NULL
, 0, handle_input_threadfunc
,
395 &h
->u
.i
, 0, &in_threadid
);
401 struct handle
*handle_output_new(HANDLE handle
, handle_outputfn_t sentdata
,
402 void *privdata
, int flags
)
404 struct handle
*h
= snew(struct handle
);
405 DWORD out_threadid
; /* required for Win9x */
409 h
->u
.o
.ev_to_main
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
410 h
->u
.o
.ev_from_main
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
412 h
->u
.o
.defunct
= FALSE
;
413 h
->u
.o
.moribund
= FALSE
;
415 h
->u
.o
.privdata
= privdata
;
416 bufchain_init(&h
->u
.o
.queued_data
);
417 h
->u
.o
.outgoingeof
= EOF_NO
;
418 h
->u
.o
.sentdata
= sentdata
;
419 h
->u
.o
.flags
= flags
;
421 if (!handles_by_evtomain
)
422 handles_by_evtomain
= newtree234(handle_cmp_evtomain
);
423 add234(handles_by_evtomain
, h
);
425 CreateThread(NULL
, 0, handle_output_threadfunc
,
426 &h
->u
.o
, 0, &out_threadid
);
431 int handle_write(struct handle
*h
, const void *data
, int len
)
434 assert(h
->u
.o
.outgoingeof
== EOF_NO
);
435 bufchain_add(&h
->u
.o
.queued_data
, data
, len
);
436 handle_try_output(&h
->u
.o
);
437 return bufchain_size(&h
->u
.o
.queued_data
);
440 void handle_write_eof(struct handle
*h
)
443 * This function is called when we want to proactively send an
444 * end-of-file notification on the handle. We can only do this by
445 * actually closing the handle - so never call this on a
446 * bidirectional handle if we're still interested in its incoming
450 if (!h
->u
.o
.outgoingeof
== EOF_NO
) {
451 h
->u
.o
.outgoingeof
= EOF_PENDING
;
452 handle_try_output(&h
->u
.o
);
456 HANDLE
*handle_get_events(int *nevents
)
463 * Go through our tree counting the handle objects currently
464 * engaged in useful activity.
468 if (handles_by_evtomain
) {
469 for (i
= 0; (h
= index234(handles_by_evtomain
, i
)) != NULL
; i
++) {
473 ret
= sresize(ret
, size
, HANDLE
);
475 ret
[n
++] = h
->u
.g
.ev_to_main
;
484 static void handle_destroy(struct handle
*h
)
487 bufchain_clear(&h
->u
.o
.queued_data
);
488 CloseHandle(h
->u
.g
.ev_from_main
);
489 CloseHandle(h
->u
.g
.ev_to_main
);
490 del234(handles_by_evtomain
, h
);
494 void handle_free(struct handle
*h
)
497 * If the handle is currently busy, we cannot immediately free
498 * it. Instead we must wait until it's finished its current
499 * operation, because otherwise the subthread will write to
500 * invalid memory after we free its context from under it.
502 assert(h
&& !h
->u
.g
.moribund
);
505 * Just set the moribund flag, which will be noticed next
506 * time an operation completes.
508 h
->u
.g
.moribund
= TRUE
;
509 } else if (h
->u
.g
.defunct
) {
511 * There isn't even a subthread; we can go straight to
517 * The subthread is alive but not busy, so we now signal it
518 * to die. Set the moribund flag to indicate that it will
519 * want destroying after that.
521 h
->u
.g
.moribund
= TRUE
;
524 SetEvent(h
->u
.g
.ev_from_main
);
528 void handle_got_event(HANDLE event
)
532 assert(handles_by_evtomain
);
533 h
= find234(handles_by_evtomain
, &event
, handle_find_evtomain
);
536 * This isn't an error condition. If two or more event
537 * objects were signalled during the same select operation,
538 * and processing of the first caused the second handle to
539 * be closed, then it will sometimes happen that we receive
540 * an event notification here for a handle which is already
541 * deceased. In that situation we simply do nothing.
546 if (h
->u
.g
.moribund
) {
548 * A moribund handle is already treated as dead from the
549 * external user's point of view, so do nothing with the
550 * actual event. Just signal the thread to die if
551 * necessary, or destroy the handle if not.
558 SetEvent(h
->u
.g
.ev_from_main
);
569 * A signal on an input handle means data has arrived.
571 if (h
->u
.i
.len
== 0) {
573 * EOF, or (nearly equivalently) read error.
575 h
->u
.i
.gotdata(h
, NULL
, -h
->u
.i
.readerr
);
576 h
->u
.i
.defunct
= TRUE
;
578 backlog
= h
->u
.i
.gotdata(h
, h
->u
.i
.buffer
, h
->u
.i
.len
);
579 handle_throttle(&h
->u
.i
, backlog
);
585 * A signal on an output handle means we have completed a
586 * write. Call the callback to indicate that the output
587 * buffer size has decreased, or to indicate an error.
589 if (h
->u
.o
.writeerr
) {
591 * Write error. Send a negative value to the callback,
592 * and mark the thread as defunct (because the output
593 * thread is terminating by now).
595 h
->u
.o
.sentdata(h
, -h
->u
.o
.writeerr
);
596 h
->u
.o
.defunct
= TRUE
;
598 bufchain_consume(&h
->u
.o
.queued_data
, h
->u
.o
.lenwritten
);
599 h
->u
.o
.sentdata(h
, bufchain_size(&h
->u
.o
.queued_data
));
600 handle_try_output(&h
->u
.o
);
605 void handle_unthrottle(struct handle
*h
, int backlog
)
608 handle_throttle(&h
->u
.i
, backlog
);
611 int handle_backlog(struct handle
*h
)
614 return bufchain_size(&h
->u
.o
.queued_data
);
617 void *handle_get_privdata(struct handle
*h
)
619 return h
->u
.g
.privdata
;