cosmos 4.2.4-java → 4.3.0-java

data/lib/cosmos/interfaces/protocols/ignore_packet_protocol.rb

@@ -0,0 +1,46 @@
+# encoding: ascii-8bit
+
+# Copyright 2018 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'cosmos/config/config_parser'
+require 'cosmos/interfaces/protocols/protocol'
+require 'cosmos/utilities/crc'
+require 'thread'
+
+module Cosmos
+  # Ignore a specific packet by not letting it through the protocol
+  class IgnorePacketProtocol < Protocol
+    # @param target_name [String] Target name
+    # @param packet_name [String] Packet name
+    def initialize(target_name, packet_name, allow_empty_data = nil)
+      super(allow_empty_data)
+      System.telemetry.packet(target_name, packet_name)
+      @target_name = target_name
+      @packet_name = packet_name
+    end
+
+    def read_packet(packet)
+      # Need to make sure packet is identified and defined
+      target_names = nil
+      target_names = @interface.target_names if @interface
+      identified_packet = System.telemetry.identify_and_define_packet(packet, target_names)
+      if identified_packet
+        if identified_packet.target_name == @target_name && identified_packet.packet_name == @packet_name
+          return :STOP
+        end
+      end
+      return super(packet)
+    end
+
+    def write_packet(packet)
+      return :STOP if packet.target_name == @target_name && packet.packet_name == @packet_name
+      return super(packet)
+    end
+  end
+end

data/lib/cosmos/interfaces/protocols/preidentified_protocol.rb

@@ -9,6 +9,7 @@
 # attribution addendums as found in the LICENSE.txt
 
 require 'cosmos/interfaces/protocols/burst_protocol'
+require 'cosmos/packet_logs/packet_log_reader'
 
 module Cosmos
   # Delineates packets using the COSMOS preidentification system
@@ -17,10 +18,11 @@ module Cosmos
     # @param sync_pattern (see BurstProtocol#initialize)
     # @param max_length [Integer] The maximum allowed value of the length field
     # @param allow_empty_data [true/false/nil] See Protocol#initialize
-    def initialize(sync_pattern = nil, max_length = nil, allow_empty_data = nil)
+    def initialize(sync_pattern = nil, max_length = nil, mode = 4, allow_empty_data = nil)
       super(0, sync_pattern, false, allow_empty_data)
       @max_length = ConfigParser.handle_nil(max_length)
       @max_length = Integer(@max_length) if @max_length
+      @mode = Integer(mode)
     end
 
     def reset
@@ -29,21 +31,34 @@ module Cosmos
     end
 
     def read_packet(packet)
-      packet.received_time = @received_time
-      packet.target_name = @target_name
-      packet.packet_name = @packet_name
+      packet.received_time = @read_received_time
+      packet.target_name = @read_target_name
+      packet.packet_name = @read_packet_name
+      if @mode == 4 # COSMOS4.3+ Protocol
+        packet.stored = @read_stored
+        packet.extra = @read_extra
+      end
       return packet
     end
 
     def write_packet(packet)
       received_time = packet.received_time
       received_time = Time.now unless received_time
-      @time_seconds = [received_time.tv_sec].pack('N') # UINT32
-      @time_microseconds = [received_time.tv_usec].pack('N') # UINT32
-      @target_name = packet.target_name
-      @target_name = 'UNKNOWN' unless @target_name
-      @packet_name = packet.packet_name
-      @packet_name = 'UNKNOWN' unless @packet_name
+      @write_time_seconds = [received_time.tv_sec].pack('N') # UINT32
+      @write_time_microseconds = [received_time.tv_usec].pack('N') # UINT32
+      @write_target_name = packet.target_name
+      @write_target_name = 'UNKNOWN' unless @write_target_name
+      @write_packet_name = packet.packet_name
+      @write_packet_name = 'UNKNOWN' unless @write_packet_name
+      if @mode == 4 # COSMOS4.3+ Protocol
+        @write_flags = 0
+        @write_flags |= PacketLogReader::COSMOS4_STORED_FLAG_MASK if packet.stored
+        @write_extra = nil
+        if packet.extra
+          @write_flags |= PacketLogReader::COSMOS4_EXTRA_FLAG_MASK
+          @write_extra = packet.extra.to_json
+        end
+      end
       return packet
     end
 
