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 = NULL;
48static volatile LONG g_OpenHandleSeq = 1;
51static INIT_ONCE g_ChannelHandlesOnce = INIT_ONCE_STATIC_INIT;
52static wHashTable* g_ChannelHandles = NULL;
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)
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 = NULL;
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)
158 rdpChannels* channels = NULL;
159 channels = (rdpChannels*)calloc(1,
sizeof(rdpChannels));
164 InitOnceExecuteOnce(&g_ChannelHandlesOnce, init_channel_handles_table, NULL, NULL);
166 if (!g_ChannelHandles)
168 if (!InitializeCriticalSectionAndSpinCount(&channels->channelsLock, 4000))
171 channels->instance = instance;
172 channels->queue = MessageQueue_New(NULL);
174 if (!channels->queue)
177 obj = MessageQueue_Object(channels->queue);
178 obj->fnObjectFree = channel_queue_free;
180 channels->channelEvents = HashTable_New(FALSE);
181 if (!channels->channelEvents)
184 obj = HashTable_ValueObject(channels->channelEvents);
186 obj->fnObjectFree = free;
187 obj->fnObjectNew = channel_event_entry_clone;
190 WINPR_PRAGMA_DIAG_PUSH
191 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
192 freerdp_channels_free(channels);
193 WINPR_PRAGMA_DIAG_POP
197void freerdp_channels_free(rdpChannels* channels)
202 HashTable_Free(channels->channelEvents);
204 DeleteCriticalSection(&channels->channelsLock);
208 MessageQueue_Free(channels->queue);
209 channels->queue = NULL;
220static UINT freerdp_drdynvc_on_channel_connected(DrdynvcClientContext* context,
const char* name,
223 UINT status = CHANNEL_RC_OK;
224 ChannelConnectedEventArgs e = { 0 };
225 rdpChannels* channels = (rdpChannels*)context->custom;
226 freerdp* instance = channels->instance;
227 EventArgsInit(&e,
"freerdp");
229 e.pInterface = pInterface;
230 PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e);
239static UINT freerdp_drdynvc_on_channel_disconnected(DrdynvcClientContext* context,
const char* name,
242 UINT status = CHANNEL_RC_OK;
243 ChannelDisconnectedEventArgs e = { 0 };
244 rdpChannels* channels = (rdpChannels*)context->custom;
245 freerdp* instance = channels->instance;
246 EventArgsInit(&e,
"freerdp");
248 e.pInterface = pInterface;
249 PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e);
253static UINT freerdp_drdynvc_on_channel_attached(DrdynvcClientContext* context,
const char* name,
256 UINT status = CHANNEL_RC_OK;
257 ChannelAttachedEventArgs e = { 0 };
258 rdpChannels* channels = (rdpChannels*)context->custom;
259 freerdp* instance = channels->instance;
260 EventArgsInit(&e,
"freerdp");
262 e.pInterface = pInterface;
263 PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e);
267static UINT freerdp_drdynvc_on_channel_detached(DrdynvcClientContext* context,
const char* name,
270 UINT status = CHANNEL_RC_OK;
271 ChannelDetachedEventArgs e = { 0 };
272 rdpChannels* channels = (rdpChannels*)context->custom;
273 freerdp* instance = channels->instance;
274 EventArgsInit(&e,
"freerdp");
276 e.pInterface = pInterface;
277 PubSub_OnChannelDetached(instance->context->pubSub, instance->context, &e);
281void freerdp_channels_register_instance(WINPR_ATTR_UNUSED rdpChannels* channels, freerdp* instance)
284 g_Instance = instance;
291UINT freerdp_channels_pre_connect(rdpChannels* channels, freerdp* instance)
293 UINT error = CHANNEL_RC_OK;
296 MessageQueue_Clear(channels->queue);
298 for (
int index = 0; index < channels->clientDataCount; index++)
300 pChannelClientData = &channels->clientDataList[index];
302 if (pChannelClientData->pChannelInitEventProc)
304 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
305 CHANNEL_EVENT_INITIALIZED, 0, 0);
307 else if (pChannelClientData->pChannelInitEventProcEx)
309 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
310 pChannelClientData->pInitHandle,
311 CHANNEL_EVENT_INITIALIZED, 0, 0);
314 if (CHANNEL_RC_OK != getChannelError(instance->context))
321UINT freerdp_channels_attach(freerdp* instance)
323 UINT error = CHANNEL_RC_OK;
324 const char* hostname = NULL;
325 size_t hostnameLength = 0;
326 rdpChannels* channels = NULL;
329 WINPR_ASSERT(instance);
330 WINPR_ASSERT(instance->context);
331 WINPR_ASSERT(instance->context->settings);
333 channels = instance->context->channels;
335 WINPR_ASSERT(hostname);
336 hostnameLength = strnlen(hostname, MAX_PATH);
338 for (
int index = 0; index < channels->clientDataCount; index++)
345 ChannelAttachedEventArgs e = { 0 };
349 pChannelClientData = &channels->clientDataList[index];
351 if (pChannelClientData->pChannelInitEventProc)
354 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
355 CHANNEL_EVENT_ATTACHED, cnv.pv,
356 (UINT)hostnameLength);
358 else if (pChannelClientData->pChannelInitEventProcEx)
360 pChannelClientData->pChannelInitEventProcEx(
361 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
362 CHANNEL_EVENT_ATTACHED, cnv.pv, (UINT)hostnameLength);
365 if (getChannelError(instance->context) != CHANNEL_RC_OK)
368 pChannelOpenData = &channels->openDataList[index];
369 EventArgsInit(&e,
"freerdp");
370 e.name = pChannelOpenData->name;
371 e.pInterface = pChannelOpenData->pInterface;
372 PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e);
379UINT freerdp_channels_detach(freerdp* instance)
381 UINT error = CHANNEL_RC_OK;
382 const char* hostname = NULL;
383 size_t hostnameLength = 0;
384 rdpChannels* channels = NULL;
385 rdpContext* context = NULL;
388 WINPR_ASSERT(instance);
390 context = instance->context;
391 WINPR_ASSERT(context);
393 channels = context->channels;
394 WINPR_ASSERT(channels);
396 WINPR_ASSERT(context->settings);
398 WINPR_ASSERT(hostname);
399 hostnameLength = strnlen(hostname, MAX_PATH);
401 for (
int index = 0; index < channels->clientDataCount; index++)
409 ChannelDetachedEventArgs e = { 0 };
413 pChannelClientData = &channels->clientDataList[index];
415 if (pChannelClientData->pChannelInitEventProc)
417 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
418 CHANNEL_EVENT_DETACHED, cnv.pv,
419 (UINT)hostnameLength);
421 else if (pChannelClientData->pChannelInitEventProcEx)
423 pChannelClientData->pChannelInitEventProcEx(
424 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
425 CHANNEL_EVENT_DETACHED, cnv.pv, (UINT)hostnameLength);
428 if (getChannelError(context) != CHANNEL_RC_OK)
431 pChannelOpenData = &channels->openDataList[index];
432 EventArgsInit(&e,
"freerdp");
433 e.name = pChannelOpenData->name;
434 e.pInterface = pChannelOpenData->pInterface;
435 PubSub_OnChannelDetached(context->pubSub, context, &e);
447UINT freerdp_channels_post_connect(rdpChannels* channels, freerdp* instance)
449 UINT error = CHANNEL_RC_OK;
450 const char* hostname = NULL;
451 size_t hostnameLength = 0;
454 WINPR_ASSERT(channels);
455 WINPR_ASSERT(instance);
456 WINPR_ASSERT(instance->context);
457 WINPR_ASSERT(instance->context->settings);
459 channels->connected = TRUE;
461 WINPR_ASSERT(hostname);
462 hostnameLength = strnlen(hostname, MAX_PATH);
464 for (
int index = 0; index < channels->clientDataCount; index++)
471 ChannelConnectedEventArgs e = { 0 };
473 pChannelClientData = &channels->clientDataList[index];
476 if (pChannelClientData->pChannelInitEventProc)
478 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
479 CHANNEL_EVENT_CONNECTED, cnv.pb,
480 (UINT)hostnameLength);
482 else if (pChannelClientData->pChannelInitEventProcEx)
484 pChannelClientData->pChannelInitEventProcEx(
485 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
486 CHANNEL_EVENT_CONNECTED, cnv.pb, (UINT)hostnameLength);
489 error = getChannelError(instance->context);
490 if (error != CHANNEL_RC_OK)
493 pChannelOpenData = &channels->openDataList[index];
494 EventArgsInit(&e,
"freerdp");
495 e.name = pChannelOpenData->name;
496 e.pInterface = pChannelOpenData->pInterface;
497 PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e);
500 channels->drdynvc = (DrdynvcClientContext*)freerdp_channels_get_static_channel_interface(
501 channels, DRDYNVC_SVC_CHANNEL_NAME);
503 if (channels->drdynvc)
505 channels->drdynvc->custom = (
void*)channels;
506 channels->drdynvc->OnChannelConnected = freerdp_drdynvc_on_channel_connected;
507 channels->drdynvc->OnChannelDisconnected = freerdp_drdynvc_on_channel_disconnected;
508 channels->drdynvc->OnChannelAttached = freerdp_drdynvc_on_channel_attached;
509 channels->drdynvc->OnChannelDetached = freerdp_drdynvc_on_channel_detached;
516BOOL freerdp_channels_data(freerdp* instance, UINT16 channelId,
const BYTE* cdata,
size_t dataSize,
517 UINT32 flags,
size_t totalSize)
520 rdpChannels* channels = NULL;
521 rdpMcsChannel* channel = NULL;
530 if (!instance || !data.pcb)
532 WLog_ERR(TAG,
"(%p, %" PRIu16
", %p, 0x%08x): Invalid arguments", instance, channelId,
537 mcs = instance->context->rdp->mcs;
538 channels = instance->context->channels;
540 if (!channels || !mcs)
545 for (UINT32 index = 0; index < mcs->channelCount; index++)
547 rdpMcsChannel* cur = &mcs->channels[index];
549 if (cur->ChannelId == channelId)
561 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, channel->Name);
563 if (!pChannelOpenData)
568 if (pChannelOpenData->pChannelOpenEventProc)
570 pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->OpenHandle,
571 CHANNEL_EVENT_DATA_RECEIVED, data.pb,
572 (UINT32)dataSize, (UINT32)totalSize, flags);
574 else if (pChannelOpenData->pChannelOpenEventProcEx)
576 pChannelOpenData->pChannelOpenEventProcEx(
577 pChannelOpenData->lpUserParam, pChannelOpenData->OpenHandle,
578 CHANNEL_EVENT_DATA_RECEIVED, data.pb, (UINT32)dataSize, (UINT32)totalSize, flags);
584UINT16 freerdp_channels_get_id_by_name(freerdp* instance,
const char* channel_name)
586 if (!instance || !channel_name)
589 rdpMcsChannel* mcsChannel =
590 freerdp_channels_find_channel_by_name(instance->context->rdp, channel_name);
594 return mcsChannel->ChannelId;
597const char* freerdp_channels_get_name_by_id(freerdp* instance, UINT16 channelId)
599 rdpMcsChannel* mcsChannel = NULL;
603 mcsChannel = freerdp_channels_find_channel_by_id(instance->context->rdp, channelId);
607 return mcsChannel->Name;
610BOOL freerdp_channels_process_message_free(wMessage* message, DWORD type)
612 if (message->id == WMQ_QUIT)
617 if (message->id == 0)
625 pChannelOpenData = item->pChannelOpenData;
627 if (pChannelOpenData->pChannelOpenEventProc)
629 pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->OpenHandle, type,
630 item->UserData, item->DataLength,
631 item->DataLength, 0);
633 else if (pChannelOpenData->pChannelOpenEventProcEx)
635 pChannelOpenData->pChannelOpenEventProcEx(
636 pChannelOpenData->lpUserParam, pChannelOpenData->OpenHandle, type, item->UserData,
637 item->DataLength, item->DataLength, 0);
644static BOOL freerdp_channels_process_message(freerdp* instance, wMessage* message)
649 WINPR_ASSERT(instance);
650 WINPR_ASSERT(message);
652 if (message->id == WMQ_QUIT)
654 else if (message->id == 0)
656 rdpMcsChannel* channel = NULL;
663 pChannelOpenData = item->pChannelOpenData;
664 if (pChannelOpenData->flags != 2)
666 freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_CANCELLED);
670 freerdp_channels_find_channel_by_name(instance->context->rdp, pChannelOpenData->name);
673 ret = instance->SendChannelData(instance, channel->ChannelId, item->Data,
677 if (!freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_COMPLETE))
683 IFCALL(message->Free, message);
690static BOOL freerdp_channels_process_sync(rdpChannels* channels, freerdp* instance)
693 wMessage message = { 0 };
695 WINPR_ASSERT(channels);
697 while (MessageQueue_Peek(channels->queue, &message, TRUE))
699 if (!freerdp_channels_process_message(instance, &message))
709#if defined(WITH_FREERDP_DEPRECATED)
710BOOL freerdp_channels_get_fds(rdpChannels* channels, WINPR_ATTR_UNUSED freerdp* instance,
711 void** read_fds,
int* read_count, WINPR_ATTR_UNUSED
void** write_fds,
712 WINPR_ATTR_UNUSED
int* write_count)
715 pfd = GetEventWaitObject(MessageQueue_Event(channels->queue));
719 read_fds[*read_count] = pfd;
727void* freerdp_channels_get_static_channel_interface(rdpChannels* channels,
const char* name)
729 void* pInterface = NULL;
731 freerdp_channels_find_channel_open_data_by_name(channels, name);
733 if (pChannelOpenData)
734 pInterface = pChannelOpenData->pInterface;
739HANDLE freerdp_channels_get_event_handle(freerdp* instance)
742 return INVALID_HANDLE_VALUE;
744 WINPR_ASSERT(instance->context);
746 rdpChannels* channels = instance->context->channels;
747 WINPR_ASSERT(channels);
749 return MessageQueue_Event(channels->queue);
752static BOOL channels_process(
const void* key,
void* value,
void* arg)
754 ChannelEventEntry* entry = value;
755 rdpContext* context = arg;
761 return entry->fkt(context, entry->userdata);
764int freerdp_channels_process_pending_messages(freerdp* instance)
769 WINPR_ASSERT(instance->context);
771 rdpChannels* channels = instance->context->channels;
772 WINPR_ASSERT(channels);
774 const DWORD status = WaitForSingleObject(MessageQueue_Event(channels->queue), 0);
775 if (status == WAIT_OBJECT_0)
777 if (!freerdp_channels_process_sync(channels, instance))
781 if (!HashTable_Foreach(channels->channelEvents, channels_process, instance->context))
790BOOL freerdp_channels_check_fds(rdpChannels* channels, freerdp* instance)
792 WINPR_ASSERT(channels);
793 WINPR_UNUSED(channels);
795 const int rc = freerdp_channels_process_pending_messages(instance);
799BOOL freerdp_client_channel_register(rdpChannels* channels, HANDLE handle,
800 freerdp_channel_handle_fkt_t fkt,
void* userdata)
802 if (!channels || (handle == INVALID_HANDLE_VALUE) || !fkt)
804 WLog_ERR(TAG,
"Invalid function arguments (channels=%p, handle=%p, fkt=%p, userdata=%p",
805 channels, handle, fkt, userdata);
809 ChannelEventEntry entry = { .fkt = fkt, .userdata = userdata };
810 return HashTable_Insert(channels->channelEvents, handle, &entry);
813BOOL freerdp_client_channel_unregister(rdpChannels* channels, HANDLE handle)
815 if (!channels || (handle == INVALID_HANDLE_VALUE))
817 WLog_ERR(TAG,
"Invalid function arguments (channels=%p, handle=%p", channels, handle);
821 return HashTable_Remove(channels->channelEvents, handle);
824SSIZE_T freerdp_client_channel_get_registered_event_handles(rdpChannels* channels, HANDLE* events,
829 WINPR_ASSERT(channels);
830 WINPR_ASSERT(events || (count == 0));
832 HashTable_Lock(channels->channelEvents);
833 size_t len = HashTable_Count(channels->channelEvents);
836 ULONG_PTR* keys = NULL;
837 const size_t nrKeys = HashTable_GetKeys(channels->channelEvents, &keys);
838 if ((nrKeys <= SSIZE_MAX) && (nrKeys == len))
840 for (
size_t x = 0; x < nrKeys; x++)
842 HANDLE cur = (HANDLE)keys[x];
845 rc = (SSIZE_T)nrKeys;
849 HashTable_Unlock(channels->channelEvents);
853UINT freerdp_channels_disconnect(rdpChannels* channels, freerdp* instance)
855 UINT error = CHANNEL_RC_OK;
859 WINPR_ASSERT(channels);
861 if (!channels->connected)
864 (void)freerdp_channels_check_fds(channels, instance);
867 for (
int index = 0; index < channels->clientDataCount; index++)
869 ChannelDisconnectedEventArgs e = { 0 };
870 pChannelClientData = &channels->clientDataList[index];
872 if (pChannelClientData->pChannelInitEventProc)
874 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
875 CHANNEL_EVENT_DISCONNECTED, 0, 0);
877 else if (pChannelClientData->pChannelInitEventProcEx)
879 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
880 pChannelClientData->pInitHandle,
881 CHANNEL_EVENT_DISCONNECTED, 0, 0);
884 if (getChannelError(instance->context) != CHANNEL_RC_OK)
887 pChannelOpenData = &channels->openDataList[index];
888 EventArgsInit(&e,
"freerdp");
889 e.name = pChannelOpenData->name;
890 e.pInterface = pChannelOpenData->pInterface;
891 PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e);
894 channels->connected = FALSE;
897 (void)freerdp_channels_check_fds(channels, instance);
901void freerdp_channels_close(rdpChannels* channels, freerdp* instance)
906 WINPR_ASSERT(channels);
907 WINPR_ASSERT(instance);
909 MessageQueue_PostQuit(channels->queue, 0);
910 (void)freerdp_channels_check_fds(channels, instance);
913 for (
int index = 0; index < channels->clientDataCount; index++)
915 pChannelClientData = &channels->clientDataList[index];
917 if (pChannelClientData->pChannelInitEventProc)
919 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
920 CHANNEL_EVENT_TERMINATED, 0, 0);
922 else if (pChannelClientData->pChannelInitEventProcEx)
924 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
925 pChannelClientData->pInitHandle,
926 CHANNEL_EVENT_TERMINATED, 0, 0);
930 for (
int index = 0; index < channels->openDataCount; index++)
932 pChannelOpenData = &channels->openDataList[index];
933 HashTable_Remove(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle);
936 channels->openDataCount = 0;
937 channels->initDataCount = 0;
938 channels->clientDataCount = 0;
940 WINPR_ASSERT(instance->context);
941 WINPR_ASSERT(instance->context->settings);
942 instance->context->settings->ChannelCount = 0;
946static UINT VCAPITYPE FreeRDP_VirtualChannelInitEx(
947 LPVOID lpUserParam, LPVOID clientContext, LPVOID pInitHandle,
PCHANNEL_DEF pChannel,
948 INT channelCount, ULONG versionRequested, PCHANNEL_INIT_EVENT_EX_FN pChannelInitEventProcEx)
950 rdpSettings* settings = NULL;
953 rdpChannels* channels = NULL;
956 return CHANNEL_RC_BAD_INIT_HANDLE;
959 return CHANNEL_RC_BAD_CHANNEL;
961 if ((channelCount <= 0) || !pChannelInitEventProcEx)
962 return CHANNEL_RC_INITIALIZATION_ERROR;
965 WINPR_ASSERT(pChannelInitData);
967 channels = pChannelInitData->channels;
968 WINPR_ASSERT(channels);
970 if (!channels->can_call_init)
971 return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
973 if ((channels->openDataCount + channelCount) > CHANNEL_MAX_COUNT)
974 return CHANNEL_RC_TOO_MANY_CHANNELS;
976 if (channels->connected)
977 return CHANNEL_RC_ALREADY_CONNECTED;
979 if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
983 for (
int index = 0; index < channelCount; index++)
987 if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) != 0)
989 return CHANNEL_RC_BAD_CHANNEL;
993 pChannelInitData->pInterface = clientContext;
994 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
995 pChannelClientData->pChannelInitEventProcEx = pChannelInitEventProcEx;
996 pChannelClientData->pInitHandle = pInitHandle;
997 pChannelClientData->lpUserParam = lpUserParam;
998 channels->clientDataCount++;
1000 WINPR_ASSERT(channels->instance);
1001 WINPR_ASSERT(channels->instance->context);
1002 settings = channels->instance->context->settings;
1003 WINPR_ASSERT(settings);
1005 for (
int index = 0; index < channelCount; index++)
1008 CHANNEL_OPEN_DATA* pChannelOpenData = &channels->openDataList[channels->openDataCount];
1010 WINPR_ASSERT(pChannelOpenData);
1012 const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1013 pChannelOpenData->OpenHandle = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1014 pChannelOpenData->channels = channels;
1015 pChannelOpenData->lpUserParam = lpUserParam;
1016 if (!HashTable_Insert(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle,
1017 (
void*)pChannelOpenData))
1019 pChannelInitData->pInterface = NULL;
1020 return CHANNEL_RC_INITIALIZATION_ERROR;
1022 pChannelOpenData->flags = 1;
1023 strncpy(pChannelOpenData->name, pChannelDef->name, CHANNEL_NAME_LEN);
1024 pChannelOpenData->options = pChannelDef->options;
1027 WINPR_ASSERT(max >= CHANNEL_MAX_COUNT);
1028 if (settings->ChannelCount < max)
1030 CHANNEL_DEF* channel = freerdp_settings_get_pointer_array_writable(
1031 settings, FreeRDP_ChannelDefArray, settings->ChannelCount);
1034 strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1035 channel->options = pChannelDef->options;
1036 settings->ChannelCount++;
1039 channels->openDataCount++;
1042 return CHANNEL_RC_OK;
1045static UINT VCAPITYPE FreeRDP_VirtualChannelInit(LPVOID* ppInitHandle,
PCHANNEL_DEF pChannel,
1046 INT channelCount, ULONG versionRequested,
1047 PCHANNEL_INIT_EVENT_FN pChannelInitEventProc)
1050 rdpSettings* settings = NULL;
1055 rdpChannels* channels = NULL;
1059 if (!g_Instance || !g_Instance->context)
1060 return CHANNEL_RC_NOT_INITIALIZED;
1062 channels = g_Instance->context->channels;
1064 if (!ppInitHandle || !channels)
1065 return CHANNEL_RC_BAD_INIT_HANDLE;
1068 return CHANNEL_RC_BAD_CHANNEL;
1070 if ((channelCount <= 0) || !pChannelInitEventProc)
1071 return CHANNEL_RC_INITIALIZATION_ERROR;
1073 pChannelInitData = &(channels->initDataList[channels->initDataCount]);
1074 *ppInitHandle = pChannelInitData;
1075 channels->initDataCount++;
1076 pChannelInitData->channels = channels;
1077 pChannelInitData->pInterface = NULL;
1079 if (!channels->can_call_init)
1080 return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
1082 if (channels->openDataCount + channelCount > CHANNEL_MAX_COUNT)
1083 return CHANNEL_RC_TOO_MANY_CHANNELS;
1085 if (channels->connected)
1086 return CHANNEL_RC_ALREADY_CONNECTED;
1088 if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
1092 for (
int index = 0; index < channelCount; index++)
1094 pChannelDef = &pChannel[index];
1096 if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) != 0)
1098 return CHANNEL_RC_BAD_CHANNEL;
1102 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1103 pChannelClientData->pChannelInitEventProc = pChannelInitEventProc;
1104 pChannelClientData->pInitHandle = *ppInitHandle;
1105 channels->clientDataCount++;
1106 settings = channels->instance->context->settings;
1108 for (
int index = 0; index < channelCount; index++)
1112 pChannelDef = &pChannel[index];
1114 pChannelOpenData = &channels->openDataList[channels->openDataCount];
1116 const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1117 pChannelOpenData->OpenHandle = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1118 pChannelOpenData->channels = channels;
1119 if (!HashTable_Insert(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle,
1120 (
void*)pChannelOpenData))
1121 return CHANNEL_RC_INITIALIZATION_ERROR;
1122 pChannelOpenData->flags = 1;
1123 strncpy(pChannelOpenData->name, pChannelDef->name, CHANNEL_NAME_LEN);
1124 pChannelOpenData->options = pChannelDef->options;
1126 if (ChannelCount < CHANNEL_MAX_COUNT)
1128 channel = freerdp_settings_get_pointer_array_writable(settings, FreeRDP_ChannelDefArray,
1130 strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1131 channel->options = pChannelDef->options;
1133 return ERROR_INTERNAL_ERROR;
1136 channels->openDataCount++;
1139 return CHANNEL_RC_OK;
1142static UINT VCAPITYPE
1143FreeRDP_VirtualChannelOpenEx(LPVOID pInitHandle, LPDWORD pOpenHandle, PCHAR pChannelName,
1144 PCHANNEL_OPEN_EVENT_EX_FN pChannelOpenEventProcEx)
1146 void* pInterface = NULL;
1147 rdpChannels* channels = NULL;
1151 channels = pChannelInitData->channels;
1152 pInterface = pChannelInitData->pInterface;
1155 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1157 if (!pChannelOpenEventProcEx)
1158 return CHANNEL_RC_BAD_PROC;
1160 if (!channels->connected)
1161 return CHANNEL_RC_NOT_CONNECTED;
1163 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1165 if (!pChannelOpenData)
1166 return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1168 if (pChannelOpenData->flags == 2)
1169 return CHANNEL_RC_ALREADY_OPEN;
1171 pChannelOpenData->flags = 2;
1172 pChannelOpenData->pInterface = pInterface;
1173 pChannelOpenData->pChannelOpenEventProcEx = pChannelOpenEventProcEx;
1174 *pOpenHandle = pChannelOpenData->OpenHandle;
1175 return CHANNEL_RC_OK;
1178static UINT VCAPITYPE FreeRDP_VirtualChannelOpen(LPVOID pInitHandle, LPDWORD pOpenHandle,
1180 PCHANNEL_OPEN_EVENT_FN pChannelOpenEventProc)
1182 void* pInterface = NULL;
1183 rdpChannels* channels = NULL;
1187 channels = pChannelInitData->channels;
1188 pInterface = pChannelInitData->pInterface;
1191 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1193 if (!pChannelOpenEventProc)
1194 return CHANNEL_RC_BAD_PROC;
1196 if (!channels->connected)
1197 return CHANNEL_RC_NOT_CONNECTED;
1199 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1201 if (!pChannelOpenData)
1202 return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1204 if (pChannelOpenData->flags == 2)
1205 return CHANNEL_RC_ALREADY_OPEN;
1207 pChannelOpenData->flags = 2;
1208 pChannelOpenData->pInterface = pInterface;
1209 pChannelOpenData->pChannelOpenEventProc = pChannelOpenEventProc;
1210 *pOpenHandle = pChannelOpenData->OpenHandle;
1211 return CHANNEL_RC_OK;
1214static UINT VCAPITYPE FreeRDP_VirtualChannelCloseEx(LPVOID pInitHandle, DWORD openHandle)
1219 return CHANNEL_RC_BAD_INIT_HANDLE;
1221 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1223 if (!pChannelOpenData)
1224 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1226 if (pChannelOpenData->flags != 2)
1227 return CHANNEL_RC_NOT_OPEN;
1229 pChannelOpenData->flags = 0;
1230 return CHANNEL_RC_OK;
1233static UINT VCAPITYPE FreeRDP_VirtualChannelClose(DWORD openHandle)
1237 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1239 if (!pChannelOpenData)
1240 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1242 if (pChannelOpenData->flags != 2)
1243 return CHANNEL_RC_NOT_OPEN;
1245 pChannelOpenData->flags = 0;
1246 return CHANNEL_RC_OK;
1249static UINT VCAPITYPE FreeRDP_VirtualChannelWriteEx(LPVOID pInitHandle, DWORD openHandle,
1250 LPVOID pData, ULONG dataLength,
1253 rdpChannels* channels = NULL;
1257 wMessage message = { 0 };
1260 return CHANNEL_RC_BAD_INIT_HANDLE;
1263 channels = pChannelInitData->channels;
1266 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1268 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1270 if (!pChannelOpenData)
1271 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1273 if (!channels->connected)
1274 return CHANNEL_RC_NOT_CONNECTED;
1277 return CHANNEL_RC_NULL_DATA;
1280 return CHANNEL_RC_ZERO_LENGTH;
1282 if (pChannelOpenData->flags != 2)
1283 return CHANNEL_RC_NOT_OPEN;
1287 if (!pChannelOpenEvent)
1288 return CHANNEL_RC_NO_MEMORY;
1290 pChannelOpenEvent->Data = pData;
1291 pChannelOpenEvent->DataLength = dataLength;
1292 pChannelOpenEvent->UserData = pUserData;
1293 pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1294 message.context = channels;
1296 message.wParam = pChannelOpenEvent;
1297 message.lParam = NULL;
1298 message.Free = channel_queue_message_free;
1300 if (!MessageQueue_Dispatch(channels->queue, &message))
1302 free(pChannelOpenEvent);
1303 return CHANNEL_RC_NO_MEMORY;
1306 return CHANNEL_RC_OK;
1309static UINT VCAPITYPE FreeRDP_VirtualChannelWrite(DWORD openHandle, LPVOID pData, ULONG dataLength,
1312 wMessage message = { 0 };
1315 rdpChannels* channels = NULL;
1317 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1319 if (!pChannelOpenData)
1320 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1322 channels = pChannelOpenData->channels;
1324 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1326 if (!channels->connected)
1327 return CHANNEL_RC_NOT_CONNECTED;
1330 return CHANNEL_RC_NULL_DATA;
1333 return CHANNEL_RC_ZERO_LENGTH;
1335 if (pChannelOpenData->flags != 2)
1336 return CHANNEL_RC_NOT_OPEN;
1340 if (!pChannelOpenEvent)
1341 return CHANNEL_RC_NO_MEMORY;
1343 pChannelOpenEvent->Data = pData;
1344 pChannelOpenEvent->DataLength = dataLength;
1345 pChannelOpenEvent->UserData = pUserData;
1346 pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1347 message.context = channels;
1349 message.wParam = pChannelOpenEvent;
1350 message.lParam = NULL;
1351 message.Free = channel_queue_message_free;
1353 if (!MessageQueue_Dispatch(channels->queue, &message))
1355 free(pChannelOpenEvent);
1356 return CHANNEL_RC_NO_MEMORY;
1359 return CHANNEL_RC_OK;
1362static BOOL freerdp_channels_is_loaded(rdpChannels* channels, PVIRTUALCHANNELENTRY entry)
1364 for (
int i = 0; i < channels->clientDataCount; i++)
1368 if (pChannelClientData->entry == entry)
1375static BOOL freerdp_channels_is_loaded_ex(rdpChannels* channels, PVIRTUALCHANNELENTRYEX entryEx)
1377 for (
int i = 0; i < channels->clientDataCount; i++)
1381 if (pChannelClientData->entryEx == entryEx)
1388int freerdp_channels_client_load(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1389 PVIRTUALCHANNELENTRY entry,
void* data)
1395 WINPR_ASSERT(channels);
1396 WINPR_ASSERT(channels->instance);
1397 WINPR_ASSERT(channels->instance->context);
1398 WINPR_ASSERT(entry);
1400 if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1402 WLog_ERR(TAG,
"error: too many channels");
1406 if (freerdp_channels_is_loaded(channels, entry))
1408 WLog_WARN(TAG,
"Skipping, channel already loaded");
1412 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1413 pChannelClientData->entry = entry;
1415 EntryPoints.cbSize =
sizeof(EntryPoints);
1416 EntryPoints.protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000;
1417 EntryPoints.pVirtualChannelInit = FreeRDP_VirtualChannelInit;
1418 EntryPoints.pVirtualChannelOpen = FreeRDP_VirtualChannelOpen;
1419 EntryPoints.pVirtualChannelClose = FreeRDP_VirtualChannelClose;
1420 EntryPoints.pVirtualChannelWrite = FreeRDP_VirtualChannelWrite;
1421 EntryPoints.MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER;
1422 EntryPoints.pExtendedData = data;
1423 EntryPoints.context = channels->instance->context;
1425 channels->can_call_init = TRUE;
1426 EnterCriticalSection(&channels->channelsLock);
1427 status = pChannelClientData->entry((PCHANNEL_ENTRY_POINTS)&EntryPoints);
1428 LeaveCriticalSection(&channels->channelsLock);
1430 channels->can_call_init = FALSE;
1434 WLog_ERR(TAG,
"error: channel export function call failed");
1441int freerdp_channels_client_load_ex(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1442 PVIRTUALCHANNELENTRYEX entryEx,
void* data)
1445 void* pInitHandle = NULL;
1450 WINPR_ASSERT(channels);
1451 WINPR_ASSERT(channels->instance);
1452 WINPR_ASSERT(channels->instance->context);
1453 WINPR_ASSERT(entryEx);
1455 if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1457 WLog_ERR(TAG,
"error: too many channels");
1461 if (freerdp_channels_is_loaded_ex(channels, entryEx))
1463 WLog_WARN(TAG,
"Skipping, channel already loaded");
1467 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1468 pChannelClientData->entryEx = entryEx;
1469 pChannelInitData = &(channels->initDataList[channels->initDataCount++]);
1470 pInitHandle = pChannelInitData;
1471 pChannelInitData->channels = channels;
1472 EntryPointsEx.cbSize =
sizeof(EntryPointsEx);
1473 EntryPointsEx.protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000;
1474 EntryPointsEx.pVirtualChannelInitEx = FreeRDP_VirtualChannelInitEx;
1475 EntryPointsEx.pVirtualChannelOpenEx = FreeRDP_VirtualChannelOpenEx;
1476 EntryPointsEx.pVirtualChannelCloseEx = FreeRDP_VirtualChannelCloseEx;
1477 EntryPointsEx.pVirtualChannelWriteEx = FreeRDP_VirtualChannelWriteEx;
1478 EntryPointsEx.MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER;
1479 EntryPointsEx.pExtendedData = data;
1480 EntryPointsEx.context = channels->instance->context;
1482 channels->can_call_init = TRUE;
1483 EnterCriticalSection(&channels->channelsLock);
1484 status = pChannelClientData->entryEx((PCHANNEL_ENTRY_POINTS_EX)&EntryPointsEx, pInitHandle);
1485 LeaveCriticalSection(&channels->channelsLock);
1487 channels->can_call_init = FALSE;
1491 WLog_ERR(TAG,
"error: channel export function call failed");
1502int freerdp_channels_load_plugin(rdpChannels* channels, rdpSettings* settings,
const char* name,
1505 PVIRTUALCHANNELENTRY entry =
1506 freerdp_load_channel_addin_entry(name, NULL, NULL, FREERDP_ADDIN_CHANNEL_STATIC);
1511 return freerdp_channels_client_load(channels, settings, entry, data);
FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 param)
Sets a UINT32 settings value.
FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
This struct contains function pointer to initialize/free objects.