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;
226 rdpChannels* channels = (rdpChannels*)context->custom;
227 freerdp* instance = channels->instance;
228 EventArgsInit(&e,
"freerdp");
230 e.pInterface = pInterface;
231 PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e);
240static UINT freerdp_drdynvc_on_channel_disconnected(DrdynvcClientContext* context,
const char* name,
243 UINT status = CHANNEL_RC_OK;
244 ChannelDisconnectedEventArgs e = WINPR_C_ARRAY_INIT;
245 rdpChannels* channels = (rdpChannels*)context->custom;
246 freerdp* instance = channels->instance;
247 EventArgsInit(&e,
"freerdp");
249 e.pInterface = pInterface;
250 PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e);
254static UINT freerdp_drdynvc_on_channel_attached(DrdynvcClientContext* context,
const char* name,
257 UINT status = CHANNEL_RC_OK;
258 ChannelAttachedEventArgs e = WINPR_C_ARRAY_INIT;
259 rdpChannels* channels = (rdpChannels*)context->custom;
260 freerdp* instance = channels->instance;
261 EventArgsInit(&e,
"freerdp");
263 e.pInterface = pInterface;
264 PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e);
268static UINT freerdp_drdynvc_on_channel_detached(DrdynvcClientContext* context,
const char* name,
271 UINT status = CHANNEL_RC_OK;
272 ChannelDetachedEventArgs e = WINPR_C_ARRAY_INIT;
273 rdpChannels* channels = (rdpChannels*)context->custom;
274 freerdp* instance = channels->instance;
275 EventArgsInit(&e,
"freerdp");
277 e.pInterface = pInterface;
278 PubSub_OnChannelDetached(instance->context->pubSub, instance->context, &e);
282void freerdp_channels_register_instance(WINPR_ATTR_UNUSED rdpChannels* channels, freerdp* instance)
285 g_Instance = instance;
292UINT freerdp_channels_pre_connect(rdpChannels* channels, freerdp* instance)
294 UINT error = CHANNEL_RC_OK;
297 MessageQueue_Clear(channels->queue);
299 for (
int index = 0; index < channels->clientDataCount; index++)
301 pChannelClientData = &channels->clientDataList[index];
303 if (pChannelClientData->pChannelInitEventProc)
305 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
306 CHANNEL_EVENT_INITIALIZED,
nullptr, 0);
308 else if (pChannelClientData->pChannelInitEventProcEx)
310 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
311 pChannelClientData->pInitHandle,
312 CHANNEL_EVENT_INITIALIZED,
nullptr, 0);
315 if (CHANNEL_RC_OK != getChannelError(instance->context))
322UINT freerdp_channels_attach(freerdp* instance)
324 UINT error = CHANNEL_RC_OK;
325 const char* hostname =
nullptr;
326 size_t hostnameLength = 0;
327 rdpChannels* channels =
nullptr;
330 WINPR_ASSERT(instance);
331 WINPR_ASSERT(instance->context);
332 WINPR_ASSERT(instance->context->settings);
334 channels = instance->context->channels;
336 WINPR_ASSERT(hostname);
337 hostnameLength = strnlen(hostname, MAX_PATH);
339 for (
int index = 0; index < channels->clientDataCount; index++)
346 ChannelAttachedEventArgs e = WINPR_C_ARRAY_INIT;
350 pChannelClientData = &channels->clientDataList[index];
352 if (pChannelClientData->pChannelInitEventProc)
355 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
356 CHANNEL_EVENT_ATTACHED, cnv.pv,
357 (UINT)hostnameLength);
359 else if (pChannelClientData->pChannelInitEventProcEx)
361 pChannelClientData->pChannelInitEventProcEx(
362 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
363 CHANNEL_EVENT_ATTACHED, cnv.pv, (UINT)hostnameLength);
366 if (getChannelError(instance->context) != CHANNEL_RC_OK)
369 pChannelOpenData = &channels->openDataList[index];
370 EventArgsInit(&e,
"freerdp");
371 e.name = pChannelOpenData->name;
372 e.pInterface = pChannelOpenData->pInterface;
373 PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e);
380UINT freerdp_channels_detach(freerdp* instance)
382 UINT error = CHANNEL_RC_OK;
383 const char* hostname =
nullptr;
384 size_t hostnameLength = 0;
385 rdpChannels* channels =
nullptr;
386 rdpContext* context =
nullptr;
389 WINPR_ASSERT(instance);
391 context = instance->context;
392 WINPR_ASSERT(context);
394 channels = context->channels;
395 WINPR_ASSERT(channels);
397 WINPR_ASSERT(context->settings);
399 WINPR_ASSERT(hostname);
400 hostnameLength = strnlen(hostname, MAX_PATH);
402 for (
int index = 0; index < channels->clientDataCount; index++)
410 ChannelDetachedEventArgs e = WINPR_C_ARRAY_INIT;
414 pChannelClientData = &channels->clientDataList[index];
416 if (pChannelClientData->pChannelInitEventProc)
418 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
419 CHANNEL_EVENT_DETACHED, cnv.pv,
420 (UINT)hostnameLength);
422 else if (pChannelClientData->pChannelInitEventProcEx)
424 pChannelClientData->pChannelInitEventProcEx(
425 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
426 CHANNEL_EVENT_DETACHED, cnv.pv, (UINT)hostnameLength);
429 if (getChannelError(context) != CHANNEL_RC_OK)
432 pChannelOpenData = &channels->openDataList[index];
433 EventArgsInit(&e,
"freerdp");
434 e.name = pChannelOpenData->name;
435 e.pInterface = pChannelOpenData->pInterface;
436 PubSub_OnChannelDetached(context->pubSub, context, &e);
448UINT freerdp_channels_post_connect(rdpChannels* channels, freerdp* instance)
450 UINT error = CHANNEL_RC_OK;
451 const char* hostname =
nullptr;
452 size_t hostnameLength = 0;
455 WINPR_ASSERT(channels);
456 WINPR_ASSERT(instance);
457 WINPR_ASSERT(instance->context);
458 WINPR_ASSERT(instance->context->settings);
460 channels->connected = TRUE;
462 WINPR_ASSERT(hostname);
463 hostnameLength = strnlen(hostname, MAX_PATH);
465 for (
int index = 0; index < channels->clientDataCount; index++)
472 ChannelConnectedEventArgs e = WINPR_C_ARRAY_INIT;
474 pChannelClientData = &channels->clientDataList[index];
477 if (pChannelClientData->pChannelInitEventProc)
479 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
480 CHANNEL_EVENT_CONNECTED, cnv.pb,
481 (UINT)hostnameLength);
483 else if (pChannelClientData->pChannelInitEventProcEx)
485 pChannelClientData->pChannelInitEventProcEx(
486 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
487 CHANNEL_EVENT_CONNECTED, cnv.pb, (UINT)hostnameLength);
490 error = getChannelError(instance->context);
491 if (error != CHANNEL_RC_OK)
494 pChannelOpenData = &channels->openDataList[index];
495 EventArgsInit(&e,
"freerdp");
496 e.name = pChannelOpenData->name;
497 e.pInterface = pChannelOpenData->pInterface;
498 PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e);
501 channels->drdynvc = (DrdynvcClientContext*)freerdp_channels_get_static_channel_interface(
502 channels, DRDYNVC_SVC_CHANNEL_NAME);
504 if (channels->drdynvc)
506 channels->drdynvc->custom = (
void*)channels;
507 channels->drdynvc->OnChannelConnected = freerdp_drdynvc_on_channel_connected;
508 channels->drdynvc->OnChannelDisconnected = freerdp_drdynvc_on_channel_disconnected;
509 channels->drdynvc->OnChannelAttached = freerdp_drdynvc_on_channel_attached;
510 channels->drdynvc->OnChannelDetached = freerdp_drdynvc_on_channel_detached;
517BOOL freerdp_channels_data(freerdp* instance, UINT16 channelId,
const BYTE* cdata,
size_t dataSize,
518 UINT32 flags,
size_t totalSize)
520 rdpMcs* mcs =
nullptr;
521 rdpChannels* channels =
nullptr;
522 rdpMcsChannel* channel =
nullptr;
531 if (!instance || !data.pcb)
533 WLog_ERR(TAG,
"(%p, %" PRIu16
", %p, 0x%08x): Invalid arguments",
534 WINPR_CXX_COMPAT_CAST(
const void*, instance), channelId,
535 WINPR_CXX_COMPAT_CAST(
const void*, data.pcb), flags);
539 mcs = instance->context->rdp->mcs;
540 channels = instance->context->channels;
542 if (!channels || !mcs)
547 for (UINT32 index = 0; index < mcs->channelCount; index++)
549 rdpMcsChannel* cur = &mcs->channels[index];
551 if (cur->ChannelId == channelId)
563 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, channel->Name);
565 if (!pChannelOpenData)
570 if (pChannelOpenData->pChannelOpenEventProc)
572 pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->OpenHandle,
573 CHANNEL_EVENT_DATA_RECEIVED, data.pb,
574 (UINT32)dataSize, (UINT32)totalSize, flags);
576 else if (pChannelOpenData->pChannelOpenEventProcEx)
578 pChannelOpenData->pChannelOpenEventProcEx(
579 pChannelOpenData->lpUserParam, pChannelOpenData->OpenHandle,
580 CHANNEL_EVENT_DATA_RECEIVED, data.pb, (UINT32)dataSize, (UINT32)totalSize, flags);
586UINT16 freerdp_channels_get_id_by_name(freerdp* instance,
const char* channel_name)
588 if (!instance || !channel_name)
591 rdpMcsChannel* mcsChannel =
592 freerdp_channels_find_channel_by_name(instance->context->rdp, channel_name);
596 return mcsChannel->ChannelId;
599const char* freerdp_channels_get_name_by_id(freerdp* instance, UINT16 channelId)
601 rdpMcsChannel* mcsChannel =
nullptr;
605 mcsChannel = freerdp_channels_find_channel_by_id(instance->context->rdp, channelId);
609 return mcsChannel->Name;
612BOOL freerdp_channels_process_message_free(wMessage* message, DWORD type)
614 if (message->id == WMQ_QUIT)
619 if (message->id == 0)
627 pChannelOpenData = item->pChannelOpenData;
629 if (pChannelOpenData->pChannelOpenEventProc)
631 pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->OpenHandle, type,
632 item->UserData, item->DataLength,
633 item->DataLength, 0);
635 else if (pChannelOpenData->pChannelOpenEventProcEx)
637 pChannelOpenData->pChannelOpenEventProcEx(
638 pChannelOpenData->lpUserParam, pChannelOpenData->OpenHandle, type, item->UserData,
639 item->DataLength, item->DataLength, 0);
646static BOOL freerdp_channels_process_message(freerdp* instance, wMessage* message)
651 WINPR_ASSERT(instance);
652 WINPR_ASSERT(message);
654 if (message->id == WMQ_QUIT)
656 else if (message->id == 0)
658 rdpMcsChannel* channel =
nullptr;
665 pChannelOpenData = item->pChannelOpenData;
666 if (pChannelOpenData->flags != 2)
668 freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_CANCELLED);
672 freerdp_channels_find_channel_by_name(instance->context->rdp, pChannelOpenData->name);
675 ret = instance->SendChannelData(instance, channel->ChannelId, item->Data,
679 if (!freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_COMPLETE))
685 IFCALL(message->Free, message);
692static BOOL freerdp_channels_process_sync(rdpChannels* channels, freerdp* instance)
695 wMessage message = WINPR_C_ARRAY_INIT;
697 WINPR_ASSERT(channels);
699 while (MessageQueue_Peek(channels->queue, &message, TRUE))
701 if (!freerdp_channels_process_message(instance, &message))
711#if defined(WITH_FREERDP_DEPRECATED)
712BOOL freerdp_channels_get_fds(rdpChannels* channels, WINPR_ATTR_UNUSED freerdp* instance,
713 void** read_fds,
int* read_count, WINPR_ATTR_UNUSED
void** write_fds,
714 WINPR_ATTR_UNUSED
int* write_count)
717 pfd = GetEventWaitObject(MessageQueue_Event(channels->queue));
721 read_fds[*read_count] = pfd;
729void* freerdp_channels_get_static_channel_interface(rdpChannels* channels,
const char* name)
731 void* pInterface =
nullptr;
733 freerdp_channels_find_channel_open_data_by_name(channels, name);
735 if (pChannelOpenData)
736 pInterface = pChannelOpenData->pInterface;
741HANDLE freerdp_channels_get_event_handle(freerdp* instance)
744 return INVALID_HANDLE_VALUE;
746 WINPR_ASSERT(instance->context);
748 rdpChannels* channels = instance->context->channels;
749 WINPR_ASSERT(channels);
751 return MessageQueue_Event(channels->queue);
754static BOOL channels_process(
const void* key,
void* value,
void* arg)
756 ChannelEventEntry* entry = value;
757 rdpContext* context = arg;
763 return entry->fkt(context, entry->userdata);
766int freerdp_channels_process_pending_messages(freerdp* instance)
771 WINPR_ASSERT(instance->context);
773 rdpChannels* channels = instance->context->channels;
774 WINPR_ASSERT(channels);
776 const DWORD status = WaitForSingleObject(MessageQueue_Event(channels->queue), 0);
777 if (status == WAIT_OBJECT_0)
779 if (!freerdp_channels_process_sync(channels, instance))
783 if (!HashTable_Foreach(channels->channelEvents, channels_process, instance->context))
792BOOL freerdp_channels_check_fds(rdpChannels* channels, freerdp* instance)
794 WINPR_ASSERT(channels);
795 WINPR_UNUSED(channels);
797 const int rc = freerdp_channels_process_pending_messages(instance);
801BOOL freerdp_client_channel_register(rdpChannels* channels, HANDLE handle,
802 freerdp_channel_handle_fkt_t fkt,
void* userdata)
804 if (!channels || (handle == INVALID_HANDLE_VALUE) || !fkt)
806 WLog_ERR(TAG,
"Invalid function arguments (channels=%p, handle=%p, fkt=%p, userdata=%p",
807 WINPR_CXX_COMPAT_CAST(
const void*, channels), handle,
808 WINPR_CXX_COMPAT_CAST(
const void*, fkt), userdata);
812 ChannelEventEntry entry = { .fkt = fkt, .userdata = userdata };
813 return HashTable_Insert(channels->channelEvents, handle, &entry);
816BOOL freerdp_client_channel_unregister(rdpChannels* channels, HANDLE handle)
818 if (!channels || (handle == INVALID_HANDLE_VALUE))
820 WLog_ERR(TAG,
"Invalid function arguments (channels=%p, handle=%p",
821 WINPR_CXX_COMPAT_CAST(
const void*, channels), handle);
825 return HashTable_Remove(channels->channelEvents, handle);
828SSIZE_T freerdp_client_channel_get_registered_event_handles(rdpChannels* channels, HANDLE* events,
833 WINPR_ASSERT(channels);
834 WINPR_ASSERT(events || (count == 0));
836 HashTable_Lock(channels->channelEvents);
837 size_t len = HashTable_Count(channels->channelEvents);
840 ULONG_PTR* keys =
nullptr;
841 const size_t nrKeys = HashTable_GetKeys(channels->channelEvents, &keys);
842 if ((nrKeys <= SSIZE_MAX) && (nrKeys == len))
844 for (
size_t x = 0; x < nrKeys; x++)
846 HANDLE cur = (HANDLE)keys[x];
849 rc = (SSIZE_T)nrKeys;
853 HashTable_Unlock(channels->channelEvents);
857UINT freerdp_channels_disconnect(rdpChannels* channels, freerdp* instance)
859 UINT error = CHANNEL_RC_OK;
863 WINPR_ASSERT(channels);
865 if (!channels->connected)
868 freerdp_channels_check_fds(channels, instance);
871 for (
int index = 0; index < channels->clientDataCount; index++)
873 ChannelDisconnectedEventArgs e = WINPR_C_ARRAY_INIT;
874 pChannelClientData = &channels->clientDataList[index];
876 if (pChannelClientData->pChannelInitEventProc)
878 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
879 CHANNEL_EVENT_DISCONNECTED,
nullptr, 0);
881 else if (pChannelClientData->pChannelInitEventProcEx)
883 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
884 pChannelClientData->pInitHandle,
885 CHANNEL_EVENT_DISCONNECTED,
nullptr, 0);
888 pChannelOpenData = &channels->openDataList[index];
889 EventArgsInit(&e,
"freerdp");
890 e.name = pChannelOpenData->name;
891 e.pInterface = pChannelOpenData->pInterface;
892 PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e);
895 channels->connected = FALSE;
898 freerdp_channels_check_fds(channels, instance);
902void freerdp_channels_close(rdpChannels* channels, freerdp* instance)
907 WINPR_ASSERT(channels);
908 WINPR_ASSERT(instance);
910 MessageQueue_PostQuit(channels->queue, 0);
911 freerdp_channels_check_fds(channels, instance);
914 for (
int index = 0; index < channels->clientDataCount; index++)
916 pChannelClientData = &channels->clientDataList[index];
918 if (pChannelClientData->pChannelInitEventProc)
920 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
921 CHANNEL_EVENT_TERMINATED,
nullptr, 0);
923 else if (pChannelClientData->pChannelInitEventProcEx)
925 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
926 pChannelClientData->pInitHandle,
927 CHANNEL_EVENT_TERMINATED,
nullptr, 0);
931 for (
int index = 0; index < channels->openDataCount; index++)
933 pChannelOpenData = &channels->openDataList[index];
934 HashTable_Remove(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle);
937 channels->openDataCount = 0;
938 channels->initDataCount = 0;
939 channels->clientDataCount = 0;
941 WINPR_ASSERT(instance->context);
942 WINPR_ASSERT(instance->context->settings);
943 instance->context->settings->ChannelCount = 0;
944 g_Instance =
nullptr;
947static UINT VCAPITYPE FreeRDP_VirtualChannelInitEx(
948 LPVOID lpUserParam, LPVOID clientContext, LPVOID pInitHandle,
PCHANNEL_DEF pChannel,
949 INT channelCount, ULONG versionRequested, PCHANNEL_INIT_EVENT_EX_FN pChannelInitEventProcEx)
951 rdpSettings* settings =
nullptr;
954 rdpChannels* channels =
nullptr;
957 return CHANNEL_RC_BAD_INIT_HANDLE;
960 return CHANNEL_RC_BAD_CHANNEL;
962 if ((channelCount <= 0) || !pChannelInitEventProcEx)
963 return CHANNEL_RC_INITIALIZATION_ERROR;
966 WINPR_ASSERT(pChannelInitData);
968 channels = pChannelInitData->channels;
969 WINPR_ASSERT(channels);
971 if (!channels->can_call_init)
972 return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
974 if ((channels->openDataCount + channelCount) > CHANNEL_MAX_COUNT)
975 return CHANNEL_RC_TOO_MANY_CHANNELS;
977 if (channels->connected)
978 return CHANNEL_RC_ALREADY_CONNECTED;
980 if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
984 for (
int index = 0; index < channelCount; index++)
988 if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) !=
nullptr)
990 return CHANNEL_RC_BAD_CHANNEL;
994 pChannelInitData->pInterface = clientContext;
995 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
996 pChannelClientData->pChannelInitEventProcEx = pChannelInitEventProcEx;
997 pChannelClientData->pInitHandle = pInitHandle;
998 pChannelClientData->lpUserParam = lpUserParam;
999 channels->clientDataCount++;
1001 WINPR_ASSERT(channels->instance);
1002 WINPR_ASSERT(channels->instance->context);
1003 settings = channels->instance->context->settings;
1004 WINPR_ASSERT(settings);
1006 for (
int index = 0; index < channelCount; index++)
1009 CHANNEL_OPEN_DATA* pChannelOpenData = &channels->openDataList[channels->openDataCount];
1011 WINPR_ASSERT(pChannelOpenData);
1013 const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1014 pChannelOpenData->OpenHandle = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1015 pChannelOpenData->channels = channels;
1016 pChannelOpenData->lpUserParam = lpUserParam;
1017 if (!HashTable_Insert(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle,
1018 (
void*)pChannelOpenData))
1020 pChannelInitData->pInterface =
nullptr;
1021 return CHANNEL_RC_INITIALIZATION_ERROR;
1023 pChannelOpenData->flags = 1;
1024 strncpy(pChannelOpenData->name, pChannelDef->name, CHANNEL_NAME_LEN);
1025 pChannelOpenData->options = pChannelDef->options;
1028 WINPR_ASSERT(max >= CHANNEL_MAX_COUNT);
1029 if (settings->ChannelCount < max)
1031 CHANNEL_DEF* channel = freerdp_settings_get_pointer_array_writable(
1032 settings, FreeRDP_ChannelDefArray, settings->ChannelCount);
1035 strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1036 channel->options = pChannelDef->options;
1037 settings->ChannelCount++;
1040 channels->openDataCount++;
1043 return CHANNEL_RC_OK;
1046static UINT VCAPITYPE FreeRDP_VirtualChannelInit(LPVOID* ppInitHandle,
PCHANNEL_DEF pChannel,
1047 INT channelCount, ULONG versionRequested,
1048 PCHANNEL_INIT_EVENT_FN pChannelInitEventProc)
1051 rdpSettings* settings =
nullptr;
1056 rdpChannels* channels =
nullptr;
1060 if (!g_Instance || !g_Instance->context)
1061 return CHANNEL_RC_NOT_INITIALIZED;
1063 channels = g_Instance->context->channels;
1065 if (!ppInitHandle || !channels)
1066 return CHANNEL_RC_BAD_INIT_HANDLE;
1069 return CHANNEL_RC_BAD_CHANNEL;
1071 if ((channelCount <= 0) || !pChannelInitEventProc)
1072 return CHANNEL_RC_INITIALIZATION_ERROR;
1074 pChannelInitData = &(channels->initDataList[channels->initDataCount]);
1075 *ppInitHandle = pChannelInitData;
1076 channels->initDataCount++;
1077 pChannelInitData->channels = channels;
1078 pChannelInitData->pInterface =
nullptr;
1080 if (!channels->can_call_init)
1081 return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
1083 if (channels->openDataCount + channelCount > CHANNEL_MAX_COUNT)
1084 return CHANNEL_RC_TOO_MANY_CHANNELS;
1086 if (channels->connected)
1087 return CHANNEL_RC_ALREADY_CONNECTED;
1089 if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
1093 for (
int index = 0; index < channelCount; index++)
1095 pChannelDef = &pChannel[index];
1097 if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) !=
nullptr)
1099 return CHANNEL_RC_BAD_CHANNEL;
1103 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1104 pChannelClientData->pChannelInitEventProc = pChannelInitEventProc;
1105 pChannelClientData->pInitHandle = *ppInitHandle;
1106 channels->clientDataCount++;
1107 settings = channels->instance->context->settings;
1109 for (
int index = 0; index < channelCount; index++)
1113 pChannelDef = &pChannel[index];
1115 pChannelOpenData = &channels->openDataList[channels->openDataCount];
1117 const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1118 pChannelOpenData->OpenHandle = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1119 pChannelOpenData->channels = channels;
1120 if (!HashTable_Insert(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle,
1121 (
void*)pChannelOpenData))
1122 return CHANNEL_RC_INITIALIZATION_ERROR;
1123 pChannelOpenData->flags = 1;
1124 strncpy(pChannelOpenData->name, pChannelDef->name, CHANNEL_NAME_LEN);
1125 pChannelOpenData->options = pChannelDef->options;
1127 if (ChannelCount < CHANNEL_MAX_COUNT)
1129 channel = freerdp_settings_get_pointer_array_writable(settings, FreeRDP_ChannelDefArray,
1131 strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1132 channel->options = pChannelDef->options;
1134 return ERROR_INTERNAL_ERROR;
1137 channels->openDataCount++;
1140 return CHANNEL_RC_OK;
1143static UINT VCAPITYPE
1144FreeRDP_VirtualChannelOpenEx(LPVOID pInitHandle, LPDWORD pOpenHandle, PCHAR pChannelName,
1145 PCHANNEL_OPEN_EVENT_EX_FN pChannelOpenEventProcEx)
1147 void* pInterface =
nullptr;
1148 rdpChannels* channels =
nullptr;
1152 channels = pChannelInitData->channels;
1153 pInterface = pChannelInitData->pInterface;
1156 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1158 if (!pChannelOpenEventProcEx)
1159 return CHANNEL_RC_BAD_PROC;
1161 if (!channels->connected)
1162 return CHANNEL_RC_NOT_CONNECTED;
1164 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1166 if (!pChannelOpenData)
1167 return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1169 if (pChannelOpenData->flags == 2)
1170 return CHANNEL_RC_ALREADY_OPEN;
1172 pChannelOpenData->flags = 2;
1173 pChannelOpenData->pInterface = pInterface;
1174 pChannelOpenData->pChannelOpenEventProcEx = pChannelOpenEventProcEx;
1175 *pOpenHandle = pChannelOpenData->OpenHandle;
1176 return CHANNEL_RC_OK;
1179static UINT VCAPITYPE FreeRDP_VirtualChannelOpen(LPVOID pInitHandle, LPDWORD pOpenHandle,
1181 PCHANNEL_OPEN_EVENT_FN pChannelOpenEventProc)
1183 void* pInterface =
nullptr;
1184 rdpChannels* channels =
nullptr;
1188 channels = pChannelInitData->channels;
1189 pInterface = pChannelInitData->pInterface;
1192 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1194 if (!pChannelOpenEventProc)
1195 return CHANNEL_RC_BAD_PROC;
1197 if (!channels->connected)
1198 return CHANNEL_RC_NOT_CONNECTED;
1200 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1202 if (!pChannelOpenData)
1203 return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1205 if (pChannelOpenData->flags == 2)
1206 return CHANNEL_RC_ALREADY_OPEN;
1208 pChannelOpenData->flags = 2;
1209 pChannelOpenData->pInterface = pInterface;
1210 pChannelOpenData->pChannelOpenEventProc = pChannelOpenEventProc;
1211 *pOpenHandle = pChannelOpenData->OpenHandle;
1212 return CHANNEL_RC_OK;
1215static UINT VCAPITYPE FreeRDP_VirtualChannelCloseEx(LPVOID pInitHandle, DWORD openHandle)
1220 return CHANNEL_RC_BAD_INIT_HANDLE;
1222 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1224 if (!pChannelOpenData)
1225 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1227 if (pChannelOpenData->flags != 2)
1228 return CHANNEL_RC_NOT_OPEN;
1230 pChannelOpenData->flags = 0;
1231 return CHANNEL_RC_OK;
1234static UINT VCAPITYPE FreeRDP_VirtualChannelClose(DWORD openHandle)
1238 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1240 if (!pChannelOpenData)
1241 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1243 if (pChannelOpenData->flags != 2)
1244 return CHANNEL_RC_NOT_OPEN;
1246 pChannelOpenData->flags = 0;
1247 return CHANNEL_RC_OK;
1250static UINT VCAPITYPE FreeRDP_VirtualChannelWriteEx(LPVOID pInitHandle, DWORD openHandle,
1251 LPVOID pData, ULONG dataLength,
1254 rdpChannels* channels =
nullptr;
1258 wMessage message = WINPR_C_ARRAY_INIT;
1261 return CHANNEL_RC_BAD_INIT_HANDLE;
1264 channels = pChannelInitData->channels;
1267 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1269 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1271 if (!pChannelOpenData)
1272 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1274 if (!channels->connected)
1275 return CHANNEL_RC_NOT_CONNECTED;
1278 return CHANNEL_RC_NULL_DATA;
1281 return CHANNEL_RC_ZERO_LENGTH;
1283 if (pChannelOpenData->flags != 2)
1284 return CHANNEL_RC_NOT_OPEN;
1288 if (!pChannelOpenEvent)
1289 return CHANNEL_RC_NO_MEMORY;
1291 pChannelOpenEvent->Data = pData;
1292 pChannelOpenEvent->DataLength = dataLength;
1293 pChannelOpenEvent->UserData = pUserData;
1294 pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1295 message.context = channels;
1297 message.wParam = pChannelOpenEvent;
1298 message.lParam =
nullptr;
1299 message.Free = channel_queue_message_free;
1301 if (!MessageQueue_Dispatch(channels->queue, &message))
1303 free(pChannelOpenEvent);
1304 return CHANNEL_RC_NO_MEMORY;
1307 return CHANNEL_RC_OK;
1310static UINT VCAPITYPE FreeRDP_VirtualChannelWrite(DWORD openHandle, LPVOID pData, ULONG dataLength,
1313 wMessage message = WINPR_C_ARRAY_INIT;
1316 rdpChannels* channels =
nullptr;
1318 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1320 if (!pChannelOpenData)
1321 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1323 channels = pChannelOpenData->channels;
1325 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1327 if (!channels->connected)
1328 return CHANNEL_RC_NOT_CONNECTED;
1331 return CHANNEL_RC_NULL_DATA;
1334 return CHANNEL_RC_ZERO_LENGTH;
1336 if (pChannelOpenData->flags != 2)
1337 return CHANNEL_RC_NOT_OPEN;
1341 if (!pChannelOpenEvent)
1342 return CHANNEL_RC_NO_MEMORY;
1344 pChannelOpenEvent->Data = pData;
1345 pChannelOpenEvent->DataLength = dataLength;
1346 pChannelOpenEvent->UserData = pUserData;
1347 pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1348 message.context = channels;
1350 message.wParam = pChannelOpenEvent;
1351 message.lParam =
nullptr;
1352 message.Free = channel_queue_message_free;
1354 if (!MessageQueue_Dispatch(channels->queue, &message))
1356 free(pChannelOpenEvent);
1357 return CHANNEL_RC_NO_MEMORY;
1360 return CHANNEL_RC_OK;
1363static BOOL freerdp_channels_is_loaded(rdpChannels* channels, PVIRTUALCHANNELENTRY entry)
1365 for (
int i = 0; i < channels->clientDataCount; i++)
1369 if (pChannelClientData->entry == entry)
1376static BOOL freerdp_channels_is_loaded_ex(rdpChannels* channels, PVIRTUALCHANNELENTRYEX entryEx)
1378 for (
int i = 0; i < channels->clientDataCount; i++)
1382 if (pChannelClientData->entryEx == entryEx)
1389int freerdp_channels_client_load(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1390 PVIRTUALCHANNELENTRY entry,
void* data)
1394 WINPR_ASSERT(channels);
1395 WINPR_ASSERT(channels->instance);
1396 WINPR_ASSERT(channels->instance->context);
1397 WINPR_ASSERT(entry);
1399 if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1401 WLog_ERR(TAG,
"error: too many channels");
1405 if (freerdp_channels_is_loaded(channels, entry))
1407 WLog_WARN(TAG,
"Skipping, channel already loaded");
1411 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1412 pChannelClientData->entry = entry;
1415 .protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000,
1416 .pVirtualChannelInit = FreeRDP_VirtualChannelInit,
1417 .pVirtualChannelOpen = FreeRDP_VirtualChannelOpen,
1418 .pVirtualChannelClose =
1419 FreeRDP_VirtualChannelClose,
1420 .pVirtualChannelWrite =
1421 FreeRDP_VirtualChannelWrite,
1422 .MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER,
1423 .pExtendedData = data,
1424 .context = channels->instance->context };
1429 PCHANNEL_ENTRY_POINTS px;
1432 ptr.pfx = &EntryPoints;
1434 channels->can_call_init = TRUE;
1435 EnterCriticalSection(&channels->channelsLock);
1436 const BOOL status = pChannelClientData->entry(ptr.px);
1437 LeaveCriticalSection(&channels->channelsLock);
1439 channels->can_call_init = FALSE;
1443 WLog_ERR(TAG,
"error: channel export function call failed");
1450int freerdp_channels_client_load_ex(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1451 PVIRTUALCHANNELENTRYEX entryEx,
void* data)
1453 WINPR_ASSERT(channels);
1454 WINPR_ASSERT(channels->instance);
1455 WINPR_ASSERT(channels->instance->context);
1456 WINPR_ASSERT(entryEx);
1458 if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1460 WLog_ERR(TAG,
"error: too many channels");
1464 if (freerdp_channels_is_loaded_ex(channels, entryEx))
1466 WLog_WARN(TAG,
"Skipping, channel already loaded");
1470 CHANNEL_CLIENT_DATA* pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1471 pChannelClientData->entryEx = entryEx;
1473 CHANNEL_INIT_DATA* pChannelInitData = &(channels->initDataList[channels->initDataCount++]);
1474 void* pInitHandle = pChannelInitData;
1475 pChannelInitData->channels = channels;
1478 .cbSize =
sizeof(EntryPointsEx),
1479 .protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000,
1480 .pVirtualChannelInitEx = FreeRDP_VirtualChannelInitEx,
1481 .pVirtualChannelOpenEx = FreeRDP_VirtualChannelOpenEx,
1482 .pVirtualChannelCloseEx = FreeRDP_VirtualChannelCloseEx,
1483 .pVirtualChannelWriteEx = FreeRDP_VirtualChannelWriteEx,
1484 .MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER,
1485 .pExtendedData = data,
1486 .context = channels->instance->context
1492 PCHANNEL_ENTRY_POINTS_EX px;
1495 ptr.pfx = &EntryPointsEx;
1498 channels->can_call_init = TRUE;
1499 EnterCriticalSection(&channels->channelsLock);
1500 const BOOL status = pChannelClientData->entryEx(ptr.px, pInitHandle);
1501 LeaveCriticalSection(&channels->channelsLock);
1503 channels->can_call_init = FALSE;
1507 WLog_ERR(TAG,
"error: channel export function call failed");
1518int freerdp_channels_load_plugin(rdpChannels* channels, rdpSettings* settings,
const char* name,
1521 PVIRTUALCHANNELENTRY entry =
1522 freerdp_load_channel_addin_entry(name,
nullptr,
nullptr, FREERDP_ADDIN_CHANNEL_STATIC);
1527 return freerdp_channels_client_load(channels, settings, entry, data);
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 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 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
OBJECT_NEW_FN fnObjectNew