@@ -51,12 +66,19 @@ module Cosmos
       data_length = [data.length].pack('N') # UINT32
       data_to_send = ''
       data_to_send << @sync_pattern if @sync_pattern
-      data_to_send << @time_seconds
-      data_to_send << @time_microseconds
-      data_to_send << @target_name.length
-      data_to_send << @target_name
-      data_to_send << @packet_name.length
-      data_to_send << @packet_name
+      if @mode == 4 # COSMOS4.3+ Protocol
+        data_to_send << @write_flags
+        if @write_extra
+          data_to_send << [@write_extra.length].pack('N')
+          data_to_send << @write_extra
+        end
+      end
+      data_to_send << @write_time_seconds
+      data_to_send << @write_time_microseconds
+      data_to_send << @write_target_name.length
+      data_to_send << @write_target_name
+      data_to_send << @write_packet_name.length
+      data_to_send << @write_packet_name
       data_to_send << data_length
       data_to_send << data
       return data_to_send
@@ -104,27 +126,50 @@ module Cosmos
         @reduction_state = :SYNC_REMOVED
       end
 
-      # Read and remove packet received time
-      if @reduction_state == :SYNC_REMOVED
+      if @reduction_state == :SYNC_REMOVED and @mode == 4
+        # Read and remove flags
+        return :STOP if @data.length < 1
+        flags = @data[0].unpack('C')[0] # byte
+        @data.replace(@data[1..-1])
+        @read_stored = false
+        @read_stored = true if (flags & PacketLogReader::COSMOS4_STORED_FLAG_MASK) != 0
+        @read_extra = nil
+        if (flags & PacketLogReader::COSMOS4_EXTRA_FLAG_MASK) != 0
+          @reduction_state = :NEED_EXTRA
+        else
+          @reduction_state = :FLAGS_REMOVED
+        end
+      end
+
+      if @reduction_state == :NEED_EXTRA
+        # Read and remove extra
+        @read_extra = read_length_field_followed_by_string(4)
+        return :STOP if @read_extra == :STOP
+        @read_extra = JSON.parse(@read_extra)
+        @reduction_state = :FLAGS_REMOVED
+      end
+
+      if @reduction_state == :FLAGS_REMOVED or (@reduction_state == :SYNC_REMOVED and @mode != 4)
+        # Read and remove packet received time
         return :STOP if @data.length < 8
         time_seconds = @data[0..3].unpack('N')[0] # UINT32
         time_microseconds = @data[4..7].unpack('N')[0] # UINT32
-        @received_time = Time.at(time_seconds, time_microseconds).sys
+        @read_received_time = Time.at(time_seconds, time_microseconds).sys
         @data.replace(@data[8..-1])
         @reduction_state = :TIME_REMOVED
       end
 
       if @reduction_state == :TIME_REMOVED
         # Read and remove the target name
-        @target_name = read_length_field_followed_by_string(1)
-        return :STOP if @target_name == :STOP
+        @read_target_name = read_length_field_followed_by_string(1)
+        return :STOP if @read_target_name == :STOP
         @reduction_state = :TARGET_NAME_REMOVED
       end
 
       if @reduction_state == :TARGET_NAME_REMOVED
         # Read and remove the packet name
-        @packet_name = read_length_field_followed_by_string(1)
-        return :STOP if @packet_name == :STOP
+        @read_packet_name = read_length_field_followed_by_string(1)
+        return :STOP if @read_packet_name == :STOP
         @reduction_state = :PACKET_NAME_REMOVED
       end
 

data/lib/cosmos/packet_logs/packet_log_reader.rb

@@ -35,6 +35,18 @@ module Cosmos
     COSMOS1_LOG_TYPE_RANGE = 6..8
     COSMOS1_CONFIGURATION_NAME_RANGE = 10..41
 
