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 WINPR_ASSERT(channels);
60 for (
int index = 0; index < channels->openDataCount; index++)
64 if (strncmp(name, pChannelOpenData->stats.channelName, CHANNEL_NAME_LEN + 1) == 0)
65 return pChannelOpenData;
72static rdpMcsChannel* freerdp_channels_find_channel_by_name(rdpRdp* rdp,
const char* name)
77 rdpMcs* mcs = rdp->mcs;
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)
98 rdpMcs* mcs = rdp->mcs;
101 for (UINT32 index = 0; index < mcs->channelCount; index++)
103 rdpMcsChannel* channel = &mcs->channels[index];
105 if (channel->ChannelId == channel_id)
114static void channel_queue_message_free(wMessage* msg)
116 if (!msg || (msg->id != 0))
123static void channel_queue_free(
void* obj)
125 wMessage* msg = (wMessage*)obj;
126 freerdp_channels_process_message_free(msg, CHANNEL_EVENT_WRITE_CANCELLED);
127 channel_queue_message_free(msg);
130static BOOL CALLBACK init_channel_handles_table(WINPR_ATTR_UNUSED
PINIT_ONCE once,
131 WINPR_ATTR_UNUSED PVOID param,
132 WINPR_ATTR_UNUSED PVOID* context)
134 g_ChannelHandles = HashTable_New(TRUE);
138static void* channel_event_entry_clone(
const void* data)
140 const ChannelEventEntry* entry = data;
144 ChannelEventEntry* copy = calloc(1,
sizeof(ChannelEventEntry));
151rdpChannels* freerdp_channels_new(freerdp* instance)
153 if (!InitOnceExecuteOnce(&g_ChannelHandlesOnce, init_channel_handles_table,
nullptr,
nullptr))
157 rdpChannels* channels =
nullptr;
158 channels = (rdpChannels*)calloc(1,
sizeof(rdpChannels));
163 if (!g_ChannelHandles)
165 if (!InitializeCriticalSectionAndSpinCount(&channels->channelsLock, 4000))
168 channels->instance = instance;
169 channels->queue = MessageQueue_New(
nullptr);
171 if (!channels->queue)
174 obj = MessageQueue_Object(channels->queue);
177 channels->channelEvents = HashTable_New(FALSE);
178 if (!channels->channelEvents)
181 obj = HashTable_ValueObject(channels->channelEvents);
187 WINPR_PRAGMA_DIAG_PUSH
188 WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
189 freerdp_channels_free(channels);
190 WINPR_PRAGMA_DIAG_POP
194void freerdp_channels_free(rdpChannels* channels)
199 HashTable_Free(channels->channelEvents);
201 DeleteCriticalSection(&channels->channelsLock);
205 MessageQueue_Free(channels->queue);
206 channels->queue =
nullptr;
217static UINT freerdp_drdynvc_on_channel_connected(DrdynvcClientContext* context,
const char* name,
220 UINT status = CHANNEL_RC_OK;
222 WINPR_ASSERT(context);
224 rdpChannels* channels = (rdpChannels*)context->custom;
225 WINPR_ASSERT(channels);
227 freerdp* instance = channels->instance;
228 WINPR_ASSERT(instance);
229 WINPR_ASSERT(instance->context);
231 ChannelConnectedEventArgs e = WINPR_C_ARRAY_INIT;
232 EventArgsInit(&e,
"freerdp");
234 e.pInterface = pInterface;
235 if (PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e) < 0)
236 return ERROR_INTERNAL_ERROR;
245static UINT freerdp_drdynvc_on_channel_disconnected(DrdynvcClientContext* context,
const char* name,
248 UINT status = CHANNEL_RC_OK;
250 WINPR_ASSERT(context);
251 rdpChannels* channels = (rdpChannels*)context->custom;
252 WINPR_ASSERT(channels);
254 freerdp* instance = channels->instance;
255 WINPR_ASSERT(instance);
256 WINPR_ASSERT(instance->context);
258 ChannelDisconnectedEventArgs e = WINPR_C_ARRAY_INIT;
259 EventArgsInit(&e,
"freerdp");
261 e.pInterface = pInterface;
262 if (PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e) < 0)
263 return ERROR_INTERNAL_ERROR;
267static UINT freerdp_drdynvc_on_channel_attached(DrdynvcClientContext* context,
const char* name,
270 UINT status = CHANNEL_RC_OK;
272 WINPR_ASSERT(context);
273 rdpChannels* channels = (rdpChannels*)context->custom;
274 WINPR_ASSERT(channels);
276 freerdp* instance = channels->instance;
277 WINPR_ASSERT(instance);
278 WINPR_ASSERT(instance->context);
280 ChannelAttachedEventArgs e = WINPR_C_ARRAY_INIT;
281 EventArgsInit(&e,
"freerdp");
283 e.pInterface = pInterface;
284 if (PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e) < 0)
285 return ERROR_INTERNAL_ERROR;
289static UINT freerdp_drdynvc_on_channel_detached(DrdynvcClientContext* context,
const char* name,
292 UINT status = CHANNEL_RC_OK;
294 WINPR_ASSERT(context);
295 rdpChannels* channels = (rdpChannels*)context->custom;
296 WINPR_ASSERT(channels);
298 freerdp* instance = channels->instance;
299 WINPR_ASSERT(instance);
300 WINPR_ASSERT(instance->context);
302 ChannelDetachedEventArgs e = WINPR_C_ARRAY_INIT;
303 EventArgsInit(&e,
"freerdp");
305 e.pInterface = pInterface;
306 if (PubSub_OnChannelDetached(instance->context->pubSub, instance->context, &e) < 0)
307 return ERROR_INTERNAL_ERROR;
311void freerdp_channels_register_instance(WINPR_ATTR_UNUSED rdpChannels* channels, freerdp* instance)
313 WINPR_ASSERT(channels);
314 WINPR_ASSERT(instance);
316 g_Instance = instance;
323UINT freerdp_channels_pre_connect(rdpChannels* channels, freerdp* instance)
325 UINT error = CHANNEL_RC_OK;
327 WINPR_ASSERT(channels);
328 WINPR_ASSERT(instance);
330 MessageQueue_Clear(channels->queue);
332 for (
int index = 0; index < channels->clientDataCount; 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 error = getChannelError(instance->context);
349 if (CHANNEL_RC_OK != error)
354 ChannelInitializedEventArgs e = WINPR_C_ARRAY_INIT;
355 EventArgsInit(&e,
"freerdp");
356 e.name = pChannelOpenData->stats.channelName;
357 e.pInterface = pChannelInitData->pInterface;
358 if (PubSub_OnChannelInitialized(instance->context->pubSub, instance->context, &e) < 0)
360 error = ERROR_INTERNAL_ERROR;
368UINT freerdp_channels_attach(freerdp* instance)
370 UINT error = CHANNEL_RC_OK;
372 WINPR_ASSERT(instance);
373 WINPR_ASSERT(instance->context);
374 WINPR_ASSERT(instance->context->settings);
376 rdpChannels* channels = instance->context->channels;
377 const char* hostname =
379 WINPR_ASSERT(hostname);
380 const size_t hostnameLength = strnlen(hostname, MAX_PATH);
382 for (
int index = 0; index < channels->clientDataCount; index++)
389 ChannelAttachedEventArgs e = WINPR_C_ARRAY_INIT;
394 if (pChannelClientData->pChannelInitEventProc)
397 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
398 CHANNEL_EVENT_ATTACHED, cnv.pv,
399 (UINT)hostnameLength);
401 else if (pChannelClientData->pChannelInitEventProcEx)
403 pChannelClientData->pChannelInitEventProcEx(
404 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
405 CHANNEL_EVENT_ATTACHED, cnv.pv, (UINT)hostnameLength);
408 error = getChannelError(instance->context);
409 if (error != CHANNEL_RC_OK)
413 EventArgsInit(&e,
"freerdp");
414 e.name = pChannelOpenData->stats.channelName;
415 e.pInterface = pChannelOpenData->pInterface;
416 if (PubSub_OnChannelAttached(instance->context->pubSub, instance->context, &e) < 0)
418 error = ERROR_INTERNAL_ERROR;
427UINT freerdp_channels_detach(freerdp* instance)
429 UINT error = CHANNEL_RC_OK;
431 WINPR_ASSERT(instance);
433 rdpContext* context = instance->context;
434 WINPR_ASSERT(context);
436 rdpChannels* channels = context->channels;
437 WINPR_ASSERT(channels);
439 WINPR_ASSERT(context->settings);
441 WINPR_ASSERT(hostname);
442 const size_t hostnameLength = strnlen(hostname, MAX_PATH);
444 for (
int index = 0; index < channels->clientDataCount; index++)
452 ChannelDetachedEventArgs e = WINPR_C_ARRAY_INIT;
457 if (pChannelClientData->pChannelInitEventProc)
459 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
460 CHANNEL_EVENT_DETACHED, cnv.pv,
461 (UINT)hostnameLength);
463 else if (pChannelClientData->pChannelInitEventProcEx)
465 pChannelClientData->pChannelInitEventProcEx(
466 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
467 CHANNEL_EVENT_DETACHED, cnv.pv, (UINT)hostnameLength);
470 error = getChannelError(context);
471 if (error != CHANNEL_RC_OK)
475 EventArgsInit(&e,
"freerdp");
476 e.name = pChannelOpenData->stats.channelName;
477 e.pInterface = pChannelOpenData->pInterface;
478 if (PubSub_OnChannelDetached(context->pubSub, context, &e) < 0)
480 error = ERROR_INTERNAL_ERROR;
494UINT freerdp_channels_post_connect(rdpChannels* channels, freerdp* instance)
496 UINT error = CHANNEL_RC_OK;
498 WINPR_ASSERT(channels);
499 WINPR_ASSERT(instance);
500 WINPR_ASSERT(instance->context);
501 WINPR_ASSERT(instance->context->settings);
503 channels->connected = TRUE;
504 const char* hostname =
506 WINPR_ASSERT(hostname);
507 const size_t hostnameLength = strnlen(hostname, MAX_PATH);
509 for (
int index = 0; index < channels->clientDataCount; index++)
521 if (pChannelClientData->pChannelInitEventProc)
523 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
524 CHANNEL_EVENT_CONNECTED, cnv.pb,
525 (UINT)hostnameLength);
527 else if (pChannelClientData->pChannelInitEventProcEx)
529 pChannelClientData->pChannelInitEventProcEx(
530 pChannelClientData->lpUserParam, pChannelClientData->pInitHandle,
531 CHANNEL_EVENT_CONNECTED, cnv.pb, (UINT)hostnameLength);
534 error = getChannelError(instance->context);
535 if (error != CHANNEL_RC_OK)
538 ChannelConnectedEventArgs e = WINPR_C_ARRAY_INIT;
539 EventArgsInit(&e,
"freerdp");
540 e.name = pChannelOpenData->stats.channelName;
541 e.pInterface = pChannelOpenData->pInterface;
542 if (PubSub_OnChannelConnected(instance->context->pubSub, instance->context, &e) < 0)
544 error = ERROR_INTERNAL_ERROR;
549 channels->drdynvc = (DrdynvcClientContext*)freerdp_channels_get_static_channel_interface(
550 channels, DRDYNVC_SVC_CHANNEL_NAME);
552 if (channels->drdynvc)
554 channels->drdynvc->custom = (
void*)channels;
555 channels->drdynvc->OnChannelConnected = freerdp_drdynvc_on_channel_connected;
556 channels->drdynvc->OnChannelDisconnected = freerdp_drdynvc_on_channel_disconnected;
557 channels->drdynvc->OnChannelAttached = freerdp_drdynvc_on_channel_attached;
558 channels->drdynvc->OnChannelDetached = freerdp_drdynvc_on_channel_detached;
565BOOL freerdp_channels_data(freerdp* instance, UINT16 channelId,
const BYTE* cdata,
size_t dataSize,
566 UINT32 flags,
size_t totalSize)
575 if (!instance || !data.pcb)
577 WLog_ERR(TAG,
"(%p, %" PRIu16
", %p, 0x%08x): Invalid arguments",
578 WINPR_CXX_COMPAT_CAST(
const void*, instance), channelId,
579 WINPR_CXX_COMPAT_CAST(
const void*, data.pcb), flags);
583 WINPR_ASSERT(instance->context);
584 WINPR_ASSERT(instance->context->rdp);
586 rdpMcs* mcs = instance->context->rdp->mcs;
589 rdpChannels* channels = instance->context->channels;
590 WINPR_ASSERT(channels);
592 if (!channels || !mcs)
597 rdpMcsChannel* channel =
nullptr;
598 for (UINT32 index = 0; index < mcs->channelCount; index++)
600 rdpMcsChannel* cur = &mcs->channels[index];
602 if (cur->ChannelId == channelId)
615 freerdp_channels_find_channel_open_data_by_name(channels, channel->Name);
617 if (!pChannelOpenData)
622 pChannelOpenData->stats.bytesIn += dataSize;
623 pChannelOpenData->stats.fragmentsIn++;
624 if ((flags & CHANNEL_FLAG_LAST) != 0)
625 pChannelOpenData->stats.packetsIn++;
627 if (pChannelOpenData->pChannelOpenEventProc)
629 pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->stats.channelId,
630 CHANNEL_EVENT_DATA_RECEIVED, data.pb,
631 (UINT32)dataSize, (UINT32)totalSize, flags);
633 else if (pChannelOpenData->pChannelOpenEventProcEx)
635 pChannelOpenData->pChannelOpenEventProcEx(
636 pChannelOpenData->lpUserParam, pChannelOpenData->stats.channelId,
637 CHANNEL_EVENT_DATA_RECEIVED, data.pb, (UINT32)dataSize, (UINT32)totalSize, flags);
643UINT16 freerdp_channels_get_id_by_name(freerdp* instance,
const char* channel_name)
645 if (!instance || !channel_name)
648 WINPR_ASSERT(instance->context);
649 WINPR_ASSERT(instance->context->rdp);
650 rdpMcsChannel* mcsChannel =
651 freerdp_channels_find_channel_by_name(instance->context->rdp, channel_name);
655 return mcsChannel->ChannelId;
658const char* freerdp_channels_get_name_by_id(freerdp* instance, UINT16 channelId)
663 WINPR_ASSERT(instance->context);
664 WINPR_ASSERT(instance->context->rdp);
665 rdpMcsChannel* mcsChannel =
666 freerdp_channels_find_channel_by_id(instance->context->rdp, channelId);
670 return mcsChannel->Name;
673BOOL freerdp_channels_process_message_free(wMessage* message, DWORD type)
675 WINPR_ASSERT(message);
677 if (message->id == WMQ_QUIT)
682 if (message->id == 0)
691 if (pChannelOpenData->pChannelOpenEventProc)
693 pChannelOpenData->pChannelOpenEventProc(pChannelOpenData->stats.channelId, type,
694 item->UserData, item->DataLength,
695 item->DataLength, 0);
697 else if (pChannelOpenData->pChannelOpenEventProcEx)
699 pChannelOpenData->pChannelOpenEventProcEx(
700 pChannelOpenData->lpUserParam, pChannelOpenData->stats.channelId, type,
701 item->UserData, item->DataLength, item->DataLength, 0);
708static BOOL freerdp_channels_process_message(freerdp* instance, wMessage* message)
713 WINPR_ASSERT(instance);
714 WINPR_ASSERT(instance->context);
715 WINPR_ASSERT(message);
717 if (message->id == WMQ_QUIT)
719 else if (message->id == 0)
728 if (pChannelOpenData->flags != 2)
730 freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_CANCELLED);
733 rdpMcsChannel* channel = freerdp_channels_find_channel_by_name(
734 instance->context->rdp, pChannelOpenData->stats.channelName);
738 pChannelOpenData->stats.bytesOut += item->DataLength;
739 pChannelOpenData->stats.packetsOut++;
741 const UINT32 VCChunkSize =
743 if (VCChunkSize == 0)
745 const uint64_t frags = (1ull * item->DataLength + VCChunkSize - 1ull) / VCChunkSize;
746 pChannelOpenData->stats.fragmentsOut += frags;
747 ret = instance->SendChannelData(instance, channel->ChannelId, item->Data,
752 if (!freerdp_channels_process_message_free(message, CHANNEL_EVENT_WRITE_COMPLETE))
758 IFCALL(message->Free, message);
765static BOOL freerdp_channels_process_sync(rdpChannels* channels, freerdp* instance)
768 wMessage message = WINPR_C_ARRAY_INIT;
770 WINPR_ASSERT(channels);
772 while (MessageQueue_Peek(channels->queue, &message, TRUE))
774 if (!freerdp_channels_process_message(instance, &message))
784#if defined(WITH_FREERDP_DEPRECATED)
785BOOL freerdp_channels_get_fds(rdpChannels* channels, WINPR_ATTR_UNUSED freerdp* instance,
786 void** read_fds,
int* read_count, WINPR_ATTR_UNUSED
void** write_fds,
787 WINPR_ATTR_UNUSED
int* write_count)
790 pfd = GetEventWaitObject(MessageQueue_Event(channels->queue));
794 read_fds[*read_count] = pfd;
802void* freerdp_channels_get_static_channel_interface(rdpChannels* channels,
const char* name)
804 void* pInterface =
nullptr;
806 freerdp_channels_find_channel_open_data_by_name(channels, name);
808 if (pChannelOpenData)
809 pInterface = pChannelOpenData->pInterface;
814HANDLE freerdp_channels_get_event_handle(freerdp* instance)
817 return INVALID_HANDLE_VALUE;
819 WINPR_ASSERT(instance->context);
821 rdpChannels* channels = instance->context->channels;
822 WINPR_ASSERT(channels);
824 return MessageQueue_Event(channels->queue);
827static BOOL channels_process(
const void* key,
void* value,
void* arg)
829 ChannelEventEntry* entry = value;
830 rdpContext* context = arg;
837 return entry->fkt(context, entry->userdata);
840int freerdp_channels_process_pending_messages(freerdp* instance)
845 WINPR_ASSERT(instance->context);
847 rdpChannels* channels = instance->context->channels;
848 WINPR_ASSERT(channels);
850 const DWORD status = WaitForSingleObject(MessageQueue_Event(channels->queue), 0);
851 if (status == WAIT_OBJECT_0)
853 if (!freerdp_channels_process_sync(channels, instance))
857 if (!HashTable_Foreach(channels->channelEvents, channels_process, instance->context))
866BOOL freerdp_channels_check_fds(rdpChannels* channels, freerdp* instance)
868 WINPR_ASSERT(channels);
869 WINPR_UNUSED(channels);
871 const int rc = freerdp_channels_process_pending_messages(instance);
875BOOL freerdp_client_channel_register(rdpChannels* channels, HANDLE handle,
876 freerdp_channel_handle_fkt_t fkt,
void* userdata)
878 if (!channels || (handle == INVALID_HANDLE_VALUE) || !fkt)
880 WLog_ERR(TAG,
"Invalid function arguments (channels=%p, handle=%p, fkt=%p, userdata=%p",
881 WINPR_FUNC_PTR_CAST(channels,
const void*), handle,
882 WINPR_FUNC_PTR_CAST(fkt,
const void*), userdata);
886 ChannelEventEntry entry = { .fkt = fkt, .userdata = userdata };
887 return HashTable_Insert(channels->channelEvents, handle, &entry);
890BOOL freerdp_client_channel_unregister(rdpChannels* channels, HANDLE handle)
892 if (!channels || (handle == INVALID_HANDLE_VALUE))
894 WLog_ERR(TAG,
"Invalid function arguments (channels=%p, handle=%p",
895 WINPR_CXX_COMPAT_CAST(
const void*, channels), handle);
899 return HashTable_Remove(channels->channelEvents, handle);
902SSIZE_T freerdp_client_channel_get_registered_event_handles(rdpChannels* channels, HANDLE* events,
907 WINPR_ASSERT(channels);
908 WINPR_ASSERT(events || (count == 0));
910 HashTable_Lock(channels->channelEvents);
911 size_t len = HashTable_Count(channels->channelEvents);
914 ULONG_PTR* keys =
nullptr;
915 const size_t nrKeys = HashTable_GetKeys(channels->channelEvents, &keys);
916 if ((nrKeys <= SSIZE_MAX) && (nrKeys == len))
918 for (
size_t x = 0; x < nrKeys; x++)
920 HANDLE cur = (HANDLE)keys[x];
923 rc = (SSIZE_T)nrKeys;
927 HashTable_Unlock(channels->channelEvents);
931UINT freerdp_channels_disconnect(rdpChannels* channels, freerdp* instance)
933 UINT error = CHANNEL_RC_OK;
935 WINPR_ASSERT(channels);
937 if (!channels->connected)
940 freerdp_channels_check_fds(channels, instance);
943 for (
int index = 0; index < channels->clientDataCount; index++)
945 ChannelDisconnectedEventArgs e = WINPR_C_ARRAY_INIT;
948 if (pChannelClientData->pChannelInitEventProc)
950 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
951 CHANNEL_EVENT_DISCONNECTED,
nullptr, 0);
953 else if (pChannelClientData->pChannelInitEventProcEx)
955 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
956 pChannelClientData->pInitHandle,
957 CHANNEL_EVENT_DISCONNECTED,
nullptr, 0);
961 EventArgsInit(&e,
"freerdp");
962 e.name = pChannelOpenData->stats.channelName;
963 e.pInterface = pChannelOpenData->pInterface;
964 if (PubSub_OnChannelDisconnected(instance->context->pubSub, instance->context, &e) < 0)
965 error = ERROR_INTERNAL_ERROR;
968 channels->connected = FALSE;
971 freerdp_channels_check_fds(channels, instance);
975void freerdp_channels_close(rdpChannels* channels, freerdp* instance)
977 WINPR_ASSERT(channels);
978 WINPR_ASSERT(instance);
980 MessageQueue_PostQuit(channels->queue, 0);
981 freerdp_channels_check_fds(channels, instance);
984 for (
int index = 0; index < channels->clientDataCount; index++)
988 if (pChannelClientData->pChannelInitEventProc)
990 pChannelClientData->pChannelInitEventProc(pChannelClientData->pInitHandle,
991 CHANNEL_EVENT_TERMINATED,
nullptr, 0);
993 else if (pChannelClientData->pChannelInitEventProcEx)
995 pChannelClientData->pChannelInitEventProcEx(pChannelClientData->lpUserParam,
996 pChannelClientData->pInitHandle,
997 CHANNEL_EVENT_TERMINATED,
nullptr, 0);
1002 ChannelTerminatedEventArgs e = WINPR_C_ARRAY_INIT;
1003 EventArgsInit(&e,
"freerdp");
1004 e.name = pChannelOpenData->stats.channelName;
1005 e.pInterface = pChannelInitData->pInterface;
1006 if (PubSub_OnChannelTerminated(instance->context->pubSub, instance->context, &e) < 0)
1008 WLog_WARN(TAG,
"PubSub_OnChannelTerminated(%s) failed",
1009 pChannelOpenData->stats.channelName);
1013 for (
int index = 0; index < channels->openDataCount; index++)
1016 HashTable_Remove(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->stats.channelId);
1019 channels->openDataCount = 0;
1020 channels->initDataCount = 0;
1021 channels->clientDataCount = 0;
1023 WINPR_ASSERT(instance->context);
1024 WINPR_ASSERT(instance->context->settings);
1025 instance->context->settings->ChannelCount = 0;
1026 g_Instance =
nullptr;
1029static UINT VCAPITYPE FreeRDP_VirtualChannelInitEx(
1030 LPVOID lpUserParam, LPVOID clientContext, LPVOID pInitHandle,
PCHANNEL_DEF pChannel,
1031 INT channelCount, ULONG versionRequested, PCHANNEL_INIT_EVENT_EX_FN pChannelInitEventProcEx)
1034 return CHANNEL_RC_BAD_INIT_HANDLE;
1037 return CHANNEL_RC_BAD_CHANNEL;
1039 if ((channelCount <= 0) || !pChannelInitEventProcEx)
1040 return CHANNEL_RC_INITIALIZATION_ERROR;
1043 WINPR_ASSERT(pChannelInitData);
1045 rdpChannels* channels = pChannelInitData->channels;
1046 WINPR_ASSERT(channels);
1048 if (!channels->can_call_init)
1049 return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
1051 if ((channels->openDataCount + channelCount) > CHANNEL_MAX_COUNT)
1052 return CHANNEL_RC_TOO_MANY_CHANNELS;
1054 if (channels->connected)
1055 return CHANNEL_RC_ALREADY_CONNECTED;
1057 if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
1061 for (
int index = 0; index < channelCount; index++)
1065 if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) !=
nullptr)
1067 return CHANNEL_RC_BAD_CHANNEL;
1071 pChannelInitData->pInterface = clientContext;
1073 CHANNEL_CLIENT_DATA* pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1074 pChannelClientData->pChannelInitEventProcEx = pChannelInitEventProcEx;
1075 pChannelClientData->pInitHandle = pInitHandle;
1076 pChannelClientData->lpUserParam = lpUserParam;
1077 channels->clientDataCount++;
1079 WINPR_ASSERT(channels->instance);
1080 WINPR_ASSERT(channels->instance->context);
1082 rdpSettings* settings = channels->instance->context->settings;
1083 WINPR_ASSERT(settings);
1085 for (
int index = 0; index < channelCount; index++)
1088 CHANNEL_OPEN_DATA* pChannelOpenData = &channels->openDataList[channels->openDataCount];
1090 WINPR_ASSERT(pChannelOpenData);
1092 const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1093 pChannelOpenData->stats.channelId = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1094 pChannelOpenData->channels = channels;
1095 pChannelOpenData->lpUserParam = lpUserParam;
1096 if (!HashTable_Insert(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->stats.channelId,
1097 (
void*)pChannelOpenData))
1099 pChannelInitData->pInterface =
nullptr;
1100 return CHANNEL_RC_INITIALIZATION_ERROR;
1102 pChannelOpenData->flags = 1;
1103 strncpy(pChannelOpenData->stats.channelName, pChannelDef->name, CHANNEL_NAME_LEN);
1104 pChannelOpenData->options = pChannelDef->options;
1107 WINPR_ASSERT(max >= CHANNEL_MAX_COUNT);
1108 if (settings->ChannelCount < max)
1110 CHANNEL_DEF* channel = freerdp_settings_get_pointer_array_writable(
1111 settings, FreeRDP_ChannelDefArray, settings->ChannelCount);
1114 strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1115 channel->options = pChannelDef->options;
1116 settings->ChannelCount++;
1119 channels->openDataCount++;
1122 return CHANNEL_RC_OK;
1125static UINT VCAPITYPE FreeRDP_VirtualChannelInit(LPVOID* ppInitHandle,
PCHANNEL_DEF pChannel,
1126 INT channelCount, ULONG versionRequested,
1127 PCHANNEL_INIT_EVENT_FN pChannelInitEventProc)
1131 if (!g_Instance || !g_Instance->context)
1132 return CHANNEL_RC_NOT_INITIALIZED;
1134 rdpChannels* channels = g_Instance->context->channels;
1136 if (!ppInitHandle || !channels)
1137 return CHANNEL_RC_BAD_INIT_HANDLE;
1140 return CHANNEL_RC_BAD_CHANNEL;
1142 if ((channelCount <= 0) || !pChannelInitEventProc)
1143 return CHANNEL_RC_INITIALIZATION_ERROR;
1145 CHANNEL_INIT_DATA* pChannelInitData = &(channels->initDataList[channels->initDataCount]);
1146 *ppInitHandle = pChannelInitData;
1147 channels->initDataCount++;
1148 pChannelInitData->channels = channels;
1149 pChannelInitData->pInterface =
nullptr;
1151 if (!channels->can_call_init)
1152 return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY;
1154 if (channels->openDataCount + channelCount > CHANNEL_MAX_COUNT)
1155 return CHANNEL_RC_TOO_MANY_CHANNELS;
1157 if (channels->connected)
1158 return CHANNEL_RC_ALREADY_CONNECTED;
1160 if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000)
1165 for (
int index = 0; index < channelCount; index++)
1167 pChannelDef = &pChannel[index];
1169 if (freerdp_channels_find_channel_open_data_by_name(channels, pChannelDef->name) !=
nullptr)
1171 return CHANNEL_RC_BAD_CHANNEL;
1175 CHANNEL_CLIENT_DATA* pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1176 pChannelClientData->pChannelInitEventProc = pChannelInitEventProc;
1177 pChannelClientData->pInitHandle = *ppInitHandle;
1178 channels->clientDataCount++;
1180 rdpSettings* settings = channels->instance->context->settings;
1182 for (
int index = 0; index < channelCount; index++)
1186 CHANNEL_OPEN_DATA* pChannelOpenData = &channels->openDataList[channels->openDataCount];
1188 const LONG hdl = InterlockedIncrement(&g_OpenHandleSeq);
1189 pChannelOpenData->stats.channelId = WINPR_ASSERTING_INT_CAST(uint32_t, hdl);
1190 pChannelOpenData->channels = channels;
1191 if (!HashTable_Insert(g_ChannelHandles, (
void*)(UINT_PTR)pChannelOpenData->stats.channelId,
1192 (
void*)pChannelOpenData))
1193 return CHANNEL_RC_INITIALIZATION_ERROR;
1194 pChannelOpenData->flags = 1;
1195 strncpy(pChannelOpenData->stats.channelName, pChannelDef->name, CHANNEL_NAME_LEN);
1196 pChannelOpenData->options = pChannelDef->options;
1198 if (ChannelCount < CHANNEL_MAX_COUNT)
1200 CHANNEL_DEF* channel = freerdp_settings_get_pointer_array_writable(
1201 settings, FreeRDP_ChannelDefArray, ChannelCount++);
1202 strncpy(channel->name, pChannelDef->name, CHANNEL_NAME_LEN);
1203 channel->options = pChannelDef->options;
1205 return ERROR_INTERNAL_ERROR;
1208 channels->openDataCount++;
1211 return CHANNEL_RC_OK;
1214static UINT VCAPITYPE
1215FreeRDP_VirtualChannelOpenEx(LPVOID pInitHandle, LPDWORD pOpenHandle, PCHAR pChannelName,
1216 PCHANNEL_OPEN_EVENT_EX_FN pChannelOpenEventProcEx)
1219 WINPR_ASSERT(pChannelInitData);
1221 rdpChannels* channels = pChannelInitData->channels;
1222 WINPR_ASSERT(channels);
1224 void* pInterface = pChannelInitData->pInterface;
1227 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1229 if (!pChannelOpenEventProcEx)
1230 return CHANNEL_RC_BAD_PROC;
1232 if (!channels->connected)
1233 return CHANNEL_RC_NOT_CONNECTED;
1236 freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1238 if (!pChannelOpenData)
1239 return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1241 if (pChannelOpenData->flags == 2)
1242 return CHANNEL_RC_ALREADY_OPEN;
1244 pChannelOpenData->flags = 2;
1245 pChannelOpenData->pInterface = pInterface;
1246 pChannelOpenData->pChannelOpenEventProcEx = pChannelOpenEventProcEx;
1247 *pOpenHandle = pChannelOpenData->stats.channelId;
1248 return CHANNEL_RC_OK;
1251static UINT VCAPITYPE FreeRDP_VirtualChannelOpen(LPVOID pInitHandle, LPDWORD pOpenHandle,
1253 PCHANNEL_OPEN_EVENT_FN pChannelOpenEventProc)
1256 WINPR_ASSERT(pChannelInitData);
1258 rdpChannels* channels = pChannelInitData->channels;
1259 void* pInterface = pChannelInitData->pInterface;
1262 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1264 if (!pChannelOpenEventProc)
1265 return CHANNEL_RC_BAD_PROC;
1267 if (!channels->connected)
1268 return CHANNEL_RC_NOT_CONNECTED;
1271 freerdp_channels_find_channel_open_data_by_name(channels, pChannelName);
1273 if (!pChannelOpenData)
1274 return CHANNEL_RC_UNKNOWN_CHANNEL_NAME;
1276 if (pChannelOpenData->flags == 2)
1277 return CHANNEL_RC_ALREADY_OPEN;
1279 pChannelOpenData->flags = 2;
1280 pChannelOpenData->pInterface = pInterface;
1281 pChannelOpenData->pChannelOpenEventProc = pChannelOpenEventProc;
1282 *pOpenHandle = pChannelOpenData->stats.channelId;
1283 return CHANNEL_RC_OK;
1286static UINT VCAPITYPE FreeRDP_VirtualChannelCloseEx(LPVOID pInitHandle, DWORD openHandle)
1289 return CHANNEL_RC_BAD_INIT_HANDLE;
1292 HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1294 if (!pChannelOpenData)
1295 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1297 if (pChannelOpenData->flags != 2)
1298 return CHANNEL_RC_NOT_OPEN;
1300 pChannelOpenData->flags = 0;
1301 return CHANNEL_RC_OK;
1304static UINT VCAPITYPE FreeRDP_VirtualChannelClose(DWORD openHandle)
1307 HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1309 if (!pChannelOpenData)
1310 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1312 if (pChannelOpenData->flags != 2)
1313 return CHANNEL_RC_NOT_OPEN;
1315 pChannelOpenData->flags = 0;
1316 return CHANNEL_RC_OK;
1319static UINT VCAPITYPE FreeRDP_VirtualChannelWriteEx(LPVOID pInitHandle, DWORD openHandle,
1320 LPVOID pData, ULONG dataLength,
1324 return CHANNEL_RC_BAD_INIT_HANDLE;
1327 rdpChannels* channels = pChannelInitData->channels;
1330 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1333 HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1335 if (!pChannelOpenData)
1336 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1338 if (!channels->connected)
1339 return CHANNEL_RC_NOT_CONNECTED;
1342 return CHANNEL_RC_NULL_DATA;
1345 return CHANNEL_RC_ZERO_LENGTH;
1347 if (pChannelOpenData->flags != 2)
1348 return CHANNEL_RC_NOT_OPEN;
1352 if (!pChannelOpenEvent)
1353 return CHANNEL_RC_NO_MEMORY;
1355 pChannelOpenEvent->Data = pData;
1356 pChannelOpenEvent->DataLength = dataLength;
1357 pChannelOpenEvent->UserData = pUserData;
1358 pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1360 const wMessage message = { .context = channels,
1362 .wParam = pChannelOpenEvent,
1364 .Free = channel_queue_message_free };
1366 if (!MessageQueue_Dispatch(channels->queue, &message))
1368 free(pChannelOpenEvent);
1369 return CHANNEL_RC_NO_MEMORY;
1372 return CHANNEL_RC_OK;
1375static UINT VCAPITYPE FreeRDP_VirtualChannelWrite(DWORD openHandle, LPVOID pData, ULONG dataLength,
1379 HashTable_GetItemValue(g_ChannelHandles, (
void*)(UINT_PTR)openHandle);
1381 if (!pChannelOpenData)
1382 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1384 rdpChannels* channels = pChannelOpenData->channels;
1386 return CHANNEL_RC_BAD_CHANNEL_HANDLE;
1388 if (!channels->connected)
1389 return CHANNEL_RC_NOT_CONNECTED;
1392 return CHANNEL_RC_NULL_DATA;
1395 return CHANNEL_RC_ZERO_LENGTH;
1397 if (pChannelOpenData->flags != 2)
1398 return CHANNEL_RC_NOT_OPEN;
1402 if (!pChannelOpenEvent)
1403 return CHANNEL_RC_NO_MEMORY;
1405 pChannelOpenEvent->Data = pData;
1406 pChannelOpenEvent->DataLength = dataLength;
1407 pChannelOpenEvent->UserData = pUserData;
1408 pChannelOpenEvent->pChannelOpenData = pChannelOpenData;
1410 const wMessage message = { .context = channels,
1412 .wParam = pChannelOpenEvent,
1414 .Free = channel_queue_message_free };
1416 if (!MessageQueue_Dispatch(channels->queue, &message))
1418 free(pChannelOpenEvent);
1419 return CHANNEL_RC_NO_MEMORY;
1422 return CHANNEL_RC_OK;
1425static BOOL freerdp_channels_is_loaded(rdpChannels* channels, PVIRTUALCHANNELENTRY entry)
1427 WINPR_ASSERT(channels);
1428 for (
int i = 0; i < channels->clientDataCount; i++)
1432 if (pChannelClientData->entry == entry)
1439static BOOL freerdp_channels_is_loaded_ex(rdpChannels* channels, PVIRTUALCHANNELENTRYEX entryEx)
1441 WINPR_ASSERT(channels);
1442 for (
int i = 0; i < channels->clientDataCount; i++)
1446 if (pChannelClientData->entryEx == entryEx)
1462 WINPR_ASSERT(channels);
1464 if (channels->openDataCount <= 0)
1467 const size_t odc = WINPR_ASSERTING_INT_CAST(
size_t, channels->openDataCount);
1472 for (
int i = 0; i < channels->openDataCount; i++)
1477 *stat = pChannelClientData->stats;
1486 statsw->count = odc;
1487 statsw->stats = stats;
1491int freerdp_channels_client_load(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1492 PVIRTUALCHANNELENTRY entry,
void* data)
1494 WINPR_ASSERT(channels);
1495 WINPR_ASSERT(channels->instance);
1496 WINPR_ASSERT(channels->instance->context);
1497 WINPR_ASSERT(entry);
1499 if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1501 WLog_ERR(TAG,
"error: too many channels");
1505 if (freerdp_channels_is_loaded(channels, entry))
1507 WLog_WARN(TAG,
"Skipping, channel already loaded");
1511 CHANNEL_CLIENT_DATA* pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1512 pChannelClientData->entry = entry;
1515 .protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000,
1516 .pVirtualChannelInit = FreeRDP_VirtualChannelInit,
1517 .pVirtualChannelOpen = FreeRDP_VirtualChannelOpen,
1518 .pVirtualChannelClose =
1519 FreeRDP_VirtualChannelClose,
1520 .pVirtualChannelWrite =
1521 FreeRDP_VirtualChannelWrite,
1522 .MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER,
1523 .pExtendedData = data,
1524 .context = channels->instance->context };
1529 PCHANNEL_ENTRY_POINTS px;
1532 ptr.pfx = &EntryPoints;
1534 channels->can_call_init = TRUE;
1535 EnterCriticalSection(&channels->channelsLock);
1536 const BOOL status = pChannelClientData->entry(ptr.px);
1537 LeaveCriticalSection(&channels->channelsLock);
1539 channels->can_call_init = FALSE;
1543 WLog_ERR(TAG,
"error: channel export function call failed");
1550int freerdp_channels_client_load_ex(rdpChannels* channels, WINPR_ATTR_UNUSED rdpSettings* settings,
1551 PVIRTUALCHANNELENTRYEX entryEx,
void* data)
1553 WINPR_ASSERT(channels);
1554 WINPR_ASSERT(channels->instance);
1555 WINPR_ASSERT(channels->instance->context);
1556 WINPR_ASSERT(entryEx);
1558 if (channels->clientDataCount + 1 > CHANNEL_MAX_COUNT)
1560 WLog_ERR(TAG,
"error: too many channels");
1564 if (freerdp_channels_is_loaded_ex(channels, entryEx))
1566 WLog_WARN(TAG,
"Skipping, channel already loaded");
1570 CHANNEL_CLIENT_DATA* pChannelClientData = &channels->clientDataList[channels->clientDataCount];
1571 pChannelClientData->entryEx = entryEx;
1573 CHANNEL_INIT_DATA* pChannelInitData = &(channels->initDataList[channels->initDataCount++]);
1574 void* pInitHandle = pChannelInitData;
1575 pChannelInitData->channels = channels;
1578 .cbSize =
sizeof(EntryPointsEx),
1579 .protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000,
1580 .pVirtualChannelInitEx = FreeRDP_VirtualChannelInitEx,
1581 .pVirtualChannelOpenEx = FreeRDP_VirtualChannelOpenEx,
1582 .pVirtualChannelCloseEx = FreeRDP_VirtualChannelCloseEx,
1583 .pVirtualChannelWriteEx = FreeRDP_VirtualChannelWriteEx,
1584 .MagicNumber = FREERDP_CHANNEL_MAGIC_NUMBER,
1585 .pExtendedData = data,
1586 .context = channels->instance->context
1592 PCHANNEL_ENTRY_POINTS_EX px;
1595 ptr.pfx = &EntryPointsEx;
1598 channels->can_call_init = TRUE;
1599 EnterCriticalSection(&channels->channelsLock);
1600 const BOOL status = pChannelClientData->entryEx(ptr.px, pInitHandle);
1601 LeaveCriticalSection(&channels->channelsLock);
1603 channels->can_call_init = FALSE;
1607 WLog_ERR(TAG,
"error: channel export function call failed");
1618int freerdp_channels_load_plugin(rdpChannels* channels, rdpSettings* settings,
const char* name,
1621 PVIRTUALCHANNELENTRY entry =
1622 freerdp_load_channel_addin_entry(name,
nullptr,
nullptr, FREERDP_ADDIN_CHANNEL_STATIC);
1627 return freerdp_channels_client_load(channels, settings, entry, data);
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_string(const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
Returns a immutable string settings value.
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 val)
Sets a UINT32 settings value.
WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
Returns a UINT32 settings value.
This struct contains function pointer to initialize/free objects.
OBJECT_FREE_FN fnObjectFree
WINPR_ATTR_NODISCARD OBJECT_NEW_FN fnObjectNew