FreeRDP
Loading...
Searching...
No Matches
multitransport_internal.h
1
17
18#ifndef FREERDP_LIB_CORE_MULTITRANSPORT_INTERNAL_H
19#define FREERDP_LIB_CORE_MULTITRANSPORT_INTERNAL_H
20
21#include <winpr/collections.h>
22#include <winpr/synch.h>
23
24#include <freerdp/config.h>
25#include <freerdp/multitransport.h>
26#if defined(WITH_RDPEUDP)
27#include "udplistener.h"
28#endif
29
30#include "rdpemt.h"
31#include "multitransport.h"
32
33typedef enum
34{
35 MT_EVENT_READY,
36 MT_EVENT_FAILED,
37 MT_EVENT_DATA,
38 MT_EVENT_AUTODETECT
39} MT_EVENT_TYPE;
40
41/* Tunnel events are queued from the tunnel thread to the main loop. The main loop sends the
42 * Initiate Multitransport Response (client), verifies the client (server), delivers tunnel
43 * data and auto-detect PDUs, and notifies the channel code of state changes. */
44typedef struct
45{
46 MT_EVENT_TYPE type;
47 UINT32 tunnel; /* rdpemt_get_serial() of the tunnel that raised the event */
48 wStream* s; /* Sealed stream, with the current position set to 0. */
49 size_t length;
50} mt_event;
51
53{
54 rdpRdp* rdp;
55
56 MultiTransportRequestCb MtRequest;
57 MultiTransportResponseCb MtResponse;
58
59 /* Server-side data */
60 UINT32 reliableReqId;
61
62 BYTE reliableCookie[RDPUDP_COOKIE_LEN];
63 BYTE reliableCookieHash[RDPUDP_COOKIE_HASHLEN];
64#if defined(WITH_RDPEUDP)
65
66 /* [MS-RDPEDYC] 3.1.5.3: tunnel carries channel data only after the client accepts it
67 * over both UDP (Tunnel Create Request) and TCP (Initiate Multitransport Response), in any
68 * order. Only serverTunnelUp and serverResponseOk are protected by the lock. */
69 BOOL serverTunnelUp;
70 BOOL serverResponseOk;
71 BOOL serverTunnelOffered;
72 BOOL serverResponsePending;
73 BOOL serverResponseFailed; /* Connection terminated by the Initiate Multitransport Response */
74 UINT64 serverOfferTime; /* GetTickCount64() value at the time of the offer, used for the
75 response timeout. */
76
77 /* UDP hooks; refer to freerdp_peer_set_udp_hooks(). */
78 rdpUdpPeerHooks udpCallbacks;
79 void* udpCustom;
80 size_t udpSendLimit;
81
82 /* Set by the tunnel thread and read by the main loop. Accessed via Interlocked functions. */
83 LONG serverSynPending;
84 LONG serverWritablePending;
85
86 /* Tunnel data bytes in events the main loop has not taken yet. Accessed via Interlocked
87 * functions. */
88 LONG serverQueuedBytes;
89 /* Set while the channel code cannot take more tunnel data, see
90 * multitransport_hold_tunnel_data(). Accessed via Interlocked functions. */
91 LONG serverDataHold;
92#endif
93
94 /* Tunnel state and synchronization; reliableResponseSent is client-only. */
95 CRITICAL_SECTION lock;
96 HANDLE event;
97 wQueue* events;
98 rdpEmt* reliable;
99 FreeRDP_MultitransportTunnelState reliableState;
100 BOOL reliableResponseSent;
101
102 /* Read and invoked on the main loop thread under hooksLock. Updated by
103 * freerdp_multitransport_set_dvc_callbacks() under the lock, which waits for any
104 * active hook. The tunnel thread reads these without the lock during direct delivery
105 * (see multitransport_direct and rdpemt_clear_receiver). */
106 CRITICAL_SECTION hooksLock;
108 void* custom;
109
110 /* Main loop thread only: connection ended due to tunnel failure. */
111 BOOL endedConnection;
112
113 /* Set by the tunnel thread if an event cannot be queued (e.g. due to queue limits or
114 * memory failure), potentially including data already acked to the client.
115 * Accessed via Interlocked functions. */
116 LONG tunnelEventLost;
117};
118
120typedef enum
121{
122 MT_REQUEST_WAIT,
123 MT_REQUEST_NONE,
124 MT_REQUEST_TUNNEL
125} MT_REQUEST_MODE;
126
127#if defined(WITH_RDPEUDP)
128
130#define MT_SHARED
131
133FREERDP_LOCAL void multitransport_tunnel_event(void* custom, rdpEmt* emt, RDPEMT_EVENT event,
134 const BYTE* data, size_t length);
135
136WINPR_ATTR_NODISCARD
137FREERDP_LOCAL BOOL multitransport_notify_state(rdpMultitransport* multi,
138 FreeRDP_MultitransportTunnelState state);
139
140#else
141
142#define MT_SHARED static
143
144#endif
145
146#if defined(WITH_RDPEUDP_SERVER)
147
149WINPR_ATTR_NODISCARD
150FREERDP_LOCAL MT_REQUEST_MODE multitransport_server_request_mode(rdpMultitransport* multi);
151
153WINPR_ATTR_NODISCARD
154FREERDP_LOCAL BOOL multitransport_is_server(const rdpMultitransport* multi);
155
157WINPR_ATTR_NODISCARD
158FREERDP_LOCAL BOOL multitransport_server_tunnel_offered(const rdpMultitransport* multi);
159
160WINPR_ATTR_NODISCARD
161FREERDP_LOCAL state_run_t multitransport_server_tunnel_response(rdpMultitransport* multi,
162 UINT32 reqId, UINT32 hrResponse);
163
166WINPR_ATTR_NODISCARD
167FREERDP_LOCAL BOOL multitransport_server_response_failed(const rdpMultitransport* multi);
168
172WINPR_ATTR_NODISCARD
173FREERDP_LOCAL BOOL multitransport_server_tunnel_ready(rdpMultitransport* multi, BOOL* rc);
174
176FREERDP_LOCAL void multitransport_server_tunnel_closed(rdpMultitransport* multi);
177
179FREERDP_LOCAL void multitransport_tunnel_check(rdpMultitransport* multi);
180
182FREERDP_LOCAL void multitransport_server_event_taken(rdpMultitransport* multi, const mt_event* ev);
183
184#else
185
186WINPR_ATTR_NODISCARD
187static inline MT_REQUEST_MODE
188multitransport_server_request_mode(WINPR_ATTR_UNUSED rdpMultitransport* multi)
189{
190 return MT_REQUEST_WAIT;
191}
192
193WINPR_ATTR_NODISCARD
194static inline BOOL multitransport_is_server(WINPR_ATTR_UNUSED const rdpMultitransport* multi)
195{
196 return FALSE;
197}
198
199WINPR_ATTR_NODISCARD
200static inline BOOL
201multitransport_server_tunnel_offered(WINPR_ATTR_UNUSED const rdpMultitransport* multi)
202{
203 return FALSE;
204}
205
206WINPR_ATTR_NODISCARD
207static inline state_run_t
208multitransport_server_tunnel_response(WINPR_ATTR_UNUSED rdpMultitransport* multi,
209 WINPR_ATTR_UNUSED UINT32 reqId,
210 WINPR_ATTR_UNUSED UINT32 hrResponse)
211{
212 return STATE_RUN_FAILED;
213}
214
215WINPR_ATTR_NODISCARD
216static inline BOOL
217multitransport_server_response_failed(WINPR_ATTR_UNUSED const rdpMultitransport* multi)
218{
219 return FALSE;
220}
221
222WINPR_ATTR_NODISCARD
223static inline BOOL multitransport_server_tunnel_ready(WINPR_ATTR_UNUSED rdpMultitransport* multi,
224 WINPR_ATTR_UNUSED BOOL* rc)
225{
226 return FALSE;
227}
228
229static inline void multitransport_server_tunnel_closed(WINPR_ATTR_UNUSED rdpMultitransport* multi)
230{
231}
232
233static inline void multitransport_tunnel_check(WINPR_ATTR_UNUSED rdpMultitransport* multi)
234{
235}
236
237static inline void multitransport_server_event_taken(WINPR_ATTR_UNUSED rdpMultitransport* multi,
238 WINPR_ATTR_UNUSED const mt_event* ev)
239{
240}
241
242#endif
243
244#endif /* End of FREERDP_LIB_CORE_MULTITRANSPORT_INTERNAL_H */
Dynamic virtual channel hooks of the client side tunnels.
Callbacks from FreeRDP_UdpPeerCallbacks and internal hooks. Executed on the thread running the freerd...
Definition udplistener.h:82