+    # COSMOS 4.3+ log file header definition
+    COSMOS4_MARKER = 'COSMOS4_'
+    COSMOS4_HEADER_LENGTH = COSMOS2_HEADER_LENGTH
+    COSMOS4_MARKER_RANGE = COSMOS2_MARKER_RANGE
+    COSMOS4_LOG_TYPE_RANGE = COSMOS2_LOG_TYPE_RANGE
+    COSMOS4_CONFIGURATION_NAME_RANGE = COSMOS2_CONFIGURATION_NAME_RANGE
+    COSMOS4_HOSTNAME_RANGE = COSMOS2_HOSTNAME_RANGE
+    COSMOS4_STORED_FLAG_MASK = 0x80
+    COSMOS4_EXTRA_FLAG_MASK = 0x40
+
+    MAX_READ_SIZE = 1000000000
+
     # Create a new log file reader
     def initialize
       reset()
@@ -62,10 +74,10 @@ module Cosmos
         packet = read(identify_and_define)
         break unless packet
 
-        received_time = packet.received_time
-        if received_time
-          next if start_time and received_time < start_time
-          break if end_time and received_time > end_time
+        time = packet.packet_time
+        if time
+          next if start_time and time < start_time
+          break if end_time and time > end_time
         end
 
         yield packet
@@ -115,6 +127,8 @@ module Cosmos
       reset()
       @filename = filename
       @file = BufferedFile.open(@filename, 'rb')
+      @max_read_size = @file.size
+      @max_read_size = MAX_READ_SIZE if @max_read_size > MAX_READ_SIZE
       @bytes_read = 0
       return read_file_header()
     rescue => err
@@ -133,11 +147,11 @@ module Cosmos
     # @return [Packet]
     def read(identify_and_define = true)
       # Read the Packet Header
-      success, target_name, packet_name, received_time = read_entry_header()
+      success, target_name, packet_name, received_time, stored, extra = read_entry_header()
       return nil unless success
 
       # Read Packet Data
-      packet_data = @file.read_length_bytes(4)
+      packet_data = @file.read_length_bytes(4, @max_read_size)
       return nil unless packet_data and packet_data.length > 0
 
       if identify_and_define
@@ -147,6 +161,8 @@ module Cosmos
         packet = Packet.new(target_name, packet_name, :BIG_ENDIAN, nil, packet_data)
         packet.set_received_time_fast(received_time)
       end
+      packet.stored = stored
+      packet.extra = extra
 
       # Auto change configuration on SYSTEM META
       if packet.target_name == 'SYSTEM'.freeze and packet.packet_name == 'META'.freeze
@@ -231,11 +247,13 @@ module Cosmos
 
     def reset
       @file = nil
+      @max_read_size = MAX_READ_SIZE
       @filename = nil
       @log_type = :TLM
       @configuration_name = nil
       @hostname = nil
-      @file_header_length = COSMOS2_HEADER_LENGTH
+      @mode = 4
+      @file_header_length = COSMOS4_HEADER_LENGTH
     end
 
     # This is best effort. May return unidentified/undefined packets
@@ -269,10 +287,15 @@ module Cosmos
 
     # Should return if successfully switched to requested configuration
     def read_file_header
-      header = @file.read(COSMOS2_HEADER_LENGTH)
-      if header and header.length == COSMOS2_HEADER_LENGTH
-        if header[COSMOS2_MARKER_RANGE] == COSMOS2_MARKER
-          # Found COSMOS 2 File Header
+      header = @file.read(COSMOS4_HEADER_LENGTH)
+      if header and header.length == COSMOS4_HEADER_LENGTH
+        if header[COSMOS4_MARKER_RANGE] == COSMOS4_MARKER or header[COSMOS2_MARKER_RANGE] == COSMOS2_MARKER
+          # Found COSMOS 2/4 File Header
+          if header[COSMOS4_MARKER_RANGE] == COSMOS4_MARKER
+            @mode = 4
+          else
+            @mode = 2
+          end
           @log_type = header[COSMOS2_LOG_TYPE_RANGE].intern
           raise "Unknown log type #{@log_type}" unless [:CMD, :TLM].include? @log_type
           @configuration_name = header[COSMOS2_CONFIGURATION_NAME_RANGE]
