cosmos 4.3.0-java → 4.4.0-java

data/lib/cosmos/interfaces.rb

@@ -21,3 +21,4 @@ require 'cosmos/interfaces/protocols/terminated_protocol'
 
 require 'cosmos/interfaces/protocols/override_protocol'
 require 'cosmos/interfaces/protocols/crc_protocol'
+require 'cosmos/interfaces/protocols/ignore_packet_protocol'

data/lib/cosmos/interfaces/interface.rb

@@ -283,7 +283,11 @@ module Cosmos
 
     # Wrap all writes in a mutex and handle errors
     def _write
-      @write_mutex.synchronize { yield }
+      if @write_mutex.owned?
+        yield
+      else
+        @write_mutex.synchronize { yield }
+      end
     rescue Exception => err
       Logger.instance.error("Error writing to interface : #{@name}")
       disconnect()

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

@@ -68,37 +68,59 @@ module Cosmos
 
       @interface.target_names.each do |target_name|
         target_packets = nil
+        unique_id_mode = false
         begin
           if @telemetry
             target_packets = System.telemetry.packets(target_name)
+            target = System.targets[target_name]
+            unique_id_mode = target.tlm_unique_id_mode if target
           else
             target_packets = System.commands.packets(target_name)
+            target = System.targets[target_name]
+            unique_id_mode = target.cmd_unique_id_mode if target
           end
         rescue RuntimeError
-          # No telemetry for this target
+          # No commands/telemetry for this target
           next
         end
 
-        target_packets.each do |packet_name, packet|
-          if packet.identify?(@data)
-            identified_packet = packet
-            if identified_packet.defined_length > @data.length
-              # Check if need more data to finish packet
-              return :STOP if @data.length < identified_packet.defined_length
+        if unique_id_mode
+          target_packets.each do |packet_name, packet|
+            if packet.identify?(@data[@discard_leading_bytes .. -1])
+              identified_packet = packet
+              break
             end
-            # Set some variables so we can update the packet in
-            # read_packet
-            @received_time = Time.now.sys
-            @target_name = identified_packet.target_name
-            @packet_name = identified_packet.packet_name
-
-            # Get the data from this packet
-            packet_data = @data[0..(identified_packet.defined_length - 1)]
-            @data.replace(@data[identified_packet.defined_length..-1])
-            break
           end
+        else
+          # Do a hash lookup to quickly identify the packet
+          if target_packets.length > 0
+            packet = target_packets.first[1]
+            key = packet.read_id_values(@data[@discard_leading_bytes .. -1])
+            if @telemetry
+              hash = System.telemetry.config.tlm_id_value_hash[target_name]
+            else
+              hash = System.commands.config.cmd_id_value_hash[target_name]
+            end
+            identified_packet = hash[key]
+            identified_packet = hash['CATCHALL'.freeze] unless identified_packet
+          end          
+        end
+        
+        if identified_packet
+          if identified_packet.defined_length + @discard_leading_bytes > @data.length
+            # Check if need more data to finish packet
+            return :STOP
+          end
+          # Set some variables so we can update the packet in
+          # read_packet
+          @received_time = Time.now.sys
+          @target_name = identified_packet.target_name
+          @packet_name = identified_packet.packet_name
+
+          # Get the data from this packet
+          packet_data = @data.slice!(0, identified_packet.defined_length + @discard_leading_bytes)
+          break
         end
-        break if identified_packet
       end
 
       unless identified_packet

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

@@ -62,6 +62,7 @@ module Cosmos
         allow_empty_data)
       @response_template = nil
       @response_packet = nil
+      @response_target_name = nil
       @response_packets = []
       @write_block_queue = Queue.new
       @ignore_lines = ignore_lines.to_i
@@ -124,7 +125,7 @@ module Cosmos
         end
 
         # Grab the response packet specified in the command
-        result_packet = System.telemetry.packet(@interface.target_names[0], @response_packet).clone
+        result_packet = System.telemetry.packet(@response_target_name, @response_packet).clone
         result_packet.received_time = nil
         result_packet.id_items.each do |item|
           result_packet.write_item(item, item.id_value, :RAW)
@@ -181,17 +182,20 @@ module Cosmos
       begin
         @response_template = packet.read("RSP_TEMPLATE").strip
         @response_packet = packet.read("RSP_PACKET").strip
+        @response_target_name = packet.target_name
         # If the template or packet are empty set them to nil. This allows for
         # the user to remove the RSP_TEMPLATE and RSP_PACKET values and avoid
         # any response timeouts
         if @response_template.empty? || @response_packet.empty?
           @response_template = nil
           @response_packet = nil
