/** * FreeRDP: A Remote Desktop Protocol client. * Virtual Channel Manager * * Copyright 2009-2011 Jay Sorg * Copyright 2010-2011 Vic Lee * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * MS compatible plugin interface * reference: * http://msdn.microsoft.com/en-us/library/aa383580.aspx * * Notes on threads: * Many virtual channel plugins are built using threads. * Non main threads may call MyVirtualChannelOpen, * MyVirtualChannelClose, or MyVirtualChannelWrite. * Since the plugin's VirtualChannelEntry function is called * from the main thread, MyVirtualChannelInit has to be called * from the main thread. */ #include "config.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "libchannels.h" #define CHANNEL_MAX_COUNT 30 struct lib_data { PVIRTUALCHANNELENTRY entry; /* the one and only exported function */ PCHANNEL_INIT_EVENT_FN init_event_proc; void* init_handle; }; struct channel_data { char name[CHANNEL_NAME_LEN + 1]; int open_handle; int options; int flags; /* 0 nothing 1 init 2 open */ PCHANNEL_OPEN_EVENT_FN open_event_proc; }; struct sync_data { void* data; uint32 data_length; void* user_data; int index; }; typedef struct rdp_init_handle rdpInitHandle; struct rdp_init_handle { rdpChannels* channels; }; struct rdp_channels { /** * Only the main thread alters these arrays, before any * library thread is allowed in(post_connect is called) * so no need to use mutex locking * After post_connect, each library thread can only access it's * own array items * ie, no two threads can access index 0, ... */ struct lib_data libs_data[CHANNEL_MAX_COUNT]; int num_libs_data; struct channel_data channels_data[CHANNEL_MAX_COUNT]; int num_channels_data; rdpInitHandle init_handles[CHANNEL_MAX_COUNT]; int num_init_handles; /* control for entry into MyVirtualChannelInit */ int can_call_init; rdpSettings* settings; /* true once freerdp_chanman_post_connect is called */ int is_connected; /* used for locating the channels for a given instance */ freerdp* instance; /* signal for incoming data or event */ struct wait_obj* signal; /* used for sync write */ freerdp_mutex sync_data_mutex; LIST* sync_data_list; /* used for sync event */ freerdp_sem event_sem; RDP_EVENT* event; }; /** * The current channel manager reference passes from VirtualChannelEntry to * VirtualChannelInit for the pInitHandle. */ static rdpChannels* g_init_channels; /* The list of all channel managers. */ typedef struct rdp_channels_list rdpChannelsList; struct rdp_channels_list { rdpChannels* channels; rdpChannelsList* next; }; static rdpChannelsList* g_channels_list; /* To generate unique sequence for all open handles */ static int g_open_handle_sequence; /* For locking the global resources */ static freerdp_mutex g_mutex_init; static freerdp_mutex g_mutex_list; /* returns the channels for the open handle passed in */ static rdpChannels* freerdp_channels_find_by_open_handle(int open_handle, int* pindex) { int lindex; rdpChannels* channels; rdpChannelsList* channels_list; freerdp_mutex_lock(g_mutex_list); for (channels_list = g_channels_list; channels_list; channels_list = channels_list->next) { channels = channels_list->channels; for (lindex = 0; lindex < channels->num_channels_data; lindex++) { if (channels->channels_data[lindex].open_handle == open_handle) { freerdp_mutex_unlock(g_mutex_list); *pindex = lindex; return channels; } } } freerdp_mutex_unlock(g_mutex_list); return NULL; } /* returns the channels for the rdp instance passed in */ static rdpChannels* freerdp_channels_find_by_instance(freerdp* instance) { rdpChannels* channels; rdpChannelsList* channels_list; freerdp_mutex_lock(g_mutex_list); for (channels_list = g_channels_list; channels_list; channels_list = channels_list->next) { channels = channels_list->channels; if (channels->instance == instance) { freerdp_mutex_unlock(g_mutex_list); return channels; } } freerdp_mutex_unlock(g_mutex_list); return NULL; } /* returns struct channel_data for the channel name passed in */ static struct channel_data* freerdp_channels_find_channel_data_by_name(rdpChannels* channels, const char* channel_name, int* pindex) { int lindex; struct channel_data* lchannel_data; for (lindex = 0; lindex < channels->num_channels_data; lindex++) { lchannel_data = channels->channels_data + lindex; if (strcmp(channel_name, lchannel_data->name) == 0) { if (pindex != 0) *pindex = lindex; return lchannel_data; } } return NULL; } /* returns rdpChannel for the channel id passed in */ static rdpChannel* freerdp_channels_find_channel_by_id(rdpChannels* channels, rdpSettings* settings, int channel_id, int* pindex) { int lindex; int lcount; rdpChannel* lrdp_channel; lcount = settings->num_channels; for (lindex = 0; lindex < lcount; lindex++) { lrdp_channel = settings->channels + lindex; if (lrdp_channel->channel_id == channel_id) { if (pindex != 0) *pindex = lindex; return lrdp_channel; } } return NULL; } /* returns rdpChannel for the channel name passed in */ static rdpChannel* freerdp_channels_find_channel_by_name(rdpChannels* channels, rdpSettings* settings, const char* channel_name, int* pindex) { int lindex; int lcount; rdpChannel* lrdp_channel; lcount = settings->num_channels; for (lindex = 0; lindex < lcount; lindex++) { lrdp_channel = settings->channels + lindex; if (strcmp(channel_name, lrdp_channel->name) == 0) { if (pindex != 0) *pindex = lindex; return lrdp_channel; } } return NULL; } /** * must be called by same thread that calls freerdp_chanman_load_plugin * according to MS docs * only called from main thread */ static uint32 FREERDP_CC MyVirtualChannelInit(void** ppInitHandle, PCHANNEL_DEF pChannel, int channelCount, uint32 versionRequested, PCHANNEL_INIT_EVENT_FN pChannelInitEventProc) { int index; rdpChannels* channels; struct lib_data* llib; rdpChannel* lrdp_channel; PCHANNEL_DEF lchannel_def; struct channel_data* lchannel_data; if (ppInitHandle == NULL) { DEBUG_CHANNELS("error bad pphan"); return CHANNEL_RC_BAD_INIT_HANDLE; } channels = g_init_channels; channels->init_handles[channels->num_init_handles].channels = channels; *ppInitHandle = &channels->init_handles[channels->num_init_handles]; channels->num_init_handles++; DEBUG_CHANNELS("enter"); if (!channels->can_call_init) { DEBUG_CHANNELS("error not in entry"); return CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY; } if (channels->num_channels_data + channelCount >= CHANNEL_MAX_COUNT) { DEBUG_CHANNELS("error too many channels"); return CHANNEL_RC_TOO_MANY_CHANNELS; } if (pChannel == 0) { DEBUG_CHANNELS("error bad pchan"); return CHANNEL_RC_BAD_CHANNEL; } if (channels->is_connected) { DEBUG_CHANNELS("error already connected"); return CHANNEL_RC_ALREADY_CONNECTED; } if (versionRequested != VIRTUAL_CHANNEL_VERSION_WIN2000) { DEBUG_CHANNELS("warning version"); } for (index = 0; index < channelCount; index++) { lchannel_def = pChannel + index; if (freerdp_channels_find_channel_data_by_name(channels, lchannel_def->name, 0) != 0) { DEBUG_CHANNELS("error channel already used"); return CHANNEL_RC_BAD_CHANNEL; } } llib = channels->libs_data + channels->num_libs_data; llib->init_event_proc = pChannelInitEventProc; llib->init_handle = *ppInitHandle; channels->num_libs_data++; for (index = 0; index < channelCount; index++) { lchannel_def = pChannel + index; lchannel_data = channels->channels_data + channels->num_channels_data; freerdp_mutex_lock(g_mutex_list); lchannel_data->open_handle = g_open_handle_sequence++; freerdp_mutex_unlock(g_mutex_list); lchannel_data->flags = 1; /* init */ strncpy(lchannel_data->name, lchannel_def->name, CHANNEL_NAME_LEN); lchannel_data->options = lchannel_def->options; if (channels->settings->num_channels < 16) { lrdp_channel = channels->settings->channels + channels->settings->num_channels; strncpy(lrdp_channel->name, lchannel_def->name, 7); lrdp_channel->options = lchannel_def->options; channels->settings->num_channels++; } else { DEBUG_CHANNELS("warning more than 16 channels"); } channels->num_channels_data++; } return CHANNEL_RC_OK; } /** * can be called from any thread * thread safe because no 2 threads can have the same channel name registered */ static uint32 FREERDP_CC MyVirtualChannelOpen(void* pInitHandle, uint32* pOpenHandle, char* pChannelName, PCHANNEL_OPEN_EVENT_FN pChannelOpenEventProc) { int index; rdpChannels* channels; struct channel_data* lchannel_data; DEBUG_CHANNELS("enter"); channels = ((rdpInitHandle*) pInitHandle)->channels; if (pOpenHandle == 0) { DEBUG_CHANNELS("error bad chanhan"); return CHANNEL_RC_BAD_CHANNEL_HANDLE; } if (pChannelOpenEventProc == 0) { DEBUG_CHANNELS("error bad proc"); return CHANNEL_RC_BAD_PROC; } if (!channels->is_connected) { DEBUG_CHANNELS("error not connected"); return CHANNEL_RC_NOT_CONNECTED; } lchannel_data = freerdp_channels_find_channel_data_by_name(channels, pChannelName, &index); if (lchannel_data == 0) { DEBUG_CHANNELS("error chan name"); return CHANNEL_RC_UNKNOWN_CHANNEL_NAME; } if (lchannel_data->flags == 2) { DEBUG_CHANNELS("error chan already open"); return CHANNEL_RC_ALREADY_OPEN; } lchannel_data->flags = 2; /* open */ lchannel_data->open_event_proc = pChannelOpenEventProc; *pOpenHandle = lchannel_data->open_handle; return CHANNEL_RC_OK; } /** * can be called from any thread * thread safe because no 2 threads can have the same openHandle */ static uint32 FREERDP_CC MyVirtualChannelClose(uint32 openHandle) { int index; rdpChannels* channels; struct channel_data* lchannel_data; DEBUG_CHANNELS("enter"); channels = freerdp_channels_find_by_open_handle(openHandle, &index); if ((channels == NULL) || (index < 0) || (index >= CHANNEL_MAX_COUNT)) { DEBUG_CHANNELS("error bad channels"); return CHANNEL_RC_BAD_CHANNEL_HANDLE; } lchannel_data = channels->channels_data + index; if (lchannel_data->flags != 2) { DEBUG_CHANNELS("error not open"); return CHANNEL_RC_NOT_OPEN; } lchannel_data->flags = 0; return CHANNEL_RC_OK; } /* can be called from any thread */ static uint32 FREERDP_CC MyVirtualChannelWrite(uint32 openHandle, void* pData, uint32 dataLength, void* pUserData) { int index; rdpChannels* channels; struct sync_data* item; struct channel_data* lchannel_data; channels = freerdp_channels_find_by_open_handle(openHandle, &index); if ((channels == NULL) || (index < 0) || (index >= CHANNEL_MAX_COUNT)) { DEBUG_CHANNELS("error bad chanhan"); return CHANNEL_RC_BAD_CHANNEL_HANDLE; } if (!channels->is_connected) { DEBUG_CHANNELS("error not connected"); return CHANNEL_RC_NOT_CONNECTED; } if (pData == 0) { DEBUG_CHANNELS("error bad pData"); return CHANNEL_RC_NULL_DATA; } if (dataLength == 0) { DEBUG_CHANNELS("error bad dataLength"); return CHANNEL_RC_ZERO_LENGTH; } lchannel_data = channels->channels_data + index; if (lchannel_data->flags != 2) { DEBUG_CHANNELS("error not open"); return CHANNEL_RC_NOT_OPEN; } freerdp_mutex_lock(channels->sync_data_mutex); /* lock channels->sync* vars */ if (!channels->is_connected) { freerdp_mutex_unlock(channels->sync_data_mutex); DEBUG_CHANNELS("error not connected"); return CHANNEL_RC_NOT_CONNECTED; } item = xnew(struct sync_data); item->data = pData; item->data_length = dataLength; item->user_data = pUserData; item->index = index; list_enqueue(channels->sync_data_list, item); freerdp_mutex_unlock(channels->sync_data_mutex); /* set the event */ wait_obj_set(channels->signal); return CHANNEL_RC_OK; } static uint32 FREERDP_CC MyVirtualChannelEventPush(uint32 openHandle, RDP_EVENT* event) { int index; rdpChannels* channels; struct channel_data* lchannel_data; channels = freerdp_channels_find_by_open_handle(openHandle, &index); if ((channels == NULL) || (index < 0) || (index >= CHANNEL_MAX_COUNT)) { DEBUG_CHANNELS("error bad chanhan"); return CHANNEL_RC_BAD_CHANNEL_HANDLE; } if (!channels->is_connected) { DEBUG_CHANNELS("error not connected"); return CHANNEL_RC_NOT_CONNECTED; } if (event == NULL) { DEBUG_CHANNELS("error bad event"); return CHANNEL_RC_NULL_DATA; } lchannel_data = channels->channels_data + index; if (lchannel_data->flags != 2) { DEBUG_CHANNELS("error not open"); return CHANNEL_RC_NOT_OPEN; } freerdp_sem_wait(channels->event_sem); /* lock channels->event */ if (!channels->is_connected) { freerdp_sem_signal(channels->event_sem); DEBUG_CHANNELS("error not connected"); return CHANNEL_RC_NOT_CONNECTED; } channels->event = event; /* set the event */ wait_obj_set(channels->signal); return CHANNEL_RC_OK; } /** * this is called shortly after the application starts and * before any other function in the file * called only from main thread */ int freerdp_channels_global_init(void) { g_init_channels = NULL; g_channels_list = NULL; g_open_handle_sequence = 1; g_mutex_init = freerdp_mutex_new(); g_mutex_list = freerdp_mutex_new(); return 0; } int freerdp_channels_global_uninit(void) { while (g_channels_list) freerdp_channels_free(g_channels_list->channels); freerdp_mutex_free(g_mutex_init); freerdp_mutex_free(g_mutex_list); return 0; } rdpChannels* freerdp_channels_new(void) { rdpChannels* channels; rdpChannelsList* channels_list; channels = xnew(rdpChannels); channels->sync_data_mutex = freerdp_mutex_new(); channels->sync_data_list = list_new(); channels->event_sem = freerdp_sem_new(1); channels->signal = wait_obj_new(); /* Add it to the global list */ channels_list = xnew(rdpChannelsList); channels_list->channels = channels; freerdp_mutex_lock(g_mutex_list); channels_list->next = g_channels_list; g_channels_list = channels_list; freerdp_mutex_unlock(g_mutex_list); return channels; } void freerdp_channels_free(rdpChannels* channels) { rdpChannelsList* list; rdpChannelsList* prev; freerdp_mutex_free(channels->sync_data_mutex); list_free(channels->sync_data_list); freerdp_sem_free(channels->event_sem); wait_obj_free(channels->signal); /* Remove from global list */ freerdp_mutex_lock(g_mutex_list); for (prev = NULL, list = g_channels_list; list; prev = list, list = list->next) { if (list->channels == channels) break; } if (list) { if (prev) prev->next = list->next; else g_channels_list = list->next; xfree(list); } freerdp_mutex_unlock(g_mutex_list); xfree(channels); } /** * this is called when processing the command line parameters * called only from main thread */ int freerdp_channels_load_plugin(rdpChannels* channels, rdpSettings* settings, const char* name, void* data) { int ok; struct lib_data* lib; CHANNEL_ENTRY_POINTS_EX ep; DEBUG_CHANNELS("%s", name); if (channels->num_libs_data + 1 >= CHANNEL_MAX_COUNT) { DEBUG_CHANNELS("too many channels"); return 1; } lib = channels->libs_data + channels->num_libs_data; lib->entry = (PVIRTUALCHANNELENTRY) freerdp_load_plugin(name, CHANNEL_EXPORT_FUNC_NAME); //lib->entry = (PVIRTUALCHANNELENTRY) freerdp_load_channel_plugin(settings, name, CHANNEL_EXPORT_FUNC_NAME); if (lib->entry == NULL) { DEBUG_CHANNELS("failed to find export function"); return 1; } ep.cbSize = sizeof(ep); ep.protocolVersion = VIRTUAL_CHANNEL_VERSION_WIN2000; ep.pVirtualChannelInit = MyVirtualChannelInit; ep.pVirtualChannelOpen = MyVirtualChannelOpen; ep.pVirtualChannelClose = MyVirtualChannelClose; ep.pVirtualChannelWrite = MyVirtualChannelWrite; ep.pExtendedData = data; ep.pVirtualChannelEventPush = MyVirtualChannelEventPush; /* enable MyVirtualChannelInit */ channels->can_call_init = 1; channels->settings = settings; freerdp_mutex_lock(g_mutex_init); g_init_channels = channels; ok = lib->entry((PCHANNEL_ENTRY_POINTS) &ep); g_init_channels = NULL; freerdp_mutex_unlock(g_mutex_init); /* disable MyVirtualChannelInit */ channels->settings = 0; channels->can_call_init = 0; if (!ok) { DEBUG_CHANNELS("export function call failed"); return 1; } return 0; } /** * go through and inform all the libraries that we are initialized * called only from main thread */ int freerdp_channels_pre_connect(rdpChannels* channels, freerdp* instance) { int index; void* dummy; struct lib_data* llib; CHANNEL_DEF lchannel_def; DEBUG_CHANNELS("enter"); channels->instance = instance; /** * If rdpsnd is registered but not rdpdr, it's necessary to register a fake * rdpdr channel to make sound work. This is a workaround for Window 7 and * Windows 2008 */ if (freerdp_channels_find_channel_data_by_name(channels, "rdpsnd", 0) != 0 && freerdp_channels_find_channel_data_by_name(channels, "rdpdr", 0) == 0) { lchannel_def.options = CHANNEL_OPTION_INITIALIZED | CHANNEL_OPTION_ENCRYPT_RDP; strcpy(lchannel_def.name, "rdpdr"); channels->can_call_init = 1; channels->settings = instance->settings; freerdp_mutex_lock(g_mutex_init); g_init_channels = channels; MyVirtualChannelInit(&dummy, &lchannel_def, 1, VIRTUAL_CHANNEL_VERSION_WIN2000, 0); g_init_channels = NULL; freerdp_mutex_unlock(g_mutex_init); channels->can_call_init = 0; channels->settings = 0; DEBUG_CHANNELS("registered fake rdpdr for rdpsnd."); } for (index = 0; index < channels->num_libs_data; index++) { llib = channels->libs_data + index; if (llib->init_event_proc != 0) llib->init_event_proc(llib->init_handle, CHANNEL_EVENT_INITIALIZED, 0, 0); } return 0; } /** * go through and inform all the libraries that we are connected * this will tell the libraries that its ok to call MyVirtualChannelOpen * called only from main thread */ int freerdp_channels_post_connect(rdpChannels* channels, freerdp* instance) { int index; char* hostname; int hostname_len; struct lib_data* llib; channels->is_connected = 1; hostname = instance->settings->hostname; hostname_len = strlen(hostname); DEBUG_CHANNELS("hostname [%s] channels->num_libs [%d]", hostname, channels->num_libs_data); for (index = 0; index < channels->num_libs_data; index++) { llib = channels->libs_data + index; if (llib->init_event_proc != 0) llib->init_event_proc(llib->init_handle, CHANNEL_EVENT_CONNECTED, hostname, hostname_len); } return 0; } /** * data comming from the server to the client * called only from main thread */ int freerdp_channels_data(freerdp* instance, int channel_id, void* data, int data_size, int flags, int total_size) { int index; rdpChannels* channels; rdpChannel* lrdp_channel; struct channel_data* lchannel_data; channels = freerdp_channels_find_by_instance(instance); if (channels == 0) { DEBUG_CHANNELS("could not find channel manager"); return 1; } lrdp_channel = freerdp_channels_find_channel_by_id(channels, instance->settings, channel_id, &index); if (lrdp_channel == 0) { DEBUG_CHANNELS("could not find channel id"); return 1; } lchannel_data = freerdp_channels_find_channel_data_by_name(channels, lrdp_channel->name, &index); if (lchannel_data == 0) { DEBUG_CHANNELS("could not find channel name"); return 1; } if (lchannel_data->open_event_proc != 0) { lchannel_data->open_event_proc(lchannel_data->open_handle, CHANNEL_EVENT_DATA_RECEIVED, data, data_size, total_size, flags); } return 0; } static const char* event_class_to_name_table[] = { "rdpdbg", /* RDP_EVENT_CLASS_DEBUG */ "cliprdr", /* RDP_EVENT_CLASS_CLIPRDR */ "tsmf", /* RDP_EVENT_CLASS_TSMF */ "rail", /* RDP_EVENT_CLASS_RAIL */ NULL }; /** * Send a plugin-defined event to the plugin. * called only from main thread * @param channels the channel manager instance * @param event an event object created by freerdp_event_new() */ FREERDP_API int freerdp_channels_send_event(rdpChannels* channels, RDP_EVENT* event) { int index; const char* name; struct channel_data* lchannel_data; name = event_class_to_name_table[event->event_class]; if (name == NULL) { DEBUG_CHANNELS("unknown event_class %d", event->event_class); freerdp_event_free(event); return 1; } lchannel_data = freerdp_channels_find_channel_data_by_name(channels, name, &index); if (lchannel_data == NULL) { DEBUG_CHANNELS("could not find channel name %s", name); freerdp_event_free(event); return 1; } if (lchannel_data->open_event_proc != NULL) { lchannel_data->open_event_proc(lchannel_data->open_handle, CHANNEL_EVENT_USER, event, sizeof(RDP_EVENT), sizeof(RDP_EVENT), 0); } return 0; } /** * called only from main thread */ static void freerdp_channels_process_sync(rdpChannels* channels, freerdp* instance) { struct sync_data* item; rdpChannel* lrdp_channel; struct channel_data* lchannel_data; while (list_size(channels->sync_data_list) > 0) { freerdp_mutex_lock(channels->sync_data_mutex); item = (struct sync_data*)list_dequeue(channels->sync_data_list); freerdp_mutex_unlock(channels->sync_data_mutex); if (!item) break ; lchannel_data = channels->channels_data + item->index; lrdp_channel = freerdp_channels_find_channel_by_name(channels, instance->settings, lchannel_data->name, &item->index); if (lrdp_channel != NULL) instance->SendChannelData(instance, lrdp_channel->channel_id, item->data, item->data_length); if (lchannel_data->open_event_proc != 0) { lchannel_data->open_event_proc(lchannel_data->open_handle, CHANNEL_EVENT_WRITE_COMPLETE, item->user_data, sizeof(void *), sizeof(void *), 0); } xfree(item); } } /** * called only from main thread */ boolean freerdp_channels_get_fds(rdpChannels* channels, freerdp* instance, void** read_fds, int* read_count, void** write_fds, int* write_count) { wait_obj_get_fds(channels->signal, read_fds, read_count); return true; } /** * called only from main thread */ boolean freerdp_channels_check_fds(rdpChannels* channels, freerdp* instance) { if (wait_obj_is_set(channels->signal)) { wait_obj_clear(channels->signal); freerdp_channels_process_sync(channels, instance); } return true; } RDP_EVENT* freerdp_channels_pop_event(rdpChannels* channels) { RDP_EVENT* event; if (channels->event == NULL) return NULL; event = channels->event; channels->event = NULL; freerdp_sem_signal(channels->event_sem); /* release channels->event */ return event; } void freerdp_channels_close(rdpChannels* channels, freerdp* instance) { int index; struct lib_data* llib; DEBUG_CHANNELS("closing"); channels->is_connected = 0; freerdp_channels_check_fds(channels, instance); /* tell all libraries we are shutting down */ for (index = 0; index < channels->num_libs_data; index++) { llib = channels->libs_data + index; if (llib->init_event_proc != 0) llib->init_event_proc(llib->init_handle, CHANNEL_EVENT_TERMINATED, 0, 0); } }