@@ -283,6 +306,7 @@ module Cosmos
           return false, error # Did not successfully change to requested configuration name
         elsif header[COSMOS1_MARKER_RANGE] == COSMOS1_MARKER
           # Found COSMOS 1 File Header
+          @mode = 1
           @log_type = header[COSMOS1_LOG_TYPE_RANGE].upcase.intern
           raise "Unknown log type #{@log_type}" unless [:CMD, :TLM].include? @log_type
           @configuration_name = header[COSMOS1_CONFIGURATION_NAME_RANGE]
@@ -297,29 +321,48 @@ module Cosmos
           raise "COSMOS file header not found on packet log"
         end
       else
-        raise "Failed to read at least #{COSMOS2_HEADER_LENGTH} bytes from packet log"
+        raise "Failed to read at least #{COSMOS4_HEADER_LENGTH} bytes from packet log"
       end
     end
 
     def read_entry_header
+      stored = false
+      extra = nil
+
+      if @mode == 4
+        # Read Flags
+        flags = @file.read(1)
+        return [nil, nil, nil, nil, nil, nil] if flags.nil? or flags.length != 1
+        flags = flags.unpack('C')[0]
+
+        stored = true if (flags & COSMOS4_STORED_FLAG_MASK) != 0
+
+        if (flags & COSMOS4_EXTRA_FLAG_MASK) != 0
+          # Read Extra data
+          extra_data = @file.read_length_bytes(4, @max_read_size)
+          return [nil, nil, nil, nil, nil, nil] unless extra_data and extra_data.length > 0
+          extra = JSON.parse(extra_data)
+        end
+      end
+
       # Read Received Time
       time_seconds = @file.read(4)
-      return [nil, nil, nil, nil] if time_seconds.nil? or time_seconds.length != 4
+      return [nil, nil, nil, nil, nil, nil] if time_seconds.nil? or time_seconds.length != 4
       time_seconds = time_seconds.unpack('N')[0]
       time_microseconds = @file.read(4)
-      return [nil, nil, nil, nil] if time_microseconds.nil? or time_microseconds.length != 4
+      return [nil, nil, nil, nil, nil, nil] if time_microseconds.nil? or time_microseconds.length != 4
       time_microseconds = time_microseconds.unpack('N')[0]
       received_time = Time.at(time_seconds, time_microseconds).sys
 
       # Read Target Name
       target_name = @file.read_length_bytes(1)
-      return [nil, nil, nil, nil] unless target_name and target_name.length > 0
+      return [nil, nil, nil, nil, nil, nil] unless target_name and target_name.length > 0
 
       # Read Packet Name
       packet_name = @file.read_length_bytes(1)
-      return [nil, nil, nil, nil] unless packet_name and packet_name.length > 0
+      return [nil, nil, nil, nil, nil, nil] unless packet_name and packet_name.length > 0
 
-      return [true, target_name, packet_name, received_time]
+      return [true, target_name, packet_name, received_time, stored, extra]
     end
 
     def test
@@ -331,7 +374,7 @@ module Cosmos
       begin
         # Try to read the packet header
         # This will fail with file read errors and invalid timestamps
-        success, target_name, packet_name, _ = read_entry_header()
+        success, target_name, packet_name, _, _, _ = read_entry_header()
         if success
           if target_name !~ File::NON_ASCII_PRINTABLE and packet_name !~ File::NON_ASCII_PRINTABLE
             packet_data_length = @file.read(4)
@@ -402,17 +445,17 @@ module Cosmos
           # Read the first packet in the log
           first_packet = first()
           raise "Error reading first packet" unless first
-          raise "First Packet does not contain a packet received time" unless first_packet.received_time
+          raise "First Packet does not contain a packet received time" unless first_packet.packet_time
 
           # Read the last packet in the log
           file_size = size()
           last_packet = last()
           raise "Search failed looking for last packet" unless last_packet
