22#include <freerdp/config.h>
26#include <winpr/assert.h>
28#include <freerdp/log.h>
29#include <freerdp/channels/drdynvc.h>
34#define TAG FREERDP_TAG("core.client")
38 freerdp_channel_handle_fkt_t fkt;
45static WINPR_TLS freerdp* g_Instance =
nullptr;
48static volatile LONG g_OpenHandleSeq = 1;
51static INIT_ONCE g_ChannelHandlesOnce = INIT_ONCE_STATIC_INIT;
52static wHashTable* g_ChannelHandles =
nullptr;
54static BOOL freerdp_channels_process_message_free(wMessage* message, DWORD type);
56static CHANNEL_OPEN_DATA* freerdp_channels_find_channel_open_data_by_name(rdpChannels* channels,
59 for (
int index = 0; index < channels->openDataCount; index++)
63 if (strncmp(name, pChannelOpenData->name, CHANNEL_NAME_LEN + 1) == 0)
64 return pChannelOpenData;
71static rdpMcsChannel* freerdp_channels_find_channel_by_name(rdpRdp* rdp,
const char* name)
73 rdpMcs* mcs =
nullptr;
80 for (UINT32 index = 0; index < mcs->channelCount; index++)
82 rdpMcsChannel* channel = &mcs->channels[index];
84 if (strncmp(name, channel->Name, CHANNEL_NAME_LEN + 1) == 0)
93static rdpMcsChannel* freerdp_channels_find_channel_by_id(rdpRdp* rdp, UINT16 channel_id)
95 rdpMcsChannel* channel =
nullptr;
96 rdpMcs* mcs =
nullptr;
103 for (UINT32 index = 0; index < mcs->channelCount; index++)
105 channel = &mcs->channels[index];
107 if (channel->ChannelId == channel_id)
116static void channel_queue_message_free(wMessage* msg)
120 if (!msg || (msg->id != 0))
127static void channel_queue_free(
void* obj)
129 wMessage* msg = (wMessage*)obj;
130 freerdp_channels_process_message_free(msg, CHANNEL_EVENT_WRITE_CANCELLED);
131 channel_queue_message_free(msg);
134static BOOL CALLBACK init_channel_handles_table(WINPR_ATTR_UNUSED
PINIT_ONCE once,
135 WINPR_ATTR_UNUSED PVOID param,
136 WINPR_ATTR_UNUSED PVOID* context)
138 g_ChannelHandles = HashTable_New(TRUE);
142static void* channel_event_entry_clone(
const void* data)
144 const ChannelEventEntry* entry = data;
148 ChannelEventEntry* copy = calloc(1,
sizeof(ChannelEventEntry));
155rdpChannels* freerdp_channels_new(freerdp* instance)
157 if (!InitOnceExecuteOnce(&g_ChannelHandlesOnce, init_channel_handles_table,
nullptr,
nullptr))
161 rdpChannels* channels =
nullptr;
162 channels = (rdpChannels*)calloc(1,
sizeof(rdpChannels));
167 if (!g_ChannelHandles)
169 if (!InitializeCriticalSectionAndSpinCount(&channels->channelsLock, 4000))
172 channels->instance = instance;
173 channels->queue = MessageQueue_New(
nullptr);
175 if (!channels->queue)
178 obj = MessageQueue_Object(channels->queue);
181 channels->channelEvents = HashTable_New(FALSE);
182 if (!channels->channelEvents)
185 obj = HashTable_ValueObject(channels->channelEvents);
191 WINPR_PRAGMA_DIAG_PUSH
192 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
193 freerdp_channels_free(channels);
194 WINPR_PRAGMA_DIAG_POP
198void freerdp_channels_free(rdpChannels* channels)
203 HashTable_Free(channels->channelEvents);
205 DeleteCriticalSection(&channels->channelsLock);
209 MessageQueue_Free(channels->queue);
210 channels->queue =
nullptr;
221static UINT freerdp_drdynvc_on_channel_connected(DrdynvcClientContext* context,
const char* name,
224 UINT status = CHANNEL_RC_OK;
225 ChannelConnectedEventArgs e = WINPR_C_ARRAY_INIT;
227 WINPR_ASSERT(context);
229 rdpChannels* channels = (rdpChannels*)context->custom;
230 WINPR_ASSERT(channels);
232 freerdp* instance = channels->instance;
233 WINPR_ASSERT(instance);
234 WINPR_ASSERT(instance->context);
236 EventArgsInit(&e,
"freerdp");
238 e.pInterface = pInterface;
239 if (PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e) < 0)
240 return ERROR_INTERNAL_ERROR;
249static UINT freerdp_drdynvc_on_channel_disconnected(DrdynvcClientContext* context,
const char* name,
252 UINT status = CHANNEL_RC_OK;
253 ChannelDisconnectedEventArgs e = WINPR_C_ARRAY_INIT;
255 WINPR_ASSERT(context);
256 rdpChannels* channels = (rdpChannels*)context->custom;
257 WINPR_ASSERT(channels);
259 freerdp* instance = channels->instance;
260 WINPR_ASSERT(instance);
261 WINPR_ASSERT(instance->context);
263 EventArgsInit(&e,
"freerdp");
265 e.pInterface = pInterface;
266 if (PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e) < 0)
267 return ERROR_INTERNAL_ERROR;
271static UINT freerdp_drdynvc_on_channel_attached(DrdynvcClientContext* context,
const char* name,
274 UINT status = CHANNEL_RC_OK;
275 ChannelAttachedEventArgs e = WINPR_C_ARRAY_INIT;
277 WINPR_ASSERT(context);
278 rdpChannels* channels = (rdpChannels*)context->custom;
279 WINPR_ASSERT(channels);
281 freerdp* instance = channels->instance;
282 WINPR_ASSERT(instance);
283 WINPR_ASSERT(instance->context);
285 EventArgsInit(&e,
"freerdp");
287 e.pInterface = pInterface;
288 if (PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e) < 0)
289 return ERROR_INTERNAL_ERROR;
293static UINT freerdp_drdynvc_on_channel_detached(DrdynvcClientContext* context,
const char* name,
296 UINT status = CHANNEL_RC_OK;
297 ChannelDetachedEventArgs e = WINPR_C_ARRAY_INIT;
299 WINPR_ASSERT(context);
300 rdpChannels* channels = (rdpChannels*)context->custom;
301 WINPR_ASSERT(channels);
303 freerdp* instance = channels->instance;
304 WINPR_ASSERT(instance);
305 WINPR_ASSERT(instance->context);
307 EventArgsInit(&e,
"freerdp");
309 e.pInterface = pInterface;
310 if (PubSub_OnChannelDetached(instance->context->pubSub, instance->context, &e) < 0)
311 return ERROR_INTERNAL_ERROR;
315void freerdp_channels_register_instance(WINPR_ATTR_UNUSED rdpChannels* channels, freerdp* instance)
318 g_Instance = instance;
325UINT freerdp_channels_pre_connect(rdpChannels* channels, freerdp* instance)
327 UINT error = CHANNEL_RC_OK;
329 MessageQueue_Clear(channels->queue);
331 for (
int index = 0; index < channels->clientDataCount; index++)
335 if (pChannelClientData->pChannelInitEventProc)
337 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
338 CHANNEL_EVENT_INITIALIZED,
nullptr, 0);
340 else if (pChannelClientData->pChannelInitEventProcEx)
342 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
343 pChannelClientData->pInitHandle,
344 CHANNEL_EVENT_INITIALIZED,
nullptr, 0);
347 error = getChannelError(instance->context);
348 if (CHANNEL_RC_OK != error)
353 ChannelInitializedEventArgs e = WINPR_C_ARRAY_INIT;
354 EventArgsInit(&e,
"freerdp");
355 e.name = pChannelOpenData->name;
356 e.pInterface = pChannelInitData->pInterface;
357 if (PubSub_OnChannelInitialized(instance->context->pubSub, instance->context, &e) < 0)
359 error = ERROR_INTERNAL_ERROR;
367UINT freerdp_channels_attach(freerdp* instance)
369 UINT error = CHANNEL_RC_OK;
370 const char* hostname =
nullptr;
371 size_t hostnameLength = 0;
372 rdpChannels* channels =
nullptr;
375 WINPR_ASSERT(instance);
376 WINPR_ASSERT(instance->context);
377 WINPR_ASSERT(instance->context->settings);
379 channels = instance->context->channels;
381 WINPR_ASSERT(hostname);
382 hostnameLength = strnlen(hostname, MAX_PATH);
384 for (
int index = 0; index < channels->clientDataCount; index++)
391 ChannelAttachedEventArgs e = WINPR_C_ARRAY_INIT;
394 pChannelClientData = &channels->clientDataList[index];
396 if (pChannelClientData->pChannelInitEventProc)
399 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
400 CHANNEL_EVENT_ATTACHED, cnv.pv,
401 (UINT)hostnameLength);
403 else if (pChannelClientData->pChannelInitEventProcEx)
405 pChannelClientData->pChannelInitEventProcEx(
406 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
407 CHANNEL_EVENT_ATTACHED, cnv.pv, (UINT)hostnameLength);
410 error = getChannelError(instance->context);
411 if (error != CHANNEL_RC_OK)
415 EventArgsInit(&e,
"freerdp");
416 e.name = pChannelOpenData->name;
417 e.pInterface = pChannelOpenData->pInterface;
418 if (PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e) < 0)
420 error = ERROR_INTERNAL_ERROR;
429UINT freerdp_channels_detach(freerdp* instance)
431 UINT error = CHANNEL_RC_OK;
432 const char* hostname =
nullptr;
433 size_t hostnameLength = 0;
434 rdpChannels* channels =
nullptr;
435 rdpContext* context =
nullptr;
438 WINPR_ASSERT(instance);
440 context = instance->context;
441 WINPR_ASSERT(context);
443 channels = context->channels;
444 WINPR_ASSERT(channels);
446 WINPR_ASSERT(context->settings);
448 WINPR_ASSERT(hostname);
449 hostnameLength = strnlen(hostname, MAX_PATH);
451 for (
int index = 0; index < channels->clientDataCount; index++)
459 ChannelDetachedEventArgs e = WINPR_C_ARRAY_INIT;
462 pChannelClientData = &channels->clientDataList[index];
464 if (pChannelClientData->pChannelInitEventProc)
466 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
467 CHANNEL_EVENT_DETACHED, cnv.pv,
468 (UINT)hostnameLength);
470 else if (pChannelClientData->pChannelInitEventProcEx)
472 pChannelClientData->pChannelInitEventProcEx(
473 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
474 CHANNEL_EVENT_DETACHED, cnv.pv, (UINT)hostnameLength);
477 error = getChannelError(context);
478 if (error != CHANNEL_RC_OK)
482 EventArgsInit(&e,
"freerdp");
483 e.name = pChannelOpenData->name;
484 e.pInterface = pChannelOpenData->pInterface;
485 if (PubSub_OnChannelDetached(context->pubSub, context, &e) < 0)
487 error = ERROR_INTERNAL_ERROR;
501UINT freerdp_channels_post_connect(rdpChannels* channels, freerdp* instance)
503 UINT error = CHANNEL_RC_OK;
505 WINPR_ASSERT(channels);
506 WINPR_ASSERT(instance);
507 WINPR_ASSERT(instance->context);
508 WINPR_ASSERT(instance->context->settings);
510 channels->connected = TRUE;
511 const char* hostname =
513 WINPR_ASSERT(hostname);
514 const size_t hostnameLength = strnlen(hostname, MAX_PATH);
516 for (
int index = 0; index < channels->clientDataCount; index++)
528 if (pChannelClientData->pChannelInitEventProc)
530 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
531 CHANNEL_EVENT_CONNECTED, cnv.pb,
532 (UINT)hostnameLength);
534 else if (pChannelClientData->pChannelInitEventProcEx)
536 pChannelClientData->pChannelInitEventProcEx(
537 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
538 CHANNEL_EVENT_CONNECTED, cnv.pb, (UINT)hostnameLength);
541 error = getChannelError(instance->context);
542 if (error != CHANNEL_RC_OK)
545 ChannelConnectedEventArgs e = WINPR_C_ARRAY_INIT;
546 EventArgsInit(&e,
"freerdp");
547 e.name = pChannelOpenData->name;
548 e.pInterface = pChannelOpenData->pInterface;
549 if (PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e) < 0)
551 error = ERROR_INTERNAL_ERROR;
556 channels->drdynvc = (DrdynvcClientContext*)freerdp_channels_get_static_channel_interface(
557 channels, DRDYNVC_SVC_CHANNEL_NAME);
559 if (channels->drdynvc)
561 channels->drdynvc->custom = (
void*)channels;
562 channels->drdynvc->OnChannelConnected = freerdp_drdynvc_on_channel_connected;
563 channels->drdynvc->OnChannelDisconnected = freerdp_drdynvc_on_channel_disconnected;
564 channels->drdynvc->OnChannelAttached = freerdp_drdynvc_on_channel_attached;
565 channels->drdynvc->OnChannelDetached = freerdp_drdynvc_on_channel_detached;
572BOOL freerdp_channels_data(freerdp* instance, UINT16 channelId,
const BYTE* cdata,
size_t dataSize,
573 UINT32 flags,
size_t totalSize)
575 rdpMcs* mcs =
nullptr;
576 rdpChannels* channels =
nullptr;
577 rdpMcsChannel* channel =
nullptr;
586 if (!instance || !data.pcb)
588 WLog_ERR(TAG,
"(%p, %" PRIu16
", %p, 0x%08x): Invalid arguments",
589 WINPR_CXX_COMPAT_CAST(
const void*, instance), channelId,
590 WINPR_CXX_COMPAT_CAST(
const void*, data.pcb), flags);
594 mcs = instance->context->rdp->mcs;
595 channels = instance->context->channels;
597 if (!channels || !mcs)
602 for (UINT32 index = 0; index < mcs->channelCount; index++)
604 rdpMcsChannel* cur = &mcs->channels[index];
606 if (cur->ChannelId == channelId)
618 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, channel->Name);
620 if (!pChannelOpenData)
625 if (pChannelOpenData->pChannelOpenEventProc)
627 pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->OpenHandle,
628 CHANNEL_EVENT_DATA_RECEIVED, data.pb,
629 (UINT32)dataSize, (UINT32)totalSize, flags);
631 else if (pChannelOpenData->pChannelOpenEventProcEx)
633 pChannelOpenData->pChannelOpenEventProcEx(
634 pChannelOpenData->lpUserParam, pChannelOpenData->OpenHandle,
635 CHANNEL_EVENT_DATA_RECEIVED, data.pb, (UINT32)dataSize, (UINT32)totalSize, flags);
641UINT16 freerdp_channels_get_id_by_name(freerdp* instance,
const char* channel_name)
643 if (!instance || !channel_name)
646 rdpMcsChannel* mcsChannel =
647 freerdp_channels_find_channel_by_name(instance->context->rdp, channel_name);
651 return mcsChannel->ChannelId;
654const char* freerdp_channels_get_name_by_id(freerdp* instance, UINT16 channelId)
656 rdpMcsChannel* mcsChannel =
nullptr;
660 mcsChannel = freerdp_channels_find_channel_by_id(instance->context->rdp, channelId);
664 return mcsChannel->Name;
667BOOL freerdp_channels_process_message_free(wMessage* message, DWORD type)
669 if (message->id == WMQ_QUIT)
674 if (message->id == 0)
682 pChannelOpenData = item->pChannelOpenData;
684 if (pChannelOpenData->pChannelOpenEventProc)
686 pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->OpenHandle, type,
687 item->UserData, item->DataLength,
688 item->DataLength, 0);
690 else if (pChannelOpenData->pChannelOpenEventProcEx)
692 pChannelOpenData->pChannelOpenEventProcEx(
693 pChannelOpenData->lpUserParam, pChannelOpenData->OpenHandle, type, item->UserData,
694 item->DataLength, item->DataLength, 0);
701static BOOL freerdp_channels_process_message(freerdp* instance, wMessage* message)
706 WINPR_ASSERT(instance);
707 WINPR_ASSERT(message);
709 if (message->id == WMQ_QUIT)
711 else if (message->id == 0)
713 rdpMcsChannel* channel =
nullptr;
720 pChannelOpenData = item->pChannelOpenData;
721 if (pChannelOpenData->flags != 2)
723 freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_CANCELLED);
727 freerdp_channels_find_channel_by_name(instance->context->rdp, pChannelOpenData->name);
730 ret = instance->SendChannelData(instance, channel->ChannelId, item->Data,
734 if (!freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_COMPLETE))
740 IFCALL(message->Free, message);
747static BOOL freerdp_channels_process_sync(rdpChannels* channels, freerdp* instance)
750 wMessage message = WINPR_C_ARRAY_INIT;
752 WINPR_ASSERT(channels);
754 while (MessageQueue_Peek(channels->queue, &message, TRUE))
756 if (!freerdp_channels_process_message(instance, &message))
766#if defined(WITH_FREERDP_DEPRECATED)
767BOOL freerdp_channels_get_fds(rdpChannels* channels, WINPR_ATTR_UNUSED freerdp* instance,
768 void** read_fds,
int* read_count, WINPR_ATTR_UNUSED
void** write_fds,
769 WINPR_ATTR_UNUSED
int* write_count)
772 pfd = GetEventWaitObject(MessageQueue_Event(channels->queue));
776 read_fds[*read_count] = pfd;
784void* freerdp_channels_get_static_channel_interface(rdpChannels* channels,
const char* name)
786 void* pInterface =
nullptr;
788 freerdp_channels_find_channel_open_data_by_name(channels, name);
790 if (pChannelOpenData)
791 pInterface = pChannelOpenData->pInterface;
796HANDLE freerdp_channels_get_event_handle(freerdp* instance)
799 return INVALID_HANDLE_VALUE;
801 WINPR_ASSERT(instance->context);
803 rdpChannels* channels = instance->context->channels;
804 WINPR_ASSERT(channels);
806 return MessageQueue_Event(channels->queue);
809static BOOL channels_process(
const void* key,
void* value,
void* arg)
811 ChannelEventEntry* entry = value;
812 rdpContext* context = arg;
818 return entry->fkt(context, entry->userdata);
821int freerdp_channels_process_pending_messages(freerdp* instance)
826 WINPR_ASSERT(instance->context);
828 rdpChannels* channels = instance->context->channels;
829 WINPR_ASSERT(channels);
831 const DWORD status = WaitForSingleObject(MessageQueue_Event(channels->queue), 0);
832 if (status == WAIT_OBJECT_0)
834 if (!freerdp_channels_process_sync(channels, instance))
838 if (!HashTable_Foreach(channels->channelEvents, channels_process, instance->context))
847BOOL freerdp_channels_check_fds(rdpChannels* channels, freerdp* instance)
849 WINPR_ASSERT(channels);
850 WINPR_UNUSED(channels);
852 const int rc = freerdp_channels_process_pending_messages(instance);
856BOOL freerdp_client_channel_register(rdpChannels* channels, HANDLE handle,
857 freerdp_channel_handle_fkt_t fkt,
void* userdata)
859 if (!channels || (handle == INVALID_HANDLE_VALUE) || !fkt)
861 WLog_ERR(TAG,
"Invalid function arguments (channels=%p, handle=%p, fkt=%p, userdata=%p",
862 WINPR_FUNC_PTR_CAST(channels,
const void*), handle,
863 WINPR_FUNC_PTR_CAST(fkt,
const void*), userdata);
867 ChannelEventEntry entry = { .fkt = fkt, .userdata = userdata };
868 return HashTable_Insert(channels->channelEvents, handle, &entry);
871BOOL freerdp_client_channel_unregister(rdpChannels* channels, HANDLE handle)
873 if (!channels || (handle == INVALID_HANDLE_VALUE))
875 WLog_ERR(TAG,
"Invalid function arguments (channels=%p, handle=%p",
876 WINPR_CXX_COMPAT_CAST(
const void*, channels), handle);
880 return HashTable_Remove(channels->channelEvents, handle);
883SSIZE_T freerdp_client_channel_get_registered_event_handles(rdpChannels* channels, HANDLE* events,
888 WINPR_ASSERT(channels);
889 WINPR_ASSERT(events || (count == 0));
891 HashTable_Lock(channels->channelEvents);
892 size_t len = HashTable_Count(channels->channelEvents);
895 ULONG_PTR* keys =
nullptr;
896 const size_t nrKeys = HashTable_GetKeys(channels->channelEvents, &keys);
897 if ((nrKeys <= SSIZE_MAX) && (nrKeys == len))
899 for (
size_t x = 0; x < nrKeys; x++)
901 HANDLE cur = (HANDLE)keys[x];
904 rc = (SSIZE_T)nrKeys;
908 HashTable_Unlock(channels->channelEvents);
912UINT freerdp_channels_disconnect(rdpChannels* channels, freerdp* instance)
914 UINT error = CHANNEL_RC_OK;
917 WINPR_ASSERT(channels);
919 if (!channels->connected)
922 freerdp_channels_check_fds(channels, instance);
925 for (
int index = 0; index < channels->clientDataCount; index++)
927 ChannelDisconnectedEventArgs e = WINPR_C_ARRAY_INIT;
928 pChannelClientData = &channels->clientDataList[index];
930 if (pChannelClientData->pChannelInitEventProc)
932 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
933 CHANNEL_EVENT_DISCONNECTED,
nullptr, 0);
935 else if (pChannelClientData->pChannelInitEventProcEx)
937 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
938 pChannelClientData->pInitHandle,
939 CHANNEL_EVENT_DISCONNECTED,
nullptr, 0);
943 EventArgsInit(&e,
"freerdp");
944 e.name = pChannelOpenData->name;
945 e.pInterface = pChannelOpenData->pInterface;
946 if (PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e) < 0)
947 error = ERROR_INTERNAL_ERROR;
950 channels->connected = FALSE;
953 freerdp_channels_check_fds(channels, instance);
957void freerdp_channels_close(rdpChannels* channels, freerdp* instance)
959 WINPR_ASSERT(channels);
960 WINPR_ASSERT(instance);
962 MessageQueue_PostQuit(channels->queue, 0);
963 freerdp_channels_check_fds(channels, instance);
966 for (
int index = 0; index < channels->clientDataCount; index++)
970 if (pChannelClientData->pChannelInitEventProc)
972 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
973 CHANNEL_EVENT_TERMINATED,
nullptr, 0);
975 else if (pChannelClientData->pChannelInitEventProcEx)
977 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
978 pChannelClientData->pInitHandle,
979 CHANNEL_EVENT_TERMINATED,
nullptr, 0);
984 ChannelTerminatedEventArgs e = WINPR_C_ARRAY_INIT;
985 EventArgsInit(&e,
"freerdp");
986 e.name = pChannelOpenData->name;
987 e.pInterface = pChannelInitData->pInterface;
988 if (PubSub_OnChannelTerminated(instance->context->pubSub, instance->context, &e) < 0)
990 WLog_WARN(TAG,
"PubSub_OnChannelTerminated(%s) failed", pChannelOpenData->name);
994 for (
int index = 0; index < channels->openDataCount; index++)
997 HashTable_Remove(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle);
1000 channels->openDataCount = 0;
1001 channels->initDataCount = 0;
1002 channels->clientDataCount = 0;
1004 WINPR_ASSERT(instance->context);
1005 WINPR_ASSERT(instance->context->settings);
1006 instance->context->settings->ChannelCount = 0;
1007 g_Instance =
nullptr;
1010static UINT VCAPITYPE FreeRDP_VirtualChannelInitEx(
1011 LPVOID lpUserParam, LPVOID clientContext, LPVOID pInitHandle,
PCHANNEL_DEF pChannel,
1012 INT channelCount, ULONG versionRequested, PCHANNEL_INIT_EVENT_EX_FN pChannelInitEventProcEx)
1014 rdpSettings* settings =
nullptr;
1018 return CHANNEL_RC_BAD_INIT_HANDLE;
1021 return CHANNEL_RC_BAD_CHANNEL;
1023 if ((channelCount <= 0) || !pChannelInitEventProcEx)
1024 return CHANNEL_RC_INITIALIZATION_ERROR;
1027 WINPR_ASSERT(pChannelInitData);
1029 rdpChannels* channels = pChannelInitData->channels;
1030 WINPR_ASSERT(channels);
1032 if (!channels->can_call_init)
1033 return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
1035 if ((channels->openDataCount + channelCount) > CHANNEL_MAX_COUNT)
1036 return CHANNEL_RC_TOO_MANY_CHANNELS;
1038 if (channels->connected)
1039 return CHANNEL_RC_ALREADY_CONNECTED;
1041 if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
1045 for (
int index = 0; index < channelCount; index++)
1049 if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) !=
nullptr)
1051 return CHANNEL_RC_BAD_CHANNEL;
1055 pChannelInitData->pInterface = clientContext;
1056 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1057 pChannelClientData->pChannelInitEventProcEx = pChannelInitEventProcEx;
1058 pChannelClientData->pInitHandle = pInitHandle;
1059 pChannelClientData->lpUserParam = lpUserParam;
1060 channels->clientDataCount++;
1062 WINPR_ASSERT(channels->instance);
1063 WINPR_ASSERT(channels->instance->context);
1064 settings = channels->instance->context->settings;
1065 WINPR_ASSERT(settings);
1067 for (
int index = 0; index < channelCount; index++)
1070 CHANNEL_OPEN_DATA* pChannelOpenData = &channels->openDataList[channels->openDataCount];
1072 WINPR_ASSERT(pChannelOpenData);
1074 const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1075 pChannelOpenData->OpenHandle = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1076 pChannelOpenData->channels = channels;
1077 pChannelOpenData->lpUserParam = lpUserParam;
1078 if (!HashTable_Insert(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle,
1079 (
void*)pChannelOpenData))
1081 pChannelInitData->pInterface =
nullptr;
1082 return CHANNEL_RC_INITIALIZATION_ERROR;
1084 pChannelOpenData->flags = 1;
1085 strncpy(pChannelOpenData->name, pChannelDef->name, CHANNEL_NAME_LEN);
1086 pChannelOpenData->options = pChannelDef->options;
1089 WINPR_ASSERT(max >= CHANNEL_MAX_COUNT);
1090 if (settings->ChannelCount < max)
1092 CHANNEL_DEF* channel = freerdp_settings_get_pointer_array_writable(
1093 settings, FreeRDP_ChannelDefArray, settings->ChannelCount);
1096 strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1097 channel->options = pChannelDef->options;
1098 settings->ChannelCount++;
1101 channels->openDataCount++;
1104 return CHANNEL_RC_OK;
1107static UINT VCAPITYPE FreeRDP_VirtualChannelInit(LPVOID* ppInitHandle,
PCHANNEL_DEF pChannel,
1108 INT channelCount, ULONG versionRequested,
1109 PCHANNEL_INIT_EVENT_FN pChannelInitEventProc)
1112 rdpSettings* settings =
nullptr;
1116 rdpChannels* channels =
nullptr;
1120 if (!g_Instance || !g_Instance->context)
1121 return CHANNEL_RC_NOT_INITIALIZED;
1123 channels = g_Instance->context->channels;
1125 if (!ppInitHandle || !channels)
1126 return CHANNEL_RC_BAD_INIT_HANDLE;
1129 return CHANNEL_RC_BAD_CHANNEL;
1131 if ((channelCount <= 0) || !pChannelInitEventProc)
1132 return CHANNEL_RC_INITIALIZATION_ERROR;
1134 pChannelInitData = &(channels->initDataList[channels->initDataCount]);
1135 *ppInitHandle = pChannelInitData;
1136 channels->initDataCount++;
1137 pChannelInitData->channels = channels;
1138 pChannelInitData->pInterface =
nullptr;
1140 if (!channels->can_call_init)
1141 return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
1143 if (channels->openDataCount + channelCount > CHANNEL_MAX_COUNT)
1144 return CHANNEL_RC_TOO_MANY_CHANNELS;
1146 if (channels->connected)
1147 return CHANNEL_RC_ALREADY_CONNECTED;
1149 if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
1153 for (
int index = 0; index < channelCount; index++)
1155 pChannelDef = &pChannel[index];
1157 if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) !=
nullptr)
1159 return CHANNEL_RC_BAD_CHANNEL;
1163 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1164 pChannelClientData->pChannelInitEventProc = pChannelInitEventProc;
1165 pChannelClientData->pInitHandle = *ppInitHandle;
1166 channels->clientDataCount++;
1167 settings = channels->instance->context->settings;
1169 for (
int index = 0; index < channelCount; index++)
1173 pChannelDef = &pChannel[index];
1175 CHANNEL_OPEN_DATA* pChannelOpenData = &channels->openDataList[channels->openDataCount];
1177 const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1178 pChannelOpenData->OpenHandle = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1179 pChannelOpenData->channels = channels;
1180 if (!HashTable_Insert(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle,
1181 (
void*)pChannelOpenData))
1182 return CHANNEL_RC_INITIALIZATION_ERROR;
1183 pChannelOpenData->flags = 1;
1184 strncpy(pChannelOpenData->name, pChannelDef->name, CHANNEL_NAME_LEN);
1185 pChannelOpenData->options = pChannelDef->options;
1187 if (ChannelCount < CHANNEL_MAX_COUNT)
1189 channel = freerdp_settings_get_pointer_array_writable(settings, FreeRDP_ChannelDefArray,
1191 strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1192 channel->options = pChannelDef->options;
1194 return ERROR_INTERNAL_ERROR;
1197 channels->openDataCount++;
1200 return CHANNEL_RC_OK;
1203static UINT VCAPITYPE
1204FreeRDP_VirtualChannelOpenEx(LPVOID pInitHandle, LPDWORD pOpenHandle, PCHAR pChannelName,
1205 PCHANNEL_OPEN_EVENT_EX_FN pChannelOpenEventProcEx)
1208 rdpChannels* channels = pChannelInitData->channels;
1209 void* pInterface = pChannelInitData->pInterface;
1212 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1214 if (!pChannelOpenEventProcEx)
1215 return CHANNEL_RC_BAD_PROC;
1217 if (!channels->connected)
1218 return CHANNEL_RC_NOT_CONNECTED;
1221 freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1223 if (!pChannelOpenData)
1224 return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1226 if (pChannelOpenData->flags == 2)
1227 return CHANNEL_RC_ALREADY_OPEN;
1229 pChannelOpenData->flags = 2;
1230 pChannelOpenData->pInterface = pInterface;
1231 pChannelOpenData->pChannelOpenEventProcEx = pChannelOpenEventProcEx;
1232 *pOpenHandle = pChannelOpenData->OpenHandle;
1233 return CHANNEL_RC_OK;
1236static UINT VCAPITYPE FreeRDP_VirtualChannelOpen(LPVOID pInitHandle, LPDWORD pOpenHandle,
1238 PCHANNEL_OPEN_EVENT_FN pChannelOpenEventProc)
1240 void* pInterface =
nullptr;
1241 rdpChannels* channels =
nullptr;
1245 channels = pChannelInitData->channels;
1246 pInterface = pChannelInitData->pInterface;
1249 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1251 if (!pChannelOpenEventProc)
1252 return CHANNEL_RC_BAD_PROC;
1254 if (!channels->connected)
1255 return CHANNEL_RC_NOT_CONNECTED;
1257 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1259 if (!pChannelOpenData)
1260 return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1262 if (pChannelOpenData->flags == 2)
1263 return CHANNEL_RC_ALREADY_OPEN;
1265 pChannelOpenData->flags = 2;
1266 pChannelOpenData->pInterface = pInterface;
1267 pChannelOpenData->pChannelOpenEventProc = pChannelOpenEventProc;
1268 *pOpenHandle = pChannelOpenData->OpenHandle;
1269 return CHANNEL_RC_OK;
1272static UINT VCAPITYPE FreeRDP_VirtualChannelCloseEx(LPVOID pInitHandle, DWORD openHandle)
1277 return CHANNEL_RC_BAD_INIT_HANDLE;
1279 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1281 if (!pChannelOpenData)
1282 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1284 if (pChannelOpenData->flags != 2)
1285 return CHANNEL_RC_NOT_OPEN;
1287 pChannelOpenData->flags = 0;
1288 return CHANNEL_RC_OK;
1291static UINT VCAPITYPE FreeRDP_VirtualChannelClose(DWORD openHandle)
1295 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1297 if (!pChannelOpenData)
1298 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1300 if (pChannelOpenData->flags != 2)
1301 return CHANNEL_RC_NOT_OPEN;
1303 pChannelOpenData->flags = 0;
1304 return CHANNEL_RC_OK;
1307static UINT VCAPITYPE FreeRDP_VirtualChannelWriteEx(LPVOID pInitHandle, DWORD openHandle,
1308 LPVOID pData, ULONG dataLength,
1311 rdpChannels* channels =
nullptr;
1315 wMessage message = WINPR_C_ARRAY_INIT;
1318 return CHANNEL_RC_BAD_INIT_HANDLE;
1321 channels = pChannelInitData->channels;
1324 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1326 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1328 if (!pChannelOpenData)
1329 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1331 if (!channels->connected)
1332 return CHANNEL_RC_NOT_CONNECTED;
1335 return CHANNEL_RC_NULL_DATA;
1338 return CHANNEL_RC_ZERO_LENGTH;
1340 if (pChannelOpenData->flags != 2)
1341 return CHANNEL_RC_NOT_OPEN;
1345 if (!pChannelOpenEvent)
1346 return CHANNEL_RC_NO_MEMORY;
1348 pChannelOpenEvent->Data = pData;
1349 pChannelOpenEvent->DataLength = dataLength;
1350 pChannelOpenEvent->UserData = pUserData;
1351 pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1352 message.context = channels;
1354 message.wParam = pChannelOpenEvent;
1355 message.lParam =
nullptr;
1356 message.Free = channel_queue_message_free;
1358 if (!MessageQueue_Dispatch(channels->queue, &message))
1360 free(pChannelOpenEvent);
1361 return CHANNEL_RC_NO_MEMORY;
1364 return CHANNEL_RC_OK;
1367static UINT VCAPITYPE FreeRDP_VirtualChannelWrite(DWORD openHandle, LPVOID pData, ULONG dataLength,
1370 wMessage message = WINPR_C_ARRAY_INIT;
1373 rdpChannels* channels =
nullptr;
1375 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1377 if (!pChannelOpenData)
1378 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1380 channels = pChannelOpenData->channels;
1382 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1384 if (!channels->connected)
1385 return CHANNEL_RC_NOT_CONNECTED;
1388 return CHANNEL_RC_NULL_DATA;
1391 return CHANNEL_RC_ZERO_LENGTH;
1393 if (pChannelOpenData->flags != 2)
1394 return CHANNEL_RC_NOT_OPEN;
1398 if (!pChannelOpenEvent)
1399 return CHANNEL_RC_NO_MEMORY;
1401 pChannelOpenEvent->Data = pData;
1402 pChannelOpenEvent->DataLength = dataLength;
1403 pChannelOpenEvent->UserData = pUserData;
1404 pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1405 message.context = channels;
1407 message.wParam = pChannelOpenEvent;
1408 message.lParam =
nullptr;
1409 message.Free = channel_queue_message_free;
1411 if (!MessageQueue_Dispatch(channels->queue, &message))
1413 free(pChannelOpenEvent);
1414 return CHANNEL_RC_NO_MEMORY;
1417 return CHANNEL_RC_OK;
1420static BOOL freerdp_channels_is_loaded(rdpChannels* channels, PVIRTUALCHANNELENTRY entry)
1422 for (
int i = 0; i < channels->clientDataCount; i++)
1426 if (pChannelClientData->entry == entry)
1433static BOOL freerdp_channels_is_loaded_ex(rdpChannels* channels, PVIRTUALCHANNELENTRYEX entryEx)
1435 for (
int i = 0; i < channels->clientDataCount; i++)
1439 if (pChannelClientData->entryEx == entryEx)
1446int freerdp_channels_client_load(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1447 PVIRTUALCHANNELENTRY entry,
void* data)
1451 WINPR_ASSERT(channels);
1452 WINPR_ASSERT(channels->instance);
1453 WINPR_ASSERT(channels->instance->context);
1454 WINPR_ASSERT(entry);
1456 if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1458 WLog_ERR(TAG,
"error: too many channels");
1462 if (freerdp_channels_is_loaded(channels, entry))
1464 WLog_WARN(TAG,
"Skipping, channel already loaded");
1468 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1469 pChannelClientData->entry = entry;
1472 .protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000,
1473 .pVirtualChannelInit = FreeRDP_VirtualChannelInit,
1474 .pVirtualChannelOpen = FreeRDP_VirtualChannelOpen,
1475 .pVirtualChannelClose =
1476 FreeRDP_VirtualChannelClose,
1477 .pVirtualChannelWrite =
1478 FreeRDP_VirtualChannelWrite,
1479 .MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER,
1480 .pExtendedData = data,
1481 .context = channels->instance->context };
1486 PCHANNEL_ENTRY_POINTS px;
1489 ptr.pfx = &EntryPoints;
1491 channels->can_call_init = TRUE;
1492 EnterCriticalSection(&channels->channelsLock);
1493 const BOOL status = pChannelClientData->entry(ptr.px);
1494 LeaveCriticalSection(&channels->channelsLock);
1496 channels->can_call_init = FALSE;
1500 WLog_ERR(TAG,
"error: channel export function call failed");
1507int freerdp_channels_client_load_ex(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1508 PVIRTUALCHANNELENTRYEX entryEx,
void* data)
1510 WINPR_ASSERT(channels);
1511 WINPR_ASSERT(channels->instance);
1512 WINPR_ASSERT(channels->instance->context);
1513 WINPR_ASSERT(entryEx);
1515 if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1517 WLog_ERR(TAG,
"error: too many channels");
1521 if (freerdp_channels_is_loaded_ex(channels, entryEx))
1523 WLog_WARN(TAG,
"Skipping, channel already loaded");
1527 CHANNEL_CLIENT_DATA* pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1528 pChannelClientData->entryEx = entryEx;
1530 CHANNEL_INIT_DATA* pChannelInitData = &(channels->initDataList[channels->initDataCount++]);
1531 void* pInitHandle = pChannelInitData;
1532 pChannelInitData->channels = channels;
1535 .cbSize =
sizeof(EntryPointsEx),
1536 .protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000,
1537 .pVirtualChannelInitEx = FreeRDP_VirtualChannelInitEx,
1538 .pVirtualChannelOpenEx = FreeRDP_VirtualChannelOpenEx,
1539 .pVirtualChannelCloseEx = FreeRDP_VirtualChannelCloseEx,
1540 .pVirtualChannelWriteEx = FreeRDP_VirtualChannelWriteEx,
1541 .MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER,
1542 .pExtendedData = data,
1543 .context = channels->instance->context
1549 PCHANNEL_ENTRY_POINTS_EX px;
1552 ptr.pfx = &EntryPointsEx;
1555 channels->can_call_init = TRUE;
1556 EnterCriticalSection(&channels->channelsLock);
1557 const BOOL status = pChannelClientData->entryEx(ptr.px, pInitHandle);
1558 LeaveCriticalSection(&channels->channelsLock);
1560 channels->can_call_init = FALSE;
1564 WLog_ERR(TAG,
"error: channel export function call failed");
1575int freerdp_channels_load_plugin(rdpChannels* channels, rdpSettings* settings,
const char* name,
1578 PVIRTUALCHANNELENTRY entry =
1579 freerdp_load_channel_addin_entry(name,
nullptr,
nullptr, FREERDP_ADDIN_CHANNEL_STATIC);
1584 return freerdp_channels_client_load(channels, settings, entry, data);
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 val)
Sets a UINT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
This struct contains function pointer to initialize/free objects.
OBJECT_FREE_FN fnObjectFree
WINPR_ATTR_NODISCARD OBJECT_NEW_FN fnObjectNew