+          @response_target_name = nil
         end
       rescue
         # If there is no response template we set to nil
         @response_template = nil
         @response_packet = nil
+        @response_target_name = nil
       end
 
       # Grab the command template because that is all we eventually send
@@ -235,6 +239,7 @@ module Cosmos
 
         @response_template = nil
         @response_packet = nil
+        @response_target_name = nil
         @response_packets.clear
       end
       return super(packet, data)

data/lib/cosmos/interfaces/simulated_target_interface.rb

@@ -56,10 +56,14 @@ module Cosmos
       if @connected
         packet = first_pending_packet()
         if packet
-          # This is just to support the override functionality
+          # Support read_packet (but not read data) in protocols
           # Generic protocol use is not supported
-          packet = @read_protocols[0].read_packet(packet)
-          return packet
+          @read_protocols.each do |protocol|
+            packet = protocol.read_packet(packet)
+            return nil if packet == :DISCONNECT # Disconnect handled by thread
+            break if packet == :STOP
+          end
+          return packet unless packet == :STOP
         end
 
         while true
@@ -80,9 +84,14 @@ module Cosmos
 
           packet = first_pending_packet()
           if packet
-            # This is just to support the override functionality
+            # Support read_packet (but not read data) in protocols
             # Generic protocol use is not supported
-            packet = @read_protocols[0].read_packet(packet)
+            @read_protocols.each do |protocol|
+              packet = protocol.read_packet(packet)
+              return nil if packet == :DISCONNECT # Disconnect handled by thread
+              break if packet == :STOP
+            end
+            next if packet == :STOP
             return packet
           end
         end

data/lib/cosmos/io/json_drb.rb

@@ -44,14 +44,19 @@ module Puma
 end
 
 module Cosmos
-
   # JsonDRb implements the JSON-RPC 2.0 Specification to provide an interface
   # for both internal and external tools to access the COSMOS server. It
   # provides methods to install an access control list to control access to the
   # API. It also limits the available methods to a known list of allowable API
   # methods.
   class JsonDRb
+    # Minimum amount of time in seconds to receive the JSON request,
+    # process it, and send the response. Requests for less than this amount
+    # will be set to the minimum
     MINIMUM_REQUEST_TIME = 0.0001
+    STOP_SERVICE_TIMEOUT = 10.0 # seconds to wait when stopping the service
+    PUMA_THREAD_TIMEOUT  = 10.0 # seconds to wait for the puma threads to die
+    SERVER_START_TIMEOUT = 15.0 # seconds to wait for the server to start
 
     @@debug = false
 
@@ -94,9 +99,9 @@ module Cosmos
 
     # Stops the DRb service by closing the socket and the processing thread
     def stop_service
-      # Kill the server thread; it can take a while, so use
-      # graceful_timeout = 5, timeout_interval = 0.1, hard_timeout = 5
-      Cosmos.kill_thread(self, @thread, 5, 0.1, 5)
+      # Kill the server thread
+      # parameters are owner, thread, graceful_timeout, timeout_interval, hard_timeout
+      Cosmos.kill_thread(self, @thread, STOP_SERVICE_TIMEOUT, 0.1, STOP_SERVICE_TIMEOUT)
       @thread = nil
       @server_mutex.synchronize do
         @server = nil
@@ -155,7 +160,7 @@ module Cosmos
               puma_threads = false
               Thread.list.each {|thread| puma_threads = true if thread.inspect.match(/puma/)}
               break if !puma_threads
-              break if (Time.now - start_time) > 10.0
+              break if (Time.now - start_time) > PUMA_THREAD_TIMEOUT
               sleep 0.25
             end
 
@@ -184,7 +189,7 @@ module Cosmos
 
         # Wait for the server to be started in the thread before returning.
         start_time = Time.now
-        while ((Time.now - start_time) < 5.0) and !server_started
+        while ((Time.now - start_time) < SERVER_START_TIMEOUT) and !server_started
           sleep(0.1)
           @server_mutex.synchronize do
             server_started = true if @server and @server.running
@@ -308,4 +313,3 @@ module Cosmos
 
   end
 end
-

data/lib/cosmos/packets/commands.rb

@@ -90,6 +90,8 @@ module Cosmos
       target_names = target_names() unless target_names
 
       target_names.each do |target_name|
+        target_name = target_name.to_s.upcase
+        
         target_packets = nil
         begin
           target_packets = packets(target_name)
@@ -98,20 +100,35 @@ module Cosmos
           next
         end
 
