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 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
use std::collections::VecDeque;
use std::fmt::Display;
use std::io::{Read, Result as IOResult};
use std::{collections::HashMap, convert::TryInto};
use crate::{DecodedFrame, SCID, VCID};
use serde::{Deserialize, Serialize};
/// Maximum packet sequence id before rollover.
pub const MAX_SEQ_NUM: i32 = 16383;
pub type APID = u16;
/// Packet represents a single CCSDS space packet and its associated data.
///
/// This packet contains the primary header data as well as the user data,
/// which may or may not container a secondary header. See the header's
/// `has_secondary_header` flag.
///
/// # Example
/// Create a packet from the minimum number of bytes.
/// ```
/// use ccsds::{Packet, PrimaryHeader};
///
/// let dat: &[u8] = &[
/// // primary header bytes
/// 0xd, 0x59, 0xd2, 0xab, 0x0, 07,
/// // CDS timecode bytes in secondary header (not decoded here)
/// 0x52, 0xc0, 0x0, 0x0, 0x0, 0xa7, 0x0, 0xdb, 0xff,
/// // minimum 1 byte of user data
/// 0xff
/// ];
/// let mut r = std::io::BufReader::new(dat);
/// let packet = Packet::read(&mut r).unwrap();
/// ```
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Packet {
/// All packets have a primary header
pub header: PrimaryHeader,
/// All packet bytes, including header and user data
pub data: Vec<u8>,
}
impl Display for Packet {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"Packet{{header: {:?}, data:[len={}]}}",
self.header,
self.data.len()
)?;
Ok(())
}
}
impl Packet {
pub fn is_first(&self) -> bool {
self.header.sequence_flags == SEQ_FIRST
}
pub fn is_last(&self) -> bool {
self.header.sequence_flags == SEQ_LAST
}
pub fn is_cont(&self) -> bool {
self.header.sequence_flags == SEQ_CONTINUATION
}
pub fn is_standalone(&self) -> bool {
self.header.sequence_flags == SEQ_UNSEGMENTED
}
/// Decode from bytes. Returns `None` if there are not enough bytes to construct the
/// header or if there are not enough bytes to construct the [Packet] of the length
/// indicated by the header.
pub fn decode(dat: &mut [u8]) -> Option<Packet> {
match PrimaryHeader::decode(dat) {
Some(header) => {
if dat.len() < header.len_minus1 as usize + 1 {
None
} else {
Some(Packet {
header,
data: dat.to_vec(),
})
}
}
None => None,
}
}
/// Read a single [Packet].
pub fn read(r: &mut dyn Read) -> IOResult<Packet> {
let ph = PrimaryHeader::read(r)?;
// read the user data, shouldn't panic since unpacking worked
let mut buf = vec![0u8; (ph.len_minus1 + 1).try_into().unwrap()];
r.read_exact(&mut buf)?;
Ok(Packet {
header: ph,
data: buf,
})
}
}
/// Packet is the first packet in a packet group
pub const SEQ_FIRST: u8 = 1;
/// Packet is a part of a packet group, but not first and not last
pub const SEQ_CONTINUATION: u8 = 0;
/// Packet is the last packet in a packet group
pub const SEQ_LAST: u8 = 2;
/// Packet is not part of a packet group, i.e., standalone.
pub const SEQ_UNSEGMENTED: u8 = 3;
/// CCSDS Primary Header
///
/// The primary header format is common to all CCSDS space packets.
///
#[derive(Serialize, Deserialize, Debug, Copy, Clone)]
pub struct PrimaryHeader {
pub version: u8,
pub type_flag: u8,
pub has_secondary_header: bool,
pub apid: APID,
/// Defines a packets grouping. See the `SEQ_*` values.
pub sequence_flags: u8,
pub sequence_id: u16,
pub len_minus1: u16,
}
impl PrimaryHeader {
/// Size of a PrimaryHeader
pub const LEN: usize = 6;
pub fn read(r: &mut dyn Read) -> IOResult<PrimaryHeader> {
let mut buf = [0u8; Self::LEN];
r.read_exact(&mut buf)?;
Ok(Self::decode(&buf).unwrap())
}
/// Decode from bytes. Returns `None` if there are not enough bytes to construct the
/// header.
pub fn decode(buf: &[u8]) -> Option<Self> {
if buf.len() < Self::LEN {
return None;
}
let d1 = u16::from_be_bytes([buf[0], buf[1]]);
let d2 = u16::from_be_bytes([buf[2], buf[3]]);
let d3 = u16::from_be_bytes([buf[4], buf[5]]);
Some(PrimaryHeader {
version: (d1 >> 13 & 0x7) as u8,
type_flag: (d1 >> 12 & 0x1) as u8,
has_secondary_header: (d1 >> 11 & 0x1) == 1,
apid: (d1 & 0x7ff) as u16,
sequence_flags: (d2 >> 14 & 0x3) as u8,
sequence_id: (d2 & 0x3fff) as u16,
len_minus1: d3,
})
}
}
/// Calculate the number of missing sequence ids.
///
/// `cur` is the current sequence id. `last` is the sequence id seen before `cur`.
pub fn missing_packets(cur: u16, last: u16) -> u16 {
let cur: i32 = cur.into();
let last: i32 = last.into();
let expected = (last + 1) as i32 % (MAX_SEQ_NUM + 1);
if cur != expected {
return (cur - last - 1) as u16;
}
return 0;
}
struct PacketReaderIter {
reader: Box<dyn Read + Send>,
offset: usize,
}
impl PacketReaderIter {
fn new(reader: Box<dyn Read + Send>) -> Self {
PacketReaderIter { reader, offset: 0 }
}
}
impl Iterator for PacketReaderIter {
type Item = IOResult<Packet>;
fn next(&mut self) -> Option<Self::Item> {
match Packet::read(&mut self.reader) {
Ok(p) => {
self.offset += PrimaryHeader::LEN + p.header.len_minus1 as usize + 1;
return Some(Ok(p));
}
Err(err) => {
if err.kind() == std::io::ErrorKind::UnexpectedEof {
return None;
}
Some(Err(err))
}
}
}
}
/// Packet data representing a CCSDS packet group according to the packet
/// sequencing value in primary header.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct PacketGroup {
pub apid: APID,
pub packets: Vec<Packet>,
}
struct PacketGroupIter<'a> {
packets: Box<dyn Iterator<Item = IOResult<Packet>> + Send + 'a>,
group: PacketGroup,
done: bool,
}
impl<'a> PacketGroupIter<'a> {
/// Create an iterator that reads source packets from the provided reader.
///
///
fn with_reader(reader: Box<dyn Read + Send>) -> Self {
let packets = PacketReaderIter::new(reader)
.filter(|zult| zult.is_ok())
.map(|zult| zult.unwrap());
Self::with_packets(Box::new(packets))
}
/// Create an iterator that sources packets directly from the provided vanilla
/// iterator.
///
/// Results genreated by the iterator will always be `Ok`.
fn with_packets(packets: Box<dyn Iterator<Item = Packet> + Send + 'a>) -> Self {
let packets: Box<dyn Iterator<Item = IOResult<Packet>> + Send + 'a> = Box::new(packets.map(|p| IOResult::<Packet>::Ok(p)));
PacketGroupIter {
packets,
group: PacketGroup {
apid: 0,
packets: vec![],
},
done: false,
}
}
/// True when this group contains at least 1 packet.
fn have_packets(&self) -> bool {
self.group.packets.len() > 0
}
/// Given our current state, does packet indicate we should start a new group.
fn should_start_new_group(&self, packet: &Packet) -> bool {
packet.is_first()
|| (self.group.packets.len() > 0
&& self.group.packets[0].header.apid != packet.header.apid)
}
/// Create a new group, returning the old, priming it with the packet
fn new_group(&mut self, packet: Option<Packet>) -> PacketGroup {
let group = self.group.clone();
self.group = PacketGroup {
apid: 0,
packets: vec![],
};
if let Some(p) = packet {
self.group.apid = p.header.apid;
self.group.packets.push(p);
}
group
}
}
impl Iterator for PacketGroupIter<'_> {
type Item = IOResult<PacketGroup>;
fn next(&mut self) -> Option<Self::Item> {
if self.done {
return None;
}
'outer: loop {
// Get a packet from the iterator. Exit the iterator
let packet: Packet = match self.packets.next() {
Some(zult) => {
match zult {
// Got a packet from the packet iter
Ok(packet) => packet,
// Got an error from the packet iter. Return a result with the
// error to let the consumer decide what to do.
Err(err) => return Some(Err(err)),
}
}
None => break 'outer,
};
// Return group of one
if packet.is_standalone() {
return Some(Ok(PacketGroup {
apid: packet.header.apid,
packets: vec![packet],
}));
}
if self.should_start_new_group(&packet) {
if self.have_packets() {
return Some(Ok(self.new_group(Some(packet))));
}
self.new_group(None);
}
self.group.packets.push(packet);
}
self.done = true;
// We're all done, so return any partial group
if self.have_packets() {
return Some(Ok(self.new_group(None)));
}
return None;
}
}
/// Return an iterator providing [Packet] data read from a byte synchronized ungrouped
/// packet stream.
///
/// For packet streams that may contain packets that utilize packet grouping see
/// [read_packet_groups].
///
/// # Examples
/// ```
/// use ccsds::read_packets;
///
/// let dat: &[u8] = &[
/// // primary header bytes
/// 0xd, 0x59, 0xd2, 0xab, 0x0, 07,
/// // CDS timecode bytes in secondary header
/// 0x52, 0xc0, 0x0, 0x0, 0x0, 0xa7, 0x0, 0xdb, 0xff,
/// // minimum 1 byte of user data
/// 0xff
/// ];
///
/// let r = std::io::BufReader::new(dat);
/// read_packets(Box::new(r)).for_each(|zult| {
/// let packet = zult.unwrap();
/// assert_eq!(packet.header.apid, 1369);
/// });
/// ```
pub fn read_packets(reader: Box<dyn Read + Send>) -> impl Iterator<Item = IOResult<Packet>> + Send{
PacketReaderIter::new(reader)
}
/// Return an [Iterator] that groups read packets into [PacketGroup]s.
///
/// This is necessary for packet streams containing APIDs that utilize packet grouping sequence
/// flags values [SEQ_FIRST], [SEQ_CONTINUATION], and [SEQ_LAST]. It can also be used for
/// non-grouped APIDs ([SEQ_UNSEGMENTED]), however, it is not necessary in such cases. See
/// [PrimaryHeader::sequence_flags].
///
/// # Examples
///
/// Reading packets from data file of space packets (level-0) would look something
/// like this:
/// ```
/// use ccsds::read_packet_groups;
///
/// // data file stand-in
/// let dat: &[u8] = &[
/// // primary header bytes
/// 0xd, 0x59, 0xd2, 0xab, 0x0, 07,
/// // CDS timecode bytes in secondary header
/// 0x52, 0xc0, 0x0, 0x0, 0x0, 0xa7, 0x0, 0xdb, 0xff,
/// // minimum 1 byte of user data
/// 0xff
/// ];
///
/// let r = std::io::BufReader::new(dat);
/// read_packet_groups(Box::new(r)).for_each(|zult| {
/// let packet = zult.unwrap();
/// assert_eq!(packet.apid, 1369);
/// });
/// ```
pub fn read_packet_groups(
reader: Box<dyn Read + Send>,
) -> impl Iterator<Item = IOResult<PacketGroup>> {
PacketGroupIter::with_reader(reader)
}
/// Collects the provided packets into [PacketGroup]s.
pub fn collect_packet_groups(
packets: Box<dyn Iterator<Item = Packet> + Send>,
) -> impl Iterator<Item = IOResult<PacketGroup>> + Send {
PacketGroupIter::with_packets(packets)
}
struct VcidTracker {
vcid: VCID,
/// Caches partial packets for this vcid
cache: Vec<u8>,
// True when any frame used to fill the cache was rs corrected
rs_corrected: bool,
// True when a FHP has been found and data should be added to cache. False
// where there is a missing data due to RS failure or missing frames.
sync: bool,
}
impl VcidTracker {
fn new(vcid: VCID) -> Self {
VcidTracker {
vcid,
sync: false,
cache: vec![],
rs_corrected: false,
}
}
fn clear(&mut self) {
self.cache.clear();
self.rs_corrected = false;
}
}
impl Display for VcidTracker {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"VcidTracker{{vcid={}, sync={}, cache_len={}, rs_corrected:{}}}",
self.vcid,
self.sync,
self.cache.len(),
self.rs_corrected
)
}
}
struct FramedPacketIter<'a> {
frames: Box<dyn Iterator<Item = DecodedFrame> + Send + 'a>,
izone_length: usize,
trailer_length: usize,
// Cache of partial packet data from frames that has not yet been decoded into
// packets. There should only be up to about 1 frame worth of data in the cache
cache: HashMap<VCID, VcidTracker>,
// Packets that have already been decoded and are waiting to be provided.
ready: VecDeque<Packet>,
}
impl<'a> Iterator for FramedPacketIter<'a> {
type Item = Packet;
fn next(&mut self) -> Option<Self::Item> {
use rs2::RSState::*;
// If there are ready packets provide the oldest one
if let Some(packet) = self.ready.pop_front() {
return Some(packet);
}
// No packet ready, we have to find one
'next_frame: loop {
let frame = self.frames.next();
if frame.is_none() {
break;
}
let DecodedFrame {
frame,
missing,
rsstate,
} = frame.unwrap();
let mpdu = frame.mpdu(self.izone_length, self.trailer_length);
let tracker = self
.cache
.entry(frame.header.vcid)
.or_insert(VcidTracker::new(frame.header.vcid));
if let Corrected(_) = rsstate {
tracker.rs_corrected = true
}
// Data loss means we dump what we're working on and force resync
if let Uncorrectable(_) = rsstate {
tracker.clear();
tracker.sync = false;
continue;
}
// For counter errors, we can still utilize the current frame (no continue)
if missing > 0 {
tracker.clear();
tracker.sync = false;
}
if tracker.sync {
// If we have sync all mpdu bytes are for this tracker/vcid
tracker.cache.extend_from_slice(mpdu.payload());
} else {
// No way to get sync if we don't have a header
if !mpdu.has_header() {
continue;
}
tracker.cache = mpdu.payload()[mpdu.header_offset()..].to_vec();
tracker.sync = true;
}
if tracker.cache.len() < PrimaryHeader::LEN {
continue 'next_frame; // need more frame data for this vcid
}
let header = PrimaryHeader::decode(&tracker.cache).unwrap();
let mut need = header.len_minus1 as usize + 1 + PrimaryHeader::LEN;
if tracker.cache.len() < need {
continue; // need more frame data for this vcid
}
loop {
// Grab data we need and update the cache
let (data, tail) = tracker.cache.split_at(need);
let packet = Packet {
header,
data: data.to_vec(),
};
tracker.cache = tail.to_vec();
self.ready.push_back(packet);
if tracker.cache.len() < PrimaryHeader::LEN {
break;
}
let header = PrimaryHeader::decode(&tracker.cache).unwrap();
need = header.len_minus1 as usize + 1 + PrimaryHeader::LEN;
if tracker.cache.len() < need {
break;
}
}
return self.ready.pop_front();
}
// Attempted to read a frame, but the iterator is done. Make sure to
// provide a ready frame if there are any.
return self.ready.pop_front();
}
}
/// Decodes the provided frames into a packets contained within the frames' MPDUs.
///
/// There are several cases when frame data cannot be fully recovered and is dropped,
/// i.e., not used to construct packets:
///
/// 1. Missing frames
/// 2. Frames with state [rs2::RSState::Uncorrectable]
/// 3. Fill Frames
/// 4. Frames before the first header is available in an MPDU
///
/// This will handle frames from multiple spacecrafts, i.e., with different SCIDs.
pub fn decode_framed_packets<'a>(
scid: SCID,
frames: Box<dyn Iterator<Item = DecodedFrame> + Send + 'a>,
izone_length: usize,
trailer_length: usize,
) -> impl Iterator<Item = Packet> + Send + 'a {
FramedPacketIter {
frames: Box::new(
frames.filter(move |dc| !dc.frame.is_fill() && dc.frame.header.scid == scid),
),
izone_length,
trailer_length,
cache: HashMap::new(),
ready: VecDeque::new(),
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_read_packet() {
let dat: [u8; 15] = [
// Primary/secondary header and a single byte of user data
0xd, 0x59, 0xd2, 0xab, 0x0, 0x8, 0x52, 0xc0, 0x0, 0x0, 0x0, 0xa7, 0x0, 0xdb, 0xff,
];
let x = &dat[..];
let mut r = std::io::BufReader::new(x);
let packet = Packet::read(&mut r).unwrap();
assert_eq!(packet.header.version, 0);
}
#[test]
fn test_read_header() {
let dat: [u8; 6] = [
// bytes from a SNPP CrIS packet
0xd, 0x59, 0xd2, 0xab, 0xa, 0x8f,
];
let x = &dat[0..];
let mut r = std::io::BufReader::new(x);
let ph = PrimaryHeader::read(&mut r).unwrap();
assert_eq!(ph.version, 0);
assert_eq!(ph.type_flag, 0);
assert_eq!(ph.has_secondary_header, true);
assert_eq!(ph.apid, 1369);
assert_eq!(ph.sequence_flags, 3);
assert_eq!(ph.sequence_id, 4779);
assert_eq!(ph.len_minus1, 2703);
}
#[test]
fn packet_iter_test() {
#[rustfmt::skip]
let dat: &[u8] = &[
// Primary/secondary header and a single byte of user data
// byte 4 is sequence number 1 & 2
0xd, 0x59, 0xc0, 0x01, 0x0, 0x8, 0x52, 0xc0, 0x0, 0x0, 0x0, 0xa7, 0x0, 0xdb, 0xff,
0xd, 0x59, 0xc0, 0x02, 0x0, 0x8, 0x52, 0xc0, 0x0, 0x0, 0x0, 0xa7, 0x0, 0xdb, 0xff,
];
let reader = std::io::BufReader::new(dat);
let packets: Vec<Packet> = PacketReaderIter::new(Box::new(reader))
.filter(|r| r.is_ok())
.map(|r| r.unwrap())
.collect();
assert_eq!(packets.len(), 2);
assert_eq!(packets[0].header.apid, 1369);
assert_eq!(packets[0].header.sequence_id, 1);
assert_eq!(packets[1].header.sequence_id, 2);
}
#[test]
fn test_missing_packets() {
assert_eq!(missing_packets(5, 4), 0);
assert_eq!(missing_packets(5, 3), 1);
assert_eq!(missing_packets(1, u16::MAX), 1);
}
}