Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2019 The WebRTC project authors. All Rights Reserved. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
| 10 | |
| 11 | #ifndef PC_DATA_CHANNEL_CONTROLLER_H_ |
| 12 | #define PC_DATA_CHANNEL_CONTROLLER_H_ |
| 13 | |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 +0000 | [diff] [blame] | 14 | #include <stdint.h> |
| 15 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 16 | #include <map> |
| 17 | #include <memory> |
| 18 | #include <string> |
| 19 | #include <vector> |
| 20 | |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 +0000 | [diff] [blame] | 21 | #include "api/data_channel_interface.h" |
| 22 | #include "api/scoped_refptr.h" |
Artem Titov | d15a575 | 2021-02-10 14:31:24 +0100 | [diff] [blame] | 23 | #include "api/sequence_checker.h" |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 +0000 | [diff] [blame] | 24 | #include "api/transport/data_channel_transport_interface.h" |
| 25 | #include "media/base/media_channel.h" |
| 26 | #include "media/base/media_engine.h" |
| 27 | #include "media/base/stream_params.h" |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 28 | #include "pc/channel.h" |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 +0000 | [diff] [blame] | 29 | #include "pc/data_channel_utils.h" |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 30 | #include "pc/rtp_data_channel.h" |
| 31 | #include "pc/sctp_data_channel.h" |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 +0000 | [diff] [blame] | 32 | #include "rtc_base/checks.h" |
| 33 | #include "rtc_base/copy_on_write_buffer.h" |
| 34 | #include "rtc_base/ssl_stream_adapter.h" |
Harald Alvestrand | 5761e7b | 2021-01-29 14:45:08 +0000 | [diff] [blame] | 35 | #include "rtc_base/third_party/sigslot/sigslot.h" |
| 36 | #include "rtc_base/thread.h" |
| 37 | #include "rtc_base/thread_annotations.h" |
Harald Alvestrand | 246724b | 2019-12-03 22:31:42 +0100 | [diff] [blame] | 38 | #include "rtc_base/weak_ptr.h" |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 39 | |
| 40 | namespace webrtc { |
| 41 | |
| 42 | class PeerConnection; |
| 43 | |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 44 | class DataChannelController : public RtpDataChannelProviderInterface, |
| 45 | public SctpDataChannelProviderInterface, |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 46 | public DataChannelSink { |
| 47 | public: |
| 48 | explicit DataChannelController(PeerConnection* pc) : pc_(pc) {} |
| 49 | |
Harald Alvestrand | ab81316 | 2020-01-09 13:29:56 +0100 | [diff] [blame] | 50 | // Not copyable or movable. |
| 51 | DataChannelController(DataChannelController&) = delete; |
| 52 | DataChannelController& operator=(const DataChannelController& other) = delete; |
| 53 | DataChannelController(DataChannelController&&) = delete; |
| 54 | DataChannelController& operator=(DataChannelController&& other) = delete; |
| 55 | |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 56 | // Implements RtpDataChannelProviderInterface/ |
| 57 | // SctpDataChannelProviderInterface. |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 58 | bool SendData(const cricket::SendDataParams& params, |
| 59 | const rtc::CopyOnWriteBuffer& payload, |
| 60 | cricket::SendDataResult* result) override; |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 61 | bool ConnectDataChannel(RtpDataChannel* webrtc_data_channel) override; |
| 62 | void DisconnectDataChannel(RtpDataChannel* webrtc_data_channel) override; |
| 63 | bool ConnectDataChannel(SctpDataChannel* webrtc_data_channel) override; |
| 64 | void DisconnectDataChannel(SctpDataChannel* webrtc_data_channel) override; |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 65 | void AddSctpDataStream(int sid) override; |
| 66 | void RemoveSctpDataStream(int sid) override; |
| 67 | bool ReadyToSendData() const override; |
| 68 | |
| 69 | // Implements DataChannelSink. |
| 70 | void OnDataReceived(int channel_id, |
| 71 | DataMessageType type, |
| 72 | const rtc::CopyOnWriteBuffer& buffer) override; |
| 73 | void OnChannelClosing(int channel_id) override; |
| 74 | void OnChannelClosed(int channel_id) override; |
| 75 | void OnReadyToSend() override; |
Harald Alvestrand | 2697ac1 | 2019-12-16 10:37:04 +0100 | [diff] [blame] | 76 | void OnTransportClosed() override; |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 77 | |
| 78 | // Called from PeerConnection::SetupDataChannelTransport_n |
| 79 | void SetupDataChannelTransport_n(); |
| 80 | // Called from PeerConnection::TeardownDataChannelTransport_n |
| 81 | void TeardownDataChannelTransport_n(); |
| 82 | |
| 83 | // Called from PeerConnection::OnTransportChanged |
| 84 | // to make required changes to datachannels' transports. |
| 85 | void OnTransportChanged( |
| 86 | DataChannelTransportInterface* data_channel_transport); |
| 87 | |
Tomas Gunnarsson | 2e94de5 | 2020-06-16 16:54:10 +0200 | [diff] [blame] | 88 | // Called from PeerConnection::GetDataChannelStats on the signaling thread. |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 89 | std::vector<DataChannelStats> GetDataChannelStats() const; |
Tomas Gunnarsson | 2e94de5 | 2020-06-16 16:54:10 +0200 | [diff] [blame] | 90 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 91 | // Creates channel and adds it to the collection of DataChannels that will |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 92 | // be offered in a SessionDescription, and wraps it in a proxy object. |
| 93 | rtc::scoped_refptr<DataChannelInterface> InternalCreateDataChannelWithProxy( |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 94 | const std::string& label, |
| 95 | const InternalDataChannelInit* |
| 96 | config) /* RTC_RUN_ON(signaling_thread()) */; |
| 97 | void AllocateSctpSids(rtc::SSLRole role); |
| 98 | |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 99 | SctpDataChannel* FindDataChannelBySid(int sid) const; |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 100 | |
| 101 | // Checks if any data channel has been added. |
| 102 | bool HasDataChannels() const; |
| 103 | bool HasSctpDataChannels() const { |
| 104 | RTC_DCHECK_RUN_ON(signaling_thread()); |
| 105 | return !sctp_data_channels_.empty(); |
| 106 | } |
| 107 | bool HasRtpDataChannels() const { |
| 108 | RTC_DCHECK_RUN_ON(signaling_thread()); |
| 109 | return !rtp_data_channels_.empty(); |
| 110 | } |
| 111 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 112 | void UpdateLocalRtpDataChannels(const cricket::StreamParamsVec& streams); |
| 113 | void UpdateRemoteRtpDataChannels(const cricket::StreamParamsVec& streams); |
| 114 | |
| 115 | // Accessors |
Tomas Gunnarsson | 7d3cfbf | 2020-06-15 13:47:42 +0200 | [diff] [blame] | 116 | cricket::DataChannelType data_channel_type() const; |
| 117 | void set_data_channel_type(cricket::DataChannelType type); |
Tomas Gunnarsson | d69e070 | 2021-04-07 15:14:43 +0200 | [diff] [blame] | 118 | cricket::RtpDataChannel* rtp_data_channel() const; |
| 119 | void set_rtp_data_channel(cricket::RtpDataChannel* channel); |
Tomas Gunnarsson | 7d3cfbf | 2020-06-15 13:47:42 +0200 | [diff] [blame] | 120 | DataChannelTransportInterface* data_channel_transport() const; |
| 121 | void set_data_channel_transport(DataChannelTransportInterface* transport); |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 122 | const std::map<std::string, rtc::scoped_refptr<RtpDataChannel>>* |
Tomas Gunnarsson | 7d3cfbf | 2020-06-15 13:47:42 +0200 | [diff] [blame] | 123 | rtp_data_channels() const; |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 124 | |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 125 | sigslot::signal1<RtpDataChannel*>& SignalRtpDataChannelCreated() { |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 126 | RTC_DCHECK_RUN_ON(signaling_thread()); |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 127 | return SignalRtpDataChannelCreated_; |
| 128 | } |
| 129 | sigslot::signal1<SctpDataChannel*>& SignalSctpDataChannelCreated() { |
| 130 | RTC_DCHECK_RUN_ON(signaling_thread()); |
| 131 | return SignalSctpDataChannelCreated_; |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 132 | } |
| 133 | // Called when the transport for the data channels is closed or destroyed. |
| 134 | void OnTransportChannelClosed(); |
| 135 | |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 136 | void OnSctpDataChannelClosed(SctpDataChannel* channel); |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 137 | |
| 138 | private: |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 139 | rtc::scoped_refptr<RtpDataChannel> InternalCreateRtpDataChannel( |
| 140 | const std::string& label, |
| 141 | const DataChannelInit* config) /* RTC_RUN_ON(signaling_thread()) */; |
| 142 | |
| 143 | rtc::scoped_refptr<SctpDataChannel> InternalCreateSctpDataChannel( |
| 144 | const std::string& label, |
| 145 | const InternalDataChannelInit* |
| 146 | config) /* RTC_RUN_ON(signaling_thread()) */; |
| 147 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 148 | // Parses and handles open messages. Returns true if the message is an open |
| 149 | // message, false otherwise. |
| 150 | bool HandleOpenMessage_s(const cricket::ReceiveDataParams& params, |
| 151 | const rtc::CopyOnWriteBuffer& buffer) |
| 152 | RTC_RUN_ON(signaling_thread()); |
| 153 | // Called when a valid data channel OPEN message is received. |
| 154 | void OnDataChannelOpenMessage(const std::string& label, |
| 155 | const InternalDataChannelInit& config) |
| 156 | RTC_RUN_ON(signaling_thread()); |
| 157 | |
| 158 | void CreateRemoteRtpDataChannel(const std::string& label, |
| 159 | uint32_t remote_ssrc) |
| 160 | RTC_RUN_ON(signaling_thread()); |
| 161 | |
| 162 | void UpdateClosingRtpDataChannels( |
| 163 | const std::vector<std::string>& active_channels, |
| 164 | bool is_local_update) RTC_RUN_ON(signaling_thread()); |
| 165 | |
Tomas Gunnarsson | 7d3cfbf | 2020-06-15 13:47:42 +0200 | [diff] [blame] | 166 | // Called from SendData when data_channel_transport() is true. |
| 167 | bool DataChannelSendData(const cricket::SendDataParams& params, |
| 168 | const rtc::CopyOnWriteBuffer& payload, |
| 169 | cricket::SendDataResult* result); |
| 170 | |
Tomas Gunnarsson | 2e94de5 | 2020-06-16 16:54:10 +0200 | [diff] [blame] | 171 | // Called when all data channels need to be notified of a transport channel |
| 172 | // (calls OnTransportChannelCreated on the signaling thread). |
| 173 | void NotifyDataChannelsOfTransportCreated(); |
| 174 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 175 | rtc::Thread* network_thread() const; |
| 176 | rtc::Thread* signaling_thread() const; |
| 177 | |
| 178 | // Specifies which kind of data channel is allowed. This is controlled |
| 179 | // by the chrome command-line flag and constraints: |
| 180 | // 1. If chrome command-line switch 'enable-sctp-data-channels' is enabled, |
| 181 | // constraint kEnableDtlsSrtp is true, and constaint kEnableRtpDataChannels is |
| 182 | // not set or false, SCTP is allowed (DCT_SCTP); |
| 183 | // 2. If constraint kEnableRtpDataChannels is true, RTP is allowed (DCT_RTP); |
| 184 | // 3. If both 1&2 are false, data channel is not allowed (DCT_NONE). |
| 185 | cricket::DataChannelType data_channel_type_ = |
| 186 | cricket::DCT_NONE; // TODO(bugs.webrtc.org/9987): Accessed on both |
| 187 | // signaling and network thread. |
| 188 | |
| 189 | // Plugin transport used for data channels. Pointer may be accessed and |
| 190 | // checked from any thread, but the object may only be touched on the |
| 191 | // network thread. |
| 192 | // TODO(bugs.webrtc.org/9987): Accessed on both signaling and network |
| 193 | // thread. |
| 194 | DataChannelTransportInterface* data_channel_transport_ = nullptr; |
| 195 | |
| 196 | // Cached value of whether the data channel transport is ready to send. |
| 197 | bool data_channel_transport_ready_to_send_ |
| 198 | RTC_GUARDED_BY(signaling_thread()) = false; |
| 199 | |
| 200 | // |rtp_data_channel_| is used if in RTP data channel mode, |
| 201 | // |data_channel_transport_| when using SCTP. |
Tomas Gunnarsson | d69e070 | 2021-04-07 15:14:43 +0200 | [diff] [blame] | 202 | // TODO(bugs.webrtc.org/9987): Accessed on both signaling and network |
| 203 | // thread. |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 204 | cricket::RtpDataChannel* rtp_data_channel_ = nullptr; |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 205 | |
| 206 | SctpSidAllocator sid_allocator_ /* RTC_GUARDED_BY(signaling_thread()) */; |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 207 | std::vector<rtc::scoped_refptr<SctpDataChannel>> sctp_data_channels_ |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 208 | RTC_GUARDED_BY(signaling_thread()); |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 209 | std::vector<rtc::scoped_refptr<SctpDataChannel>> sctp_data_channels_to_free_ |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 210 | RTC_GUARDED_BY(signaling_thread()); |
| 211 | |
| 212 | // Map of label -> DataChannel |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 213 | std::map<std::string, rtc::scoped_refptr<RtpDataChannel>> rtp_data_channels_ |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 214 | RTC_GUARDED_BY(signaling_thread()); |
| 215 | |
| 216 | // Signals from |data_channel_transport_|. These are invoked on the |
| 217 | // signaling thread. |
Tomas Gunnarsson | 7d3cfbf | 2020-06-15 13:47:42 +0200 | [diff] [blame] | 218 | // TODO(bugs.webrtc.org/11547): These '_s' signals likely all belong on the |
| 219 | // network thread. |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 220 | sigslot::signal1<bool> SignalDataChannelTransportWritable_s |
| 221 | RTC_GUARDED_BY(signaling_thread()); |
| 222 | sigslot::signal2<const cricket::ReceiveDataParams&, |
| 223 | const rtc::CopyOnWriteBuffer&> |
| 224 | SignalDataChannelTransportReceivedData_s |
| 225 | RTC_GUARDED_BY(signaling_thread()); |
| 226 | sigslot::signal1<int> SignalDataChannelTransportChannelClosing_s |
| 227 | RTC_GUARDED_BY(signaling_thread()); |
| 228 | sigslot::signal1<int> SignalDataChannelTransportChannelClosed_s |
| 229 | RTC_GUARDED_BY(signaling_thread()); |
| 230 | |
Taylor Brandstetter | 3a034e1 | 2020-07-09 15:32:34 -0700 | [diff] [blame] | 231 | sigslot::signal1<RtpDataChannel*> SignalRtpDataChannelCreated_ |
| 232 | RTC_GUARDED_BY(signaling_thread()); |
| 233 | sigslot::signal1<SctpDataChannel*> SignalSctpDataChannelCreated_ |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 234 | RTC_GUARDED_BY(signaling_thread()); |
| 235 | |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 236 | // Owning PeerConnection. |
| 237 | PeerConnection* const pc_; |
Niels Möller | 236e36c | 2021-03-23 09:23:10 +0100 | [diff] [blame] | 238 | // The weak pointers must be dereferenced and invalidated on the signalling |
| 239 | // thread only. |
Harald Alvestrand | 246724b | 2019-12-03 22:31:42 +0100 | [diff] [blame] | 240 | rtc::WeakPtrFactory<DataChannelController> weak_factory_{this}; |
Harald Alvestrand | 05e4d08 | 2019-12-03 14:04:21 +0100 | [diff] [blame] | 241 | }; |
| 242 | |
| 243 | } // namespace webrtc |
| 244 | |
| 245 | #endif // PC_DATA_CHANNEL_CONTROLLER_H_ |