-        # Iterate through the packets and see if any represent the buffer
-        target_packets.each do |packet_name, packet|
-          if (packet.identify?(packet_data))
-            identified_packet = packet.clone
-            identified_packet.received_time = nil
-            identified_packet.stored = false
-            identified_packet.extra = nil
-            identified_packet.received_count = 0
-            identified_packet.buffer = packet_data
-            break
+        target = System.targets[target_name]
+        if target and target.cmd_unique_id_mode
+          # Iterate through the packets and see if any represent the buffer
+          target_packets.each do |packet_name, packet|
+            if packet.identify?(packet_data)
+              identified_packet = packet
+              break
+            end
           end
+        else
+          # Do a hash lookup to quickly identify the packet
+          if target_packets.length > 0
+            packet = target_packets.first[1]
+            key = packet.read_id_values(packet_data)
+            hash = @config.cmd_id_value_hash[target_name]
+            identified_packet = hash[key]
+            identified_packet = hash['CATCHALL'.freeze] unless identified_packet
+          end          
         end
 
-        break if identified_packet
+        if identified_packet
+          identified_packet = identified_packet.clone
+          identified_packet.received_time = nil
+          identified_packet.stored = false
+          identified_packet.extra = nil
+          identified_packet.received_count = 0
+          identified_packet.buffer = packet_data
+          break
+        end
       end
 
       return identified_packet

data/lib/cosmos/packets/packet.rb

@@ -8,7 +8,7 @@
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
 
-require 'digest/md5'
+require 'digest'
 require 'cosmos/packets/structure'
 require 'cosmos/packets/packet_item'
 require 'cosmos/ext/packet' if RUBY_ENGINE == 'ruby' and !ENV['COSMOS_NO_EXT']
@@ -186,36 +186,58 @@ module Cosmos
         @read_conversion_cache.clear if @read_conversion_cache
         @received_count
       end
+      
+    end # if RUBY_ENGINE != 'ruby' or ENV['COSMOS_NO_EXT']      
+      
+    # Tries to identify if a buffer represents the currently defined packet. It
+    # does this by iterating over all the packet items that were created with
+    # an ID value and checking whether that ID value is present at the correct
+    # location in the buffer.
+    #
+    # Incorrectly sized buffers will still positively identify if there is
+    # enough data to match the ID values. This is to allow incorrectly sized
+    # packets to still be processed as well as possible given the incorrectly
+    # sized data.
+    #
+    # @param buffer [String] Raw buffer of binary data
+    # @return [Boolean] Whether or not the buffer of data is this packet
+    def identify?(buffer)
+      return false unless buffer
+      return true unless @id_items
 
-      # Tries to identify if a buffer represents the currently defined packet. It
-      # does this by iterating over all the packet items that were created with
-      # an ID value and checking whether that ID value is present at the correct
-      # location in the buffer.
-      #
-      # Incorrectly sized buffers will still positively identify if there is
-      # enough data to match the ID values. This is to allow incorrectly sized
-      # packets to still be processed as well as possible given the incorrectly
-      # sized data.
-      #
-      # @param buffer [String] Raw buffer of binary data
-      # @return [Boolean] Whether or not the buffer of data is this packet
-      def identify?(buffer)
-        return false unless buffer
-        return true unless @id_items
-
-        @id_items.each do |item|
-          begin
-            value = read_item(item, :RAW, buffer)
-          rescue Exception
-            value = nil
-          end
-          return false if item.id_value != value
+      @id_items.each do |item|
+        begin
+          value = read_item(item, :RAW, buffer)
+        rescue Exception
+          value = nil
         end
-
-        true
+        return false if item.id_value != value
       end
-    end # if RUBY_ENGINE != 'ruby' or ENV['COSMOS_NO_EXT']
 
+      true
+    end
+    
+    # Reads the values from a buffer at the position of each id_item defined
+    # in the packet.
+    #
+    # @param buffer [String] Raw buffer of binary data
+    # @return [Array] Array of read id values in order
+    def read_id_values(buffer)
+      return [] unless buffer
+      return [] unless @id_items
+      values = []
+      
+      @id_items.each do |item|
+        begin
+          values << read_item(item, :RAW, buffer)
+        rescue Exception
+          values << nil
+        end
+      end
+      
+      values
+    end
+    
     # Returns @received_time unless a packet item called PACKET_TIME exists that returns
     # a Ruby Time object that represents a different timestamp for the packet
     def packet_time
@@ -227,7 +249,7 @@ module Cosmos
       end
     end
 
-    # Calculates a unique MD5Sum that changes if the parts of the packet configuration change that could affect
+    # Calculates a unique hashing sum that changes if the parts of the packet configuration change that could affect
     # the "shape" of the packet.  This value is cached and that packet should not be changed if this method is being used
     def config_name
       return @config_name if @config_name