-          raise "Last Packet does not contain a packet received time" unless last_packet.received_time
+          raise "Last Packet does not contain a packet received time" unless last_packet.packet_time
 
-          if time >= first_packet.received_time and time <= last_packet.received_time
+          if time >= first_packet.packet_time and time <= last_packet.packet_time
             # Guess at where to start looking for time in log
-            percentage = (time - first_packet.received_time) / (last_packet.received_time - first_packet.received_time)
+            percentage = (time - first_packet.packet_time) / (last_packet.packet_time - first_packet.packet_time)
             offset = (percentage * file_size.to_f).to_i
             offset = @file_header_length if offset < @file_header_length
             @file.seek(offset, IO::SEEK_SET)
@@ -420,10 +463,10 @@ module Cosmos
             # Move backwards until a packet before the time is found
             while true
               packet = search(-1, :BEFORE)
-              break if !packet or packet.received_time <= time
+              break if !packet or packet.packet_time <= time
 
               # Guess again
-              percentage = 1.0 - ((packet.received_time - time) / (packet.received_time - first_packet.received_time))
+              percentage = 1.0 - ((packet.packet_time - time) / (packet.packet_time - first_packet.packet_time))
               offset = (percentage * @file.pos.to_f).to_i
               offset = @file_header_length if offset < @file_header_length
               @file.seek(offset, IO::SEEK_SET)
@@ -434,7 +477,7 @@ module Cosmos
               position = @file.pos
               packet = read(false)
               raise "Search failed looking for packet after time" unless packet
-              if packet.received_time >= time
+              if packet.packet_time >= time
                 # Back up this packet so the read can get it because we want it
                 @file.seek(position, IO::SEEK_SET)
                 break
@@ -442,7 +485,7 @@ module Cosmos
             end
 
           else
-            if time > last_packet.received_time
+            if time > last_packet.packet_time
               # File is entirely before time, so jump to the end
               @file.seek(0, IO::SEEK_END)
             else

data/lib/cosmos/packet_logs/packet_log_writer.rb

@@ -311,7 +311,7 @@ module Cosmos
 
     def build_file_header(configuration_name = System.configuration_name)
       hostname = Socket.gethostname.to_s
-      file_header = "COSMOS2_#{@log_type}_#{configuration_name.ljust(32, ' ')[0..31]}_"
+      file_header = "COSMOS4_#{@log_type}_#{configuration_name.ljust(32, ' ')[0..31]}_"
       file_header << hostname.ljust(83)
       return file_header
     end
@@ -322,6 +322,18 @@ module Cosmos
       # This is an optimization to avoid creating a new entry_header object
       # each time we create an entry_header which we do a LOT!
       @entry_header.clear
+      flags = 0
+      flags |= PacketLogReader::COSMOS4_STORED_FLAG_MASK if packet.stored
+      extra = packet.extra
+      if extra
+        flags |= PacketLogReader::COSMOS4_EXTRA_FLAG_MASK
+        extra = extra.to_json
+      end
+      @entry_header << [flags].pack('C'.freeze)
+      if extra
+        @entry_header << [extra.length].pack('N'.freeze)
+        @entry_header << extra
+      end
       @entry_header << [received_time.tv_sec].pack('N'.freeze)
       @entry_header << [received_time.tv_usec].pack('N'.freeze)
       target_name = packet.target_name

data/lib/cosmos/packets/commands.rb

@@ -102,7 +102,9 @@ module Cosmos
         target_packets.each do |packet_name, packet|
           if (packet.identify?(packet_data))
             identified_packet = packet.clone
-            identified_packet.received_time  = nil
+            identified_packet.received_time = nil
+            identified_packet.stored = false
+            identified_packet.extra = nil
             identified_packet.received_count = 0
             identified_packet.buffer = packet_data
             break
@@ -141,6 +143,8 @@ module Cosmos
 
       # Set time, parameters, and restore defaults
       command.received_time = Time.now.sys
+      command.stored = false
+      command.extra = nil
       command.given_values = params
       command.restore_defaults(command.buffer(false), params.keys)
       command.raw = raw