2 * Copyright (c) 2017-2020 Tilman Sauerbeck (tilman at code-monkey de)
4 * Permission is hereby granted, free of charge, to any person obtaining
5 * a copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sublicense, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 use systick::elapsed_ms;
33 pub const MEMORY_SIZE: usize = 2 << 20;
34 const SECTOR_SIZE: usize = 4 << 10;
36 const NUM_SECTORS: usize = MEMORY_SIZE / SECTOR_SIZE;
38 #[derive(Clone, Copy, PartialEq, Debug)]
47 // Overrides InUse. The idea is to have erased flash sectors
48 // (0xff..ff) be detected as not in use.
53 #[derive(Clone, Copy)]
55 flags: u16, // Combination of SectorFlag items.
56 recording_id: u16, // Zero is considered invalid.
57 start_time: u32, // UNIX time. Only present if flag DataRecord isn't set.
61 fn new() -> SectorHeader {
69 fn is_in_use(&self) -> bool {
70 let mask = (SectorFlag::InUse as u16) | (SectorFlag::NotInUse as u16);
71 let value = SectorFlag::InUse as u16;
73 (self.flags & mask) == value
76 fn starts_recording(&self) -> bool {
77 let mask = (SectorFlag::InUse as u16)
78 | (SectorFlag::DataRecord as u16)
79 | (SectorFlag::NotInUse as u16);
80 let value = SectorFlag::InUse as u16;
82 (self.flags & mask) == value
85 fn belongs_to(&self, recording_id: u16) -> bool {
86 self.is_in_use() && self.recording_id == recording_id
90 #[derive(Clone, Copy)]
98 fn new() -> InFlight {
107 pub struct Logger<'a> {
108 pub storage: &'a mut dyn Storage,
110 recording_id: u16, // Zero is considered invalid.
112 // The index of the first sector of the currently running recording.
113 // Only written in logger_start_recording.
116 recording_started: u32,
118 // The number of slots filled in num_flight.
119 num_in_flight: usize,
121 // Deltas not yet written out to write_buffer.
123 // Limiting ourselves to 7 items here means we can use
124 // 0xff as a padding byte.
125 in_flight: [InFlight; 7],
127 sector_header: [SectorHeader; NUM_SECTORS],
129 sectors_written: u16,
131 write_buffer_offset: usize,
132 write_buffer: [u8; SECTOR_SIZE],
135 struct SectorHeaderIter<'a> {
136 sector_header: &'a [SectorHeader; NUM_SECTORS],
139 indices: [u16; NUM_SECTORS],
142 fn cmp_sector_header_indices(a: u16, b: u16,
143 sector_header: &[SectorHeader]) -> i32 {
144 let header_a = §or_header[a as usize];
145 let header_b = §or_header[b as usize];
147 // Latest entries come first.
148 if header_a.start_time > header_b.start_time {
150 } else if header_a.start_time < header_b.start_time {
157 fn downheap(heap: &mut [u16], mut index: usize, num_elts: usize,
158 sector_header: &[SectorHeader]) {
159 let orig = heap[index];
162 let mut worker = index * 2;
164 if worker < num_elts &&
165 cmp_sector_header_indices(heap[worker], heap[worker + 1], sector_header) < 0 {
169 if worker > num_elts ||
170 cmp_sector_header_indices(orig, heap[worker], sector_header) >= 0 {
174 heap[index] = heap[worker];
181 impl<'a> SectorHeaderIter<'a> {
182 fn new(logger: &'a Logger) -> SectorHeaderIter<'a> {
183 let mut iter = SectorHeaderIter {
184 sector_header: &logger.sector_header,
186 it_back: NUM_SECTORS,
187 indices: [0; NUM_SECTORS]
190 let mut num_used = 0;
192 // Put the indices of the used directory entries at the beginning
193 // of the array. Ignore the unused ones since we are not going
194 // to sort them anyway.
195 for i in 0..NUM_SECTORS {
196 let sector_header = &iter.sector_header[i];
198 if sector_header.starts_recording() {
199 iter.indices[num_used] = i as u16;
204 let num_elts_to_sort = num_used;
206 if num_elts_to_sort != 0 {
207 // Sort the used directory entries.
208 iter.sort(num_elts_to_sort);
211 // Now put the indices of the unused directory entries in the array.
213 for i in 0..NUM_SECTORS {
214 iter.indices[i] = i as u16;
217 let latest_used = iter.indices[0] as usize;
218 let mut offset_unused = num_used;
220 // First put the entries that come after the latest one in use...
221 for i in (latest_used + 1)..NUM_SECTORS {
222 let sector_header = &iter.sector_header[i];
224 if !sector_header.is_in_use() {
225 iter.indices[offset_unused] = i as u16;
230 // ... then wrap around if necessary.
231 for i in 0..latest_used {
232 let sector_header = &iter.sector_header[i];
234 if !sector_header.is_in_use() {
235 iter.indices[offset_unused] = i as u16;
242 // Need to handle those sectors that don't start recordings
243 // but that are still used.
248 fn sort(&mut self, num_elts_to_sort: usize) {
249 for i in (1..((num_elts_to_sort + 1) / 2) + 1).rev() {
250 downheap(&mut self.indices, i - 1, num_elts_to_sort - 1,
254 for i in (1..num_elts_to_sort).rev() {
255 self.indices.swap(0, i);
257 downheap(&mut self.indices, 0, i - 1, self.sector_header);
262 impl<'a> Iterator for SectorHeaderIter<'a> {
265 fn next(&mut self) -> Option<usize> {
266 if self.it_front == self.it_back {
269 let next_index = self.indices[self.it_front] as usize;
278 impl<'a> DoubleEndedIterator for SectorHeaderIter<'a> {
279 fn next_back(&mut self) -> Option<usize> {
280 if self.it_back == self.it_front {
285 let next_index = self.indices[self.it_back] as usize;
292 fn normalize_angle(mut angle: i32) -> i32 {
293 let deg90 = 90 * 60 * 10000;
294 let deg180 = deg90 << 1;
295 let deg360 = deg180 << 1;
297 while angle >= deg180 {
301 while angle <= -deg180 {
308 fn max<T>(a: T, b: T) -> T
309 where T: PartialOrd {
317 impl<'a> Logger<'a> {
318 pub fn new(storage: &'a mut dyn Storage) -> Logger {
324 recording_started: 0,
327 in_flight: [InFlight::new(); 7],
328 sector_header: [SectorHeader::new(); NUM_SECTORS],
332 write_buffer_offset: 0,
333 write_buffer: [0xff; SECTOR_SIZE],
337 pub fn init(&mut self) {
338 // Reading the directory entries one by one means
339 // we won't need an as large buffer on the stack.
340 for i in 0..NUM_SECTORS {
341 self.read_sector_header(i);
345 fn read_sector_header(&mut self, sector_index: usize) {
346 let address = sector_index * SECTOR_SIZE;
347 let mut chunk = [0u8; 8];
349 self.storage.read(address, &mut chunk);
351 let sector_header_ptr: *mut SectorHeader =
352 &mut self.sector_header[sector_index];
355 core::ptr::copy(chunk.as_ptr(),
356 sector_header_ptr as *mut u8,
361 fn prepare_write_buffer(&mut self, is_initial: bool) {
362 self.write_buffer = [0xff; SECTOR_SIZE];
364 let flags = if is_initial {
365 (SectorFlag::InUse as u16)
367 (SectorFlag::InUse as u16) | (SectorFlag::DataRecord as u16)
370 // Write sector header.
371 self.write_buffer[0..2].copy_from_slice(&flags.to_le_bytes());
372 self.write_buffer[2..4].copy_from_slice(&self.recording_id.to_le_bytes());
374 self.write_buffer_offset = 4;
377 let start = self.write_buffer_offset;
380 self.write_buffer[start..end].copy_from_slice(
381 &self.recording_started.to_le_bytes());
383 self.write_buffer_offset += 4;
387 pub fn start_recording(&mut self, tap: &TimeAndPos) -> u16 {
388 self.find_next_record_slot();
390 self.sectors_written = 0;
391 self.recording_started = tap.unix_time;
392 self.num_in_flight = 0;
394 self.prepare_write_buffer(true);
396 self.write_packet(0, tap.latitude, tap.longitude);
401 pub fn log(&mut self, prev_tap: &TimeAndPos, tap: &TimeAndPos) {
402 let d_time_ms = elapsed_ms(tap.system_time, prev_tap.system_time);
404 // We know that our hardware cannot deliver updates more often
405 // than once a second. However when there's a delay in evaluating
406 // the hardware's messages, we will end up with intervals like
407 // 1050ms and 950ms (the latter will "make up" for the slowness
408 // in the former). To avoid logging deltas of 0 seconds, we round
409 // the intervals to full seconds.
410 let d_time_s = (d_time_ms + 500) / 1000;
412 let d_lat = tap.latitude - prev_tap.latitude;
413 let d_lon = tap.longitude - prev_tap.longitude;
415 if self.write_packet(d_time_s, d_lat, d_lon) {
416 self.flush_in_flight(false);
420 pub fn stop_recording(&mut self, tap: &TimeAndPos) -> u16 {
421 // Mark the end of the points stream.
422 self.write_packet(0xffffffff, 0, 0);
423 self.flush_in_flight(true);
426 let duration = (tap.unix_time - self.recording_started) as u16;
428 let start = self.write_buffer_offset;
430 let dst = &mut self.write_buffer[start..end];
432 dst.copy_from_slice(&duration.to_le_bytes());
434 let this_sector = self.first_sector + self.sectors_written;
436 if self.storage.write(this_sector as usize * SECTOR_SIZE,
437 &self.write_buffer).is_err() {
441 self.sectors_written += 1;
443 for i in 0..self.sectors_written {
444 self.read_sector_header((self.first_sector + i) as usize);
450 fn sector_header_iter(&self) -> SectorHeaderIter {
451 SectorHeaderIter::new(self)
454 fn find_next_record_slot(&mut self) {
455 let mut candidate_index = 0;
456 let mut max_recording_id = 0;
458 for index in self.sector_header_iter() {
459 candidate_index = index;
461 let sector_header = &self.sector_header[index];
463 if !sector_header.is_in_use() {
464 // Due to our sorting we know that there will be no more
465 // used directory entries following. At this point
466 // we aren't interested in unused ones, so break the loop.
471 max(max_recording_id, sector_header.recording_id);
474 self.first_sector = candidate_index as u16;
475 self.recording_id = max_recording_id.wrapping_add(1);
478 fn write_packet(&mut self, d_time_s: u32, d_lat: i32, d_lon: i32) -> bool {
480 let in_flight = &mut self.in_flight[self.num_in_flight];
482 in_flight.d_time_s = d_time_s;
483 in_flight.d_lat = normalize_angle(d_lat);
484 in_flight.d_lon = normalize_angle(d_lon);
487 self.num_in_flight += 1;
489 self.num_in_flight == self.in_flight.len()
492 // Flushes the "in flight" items to the write buffer.
494 // @param is_final @c true iff this is the final flush in this recording.
496 // @note May only be called if logger.num_in_flight is greater than zero.
497 fn flush_in_flight(&mut self, is_final: bool) {
500 // Normally our items will have a time delta of one second.
501 // Mark the ones that differ from that.
502 for i in 0..self.num_in_flight {
503 if self.in_flight[i].d_time_s != 1 {
508 let mut buffer = [0u8; 128];
511 buffer[offset] = flags;
514 for i in 0..(self.num_in_flight - 1) {
515 let in_flight = &self.in_flight[i];
517 // Only write the time delta for the atypical cases.
518 if (flags & (1 << i)) != 0 {
520 varint::write_u32(&mut buffer[offset..], in_flight.d_time_s);
524 varint::write_s32(&mut buffer[offset..], in_flight.d_lat);
527 varint::write_s32(&mut buffer[offset..], in_flight.d_lon);
530 let i = self.num_in_flight - 1;
531 let in_flight = &self.in_flight[i];
533 // Only write the time delta for the atypical cases.
534 if (flags & (1 << i)) != 0 {
536 varint::write_u32(&mut buffer[offset..], in_flight.d_time_s);
539 // The final point is an end-of-stream marker and doesn't store
543 varint::write_s32(&mut buffer[offset..], in_flight.d_lat);
546 varint::write_s32(&mut buffer[offset..], in_flight.d_lon);
549 self.num_in_flight = 0;
551 let num_bytes_written = offset;
553 let remaining = self.write_buffer.len() - self.write_buffer_offset;
555 if remaining < num_bytes_written {
556 // We may use 0xff as padding bytes, since 0xff isn't a valid
557 // first byte in a points batch. prepare_write_buffer() fills
558 // our buffer with 0xff, so we don't need to do anything here.
559 let this_sector = self.first_sector + self.sectors_written;
561 if self.storage.write(this_sector as usize * SECTOR_SIZE,
562 &self.write_buffer).is_err() {
566 self.sectors_written += 1;
568 self.prepare_write_buffer(false);
571 let start = self.write_buffer_offset;
572 let end = start + num_bytes_written;
573 let dst = &mut self.write_buffer[start..end];
575 dst.copy_from_slice(&buffer[0..num_bytes_written]);
577 self.write_buffer_offset += num_bytes_written;
581 /// Write a listing of the stored recordings to @p tx_buf.
582 pub fn list_recordings(&mut self, tx_buf: &mut Buffer) {
583 for index in self.sector_header_iter().rev() {
584 let sector_header = &self.sector_header[index as usize];
586 if !sector_header.starts_recording() {
590 let mut date_time_s = [b' '; 19];
592 if let Some(tm) = Time::from_unix_time(sector_header.start_time) {
593 tm.fmt_date(&mut date_time_s[0..]);
594 tm.fmt_time(&mut date_time_s[11..]);
597 let mut recording_id_s = [b'0'; 9];
598 let recording_id_s_len =
599 fmt_u32_pad(&mut recording_id_s,
600 sector_header.recording_id as u32,
603 tx_buf.write(&date_time_s);
605 tx_buf.write(&recording_id_s[0..recording_id_s_len]);
613 /// Check whether or not recording @p recording_id exists.
614 pub fn has_recording(&mut self, recording_id: u16) -> bool {
615 if recording_id == 0 {
619 self.sector_header_iter().find(|&index| {
620 let sector_header = &self.sector_header[index as usize];
622 sector_header.recording_id == recording_id &&
623 sector_header.starts_recording()
628 /// Retrieve recording @p recording_id and
629 /// write it to @p tx_buf in yencoded form.
630 pub fn get_recording(&mut self, recording_id: u16,
631 tx_buf: &mut Buffer) -> Result<(), Error> {
632 if recording_id == 0 {
633 return Err(Error::NoSuchRecording);
636 if let Some(found_index) = self.sector_header_iter().find(|&index| {
637 let sector_header = &self.sector_header[index as usize];
639 sector_header.recording_id == recording_id &&
640 sector_header.starts_recording()
642 let mut filename = [b' '; 29];
644 filename[0..].copy_from_slice(b"gps-watch-recording-XXXXX.bin");
646 fmt_u32_pad(&mut filename[20..], recording_id as u32, 5, b'0');
648 let mut yenc = Yencode::new(tx_buf);
650 yenc.start(&filename);
652 let format_version = 1u8;
653 yenc.data(&[format_version]);
655 let mut next_sector = found_index as usize;
657 for _ in 0..NUM_SECTORS {
658 let address = next_sector * SECTOR_SIZE;
659 let mut buf = [0u8; SECTOR_SIZE];
661 self.storage.read(address, &mut buf);
663 // Skip flags and recording ID.
664 yenc.data(&buf[4..]);
667 next_sector &= NUM_SECTORS - 1;
669 if !self.sector_header[next_sector].belongs_to(recording_id) {
680 Err(Error::NoSuchRecording)