@@ -235,7 +257,9 @@ module Cosmos
       @sorted_items.each do |item|
         string << " ITEM #{item.name} #{item.bit_offset} #{item.bit_size} #{item.data_type} #{item.array_size} #{item.endianness} #{item.overflow} #{item.states} #{item.read_conversion ? item.read_conversion.class : 'NO_CONVERSION'}"
       end
-      digest = Digest::MD5.new
+
+      # Use the hashing algorithm established by Cosmos::System
+      digest = Digest.const_get(System.hashing_algorithm).send('new')
       digest << string
       @config_name = digest.hexdigest
       @config_name
@@ -676,9 +700,10 @@ module Cosmos
     # @param value_type (see #read_item)
     # @param indent (see Structure#formatted)
     # @param buffer (see Structure#formatted)
+    # @param ignored (see Structure#ignored)
     # @return (see Structure#formatted)
-    def formatted(value_type = :CONVERTED, indent = 0, buffer = @buffer)
-      return super(value_type, indent, buffer)
+    def formatted(value_type = :CONVERTED, indent = 0, buffer = @buffer, ignored = nil)
+      return super(value_type, indent, buffer, ignored)
     end
 
     # Restore all items in the packet to their default value
@@ -852,7 +877,19 @@ module Cosmos
     def update_id_items(item)
       if item.id_value
         @id_items ||= []
-        @id_items << item
+        # Add to Id Items
+        unless @id_items.empty?
+          last_item = @id_items[-1]
+          @id_items << item
+          # If the current item or last item have a negative offset then we have
+          # to re-sort. We also re-sort if the current item is less than the last
+          # item because we are inserting.
+          if last_item.bit_offset <= 0 or item.bit_offset <= 0 or item.bit_offset < last_item.bit_offset
+            @id_items = @id_items.sort
+          end
+        else
+          @id_items << item
+        end
       end
       item
     end

data/lib/cosmos/packets/packet_config.rb

@@ -60,6 +60,16 @@ module Cosmos
     #   packet is not.
     attr_reader :latest_data
 
+    # @return [Hash<String>=>Hash<Array>=>Packet] Hash keyed by target name
+    # that returns a hash keyed by an array of id values.  The id values resolve to the packet
+    # defined by that identification.  Command version
+    attr_reader :cmd_id_value_hash
+
+    # @return [Hash<String>=>Hash<Array>=>Packet] Hash keyed by target name
+    # that returns a hash keyed by an array of id values.  The id values resolve to the packet
+    # defined by that identification.  Telemetry version
+    attr_reader :tlm_id_value_hash
+
     COMMAND = "Command"
     TELEMETRY = "Telemetry"
 
@@ -73,6 +83,8 @@ module Cosmos
       # Returns an array of packets with that target and item.
       @latest_data = {}
       @warnings = []
+      @cmd_id_value_hash = {}
+      @tlm_id_value_hash = {}
 
       # Create unknown packets
       @commands['UNKNOWN'] = {}
@@ -91,7 +103,8 @@ module Cosmos
     # knowledge of the commands, telemetry, and limits groups.
     #
     # @param filename [String] The name of the configuration file
-    # @param process_target_name [String] The target name
+    # @param process_target_name [String] The target name. Pass nil when parsing
+    #   an xtce file to automatically determine the target name.
     def process_file(filename, process_target_name)
       # Handle .xtce files
       if File.extname(filename).to_s.downcase == ".xtce"
@@ -274,8 +287,16 @@ module Cosmos
         if @current_cmd_or_tlm == COMMAND
           PacketParser.check_item_data_types(@current_packet)
           @commands[@current_packet.target_name][@current_packet.packet_name] = @current_packet
+          hash = @cmd_id_value_hash[@current_packet.target_name]
+          hash = {} unless hash
+          @cmd_id_value_hash[@current_packet.target_name] = hash
+          update_id_value_hash(hash)
         else
           @telemetry[@current_packet.target_name][@current_packet.packet_name] = @current_packet
+          hash = @tlm_id_value_hash[@current_packet.target_name]
+          hash = {} unless hash
+          @tlm_id_value_hash[@current_packet.target_name] = hash
+          update_id_value_hash(hash)
         end
         @current_packet = nil
         @current_item = nil
@@ -284,6 +305,18 @@ module Cosmos
 
     protected
 
+    def update_id_value_hash(hash)
+      if @current_packet.id_items.length > 0
+        key = []
+        @current_packet.id_items.each do |item|
+          key << item.id_value
+        end
+        hash[key] = @current_packet
+      else
+        hash['CATCHALL'.freeze] = @current_packet
+      end
+    end
+
     def reset_processing_variables
       @current_cmd_or_tlm = nil
       @current_packet = nil