bacnet-server 0.11.0

BACnet server: APDU dispatch and service handlers
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
use super::*;

#[derive(Debug)]
enum SegmentedSendWaitResult {
    SegmentAck(SegmentAckPdu),
    Abort(AbortPdu),
    Cancel,
    ChannelClosed,
    Timeout,
}

impl<T: TransportPort + 'static> BACnetServer<T> {
    /// Send a ComplexAck response using segmented transfer.
    ///
    /// Splits the service ack data into segments that fit within the client's
    /// max APDU length, sends each segment, and waits for SegmentAck from
    /// the client before sending the next (window size 1).
    #[allow(clippy::too_many_arguments)]
    pub(super) async fn send_segmented_complex_ack(
        network: &Arc<NetworkLayer<T>>,
        seg_ack_senders: &Arc<Mutex<HashMap<SegKey, Arc<SegmentedSendHandle>>>>,
        seg_send_permits: &Arc<Semaphore>,
        source_mac: &[u8],
        source_network: Option<&NpduAddress>,
        invoke_id: u8,
        service_choice: ConfirmedServiceChoice,
        service_ack_data: &[u8],
        client_max_apdu: u16,
        client_max_segments: Option<u8>,
    ) {
        Self::send_segmented_complex_ack_with_options(
            network,
            seg_ack_senders,
            seg_send_permits,
            source_mac,
            source_network,
            invoke_id,
            service_choice,
            service_ack_data,
            client_max_apdu,
            client_max_segments,
            SegmentedSendOptions::default(),
        )
        .await;
    }

    #[allow(clippy::too_many_arguments)]
    pub(super) async fn send_segmented_complex_ack_with_options(
        network: &Arc<NetworkLayer<T>>,
        seg_ack_senders: &Arc<Mutex<HashMap<SegKey, Arc<SegmentedSendHandle>>>>,
        seg_send_permits: &Arc<Semaphore>,
        source_mac: &[u8],
        source_network: Option<&NpduAddress>,
        invoke_id: u8,
        service_choice: ConfirmedServiceChoice,
        service_ack_data: &[u8],
        client_max_apdu: u16,
        client_max_segments: Option<u8>,
        options: SegmentedSendOptions,
    ) {
        let max_seg_size = max_segment_payload(client_max_apdu, SegmentedPduType::ComplexAck);
        let segments = match split_payload(service_ack_data, max_seg_size) {
            Ok(segments) => segments,
            Err(e) => {
                warn!(error = %e, "Response requires too many segments, aborting");
                let abort = Apdu::Abort(AbortPdu {
                    sent_by_server: true,
                    invoke_id,
                    abort_reason: AbortReason::BUFFER_OVERFLOW,
                });
                let mut buf = BytesMut::new();
                encode_apdu(&mut buf, &abort).expect("valid APDU encoding");
                let _ =
                    Self::send_confirmed_response_apdu(network, &buf, source_mac, source_network)
                        .await;
                return;
            }
        };
        let total_segments = segments.len();

        if let Some(max_segments) = client_max_segments {
            if total_segments > max_segments as usize {
                warn!(
                    total_segments,
                    max_segments, "Response exceeds client's max-segments-accepted, aborting"
                );
                let abort = Apdu::Abort(AbortPdu {
                    sent_by_server: true,
                    invoke_id,
                    abort_reason: AbortReason::BUFFER_OVERFLOW,
                });
                let mut buf = BytesMut::new();
                encode_apdu(&mut buf, &abort).expect("valid APDU encoding");
                let _ =
                    Self::send_confirmed_response_apdu(network, &buf, source_mac, source_network)
                        .await;
                return;
            }
        }

        if total_segments > 256 {
            warn!(
                total_segments,
                "Response requires too many segments, aborting"
            );
            let abort = Apdu::Abort(AbortPdu {
                sent_by_server: true,
                invoke_id,
                abort_reason: AbortReason::BUFFER_OVERFLOW,
            });
            let mut buf = BytesMut::new();
            encode_apdu(&mut buf, &abort).expect("valid APDU encoding");
            let _ =
                Self::send_confirmed_response_apdu(network, &buf, source_mac, source_network).await;
            return;
        }

        let _sender_permit = match Arc::clone(seg_send_permits).try_acquire_owned() {
            Ok(permit) => permit,
            Err(_) => {
                warn!(
                    invoke_id,
                    limit = MAX_SEG_SENDERS,
                    "Too many live segmented ComplexAck senders, aborting"
                );
                let abort = Apdu::Abort(AbortPdu {
                    sent_by_server: true,
                    invoke_id,
                    abort_reason: AbortReason::BUFFER_OVERFLOW,
                });
                let mut buf = BytesMut::new();
                encode_apdu(&mut buf, &abort).expect("valid APDU encoding");
                let _ =
                    Self::send_confirmed_response_apdu(network, &buf, source_mac, source_network)
                        .await;
                return;
            }
        };

        debug!(
            total_segments,
            max_seg_size,
            payload_len = service_ack_data.len(),
            "Starting segmented ComplexAck send"
        );

        let (seg_ack_tx, mut seg_ack_rx) = mpsc::channel::<SegmentAckPdu>(16);
        let (control_tx, mut control_rx) =
            watch::channel::<Option<SegmentedSendControlEvent>>(None);
        let send_handle = Arc::new(SegmentedSendHandle::new(
            seg_ack_tx.clone(),
            control_tx,
            total_segments,
        ));
        let key = segmented_transaction_key(source_mac, source_network, invoke_id);
        let insert_result = {
            let mut senders = seg_ack_senders.lock().await;
            if !senders.contains_key(&key) && senders.len() >= MAX_SEG_SENDERS {
                Err(())
            } else {
                Ok(senders.insert(key.clone(), Arc::clone(&send_handle)))
            }
        };
        let replaced = match insert_result {
            Ok(replaced) => replaced,
            Err(()) => {
                warn!(
                    invoke_id,
                    limit = MAX_SEG_SENDERS,
                    "Too many active segmented ComplexAck senders, aborting"
                );
                let abort = Apdu::Abort(AbortPdu {
                    sent_by_server: true,
                    invoke_id,
                    abort_reason: AbortReason::BUFFER_OVERFLOW,
                });
                let mut buf = BytesMut::new();
                encode_apdu(&mut buf, &abort).expect("valid APDU encoding");
                let _ =
                    Self::send_confirmed_response_apdu(network, &buf, source_mac, source_network)
                        .await;
                return;
            }
        };
        if let Some(replaced) = replaced {
            warn!(
                invoke_id,
                "Replacing active segmented ComplexAck sender for peer/invoke-id"
            );
            replaced.send_control(SegmentedSendControlEvent::Cancel);
        }

        let seg_timeout = options.segment_timeout;
        let mut seg_idx: usize = 0;
        let mut retransmission_retries: u8 = 0;

        'send_segments: while seg_idx < total_segments {
            let is_last = seg_idx == total_segments - 1;

            let pdu = Apdu::ComplexAck(ComplexAck {
                segmented: true,
                more_follows: !is_last,
                invoke_id,
                sequence_number: Some(seg_idx as u8),
                proposed_window_size: Some(1),
                service_choice,
                service_ack: segments[seg_idx].clone(),
            });

            let mut buf = BytesMut::with_capacity(client_max_apdu as usize);
            encode_apdu(&mut buf, &pdu).expect("valid APDU encoding");

            send_handle
                .current_sequence
                .store(seg_idx as u16, Ordering::Release);

            if let Err(e) = Self::send_confirmed_response_apdu_expecting_reply(
                network,
                &buf,
                source_mac,
                source_network,
                true,
            )
            .await
            {
                warn!(error = %e, seq = seg_idx, "Failed to send segment");
                break;
            }

            debug!(seq = seg_idx, is_last, "Sent ComplexAck segment");

            let ack_deadline = tokio::time::Instant::now() + seg_timeout;
            loop {
                if send_handle.closed.load(Ordering::Acquire) {
                    match control_rx.borrow_and_update().clone() {
                        Some(SegmentedSendControlEvent::Abort(abort)) => {
                            warn!(
                                invoke_id = abort.invoke_id,
                                reason = ?abort.abort_reason,
                                "Client aborted segmented ComplexAck send"
                            );
                        }
                        Some(SegmentedSendControlEvent::Cancel) | None => {
                            warn!(
                                invoke_id,
                                "Segmented ComplexAck send cancelled by newer same-peer transaction"
                            );
                        }
                    }
                    break 'send_segments;
                }

                let wait_result = tokio::select! {
                    biased;
                    changed = control_rx.changed() => {
                        if changed.is_err() {
                            SegmentedSendWaitResult::ChannelClosed
                        } else {
                            match control_rx.borrow_and_update().clone() {
                                Some(SegmentedSendControlEvent::Abort(abort)) => {
                                    SegmentedSendWaitResult::Abort(abort)
                                }
                                Some(SegmentedSendControlEvent::Cancel) => {
                                    SegmentedSendWaitResult::Cancel
                                }
                                None => continue,
                            }
                        }
                    }
                    ack = seg_ack_rx.recv() => {
                        match ack {
                            Some(ack) => SegmentedSendWaitResult::SegmentAck(ack),
                            None => SegmentedSendWaitResult::ChannelClosed,
                        }
                    }
                    _ = tokio::time::sleep_until(ack_deadline) => {
                        SegmentedSendWaitResult::Timeout
                    }
                };

                match wait_result {
                    SegmentedSendWaitResult::SegmentAck(ack) => {
                        if send_handle.closed.load(Ordering::Acquire) {
                            continue;
                        }

                        debug!(
                            seq = ack.sequence_number,
                            negative = ack.negative_ack,
                            sent_by_server = ack.sent_by_server,
                            "Received SegmentAck for ComplexAck"
                        );

                        if ack.sent_by_server {
                            tracing::warn!(
                                seq = ack.sequence_number,
                                negative = ack.negative_ack,
                                "Ignoring SegmentAck with server bit set for server ComplexAck send"
                            );
                            continue;
                        }

                        let Some(disposition) =
                            segment_ack_disposition(&ack, seg_idx, total_segments)
                        else {
                            tracing::warn!(
                                seq = ack.sequence_number,
                                negative = ack.negative_ack,
                                current = seg_idx,
                                total = total_segments,
                                "Ignoring SegmentAck outside current send window"
                            );
                            continue;
                        };

                        if disposition == SegmentAckDisposition::Retransmit {
                            if retransmission_retries >= options.max_retries {
                                warn!(
                                    invoke_id,
                                    retries = retransmission_retries,
                                    "Too many negative SegmentAck retries, aborting segmented send"
                                );
                                let abort = Apdu::Abort(AbortPdu {
                                    sent_by_server: true,
                                    invoke_id,
                                    abort_reason: AbortReason::TSM_TIMEOUT,
                                });
                                let mut abort_buf = BytesMut::new();
                                encode_apdu(&mut abort_buf, &abort).expect("valid APDU encoding");
                                let _ = Self::send_confirmed_response_apdu(
                                    network,
                                    &abort_buf,
                                    source_mac,
                                    source_network,
                                )
                                .await;
                                break 'send_segments;
                            }
                            retransmission_retries += 1;

                            debug!(
                                seq = ack.sequence_number,
                                current = seg_idx,
                                "Negative SegmentAck retransmitting current sequence"
                            );
                            continue 'send_segments;
                        }

                        retransmission_retries = 0;
                        seg_idx += 1;
                        continue 'send_segments;
                    }
                    SegmentedSendWaitResult::Abort(abort) => {
                        warn!(
                            invoke_id = abort.invoke_id,
                            reason = ?abort.abort_reason,
                            "Client aborted segmented ComplexAck send"
                        );
                        break 'send_segments;
                    }
                    SegmentedSendWaitResult::Cancel => {
                        warn!(
                            invoke_id,
                            "Segmented ComplexAck send cancelled by newer same-peer transaction"
                        );
                        break 'send_segments;
                    }
                    SegmentedSendWaitResult::ChannelClosed => {
                        warn!("Segmented send event channel closed during segmented send");
                        break 'send_segments;
                    }
                    SegmentedSendWaitResult::Timeout => {
                        if retransmission_retries < options.max_retries {
                            retransmission_retries += 1;
                            warn!(
                                seq = seg_idx,
                                retries = retransmission_retries,
                                "Timeout waiting for SegmentAck, retransmitting segment"
                            );
                            continue 'send_segments;
                        }

                        warn!(
                            seq = seg_idx,
                            retries = retransmission_retries,
                            "SegmentAck retry budget exhausted, ending segmented send"
                        );
                        break 'send_segments;
                    }
                }
            }
        }

        {
            let mut senders = seg_ack_senders.lock().await;
            if senders
                .get(&key)
                .is_some_and(|sender| sender.same_channel(&seg_ack_tx))
            {
                senders.remove(&key);
            }
        }
    }
}