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;
330 MessageQueue_Clear(channels->queue);
332 for (
int index = 0; index < channels->clientDataCount; index++)
334 pChannelClientData = &channels->clientDataList[index];
336 if (pChannelClientData->pChannelInitEventProc)
338 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
339 CHANNEL_EVENT_INITIALIZED,
nullptr, 0);
341 else if (pChannelClientData->pChannelInitEventProcEx)
343 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
344 pChannelClientData->pInitHandle,
345 CHANNEL_EVENT_INITIALIZED,
nullptr, 0);
348 if (CHANNEL_RC_OK != getChannelError(instance->context))
355UINT freerdp_channels_attach(freerdp* instance)
357 UINT error = CHANNEL_RC_OK;
358 const char* hostname =
nullptr;
359 size_t hostnameLength = 0;
360 rdpChannels* channels =
nullptr;
363 WINPR_ASSERT(instance);
364 WINPR_ASSERT(instance->context);
365 WINPR_ASSERT(instance->context->settings);
367 channels = instance->context->channels;
369 WINPR_ASSERT(hostname);
370 hostnameLength = strnlen(hostname, MAX_PATH);
372 for (
int index = 0; index < channels->clientDataCount; index++)
379 ChannelAttachedEventArgs e = WINPR_C_ARRAY_INIT;
383 pChannelClientData = &channels->clientDataList[index];
385 if (pChannelClientData->pChannelInitEventProc)
388 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
389 CHANNEL_EVENT_ATTACHED, cnv.pv,
390 (UINT)hostnameLength);
392 else if (pChannelClientData->pChannelInitEventProcEx)
394 pChannelClientData->pChannelInitEventProcEx(
395 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
396 CHANNEL_EVENT_ATTACHED, cnv.pv, (UINT)hostnameLength);
399 error = getChannelError(instance->context);
400 if (error != CHANNEL_RC_OK)
403 pChannelOpenData = &channels->openDataList[index];
404 EventArgsInit(&e,
"freerdp");
405 e.name = pChannelOpenData->name;
406 e.pInterface = pChannelOpenData->pInterface;
407 if (PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e) < 0)
409 error = ERROR_INTERNAL_ERROR;
418UINT freerdp_channels_detach(freerdp* instance)
420 UINT error = CHANNEL_RC_OK;
421 const char* hostname =
nullptr;
422 size_t hostnameLength = 0;
423 rdpChannels* channels =
nullptr;
424 rdpContext* context =
nullptr;
427 WINPR_ASSERT(instance);
429 context = instance->context;
430 WINPR_ASSERT(context);
432 channels = context->channels;
433 WINPR_ASSERT(channels);
435 WINPR_ASSERT(context->settings);
437 WINPR_ASSERT(hostname);
438 hostnameLength = strnlen(hostname, MAX_PATH);
440 for (
int index = 0; index < channels->clientDataCount; index++)
448 ChannelDetachedEventArgs e = WINPR_C_ARRAY_INIT;
452 pChannelClientData = &channels->clientDataList[index];
454 if (pChannelClientData->pChannelInitEventProc)
456 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
457 CHANNEL_EVENT_DETACHED, cnv.pv,
458 (UINT)hostnameLength);
460 else if (pChannelClientData->pChannelInitEventProcEx)
462 pChannelClientData->pChannelInitEventProcEx(
463 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
464 CHANNEL_EVENT_DETACHED, cnv.pv, (UINT)hostnameLength);
467 error = getChannelError(context);
468 if (error != CHANNEL_RC_OK)
471 pChannelOpenData = &channels->openDataList[index];
472 EventArgsInit(&e,
"freerdp");
473 e.name = pChannelOpenData->name;
474 e.pInterface = pChannelOpenData->pInterface;
475 if (PubSub_OnChannelDetached(context->pubSub, context, &e) < 0)
477 error = ERROR_INTERNAL_ERROR;
491UINT freerdp_channels_post_connect(rdpChannels* channels, freerdp* instance)
493 UINT error = CHANNEL_RC_OK;
494 const char* hostname =
nullptr;
495 size_t hostnameLength = 0;
498 WINPR_ASSERT(channels);
499 WINPR_ASSERT(instance);
500 WINPR_ASSERT(instance->context);
501 WINPR_ASSERT(instance->context->settings);
503 channels->connected = TRUE;
505 WINPR_ASSERT(hostname);
506 hostnameLength = strnlen(hostname, MAX_PATH);
508 for (
int index = 0; index < channels->clientDataCount; index++)
515 ChannelConnectedEventArgs e = WINPR_C_ARRAY_INIT;
517 pChannelClientData = &channels->clientDataList[index];
520 if (pChannelClientData->pChannelInitEventProc)
522 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
523 CHANNEL_EVENT_CONNECTED, cnv.pb,
524 (UINT)hostnameLength);
526 else if (pChannelClientData->pChannelInitEventProcEx)
528 pChannelClientData->pChannelInitEventProcEx(
529 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
530 CHANNEL_EVENT_CONNECTED, cnv.pb, (UINT)hostnameLength);
533 error = getChannelError(instance->context);
534 if (error != CHANNEL_RC_OK)
537 pChannelOpenData = &channels->openDataList[index];
538 EventArgsInit(&e,
"freerdp");
539 e.name = pChannelOpenData->name;
540 e.pInterface = pChannelOpenData->pInterface;
541 if (PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e) < 0)
543 error = ERROR_INTERNAL_ERROR;
548 channels->drdynvc = (DrdynvcClientContext*)freerdp_channels_get_static_channel_interface(
549 channels, DRDYNVC_SVC_CHANNEL_NAME);
551 if (channels->drdynvc)
553 channels->drdynvc->custom = (
void*)channels;
554 channels->drdynvc->OnChannelConnected = freerdp_drdynvc_on_channel_connected;
555 channels->drdynvc->OnChannelDisconnected = freerdp_drdynvc_on_channel_disconnected;
556 channels->drdynvc->OnChannelAttached = freerdp_drdynvc_on_channel_attached;
557 channels->drdynvc->OnChannelDetached = freerdp_drdynvc_on_channel_detached;
564BOOL freerdp_channels_data(freerdp* instance, UINT16 channelId,
const BYTE* cdata,
size_t dataSize,
565 UINT32 flags,
size_t totalSize)
567 rdpMcs* mcs =
nullptr;
568 rdpChannels* channels =
nullptr;
569 rdpMcsChannel* channel =
nullptr;
578 if (!instance || !data.pcb)
580 WLog_ERR(TAG,
"(%p, %" PRIu16
", %p, 0x%08x): Invalid arguments",
581 WINPR_CXX_COMPAT_CAST(
const void*, instance), channelId,
582 WINPR_CXX_COMPAT_CAST(
const void*, data.pcb), flags);
586 mcs = instance->context->rdp->mcs;
587 channels = instance->context->channels;
589 if (!channels || !mcs)
594 for (UINT32 index = 0; index < mcs->channelCount; index++)
596 rdpMcsChannel* cur = &mcs->channels[index];
598 if (cur->ChannelId == channelId)
610 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, channel->Name);
612 if (!pChannelOpenData)
617 if (pChannelOpenData->pChannelOpenEventProc)
619 pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->OpenHandle,
620 CHANNEL_EVENT_DATA_RECEIVED, data.pb,
621 (UINT32)dataSize, (UINT32)totalSize, flags);
623 else if (pChannelOpenData->pChannelOpenEventProcEx)
625 pChannelOpenData->pChannelOpenEventProcEx(
626 pChannelOpenData->lpUserParam, pChannelOpenData->OpenHandle,
627 CHANNEL_EVENT_DATA_RECEIVED, data.pb, (UINT32)dataSize, (UINT32)totalSize, flags);
633UINT16 freerdp_channels_get_id_by_name(freerdp* instance,
const char* channel_name)
635 if (!instance || !channel_name)
638 rdpMcsChannel* mcsChannel =
639 freerdp_channels_find_channel_by_name(instance->context->rdp, channel_name);
643 return mcsChannel->ChannelId;
646const char* freerdp_channels_get_name_by_id(freerdp* instance, UINT16 channelId)
648 rdpMcsChannel* mcsChannel =
nullptr;
652 mcsChannel = freerdp_channels_find_channel_by_id(instance->context->rdp, channelId);
656 return mcsChannel->Name;
659BOOL freerdp_channels_process_message_free(wMessage* message, DWORD type)
661 if (message->id == WMQ_QUIT)
666 if (message->id == 0)
674 pChannelOpenData = item->pChannelOpenData;
676 if (pChannelOpenData->pChannelOpenEventProc)
678 pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->OpenHandle, type,
679 item->UserData, item->DataLength,
680 item->DataLength, 0);
682 else if (pChannelOpenData->pChannelOpenEventProcEx)
684 pChannelOpenData->pChannelOpenEventProcEx(
685 pChannelOpenData->lpUserParam, pChannelOpenData->OpenHandle, type, item->UserData,
686 item->DataLength, item->DataLength, 0);
693static BOOL freerdp_channels_process_message(freerdp* instance, wMessage* message)
698 WINPR_ASSERT(instance);
699 WINPR_ASSERT(message);
701 if (message->id == WMQ_QUIT)
703 else if (message->id == 0)
705 rdpMcsChannel* channel =
nullptr;
712 pChannelOpenData = item->pChannelOpenData;
713 if (pChannelOpenData->flags != 2)
715 freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_CANCELLED);
719 freerdp_channels_find_channel_by_name(instance->context->rdp, pChannelOpenData->name);
722 ret = instance->SendChannelData(instance, channel->ChannelId, item->Data,
726 if (!freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_COMPLETE))
732 IFCALL(message->Free, message);
739static BOOL freerdp_channels_process_sync(rdpChannels* channels, freerdp* instance)
742 wMessage message = WINPR_C_ARRAY_INIT;
744 WINPR_ASSERT(channels);
746 while (MessageQueue_Peek(channels->queue, &message, TRUE))
748 if (!freerdp_channels_process_message(instance, &message))
758#if defined(WITH_FREERDP_DEPRECATED)
759BOOL freerdp_channels_get_fds(rdpChannels* channels, WINPR_ATTR_UNUSED freerdp* instance,
760 void** read_fds,
int* read_count, WINPR_ATTR_UNUSED
void** write_fds,
761 WINPR_ATTR_UNUSED
int* write_count)
764 pfd = GetEventWaitObject(MessageQueue_Event(channels->queue));
768 read_fds[*read_count] = pfd;
776void* freerdp_channels_get_static_channel_interface(rdpChannels* channels,
const char* name)
778 void* pInterface =
nullptr;
780 freerdp_channels_find_channel_open_data_by_name(channels, name);
782 if (pChannelOpenData)
783 pInterface = pChannelOpenData->pInterface;
788HANDLE freerdp_channels_get_event_handle(freerdp* instance)
791 return INVALID_HANDLE_VALUE;
793 WINPR_ASSERT(instance->context);
795 rdpChannels* channels = instance->context->channels;
796 WINPR_ASSERT(channels);
798 return MessageQueue_Event(channels->queue);
801static BOOL channels_process(
const void* key,
void* value,
void* arg)
803 ChannelEventEntry* entry = value;
804 rdpContext* context = arg;
810 return entry->fkt(context, entry->userdata);
813int freerdp_channels_process_pending_messages(freerdp* instance)
818 WINPR_ASSERT(instance->context);
820 rdpChannels* channels = instance->context->channels;
821 WINPR_ASSERT(channels);
823 const DWORD status = WaitForSingleObject(MessageQueue_Event(channels->queue), 0);
824 if (status == WAIT_OBJECT_0)
826 if (!freerdp_channels_process_sync(channels, instance))
830 if (!HashTable_Foreach(channels->channelEvents, channels_process, instance->context))
839BOOL freerdp_channels_check_fds(rdpChannels* channels, freerdp* instance)
841 WINPR_ASSERT(channels);
842 WINPR_UNUSED(channels);
844 const int rc = freerdp_channels_process_pending_messages(instance);
848BOOL freerdp_client_channel_register(rdpChannels* channels, HANDLE handle,
849 freerdp_channel_handle_fkt_t fkt,
void* userdata)
851 if (!channels || (handle == INVALID_HANDLE_VALUE) || !fkt)
853 WLog_ERR(TAG,
"Invalid function arguments (channels=%p, handle=%p, fkt=%p, userdata=%p",
854 WINPR_FUNC_PTR_CAST(channels,
const void*), handle,
855 WINPR_FUNC_PTR_CAST(fkt,
const void*), userdata);
859 ChannelEventEntry entry = { .fkt = fkt, .userdata = userdata };
860 return HashTable_Insert(channels->channelEvents, handle, &entry);
863BOOL freerdp_client_channel_unregister(rdpChannels* channels, HANDLE handle)
865 if (!channels || (handle == INVALID_HANDLE_VALUE))
867 WLog_ERR(TAG,
"Invalid function arguments (channels=%p, handle=%p",
868 WINPR_CXX_COMPAT_CAST(
const void*, channels), handle);
872 return HashTable_Remove(channels->channelEvents, handle);
875SSIZE_T freerdp_client_channel_get_registered_event_handles(rdpChannels* channels, HANDLE* events,
880 WINPR_ASSERT(channels);
881 WINPR_ASSERT(events || (count == 0));
883 HashTable_Lock(channels->channelEvents);
884 size_t len = HashTable_Count(channels->channelEvents);
887 ULONG_PTR* keys =
nullptr;
888 const size_t nrKeys = HashTable_GetKeys(channels->channelEvents, &keys);
889 if ((nrKeys <= SSIZE_MAX) && (nrKeys == len))
891 for (
size_t x = 0; x < nrKeys; x++)
893 HANDLE cur = (HANDLE)keys[x];
896 rc = (SSIZE_T)nrKeys;
900 HashTable_Unlock(channels->channelEvents);
904UINT freerdp_channels_disconnect(rdpChannels* channels, freerdp* instance)
906 UINT error = CHANNEL_RC_OK;
910 WINPR_ASSERT(channels);
912 if (!channels->connected)
915 freerdp_channels_check_fds(channels, instance);
918 for (
int index = 0; index < channels->clientDataCount; index++)
920 ChannelDisconnectedEventArgs e = WINPR_C_ARRAY_INIT;
921 pChannelClientData = &channels->clientDataList[index];
923 if (pChannelClientData->pChannelInitEventProc)
925 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
926 CHANNEL_EVENT_DISCONNECTED,
nullptr, 0);
928 else if (pChannelClientData->pChannelInitEventProcEx)
930 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
931 pChannelClientData->pInitHandle,
932 CHANNEL_EVENT_DISCONNECTED,
nullptr, 0);
935 pChannelOpenData = &channels->openDataList[index];
936 EventArgsInit(&e,
"freerdp");
937 e.name = pChannelOpenData->name;
938 e.pInterface = pChannelOpenData->pInterface;
939 if (PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e) < 0)
940 error = ERROR_INTERNAL_ERROR;
943 channels->connected = FALSE;
946 freerdp_channels_check_fds(channels, instance);
950void freerdp_channels_close(rdpChannels* channels, freerdp* instance)
955 WINPR_ASSERT(channels);
956 WINPR_ASSERT(instance);
958 MessageQueue_PostQuit(channels->queue, 0);
959 freerdp_channels_check_fds(channels, instance);
962 for (
int index = 0; index < channels->clientDataCount; index++)
964 pChannelClientData = &channels->clientDataList[index];
966 if (pChannelClientData->pChannelInitEventProc)
968 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
969 CHANNEL_EVENT_TERMINATED,
nullptr, 0);
971 else if (pChannelClientData->pChannelInitEventProcEx)
973 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
974 pChannelClientData->pInitHandle,
975 CHANNEL_EVENT_TERMINATED,
nullptr, 0);
979 for (
int index = 0; index < channels->openDataCount; index++)
981 pChannelOpenData = &channels->openDataList[index];
982 HashTable_Remove(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle);
985 channels->openDataCount = 0;
986 channels->initDataCount = 0;
987 channels->clientDataCount = 0;
989 WINPR_ASSERT(instance->context);
990 WINPR_ASSERT(instance->context->settings);
991 instance->context->settings->ChannelCount = 0;
992 g_Instance =
nullptr;
995static UINT VCAPITYPE FreeRDP_VirtualChannelInitEx(
996 LPVOID lpUserParam, LPVOID clientContext, LPVOID pInitHandle,
PCHANNEL_DEF pChannel,
997 INT channelCount, ULONG versionRequested, PCHANNEL_INIT_EVENT_EX_FN pChannelInitEventProcEx)
999 rdpSettings* settings =
nullptr;
1002 rdpChannels* channels =
nullptr;
1005 return CHANNEL_RC_BAD_INIT_HANDLE;
1008 return CHANNEL_RC_BAD_CHANNEL;
1010 if ((channelCount <= 0) || !pChannelInitEventProcEx)
1011 return CHANNEL_RC_INITIALIZATION_ERROR;
1014 WINPR_ASSERT(pChannelInitData);
1016 channels = pChannelInitData->channels;
1017 WINPR_ASSERT(channels);
1019 if (!channels->can_call_init)
1020 return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
1022 if ((channels->openDataCount + channelCount) > CHANNEL_MAX_COUNT)
1023 return CHANNEL_RC_TOO_MANY_CHANNELS;
1025 if (channels->connected)
1026 return CHANNEL_RC_ALREADY_CONNECTED;
1028 if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
1032 for (
int index = 0; index < channelCount; index++)
1036 if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) !=
nullptr)
1038 return CHANNEL_RC_BAD_CHANNEL;
1042 pChannelInitData->pInterface = clientContext;
1043 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1044 pChannelClientData->pChannelInitEventProcEx = pChannelInitEventProcEx;
1045 pChannelClientData->pInitHandle = pInitHandle;
1046 pChannelClientData->lpUserParam = lpUserParam;
1047 channels->clientDataCount++;
1049 WINPR_ASSERT(channels->instance);
1050 WINPR_ASSERT(channels->instance->context);
1051 settings = channels->instance->context->settings;
1052 WINPR_ASSERT(settings);
1054 for (
int index = 0; index < channelCount; index++)
1057 CHANNEL_OPEN_DATA* pChannelOpenData = &channels->openDataList[channels->openDataCount];
1059 WINPR_ASSERT(pChannelOpenData);
1061 const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1062 pChannelOpenData->OpenHandle = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1063 pChannelOpenData->channels = channels;
1064 pChannelOpenData->lpUserParam = lpUserParam;
1065 if (!HashTable_Insert(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle,
1066 (
void*)pChannelOpenData))
1068 pChannelInitData->pInterface =
nullptr;
1069 return CHANNEL_RC_INITIALIZATION_ERROR;
1071 pChannelOpenData->flags = 1;
1072 strncpy(pChannelOpenData->name, pChannelDef->name, CHANNEL_NAME_LEN);
1073 pChannelOpenData->options = pChannelDef->options;
1076 WINPR_ASSERT(max >= CHANNEL_MAX_COUNT);
1077 if (settings->ChannelCount < max)
1079 CHANNEL_DEF* channel = freerdp_settings_get_pointer_array_writable(
1080 settings, FreeRDP_ChannelDefArray, settings->ChannelCount);
1083 strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1084 channel->options = pChannelDef->options;
1085 settings->ChannelCount++;
1088 channels->openDataCount++;
1091 return CHANNEL_RC_OK;
1094static UINT VCAPITYPE FreeRDP_VirtualChannelInit(LPVOID* ppInitHandle,
PCHANNEL_DEF pChannel,
1095 INT channelCount, ULONG versionRequested,
1096 PCHANNEL_INIT_EVENT_FN pChannelInitEventProc)
1099 rdpSettings* settings =
nullptr;
1104 rdpChannels* channels =
nullptr;
1108 if (!g_Instance || !g_Instance->context)
1109 return CHANNEL_RC_NOT_INITIALIZED;
1111 channels = g_Instance->context->channels;
1113 if (!ppInitHandle || !channels)
1114 return CHANNEL_RC_BAD_INIT_HANDLE;
1117 return CHANNEL_RC_BAD_CHANNEL;
1119 if ((channelCount <= 0) || !pChannelInitEventProc)
1120 return CHANNEL_RC_INITIALIZATION_ERROR;
1122 pChannelInitData = &(channels->initDataList[channels->initDataCount]);
1123 *ppInitHandle = pChannelInitData;
1124 channels->initDataCount++;
1125 pChannelInitData->channels = channels;
1126 pChannelInitData->pInterface =
nullptr;
1128 if (!channels->can_call_init)
1129 return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
1131 if (channels->openDataCount + channelCount > CHANNEL_MAX_COUNT)
1132 return CHANNEL_RC_TOO_MANY_CHANNELS;
1134 if (channels->connected)
1135 return CHANNEL_RC_ALREADY_CONNECTED;
1137 if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
1141 for (
int index = 0; index < channelCount; index++)
1143 pChannelDef = &pChannel[index];
1145 if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) !=
nullptr)
1147 return CHANNEL_RC_BAD_CHANNEL;
1151 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1152 pChannelClientData->pChannelInitEventProc = pChannelInitEventProc;
1153 pChannelClientData->pInitHandle = *ppInitHandle;
1154 channels->clientDataCount++;
1155 settings = channels->instance->context->settings;
1157 for (
int index = 0; index < channelCount; index++)
1161 pChannelDef = &pChannel[index];
1163 pChannelOpenData = &channels->openDataList[channels->openDataCount];
1165 const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1166 pChannelOpenData->OpenHandle = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1167 pChannelOpenData->channels = channels;
1168 if (!HashTable_Insert(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->OpenHandle,
1169 (
void*)pChannelOpenData))
1170 return CHANNEL_RC_INITIALIZATION_ERROR;
1171 pChannelOpenData->flags = 1;
1172 strncpy(pChannelOpenData->name, pChannelDef->name, CHANNEL_NAME_LEN);
1173 pChannelOpenData->options = pChannelDef->options;
1175 if (ChannelCount < CHANNEL_MAX_COUNT)
1177 channel = freerdp_settings_get_pointer_array_writable(settings, FreeRDP_ChannelDefArray,
1179 strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1180 channel->options = pChannelDef->options;
1182 return ERROR_INTERNAL_ERROR;
1185 channels->openDataCount++;
1188 return CHANNEL_RC_OK;
1191static UINT VCAPITYPE
1192FreeRDP_VirtualChannelOpenEx(LPVOID pInitHandle, LPDWORD pOpenHandle, PCHAR pChannelName,
1193 PCHANNEL_OPEN_EVENT_EX_FN pChannelOpenEventProcEx)
1195 void* pInterface =
nullptr;
1196 rdpChannels* channels =
nullptr;
1200 channels = pChannelInitData->channels;
1201 pInterface = pChannelInitData->pInterface;
1204 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1206 if (!pChannelOpenEventProcEx)
1207 return CHANNEL_RC_BAD_PROC;
1209 if (!channels->connected)
1210 return CHANNEL_RC_NOT_CONNECTED;
1212 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1214 if (!pChannelOpenData)
1215 return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1217 if (pChannelOpenData->flags == 2)
1218 return CHANNEL_RC_ALREADY_OPEN;
1220 pChannelOpenData->flags = 2;
1221 pChannelOpenData->pInterface = pInterface;
1222 pChannelOpenData->pChannelOpenEventProcEx = pChannelOpenEventProcEx;
1223 *pOpenHandle = pChannelOpenData->OpenHandle;
1224 return CHANNEL_RC_OK;
1227static UINT VCAPITYPE FreeRDP_VirtualChannelOpen(LPVOID pInitHandle, LPDWORD pOpenHandle,
1229 PCHANNEL_OPEN_EVENT_FN pChannelOpenEventProc)
1231 void* pInterface =
nullptr;
1232 rdpChannels* channels =
nullptr;
1236 channels = pChannelInitData->channels;
1237 pInterface = pChannelInitData->pInterface;
1240 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1242 if (!pChannelOpenEventProc)
1243 return CHANNEL_RC_BAD_PROC;
1245 if (!channels->connected)
1246 return CHANNEL_RC_NOT_CONNECTED;
1248 pChannelOpenData = freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1250 if (!pChannelOpenData)
1251 return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1253 if (pChannelOpenData->flags == 2)
1254 return CHANNEL_RC_ALREADY_OPEN;
1256 pChannelOpenData->flags = 2;
1257 pChannelOpenData->pInterface = pInterface;
1258 pChannelOpenData->pChannelOpenEventProc = pChannelOpenEventProc;
1259 *pOpenHandle = pChannelOpenData->OpenHandle;
1260 return CHANNEL_RC_OK;
1263static UINT VCAPITYPE FreeRDP_VirtualChannelCloseEx(LPVOID pInitHandle, DWORD openHandle)
1268 return CHANNEL_RC_BAD_INIT_HANDLE;
1270 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1272 if (!pChannelOpenData)
1273 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1275 if (pChannelOpenData->flags != 2)
1276 return CHANNEL_RC_NOT_OPEN;
1278 pChannelOpenData->flags = 0;
1279 return CHANNEL_RC_OK;
1282static UINT VCAPITYPE FreeRDP_VirtualChannelClose(DWORD openHandle)
1286 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1288 if (!pChannelOpenData)
1289 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1291 if (pChannelOpenData->flags != 2)
1292 return CHANNEL_RC_NOT_OPEN;
1294 pChannelOpenData->flags = 0;
1295 return CHANNEL_RC_OK;
1298static UINT VCAPITYPE FreeRDP_VirtualChannelWriteEx(LPVOID pInitHandle, DWORD openHandle,
1299 LPVOID pData, ULONG dataLength,
1302 rdpChannels* channels =
nullptr;
1306 wMessage message = WINPR_C_ARRAY_INIT;
1309 return CHANNEL_RC_BAD_INIT_HANDLE;
1312 channels = pChannelInitData->channels;
1315 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1317 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1319 if (!pChannelOpenData)
1320 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1322 if (!channels->connected)
1323 return CHANNEL_RC_NOT_CONNECTED;
1326 return CHANNEL_RC_NULL_DATA;
1329 return CHANNEL_RC_ZERO_LENGTH;
1331 if (pChannelOpenData->flags != 2)
1332 return CHANNEL_RC_NOT_OPEN;
1336 if (!pChannelOpenEvent)
1337 return CHANNEL_RC_NO_MEMORY;
1339 pChannelOpenEvent->Data = pData;
1340 pChannelOpenEvent->DataLength = dataLength;
1341 pChannelOpenEvent->UserData = pUserData;
1342 pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1343 message.context = channels;
1345 message.wParam = pChannelOpenEvent;
1346 message.lParam =
nullptr;
1347 message.Free = channel_queue_message_free;
1349 if (!MessageQueue_Dispatch(channels->queue, &message))
1351 free(pChannelOpenEvent);
1352 return CHANNEL_RC_NO_MEMORY;
1355 return CHANNEL_RC_OK;
1358static UINT VCAPITYPE FreeRDP_VirtualChannelWrite(DWORD openHandle, LPVOID pData, ULONG dataLength,
1361 wMessage message = WINPR_C_ARRAY_INIT;
1364 rdpChannels* channels =
nullptr;
1366 pChannelOpenData = HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1368 if (!pChannelOpenData)
1369 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1371 channels = pChannelOpenData->channels;
1373 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1375 if (!channels->connected)
1376 return CHANNEL_RC_NOT_CONNECTED;
1379 return CHANNEL_RC_NULL_DATA;
1382 return CHANNEL_RC_ZERO_LENGTH;
1384 if (pChannelOpenData->flags != 2)
1385 return CHANNEL_RC_NOT_OPEN;
1389 if (!pChannelOpenEvent)
1390 return CHANNEL_RC_NO_MEMORY;
1392 pChannelOpenEvent->Data = pData;
1393 pChannelOpenEvent->DataLength = dataLength;
1394 pChannelOpenEvent->UserData = pUserData;
1395 pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1396 message.context = channels;
1398 message.wParam = pChannelOpenEvent;
1399 message.lParam =
nullptr;
1400 message.Free = channel_queue_message_free;
1402 if (!MessageQueue_Dispatch(channels->queue, &message))
1404 free(pChannelOpenEvent);
1405 return CHANNEL_RC_NO_MEMORY;
1408 return CHANNEL_RC_OK;
1411static BOOL freerdp_channels_is_loaded(rdpChannels* channels, PVIRTUALCHANNELENTRY entry)
1413 for (
int i = 0; i < channels->clientDataCount; i++)
1417 if (pChannelClientData->entry == entry)
1424static BOOL freerdp_channels_is_loaded_ex(rdpChannels* channels, PVIRTUALCHANNELENTRYEX entryEx)
1426 for (
int i = 0; i < channels->clientDataCount; i++)
1430 if (pChannelClientData->entryEx == entryEx)
1437int freerdp_channels_client_load(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1438 PVIRTUALCHANNELENTRY entry,
void* data)
1442 WINPR_ASSERT(channels);
1443 WINPR_ASSERT(channels->instance);
1444 WINPR_ASSERT(channels->instance->context);
1445 WINPR_ASSERT(entry);
1447 if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1449 WLog_ERR(TAG,
"error: too many channels");
1453 if (freerdp_channels_is_loaded(channels, entry))
1455 WLog_WARN(TAG,
"Skipping, channel already loaded");
1459 pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1460 pChannelClientData->entry = entry;
1463 .protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000,
1464 .pVirtualChannelInit = FreeRDP_VirtualChannelInit,
1465 .pVirtualChannelOpen = FreeRDP_VirtualChannelOpen,
1466 .pVirtualChannelClose =
1467 FreeRDP_VirtualChannelClose,
1468 .pVirtualChannelWrite =
1469 FreeRDP_VirtualChannelWrite,
1470 .MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER,
1471 .pExtendedData = data,
1472 .context = channels->instance->context };
1477 PCHANNEL_ENTRY_POINTS px;
1480 ptr.pfx = &EntryPoints;
1482 channels->can_call_init = TRUE;
1483 EnterCriticalSection(&channels->channelsLock);
1484 const BOOL status = pChannelClientData->entry(ptr.px);
1485 LeaveCriticalSection(&channels->channelsLock);
1487 channels->can_call_init = FALSE;
1491 WLog_ERR(TAG,
"error: channel export function call failed");
1498int freerdp_channels_client_load_ex(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1499 PVIRTUALCHANNELENTRYEX entryEx,
void* data)
1501 WINPR_ASSERT(channels);
1502 WINPR_ASSERT(channels->instance);
1503 WINPR_ASSERT(channels->instance->context);
1504 WINPR_ASSERT(entryEx);
1506 if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1508 WLog_ERR(TAG,
"error: too many channels");
1512 if (freerdp_channels_is_loaded_ex(channels, entryEx))
1514 WLog_WARN(TAG,
"Skipping, channel already loaded");
1518 CHANNEL_CLIENT_DATA* pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1519 pChannelClientData->entryEx = entryEx;
1521 CHANNEL_INIT_DATA* pChannelInitData = &(channels->initDataList[channels->initDataCount++]);
1522 void* pInitHandle = pChannelInitData;
1523 pChannelInitData->channels = channels;
1526 .cbSize =
sizeof(EntryPointsEx),
1527 .protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000,
1528 .pVirtualChannelInitEx = FreeRDP_VirtualChannelInitEx,
1529 .pVirtualChannelOpenEx = FreeRDP_VirtualChannelOpenEx,
1530 .pVirtualChannelCloseEx = FreeRDP_VirtualChannelCloseEx,
1531 .pVirtualChannelWriteEx = FreeRDP_VirtualChannelWriteEx,
1532 .MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER,
1533 .pExtendedData = data,
1534 .context = channels->instance->context
1540 PCHANNEL_ENTRY_POINTS_EX px;
1543 ptr.pfx = &EntryPointsEx;
1546 channels->can_call_init = TRUE;
1547 EnterCriticalSection(&channels->channelsLock);
1548 const BOOL status = pChannelClientData->entryEx(ptr.px, pInitHandle);
1549 LeaveCriticalSection(&channels->channelsLock);
1551 channels->can_call_init = FALSE;
1555 WLog_ERR(TAG,
"error: channel export function call failed");
1566int freerdp_channels_load_plugin(rdpChannels* channels, rdpSettings* settings,
const char* name,
1569 PVIRTUALCHANNELENTRY entry =
1570 freerdp_load_channel_addin_entry(name,
nullptr,
nullptr, FREERDP_ADDIN_CHANNEL_STATIC);
1575 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