FreeRDP
Loading...
Searching...
No Matches
serial_main.c
1
22#include <freerdp/config.h>
23
24#include <errno.h>
25#include <stdio.h>
26#include <stdint.h>
27#include <stdlib.h>
28#include <string.h>
29
30#include <winpr/collections.h>
31#include <winpr/comm.h>
32#include <winpr/crt.h>
33#include <winpr/stream.h>
34#include <winpr/synch.h>
35#include <winpr/thread.h>
36#include <winpr/wlog.h>
37#include <winpr/assert.h>
38
39#include <freerdp/freerdp.h>
40#include <freerdp/channels/rdpdr.h>
41#include <freerdp/channels/log.h>
42#include <freerdp/utils/rdpdr_utils.h>
43
44#define TAG CHANNELS_TAG("serial.client")
45
46#define MAX_IRP_THREADS 5
47
48typedef struct
49{
50 DEVICE device;
51 BOOL permissive;
52 SERIAL_DRIVER_ID ServerSerialDriverId;
53 HANDLE hComm;
54
55 wLog* log;
56 HANDLE MainThread;
57 wMessageQueue* MainIrpQueue;
58
59 /* one thread per pending IRP and indexed according their CompletionId */
60 wListDictionary* IrpThreads;
61 CRITICAL_SECTION TerminatingIrpThreadsLock;
62 rdpContext* rdpcontext;
63} SERIAL_DEVICE;
64
65typedef struct
66{
67 SERIAL_DEVICE* serial;
68 IRP* irp;
69} IRP_THREAD_DATA;
70
71static void close_terminated_irp_thread_handles(SERIAL_DEVICE* serial, BOOL forceClose);
72static NTSTATUS GetLastErrorToIoStatus(SERIAL_DEVICE* serial)
73{
74 /* http://msdn.microsoft.com/en-us/library/ff547466%28v=vs.85%29.aspx#generic_status_values_for_serial_device_control_requests
75 */
76 switch (GetLastError())
77 {
78 case ERROR_BAD_DEVICE:
79 return STATUS_INVALID_DEVICE_REQUEST;
80
81 case ERROR_CALL_NOT_IMPLEMENTED:
82 return STATUS_NOT_IMPLEMENTED;
83
84 case ERROR_CANCELLED:
85 return STATUS_CANCELLED;
86
87 case ERROR_INSUFFICIENT_BUFFER:
88 return STATUS_BUFFER_TOO_SMALL; /* NB: STATUS_BUFFER_SIZE_TOO_SMALL not defined */
89
90 case ERROR_INVALID_DEVICE_OBJECT_PARAMETER: /* eg: SerCx2.sys' _purge() */
91 return STATUS_INVALID_DEVICE_STATE;
92
93 case ERROR_INVALID_HANDLE:
94 return STATUS_INVALID_DEVICE_REQUEST;
95
96 case ERROR_INVALID_PARAMETER:
97 return STATUS_INVALID_PARAMETER;
98
99 case ERROR_IO_DEVICE:
100 return STATUS_IO_DEVICE_ERROR;
101
102 case ERROR_IO_PENDING:
103 return STATUS_PENDING;
104
105 case ERROR_NOT_SUPPORTED:
106 return STATUS_NOT_SUPPORTED;
107
108 case ERROR_TIMEOUT:
109 return STATUS_TIMEOUT;
110 default:
111 break;
112 }
113
114 WLog_Print(serial->log, WLOG_DEBUG, "unexpected last-error: 0x%08" PRIX32 "", GetLastError());
115 return STATUS_UNSUCCESSFUL;
116}
117
118WINPR_ATTR_NODISCARD
119static UINT serial_process_irp_create(SERIAL_DEVICE* serial, IRP* irp)
120{
121 DWORD DesiredAccess = 0;
122 DWORD SharedAccess = 0;
123 DWORD CreateDisposition = 0;
124 UINT32 PathLength = 0;
125
126 WINPR_ASSERT(serial);
127 WINPR_ASSERT(irp);
128
129 if (!Stream_CheckAndLogRequiredLengthWLog(serial->log, irp->input, 32))
130 return ERROR_INVALID_DATA;
131
132 Stream_Read_UINT32(irp->input, DesiredAccess); /* DesiredAccess (4 bytes) */
133 Stream_Seek_UINT64(irp->input); /* AllocationSize (8 bytes) */
134 Stream_Seek_UINT32(irp->input); /* FileAttributes (4 bytes) */
135 Stream_Read_UINT32(irp->input, SharedAccess); /* SharedAccess (4 bytes) */
136 Stream_Read_UINT32(irp->input, CreateDisposition); /* CreateDisposition (4 bytes) */
137 Stream_Seek_UINT32(irp->input); /* CreateOptions (4 bytes) */
138 Stream_Read_UINT32(irp->input, PathLength); /* PathLength (4 bytes) */
139
140 if (!Stream_SafeSeek(irp->input, PathLength)) /* Path (variable) */
141 return ERROR_INVALID_DATA;
142
143 WINPR_ASSERT(PathLength == 0); /* MS-RDPESP 2.2.2.2 */
144#ifndef _WIN32
145 /* Windows 2012 server sends on a first call :
146 * DesiredAccess = 0x00100080: SYNCHRONIZE | FILE_READ_ATTRIBUTES
147 * SharedAccess = 0x00000007: FILE_SHARE_DELETE | FILE_SHARE_WRITE | FILE_SHARE_READ
148 * CreateDisposition = 0x00000001: CREATE_NEW
149 *
150 * then Windows 2012 sends :
151 * DesiredAccess = 0x00120089: SYNCHRONIZE | READ_CONTROL | FILE_READ_ATTRIBUTES |
152 * FILE_READ_EA | FILE_READ_DATA SharedAccess = 0x00000007: FILE_SHARE_DELETE |
153 * FILE_SHARE_WRITE | FILE_SHARE_READ CreateDisposition = 0x00000001: CREATE_NEW
154 *
155 * WINPR_ASSERT(DesiredAccess == (GENERIC_READ | GENERIC_WRITE));
156 * WINPR_ASSERT(SharedAccess == 0);
157 * WINPR_ASSERT(CreateDisposition == OPEN_EXISTING);
158 *
159 */
160 WLog_Print(serial->log, WLOG_DEBUG,
161 "DesiredAccess: 0x%" PRIX32 ", SharedAccess: 0x%" PRIX32
162 ", CreateDisposition: 0x%" PRIX32 "",
163 DesiredAccess, SharedAccess, CreateDisposition);
164 /* FIXME: As of today only the flags below are supported by CommCreateFileA: */
165 DesiredAccess = GENERIC_READ | GENERIC_WRITE;
166 SharedAccess = 0;
167 CreateDisposition = OPEN_EXISTING;
168#endif
169 if (serial->hComm)
170 {
171 WLog_Print(serial->log, WLOG_ERROR, "Device %s already open, cancel request",
172 serial->device.name);
173 return ERROR_INVALID_DATA;
174 }
175
176 serial->hComm = winpr_CreateFile(serial->device.name, DesiredAccess, SharedAccess,
177 nullptr, /* SecurityAttributes */
178 CreateDisposition, 0, /* FlagsAndAttributes */
179 nullptr); /* TemplateFile */
180
181 if (!serial->hComm || (serial->hComm == INVALID_HANDLE_VALUE))
182 {
183 WLog_Print(serial->log, WLOG_WARN, "CreateFile failure: %s last-error: 0x%08" PRIX32 "",
184 serial->device.name, GetLastError());
185 irp->IoStatus = STATUS_UNSUCCESSFUL;
186 goto error_handle;
187 }
188
189 _comm_setServerSerialDriver(serial->hComm, serial->ServerSerialDriverId);
190 _comm_set_permissive(serial->hComm, serial->permissive);
191 /* NOTE: binary mode/raw mode required for the redirection. On
192 * Linux, CommCreateFileA forces this setting.
193 */
194 /* ZeroMemory(&dcb, sizeof(DCB)); */
195 /* dcb.DCBlength = sizeof(DCB); */
196 /* GetCommState(serial->hComm, &dcb); */
197 /* dcb.fBinary = TRUE; */
198 /* SetCommState(serial->hComm, &dcb); */
199 WINPR_ASSERT(irp->FileId == 0);
200 irp->FileId = irp->devman->id_sequence++; /* FIXME: why not ((WINPR_COMM*)hComm)->fd? */
201 irp->IoStatus = STATUS_SUCCESS;
202 WLog_Print(serial->log, WLOG_DEBUG, "%s (DeviceId: %" PRIu32 ", FileId: %" PRIu32 ") created.",
203 serial->device.name, irp->device->id, irp->FileId);
204
205 {
206 DWORD BytesReturned = 0;
207 if (!CommDeviceIoControl(serial->hComm, IOCTL_SERIAL_RESET_DEVICE, nullptr, 0, nullptr, 0,
208 &BytesReturned, nullptr))
209 goto error_handle;
210 }
211
212error_handle:
213 Stream_Write_UINT32(irp->output, irp->FileId); /* FileId (4 bytes) */
214 Stream_Write_UINT8(irp->output, 0); /* Information (1 byte) */
215 return CHANNEL_RC_OK;
216}
217
218static UINT serial_process_irp_close(SERIAL_DEVICE* serial, IRP* irp)
219{
220 WINPR_ASSERT(serial);
221 WINPR_ASSERT(irp);
222
223 if (!Stream_CheckAndLogRequiredLengthWLog(serial->log, irp->input, 32))
224 return ERROR_INVALID_DATA;
225
226 Stream_Seek(irp->input, 32); /* Padding (32 bytes) */
227
228 if (!serial->hComm)
229 {
230 WLog_Print(serial->log, WLOG_ERROR, "serial device %s is not open, aborting close",
231 serial->device.name);
232 return ERROR_INVALID_DATA;
233 }
234
235 close_terminated_irp_thread_handles(serial, TRUE);
236
237 if (!CloseHandle(serial->hComm))
238 {
239 WLog_Print(serial->log, WLOG_WARN, "CloseHandle failure: %s (%" PRIu32 ") closed.",
240 serial->device.name, irp->device->id);
241 irp->IoStatus = STATUS_UNSUCCESSFUL;
242 goto error_handle;
243 }
244
245 WLog_Print(serial->log, WLOG_DEBUG, "%s (DeviceId: %" PRIu32 ", FileId: %" PRIu32 ") closed.",
246 serial->device.name, irp->device->id, irp->FileId);
247 irp->IoStatus = STATUS_SUCCESS;
248error_handle:
249 serial->hComm = nullptr;
250 Stream_Zero(irp->output, 5); /* Padding (5 bytes) */
251 return CHANNEL_RC_OK;
252}
253
259WINPR_ATTR_NODISCARD
260static UINT serial_process_irp_read(SERIAL_DEVICE* serial, IRP* irp)
261{
262 UINT32 Length = 0;
263 UINT64 Offset = 0;
264 DWORD nbRead = 0;
265
266 WINPR_ASSERT(serial);
267 WINPR_ASSERT(irp);
268
269 if (!Stream_CheckAndLogRequiredLengthWLog(serial->log, irp->input, 32))
270 return ERROR_INVALID_DATA;
271
272 Stream_Read_UINT32(irp->input, Length); /* Length (4 bytes) */
273 Stream_Read_UINT64(irp->input, Offset); /* Offset (8 bytes) */
274 (void)Offset; /* [MS-RDPESP] 3.2.5.1.4 Processing a Server Read Request Message
275 * ignored */
276 Stream_Seek(irp->input, 20); /* Padding (20 bytes) */
277
278 if (!serial->hComm)
279 {
280 WLog_Print(serial->log, WLOG_ERROR, "serial device %s is not open, aborting read",
281 serial->device.name);
282 return ERROR_INVALID_DATA;
283 }
284
285 BYTE* buffer = (BYTE*)calloc(Length, sizeof(BYTE));
286
287 if (buffer == nullptr)
288 {
289 irp->IoStatus = STATUS_NO_MEMORY;
290 goto error_handle;
291 }
292
293 /* MS-RDPESP 3.2.5.1.4: If the Offset field is not set to 0, the value MUST be ignored
294 * WINPR_ASSERT(Offset == 0);
295 */
296 WLog_Print(serial->log, WLOG_DEBUG, "reading %" PRIu32 " bytes from %s", Length,
297 serial->device.name);
298
299 /* FIXME: CommReadFile to be replaced by ReadFile */
300 if (CommReadFile(serial->hComm, buffer, Length, &nbRead, nullptr))
301 {
302 irp->IoStatus = STATUS_SUCCESS;
303 }
304 else
305 {
306 WLog_Print(serial->log, WLOG_DEBUG,
307 "read failure to %s, nbRead=%" PRIu32 ", last-error: 0x%08" PRIX32 "",
308 serial->device.name, nbRead, GetLastError());
309 irp->IoStatus = GetLastErrorToIoStatus(serial);
310 }
311
312 WLog_Print(serial->log, WLOG_DEBUG, "%" PRIu32 " bytes read from %s", nbRead,
313 serial->device.name);
314error_handle:
315 Stream_Write_UINT32(irp->output, nbRead); /* Length (4 bytes) */
316
317 if (nbRead > 0)
318 {
319 if (!Stream_EnsureRemainingCapacity(irp->output, nbRead))
320 {
321 WLog_Print(serial->log, WLOG_ERROR, "Stream_EnsureRemainingCapacity failed!");
322 free(buffer);
323 return CHANNEL_RC_NO_MEMORY;
324 }
325
326 Stream_Write(irp->output, buffer, nbRead); /* ReadData */
327 }
328
329 free(buffer);
330 return CHANNEL_RC_OK;
331}
332
333WINPR_ATTR_NODISCARD
334static UINT serial_process_irp_write(SERIAL_DEVICE* serial, IRP* irp)
335{
336 UINT32 Length = 0;
337 UINT64 Offset = 0;
338 DWORD nbWritten = 0;
339
340 WINPR_ASSERT(serial);
341 WINPR_ASSERT(irp);
342
343 if (!Stream_CheckAndLogRequiredLengthWLog(serial->log, irp->input, 32))
344 return ERROR_INVALID_DATA;
345
346 Stream_Read_UINT32(irp->input, Length); /* Length (4 bytes) */
347 Stream_Read_UINT64(irp->input, Offset); /* Offset (8 bytes) */
348 (void)Offset; /* [MS-RDPESP] 3.2.5.1.4 Processing a Server Read Request Message
349 * ignored */
350 if (!Stream_SafeSeek(irp->input, 20)) /* Padding (20 bytes) */
351 return ERROR_INVALID_DATA;
352
353 /* MS-RDPESP 3.2.5.1.5: The Offset field is ignored
354 * WINPR_ASSERT(Offset == 0);
355 *
356 * Using a serial printer, noticed though this field could be
357 * set.
358 */
359 WLog_Print(serial->log, WLOG_DEBUG, "writing %" PRIu32 " bytes to %s", Length,
360 serial->device.name);
361
362 const void* ptr = Stream_ConstPointer(irp->input);
363 if (!Stream_SafeSeek(irp->input, Length))
364 return ERROR_INVALID_DATA;
365
366 if (!serial->hComm)
367 {
368 WLog_Print(serial->log, WLOG_ERROR, "serial device %s is not open, aborting write",
369 serial->device.name);
370 return ERROR_INVALID_DATA;
371 }
372
373 /* FIXME: CommWriteFile to be replaced by WriteFile */
374 if (CommWriteFile(serial->hComm, ptr, Length, &nbWritten, nullptr))
375 {
376 irp->IoStatus = STATUS_SUCCESS;
377 }
378 else
379 {
380 WLog_Print(serial->log, WLOG_DEBUG,
381 "write failure to %s, nbWritten=%" PRIu32 ", last-error: 0x%08" PRIX32 "",
382 serial->device.name, nbWritten, GetLastError());
383 irp->IoStatus = GetLastErrorToIoStatus(serial);
384 }
385
386 WLog_Print(serial->log, WLOG_DEBUG, "%" PRIu32 " bytes written to %s", nbWritten,
387 serial->device.name);
388 Stream_Write_UINT32(irp->output, nbWritten); /* Length (4 bytes) */
389 Stream_Write_UINT8(irp->output, 0); /* Padding (1 byte) */
390 return CHANNEL_RC_OK;
391}
392
398WINPR_ATTR_NODISCARD
399static UINT serial_process_irp_device_control(SERIAL_DEVICE* serial, IRP* irp)
400{
401 DWORD BytesReturned = 0;
402
403 WINPR_ASSERT(serial);
404 WINPR_ASSERT(irp);
405
406 if (!Stream_CheckAndLogRequiredLengthWLog(serial->log, irp->input, 32))
407 return ERROR_INVALID_DATA;
408
409 const UINT32 OutputBufferLength =
410 Stream_Get_UINT32(irp->input); /* OutputBufferLength (4 bytes) */
411 const UINT32 InputBufferLength =
412 Stream_Get_UINT32(irp->input); /* InputBufferLength (4 bytes) */
413 const UINT32 IoControlCode = Stream_Get_UINT32(irp->input); /* IoControlCode (4 bytes) */
414 Stream_Seek(irp->input, 20); /* Padding (20 bytes) */
415
416 if (!Stream_CheckAndLogRequiredLengthWLog(serial->log, irp->input, InputBufferLength))
417 return ERROR_INVALID_DATA;
418
419 if (!serial->hComm)
420 {
421 WLog_Print(serial->log, WLOG_ERROR,
422 "serial device %s is not open, aborting device IO control", serial->device.name);
423 return ERROR_INVALID_DATA;
424 }
425
426 const BYTE* InputBuffer = Stream_PointerAs(irp->input, BYTE);
427 if (!Stream_SafeSeek(irp->input, InputBufferLength))
428 return ERROR_INVALID_DATA;
429
430 WLog_Print(serial->log, WLOG_DEBUG,
431 "CommDeviceIoControl: CompletionId=%" PRIu32 ", IoControlCode=[0x%" PRIX32 "] %s",
432 irp->CompletionId, IoControlCode, _comm_serial_ioctl_name(IoControlCode));
433
434 BYTE* OutputBuffer = nullptr;
435 if (OutputBufferLength > 0)
436 {
437 OutputBuffer = (BYTE*)calloc(OutputBufferLength, sizeof(BYTE));
438 if (!OutputBuffer)
439 {
440 irp->IoStatus = STATUS_NO_MEMORY;
441 goto error_handle;
442 }
443 }
444
445 /* FIXME: CommDeviceIoControl to be replaced by DeviceIoControl() */
446 if (CommDeviceIoControl(serial->hComm, IoControlCode, InputBuffer, InputBufferLength,
447 OutputBuffer, OutputBufferLength, &BytesReturned, nullptr))
448 {
449 /* WLog_Print(serial->log, WLOG_DEBUG, "CommDeviceIoControl: CompletionId=%"PRIu32",
450 * IoControlCode=[0x%"PRIX32"] %s done", irp->CompletionId, IoControlCode,
451 * _comm_serial_ioctl_name(IoControlCode)); */
452 irp->IoStatus = STATUS_SUCCESS;
453 }
454 else
455 {
456 WLog_Print(serial->log, WLOG_DEBUG,
457 "CommDeviceIoControl failure: IoControlCode=[0x%" PRIX32
458 "] %s, last-error: 0x%08" PRIX32 "",
459 IoControlCode, _comm_serial_ioctl_name(IoControlCode), GetLastError());
460 irp->IoStatus = GetLastErrorToIoStatus(serial);
461 }
462
463error_handle:
464 Stream_Write_UINT32(irp->output, BytesReturned); /* OutputBufferLength (4 bytes) */
465
466 if (BytesReturned > 0)
467 {
468 if (!Stream_EnsureRemainingCapacity(irp->output, BytesReturned))
469 {
470 WLog_Print(serial->log, WLOG_ERROR, "Stream_EnsureRemainingCapacity failed!");
471 free(OutputBuffer);
472 return CHANNEL_RC_NO_MEMORY;
473 }
474
475 Stream_Write(irp->output, OutputBuffer, BytesReturned); /* OutputBuffer */
476 }
477
478 /* FIXME: Why at least Windows 2008R2 gets lost with this
479 * extra byte and likely on a IOCTL_SERIAL_SET_BAUD_RATE? The
480 * extra byte is well required according MS-RDPEFS
481 * 2.2.1.5.5 */
482 /* else */
483 /* { */
484 /* Stream_Write_UINT8(irp->output, 0); /\* Padding (1 byte) *\/ */
485 /* } */
486 free(OutputBuffer);
487 return CHANNEL_RC_OK;
488}
489
495static UINT serial_process_irp(SERIAL_DEVICE* serial, IRP* irp)
496{
497 UINT error = CHANNEL_RC_OK;
498
499 WINPR_ASSERT(serial);
500 WINPR_ASSERT(irp);
501
502 WLog_Print(serial->log, WLOG_DEBUG, "IRP MajorFunction: %s, MinorFunction: 0x%08" PRIX32 "\n",
503 rdpdr_irp_string(irp->MajorFunction), irp->MinorFunction);
504
505 switch (irp->MajorFunction)
506 {
507 case IRP_MJ_CREATE:
508 error = serial_process_irp_create(serial, irp);
509 break;
510
511 case IRP_MJ_CLOSE:
512 error = serial_process_irp_close(serial, irp);
513 break;
514
515 case IRP_MJ_READ:
516 error = serial_process_irp_read(serial, irp);
517 break;
518
519 case IRP_MJ_WRITE:
520 error = serial_process_irp_write(serial, irp);
521 break;
522
523 case IRP_MJ_DEVICE_CONTROL:
524 error = serial_process_irp_device_control(serial, irp);
525 break;
526
527 default:
528 irp->IoStatus = STATUS_NOT_SUPPORTED;
529 break;
530 }
531
532 DWORD level = WLOG_TRACE;
533 if (error)
534 level = WLOG_WARN;
535
536 WLog_Print(serial->log, level,
537 "[%s|0x%08" PRIx32 "] completed with %s [0x%08" PRIx32 "] (IoStatus %s [0x%08" PRIx32
538 "])",
539 rdpdr_irp_string(irp->MajorFunction), irp->MajorFunction, WTSErrorToString(error),
540 error, NtStatus2Tag(irp->IoStatus), WINPR_CXX_COMPAT_CAST(UINT32, irp->IoStatus));
541
542 return error;
543}
544
545static DWORD WINAPI irp_thread_func(LPVOID arg)
546{
547 IRP_THREAD_DATA* data = (IRP_THREAD_DATA*)arg;
548
549 WINPR_ASSERT(data);
550 WINPR_ASSERT(data->serial);
551 WINPR_ASSERT(data->irp);
552
553 /* blocks until the end of the request */
554 UINT error = serial_process_irp(data->serial, data->irp);
555 if (error)
556 {
557 WLog_Print(data->serial->log, WLOG_ERROR,
558 "serial_process_irp failed with error %" PRIu32 "", error);
559 data->irp->Discard(data->irp);
560 goto error_out;
561 }
562
563 EnterCriticalSection(&data->serial->TerminatingIrpThreadsLock);
564 WINPR_ASSERT(data->irp->Complete);
565 error = data->irp->Complete(data->irp);
566 LeaveCriticalSection(&data->serial->TerminatingIrpThreadsLock);
567error_out:
568
569 if (error && data->serial->rdpcontext)
570 setChannelError(data->serial->rdpcontext, error, "irp_thread_func reported an error");
571
572 /* NB: At this point, the server might already being reusing
573 * the CompletionId whereas the thread is not yet
574 * terminated */
575 free(data);
576 ExitThread(error);
577 return error;
578}
579
580static void close_unterminated_irp_thread(wListDictionary* list, wLog* log, ULONG_PTR id)
581{
582 WINPR_ASSERT(list);
583 HANDLE self = _GetCurrentThread();
584 HANDLE cirpThread = ListDictionary_GetItemValue(list, (void*)id);
585 if (self == cirpThread)
586 WLog_Print(log, WLOG_DEBUG, "Skipping termination of own IRP thread");
587 else
588 ListDictionary_Remove(list, (void*)id);
589}
590
591static void close_terminated_irp_thread(wListDictionary* list, wLog* log, ULONG_PTR id)
592{
593 WINPR_ASSERT(list);
594
595 HANDLE cirpThread = ListDictionary_GetItemValue(list, (void*)id);
596 /* FIXME: not quite sure a zero timeout is a good thing to check whether a thread is
597 * still alive or not */
598 const DWORD waitResult = WaitForSingleObject(cirpThread, 0);
599
600 if (waitResult == WAIT_OBJECT_0)
601 ListDictionary_Remove(list, (void*)id);
602 else if (waitResult != WAIT_TIMEOUT)
603 {
604 /* unexpected thread state */
605 WLog_Print(log, WLOG_WARN, "WaitForSingleObject, got an unexpected result=0x%" PRIX32 "\n",
606 waitResult);
607 }
608}
609
610void close_terminated_irp_thread_handles(SERIAL_DEVICE* serial, BOOL forceClose)
611{
612 WINPR_ASSERT(serial);
613
614 EnterCriticalSection(&serial->TerminatingIrpThreadsLock);
615
616 ListDictionary_Lock(serial->IrpThreads);
617 ULONG_PTR* ids = nullptr;
618 const size_t nbIds = ListDictionary_GetKeys(serial->IrpThreads, &ids);
619
620 for (size_t i = 0; i < nbIds; i++)
621 {
622 ULONG_PTR id = ids[i];
623 if (forceClose)
624 close_unterminated_irp_thread(serial->IrpThreads, serial->log, id);
625 else
626 close_terminated_irp_thread(serial->IrpThreads, serial->log, id);
627 }
628
629 free(ids);
630 ListDictionary_Unlock(serial->IrpThreads);
631
632 LeaveCriticalSection(&serial->TerminatingIrpThreadsLock);
633}
634
635static void create_irp_thread(SERIAL_DEVICE* serial, IRP* irp)
636{
637 IRP_THREAD_DATA* data = nullptr;
638 HANDLE irpThread = nullptr;
639 HANDLE previousIrpThread = nullptr;
640 uintptr_t key = 0;
641
642 WINPR_ASSERT(serial);
643 WINPR_ASSERT(irp);
644
645 close_terminated_irp_thread_handles(serial, FALSE);
646
647 /* NB: At this point and thanks to the synchronization we're
648 * sure that the incoming IRP uses well a recycled
649 * CompletionId or the server sent again an IRP already posted
650 * which didn't get yet a response (this later server behavior
651 * at least observed with IOCTL_SERIAL_WAIT_ON_MASK and
652 * mstsc.exe).
653 *
654 * FIXME: behavior documented somewhere? behavior not yet
655 * observed with FreeRDP).
656 */
657 key = irp->CompletionId + 1ull;
658
659 ListDictionary_Lock(serial->IrpThreads);
660 previousIrpThread = ListDictionary_GetItemValue(serial->IrpThreads, (void*)key);
661 ListDictionary_Unlock(serial->IrpThreads);
662
663 if (previousIrpThread)
664 {
665 /* Thread still alived <=> Request still pending */
666 WLog_Print(serial->log, WLOG_DEBUG,
667 "IRP recall: IRP with the CompletionId=%" PRIu32 " not yet completed!",
668 irp->CompletionId);
669 WINPR_ASSERT(FALSE); /* unimplemented */
670 /* TODO: WINPR_ASSERTs that previousIrpThread handles well
671 * the same request by checking more details. Need an
672 * access to the IRP object used by previousIrpThread
673 */
674 /* TODO: taking over the pending IRP or sending a kind
675 * of wake up signal to accelerate the pending
676 * request
677 *
678 * To be considered:
679 * if (IoControlCode == IOCTL_SERIAL_WAIT_ON_MASK) {
680 * pComm->PendingEvents |= SERIAL_EV_FREERDP_*;
681 * }
682 */
683 irp->Discard(irp);
684 return;
685 }
686
687 /* error_handle to be used ... */
688 data = (IRP_THREAD_DATA*)calloc(1, sizeof(IRP_THREAD_DATA));
689
690 if (data == nullptr)
691 {
692 WLog_Print(serial->log, WLOG_WARN, "Could not allocate a new IRP_THREAD_DATA.");
693 goto error_handle;
694 }
695
696 data->serial = serial;
697 data->irp = irp;
698 /* data freed by irp_thread_func */
699 irpThread = CreateThread(nullptr, 0, irp_thread_func, (void*)data, CREATE_SUSPENDED, nullptr);
700
701 if (irpThread == INVALID_HANDLE_VALUE)
702 {
703 WLog_Print(serial->log, WLOG_WARN, "Could not allocate a new IRP thread.");
704 goto error_handle;
705 }
706
707 key = irp->CompletionId + 1ull;
708
709 ListDictionary_Lock(serial->IrpThreads);
710 if (ListDictionary_Count(serial->IrpThreads) >= MAX_IRP_THREADS)
711 {
712 WLog_Print(serial->log, WLOG_WARN,
713 "Number of IRP threads threshold reached: %" PRIuz ", keep on anyway",
714 ListDictionary_Count(serial->IrpThreads));
715 WINPR_ASSERT(FALSE); /* unimplemented */
716 /* TODO: MAX_IRP_THREADS has been thought to avoid a
717 * flooding of pending requests. Use
718 * WaitForMultipleObjects() when available in winpr
719 * for threads.
720 */
721 }
722
723 {
724 const BOOL added = ListDictionary_Add(serial->IrpThreads, (void*)key, irpThread);
725 ListDictionary_Unlock(serial->IrpThreads);
726
727 if (!added)
728 {
729 WLog_Print(serial->log, WLOG_ERROR, "ListDictionary_Add failed!");
730 goto error_handle;
731 }
732 }
733
734 ResumeThread(irpThread);
735
736 return;
737error_handle:
738 if (irpThread)
739 (void)CloseHandle(irpThread);
740 irp->IoStatus = STATUS_NO_MEMORY;
741 WINPR_ASSERT(irp->Complete);
742 const UINT rc = irp->Complete(irp);
743 if (rc != CHANNEL_RC_OK)
744 WLog_Print(serial->log, WLOG_WARN, "irp->Complete failed with %" PRIu32, rc);
745 free(data);
746}
747
748static DWORD WINAPI serial_thread_func(LPVOID arg)
749{
750 IRP* irp = nullptr;
751 wMessage message = WINPR_C_ARRAY_INIT;
752 SERIAL_DEVICE* serial = (SERIAL_DEVICE*)arg;
753 UINT error = CHANNEL_RC_OK;
754
755 WINPR_ASSERT(serial);
756
757 while (1)
758 {
759 if (!MessageQueue_Wait(serial->MainIrpQueue))
760 {
761 WLog_Print(serial->log, WLOG_ERROR, "MessageQueue_Wait failed!");
762 error = ERROR_INTERNAL_ERROR;
763 break;
764 }
765
766 if (!MessageQueue_Peek(serial->MainIrpQueue, &message, TRUE))
767 {
768 WLog_Print(serial->log, WLOG_ERROR, "MessageQueue_Peek failed!");
769 error = ERROR_INTERNAL_ERROR;
770 break;
771 }
772
773 if (message.id == WMQ_QUIT)
774 break;
775
776 irp = (IRP*)message.wParam;
777
778 if (irp)
779 create_irp_thread(serial, irp);
780 }
781
782 ListDictionary_Lock(serial->IrpThreads);
783 ListDictionary_Clear(serial->IrpThreads);
784 ListDictionary_Unlock(serial->IrpThreads);
785
786 if (error && serial->rdpcontext)
787 setChannelError(serial->rdpcontext, error, "serial_thread_func reported an error");
788
789 ExitThread(error);
790 return error;
791}
792
798static UINT serial_irp_request(DEVICE* device, IRP* irp)
799{
800 SERIAL_DEVICE* serial = (SERIAL_DEVICE*)device;
801 WINPR_ASSERT(irp != nullptr);
802 WINPR_ASSERT(serial);
803
804 /* NB: ENABLE_ASYNCIO is set, (MS-RDPEFS 2.2.2.7.2) this
805 * allows the server to send multiple simultaneous read or
806 * write requests.
807 */
808
809 if (!MessageQueue_Post(serial->MainIrpQueue, nullptr, 0, (void*)irp, nullptr))
810 {
811 WLog_Print(serial->log, WLOG_ERROR, "MessageQueue_Post failed!");
812 irp->Discard(irp);
813 return ERROR_INTERNAL_ERROR;
814 }
815
816 return CHANNEL_RC_OK;
817}
818
824static UINT serial_free(DEVICE* device)
825{
826 UINT error = 0;
827 SERIAL_DEVICE* serial = (SERIAL_DEVICE*)device;
828 if (!serial)
829 return CHANNEL_RC_OK;
830
831 WLog_Print(serial->log, WLOG_DEBUG, "freeing");
832 if (serial->MainIrpQueue)
833 MessageQueue_PostQuit(serial->MainIrpQueue, 0);
834
835 if (serial->MainThread)
836 {
837 if (WaitForSingleObject(serial->MainThread, INFINITE) == WAIT_FAILED)
838 {
839 error = GetLastError();
840 WLog_Print(serial->log, WLOG_ERROR,
841 "WaitForSingleObject failed with error %" PRIu32 "!", error);
842 }
843 (void)CloseHandle(serial->MainThread);
844 }
845
846 if (serial->hComm)
847 (void)CloseHandle(serial->hComm);
848
849 /* Clean up resources */
850 Stream_Free(serial->device.data, TRUE);
851 MessageQueue_Free(serial->MainIrpQueue);
852 ListDictionary_Free(serial->IrpThreads);
853 DeleteCriticalSection(&serial->TerminatingIrpThreadsLock);
854 free(serial);
855 return CHANNEL_RC_OK;
856}
857
858static void serial_message_free(void* obj)
859{
860 wMessage* msg = obj;
861 if (!msg)
862 return;
863 if (msg->id != 0)
864 return;
865
866 IRP* irp = (IRP*)msg->wParam;
867 if (!irp)
868 return;
869 WINPR_ASSERT(irp->Discard);
870 irp->Discard(irp);
871}
872
873static void irp_thread_close(void* arg)
874{
875 HANDLE hdl = arg;
876 if (hdl)
877 {
878 HANDLE thz = _GetCurrentThread();
879 if (thz == hdl)
880 WLog_WARN(TAG, "closing self, ignoring...");
881 else
882 {
883 (void)TerminateThread(hdl, 0);
884 (void)WaitForSingleObject(hdl, INFINITE);
885 (void)CloseHandle(hdl);
886 }
887 }
888}
889
895FREERDP_ENTRY_POINT(
896 UINT VCAPITYPE serial_DeviceServiceEntry(PDEVICE_SERVICE_ENTRY_POINTS pEntryPoints))
897{
898 size_t len = 0;
899 SERIAL_DEVICE* serial = nullptr;
900 UINT error = CHANNEL_RC_OK;
901
902 WINPR_ASSERT(pEntryPoints);
903
904 RDPDR_SERIAL* device = (RDPDR_SERIAL*)pEntryPoints->device;
905 WINPR_ASSERT(device);
906
907 wLog* log = WLog_Get(TAG);
908 const char* name = device->device.Name;
909 const char* path = device->Path;
910 const char* driver = device->Driver;
911
912 if (!name || (name[0] == '*'))
913 {
914 /* TODO: implement auto detection of serial ports */
915 WLog_Print(log, WLOG_WARN,
916 "Serial port autodetection not implemented, nothing will be redirected!");
917 return CHANNEL_RC_OK;
918 }
919
920 if ((name && name[0]) && (path && path[0]))
921 {
922 WLog_Print(log, WLOG_DEBUG, "Defining %s as %s", name, path);
923
924 if (!DefineCommDevice(name /* eg: COM1 */, path /* eg: /dev/ttyS0 */))
925 {
926 DWORD status = GetLastError();
927 WLog_Print(log, WLOG_ERROR, "DefineCommDevice failed with %08" PRIx32, status);
928 return ERROR_INTERNAL_ERROR;
929 }
930
931 serial = (SERIAL_DEVICE*)calloc(1, sizeof(SERIAL_DEVICE));
932
933 if (!serial)
934 {
935 WLog_Print(log, WLOG_ERROR, "calloc failed!");
936 return CHANNEL_RC_NO_MEMORY;
937 }
938
939 serial->log = log;
940 serial->device.type = RDPDR_DTYP_SERIAL;
941 serial->device.name = name;
942 serial->device.IRPRequest = serial_irp_request;
943 serial->device.Free = serial_free;
944 serial->rdpcontext = pEntryPoints->rdpcontext;
945 len = strlen(name);
946 serial->device.data = Stream_New(nullptr, len + 1);
947
948 if (!serial->device.data)
949 {
950 WLog_Print(serial->log, WLOG_ERROR, "calloc failed!");
951 error = CHANNEL_RC_NO_MEMORY;
952 goto error_out;
953 }
954
955 for (size_t i = 0; i <= len; i++)
956 Stream_Write_INT8(serial->device.data, name[i] < 0 ? '_' : name[i]);
957
958 if (driver != nullptr)
959 {
960 if (_stricmp(driver, "Serial") == 0)
961 serial->ServerSerialDriverId = SerialDriverSerialSys;
962 else if (_stricmp(driver, "SerCx") == 0)
963 serial->ServerSerialDriverId = SerialDriverSerCxSys;
964 else if (_stricmp(driver, "SerCx2") == 0)
965 serial->ServerSerialDriverId = SerialDriverSerCx2Sys;
966 else
967 {
968 WLog_Print(serial->log, WLOG_WARN, "Unknown server's serial driver: %s.", driver);
969 WLog_Print(serial->log, WLOG_WARN,
970 "Valid options are: 'Serial' (default), 'SerCx' and 'SerCx2'");
971 goto error_out;
972 }
973 }
974 else
975 {
976 /* default driver */
977 serial->ServerSerialDriverId = SerialDriverSerialSys;
978 }
979
980 if (device->Permissive != nullptr)
981 {
982 if (_stricmp(device->Permissive, "permissive") == 0)
983 {
984 serial->permissive = TRUE;
985 }
986 else
987 {
988 WLog_Print(serial->log, WLOG_WARN, "Unknown flag: %s", device->Permissive);
989 goto error_out;
990 }
991 }
992
993 WLog_Print(serial->log, WLOG_DEBUG, "Server's serial driver: %s (id: %u)", driver,
994 serial->ServerSerialDriverId);
995
996 serial->MainIrpQueue = MessageQueue_New(nullptr);
997
998 if (!serial->MainIrpQueue)
999 {
1000 WLog_Print(serial->log, WLOG_ERROR, "MessageQueue_New failed!");
1001 error = CHANNEL_RC_NO_MEMORY;
1002 goto error_out;
1003 }
1004
1005 {
1006 wObject* obj = MessageQueue_Object(serial->MainIrpQueue);
1007 WINPR_ASSERT(obj);
1008 obj->fnObjectFree = serial_message_free;
1009 }
1010
1011 /* IrpThreads content only modified by create_irp_thread() */
1012 serial->IrpThreads = ListDictionary_New(FALSE);
1013
1014 if (!serial->IrpThreads)
1015 {
1016 WLog_Print(serial->log, WLOG_ERROR, "ListDictionary_New failed!");
1017 error = CHANNEL_RC_NO_MEMORY;
1018 goto error_out;
1019 }
1020
1021 {
1022 wObject* obj = ListDictionary_ValueObject(serial->IrpThreads);
1023 WINPR_ASSERT(obj);
1024 obj->fnObjectFree = irp_thread_close;
1025 }
1026
1027 InitializeCriticalSection(&serial->TerminatingIrpThreadsLock);
1028
1029 error = pEntryPoints->RegisterDevice(pEntryPoints->devman, &serial->device);
1030 if (error != CHANNEL_RC_OK)
1031 {
1032 WLog_Print(serial->log, WLOG_ERROR,
1033 "EntryPoints->RegisterDevice failed with error %" PRIu32 "!", error);
1034 goto error_out;
1035 }
1036
1037 serial->MainThread = CreateThread(nullptr, 0, serial_thread_func, serial, 0, nullptr);
1038 if (!serial->MainThread)
1039 {
1040 WLog_Print(serial->log, WLOG_ERROR, "CreateThread failed!");
1041 error = ERROR_INTERNAL_ERROR;
1042 goto error_out;
1043 }
1044 }
1045
1046 return error;
1047error_out:
1048 if (serial)
1049 serial_free(&serial->device);
1050 return error;
1051}
RDPDR_SERIAL
Definition settings_types.h:493
DEVICE_SERVICE_ENTRY_POINTS
Definition channels/rdpdr.h:381
RTL_CRITICAL_SECTION
Definition include/winpr/synch.h:160
wObject
This struct contains function pointer to initialize/free objects.
Definition collections.h:52
wObject::fnObjectFree
OBJECT_FREE_FN fnObjectFree
Definition collections.h:59