openc3 5.15.2 → 5.16.0

data/lib/openc3/interfaces/protocols/burst_protocol.rb

@@ -22,7 +22,7 @@
 
 require 'openc3/config/config_parser'
 require 'openc3/interfaces/protocols/protocol'
-require 'thread'
+require 'openc3/ext/burst_protocol' if RUBY_ENGINE == 'ruby' and !ENV['OPENC3_NO_EXT']
 
 module OpenC3
   # Reads all data available on the interface and creates a packet
@@ -51,50 +51,116 @@ module OpenC3
       @sync_state = :SEARCHING
     end
 
-    # Reads from the interface. It can look for a sync pattern before
-    # creating a Packet. It can discard a set number of bytes at the beginning
-    # before creating the Packet.
-    #
-    # Note: On the first call to this from any interface read(), data will contain a blank
-    # string. Blank string is an opportunity for protocols to return any queued up packets.
-    # If they have no queued up packets, they should pass the blank string down to chained
-    # protocols giving them the same opportunity.
-    #
-    # @return [String|nil] Data for a packet consisting of the bytes read
-    def read_data(data, extra = nil)
-      @data << data
-      @extra = extra
-
-      while true
-        control = handle_sync_pattern()
-        return control if control and data.length > 0 # Only return here if not blank string test
-
-        # Reduce the data to a single packet
-        packet_data, extra = reduce_to_single_packet()
-        if packet_data == :RESYNC
+    if RUBY_ENGINE != 'ruby' or ENV['OPENC3_NO_EXT']
+
+      # Reads from the interface. It can look for a sync pattern before
+      # creating a Packet. It can discard a set number of bytes at the beginning
+      # before creating the Packet.
+      #
+      # Note: On the first call to this from any interface read(), data will contain a blank
+      # string. Blank string is an opportunity for protocols to return any queued up packets.
+      # If they have no queued up packets, they should pass the blank string down to chained
+      # protocols giving them the same opportunity.
+      #
+      # @return [String|nil] Data for a packet consisting of the bytes read
+      def read_data(data, extra = nil)
+        @data << data
+        @extra = extra
+
+        while true
+          control = handle_sync_pattern()
+          return control if control and data.length > 0 # Only return here if not blank string test
+
+          # Reduce the data to a single packet
+          packet_data, extra = reduce_to_single_packet()
+          if packet_data == :RESYNC
+            @sync_state = :SEARCHING
+            next if data.length > 0 # Only immediately resync if not blank string test
+          end
+
+          # Potentially allow blank string to be sent to other protocols if no packet is ready in this one
+          if Symbol === packet_data
+            if (data.length <= 0) and packet_data != :DISCONNECT
+              # On blank string test, return blank string (unless we had a packet or need disconnect)
+              # The base class handles the special case of returning STOP if on the last protocol in the
+              # chain
+              return super(data, extra)
+            else
+              return packet_data, extra # Return any control code if not on blank string test
+            end
+          end
+
           @sync_state = :SEARCHING
-          next if data.length > 0 # Only immediately resync if not blank string test
+
+          # Discard leading bytes if necessary
+          packet_data.replace(packet_data[@discard_leading_bytes..-1]) if @discard_leading_bytes > 0
+          return packet_data, extra
         end
+      end
 
-        # Potentially allow blank string to be sent to other protocols if no packet is ready in this one
-        if Symbol === packet_data
-          if (data.length <= 0) and packet_data != :DISCONNECT
-            # On blank string test, return blank string (unless we had a packet or need disconnect)
-            # The base class handles the special case of returning STOP if on the last protocol in the
-            # chain
-            return super(data, extra)
-          else
-            return packet_data, extra # Return any control code if not on blank string test
-          end
+      def reduce_to_single_packet
+        if @data.length <= 0
+          # Need some data
+          return :STOP
         end
 
-        @sync_state = :SEARCHING
+        # Reduce to packet data and clear data for next packet
+        packet_data = @data.clone
+        @data.replace('')
+        return packet_data, @extra
+      end
+
+      # @return [Boolean] control code (nil, :STOP)
+      def handle_sync_pattern
+        if @sync_pattern and @sync_state == :SEARCHING
+          loop do
+            # Make sure we have some data to look for a sync word in
+            return :STOP if @data.length < @sync_pattern.length
+
+            # Find the beginning of the sync pattern
+            sync_index = @data.index(@sync_pattern.getbyte(0).chr)
+            if sync_index
+              # Make sure we have enough data for the whole sync pattern past this index
+              return :STOP if @data.length < (sync_index + @sync_pattern.length)
+
+              # Check for the rest of the sync pattern
+              found = true
+              index = sync_index
+              @sync_pattern.each_byte do |byte|
+                if @data.getbyte(index) != byte
+                  found = false
+                  break
+                end
+                index += 1
+              end
 
-        # Discard leading bytes if necessary
-        packet_data.replace(packet_data[@discard_leading_bytes..-1]) if @discard_leading_bytes > 0
-        return packet_data, extra
+              if found
+                if sync_index != 0
+                  log_discard(sync_index, true)
+                  # Delete Data Before Sync Pattern
+                  @data.replace(@data[sync_index..-1])
+                end
+                @sync_state = :FOUND
+                return nil
+
+              else # not found
+                log_discard(sync_index + 1, false)
+                # Delete Data Before and including first character of suspected sync Pattern
+                @data.replace(@data[(sync_index + 1)..-1])
+                next
+              end # if found
+
+            else # sync_index = nil
+              log_discard(@data.length, false)
+              @data.replace('')
+              return :STOP
+            end # unless sync_index.nil?
+          end # end loop
+        end # if @sync_pattern
+        nil
       end
-    end
+
+    end # if RUBY_ENGINE != 'ruby' or ENV['OPENC3_NO_EXT']
 
     # Called to perform modifications on a command packet before it is sent
     #
@@ -131,56 +197,6 @@ module OpenC3
       return super(data, extra)
     end
 
-    # @return [Boolean] control code (nil, :STOP)
-    def handle_sync_pattern
-      if @sync_pattern and @sync_state == :SEARCHING
-        loop do
-          # Make sure we have some data to look for a sync word in
-          return :STOP if @data.length < @sync_pattern.length
-
-          # Find the beginning of the sync pattern
-          sync_index = @data.index(@sync_pattern.getbyte(0).chr)
-          if sync_index
-            # Make sure we have enough data for the whole sync pattern past this index
-            return :STOP if @data.length < (sync_index + @sync_pattern.length)
-
-            # Check for the rest of the sync pattern
-            found = true
-            index = sync_index
-            @sync_pattern.each_byte do |byte|
-              if @data.getbyte(index) != byte
-                found = false
-                break
-              end
-              index += 1
-            end
-
-            if found
-              if sync_index != 0
-                log_discard(sync_index, true)
-                # Delete Data Before Sync Pattern
-                @data.replace(@data[sync_index..-1])
-              end
-              @sync_state = :FOUND
-              return nil
-
-            else # not found
-              log_discard(sync_index + 1, false)
-              # Delete Data Before and including first character of suspected sync Pattern
-              @data.replace(@data[(sync_index + 1)..-1])
-              next
-            end # if found
-
-          else # sync_index = nil
-            log_discard(@data.length, false)
-            @data.replace('')
-            return :STOP
-          end # unless sync_index.nil?
-        end # end loop
-      end # if @sync_pattern
-      nil
-    end
-
     def log_discard(length, found)
       Logger.error("#{@interface ? @interface.name : ""}: Sync #{'not ' unless found}found. Discarding #{length} bytes of data.")
       if @data.length >= 0
@@ -193,17 +209,5 @@ module OpenC3
                              @data.length >= 6 ? @data.getbyte(5) : 0))
       end
     end
-
-    def reduce_to_single_packet
-      if @data.length <= 0
-        # Need some data
-        return :STOP
-      end
-
-      # Reduce to packet data and clear data for next packet
-      packet_data = @data.clone
-      @data.replace('')
-      return packet_data, @extra
-    end
   end
 end

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

@@ -102,7 +102,7 @@ module OpenC3
         end
 
         if unique_id_mode
-          target_packets.each do |packet_name, packet|
+          target_packets.each do |_packet_name, packet|
             if packet.identify?(@data[@discard_leading_bytes..-1])
               identified_packet = packet
               break
@@ -136,7 +136,15 @@ module OpenC3
           @packet_name = identified_packet.packet_name
 
           # Get the data from this packet
-          packet_data = @data.slice!(0, identified_packet.defined_length + @discard_leading_bytes)
+          # Previous implementation looked like the following:
+          #   packet_data = @data.slice!(0, identified_packet.defined_length + @discard_leading_bytes)
+          # But slice! is 6x slower at small packets (1024)
+          # and 1000x slower at large packets (1Mb)
+          # Run test/benchmarks/string_mod_benchmark.rb for details
+
+          # Triple dot range because it's effectively a length calculation and we start with 0
+          packet_data = @data[0...(identified_packet.defined_length + @discard_leading_bytes)]
+          @data = @data[(identified_packet.defined_length + @discard_leading_bytes)..-1]
           break
         end
       end
@@ -152,7 +160,7 @@ module OpenC3
         @data.replace('')
       end
 
-      return packet_data
+      return packet_data, @extra
     end
 
     def reduce_to_single_packet

data/lib/openc3/interfaces/serial_interface.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -65,6 +65,21 @@ module OpenC3
       @data_bits = 8
     end
 
+    def connection_string
+      type = ''
+      if @write_port_name and @read_port_name
+        port = @write_port_name
+        type = 'R/W'
+      elsif @write_port_name
+        port = @write_port_name
+        type = 'write only'
+      else
+        port = @read_port_name
+        type = 'read only'
+      end
+      return "#{port} (#{type}) #{@baud_rate} #{@parity} #{@stop_bits}"
+    end
+
     # Creates a new {SerialStream} using the parameters passed in the constructor
     def connect
       @stream = SerialStream.new(

data/lib/openc3/interfaces/simulated_target_interface.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -38,6 +38,10 @@ module OpenC3
       @write_raw_allowed = false
     end
 
+    def connection_string
+      return @sim_target_class.to_s
+    end
+
     # Initialize the simulated target object and "connect" to the target
     def connect
       unless @initialized
@@ -139,12 +143,12 @@ module OpenC3
     end
 
     # write_raw is not implemented and will raise a RuntimeError
-    def write_raw(data)
+    def write_raw(_data)
       raise "write_raw not implemented for SimulatedTargetInterface"
     end
 
     # Raise an error because raw logging is not supported for this interface
-    def stream_log_pair=(stream_log_pair)
+    def stream_log_pair=(_stream_log_pair)
       raise "Raw logging not supported for SimulatedTargetInterface"
     end
 

data/lib/openc3/interfaces/tcpip_client_interface.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -57,6 +57,23 @@ module OpenC3
       @write_raw_allowed = false unless @write_port
     end
 
+    def connection_string
+      # Probably most common is write == read so handle that
+      if @write_port == @read_port
+        return "#{@hostname}:#{@write_port} (R/W)"
+      end
+
+      result = ''
+      if @write_port
+        result += "#{@hostname}:#{@write_port} (write)"
+      end
+      if @read_port
+        result += ' ' if result.length != 0
+        result += "#{@hostname}:#{@read_port} (read)"
+      end
+      return result
+    end
+
     # Connects the {TcpipClientStream} by passing the
     # initialization parameters to the {TcpipClientStream}.
     def connect

data/lib/openc3/interfaces/tcpip_server_interface.rb

@@ -14,14 +14,13 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'socket'
-require 'thread' # For Mutex
 require 'timeout' # For Timeout::Error
 require 'openc3/interfaces/stream_interface'
 require 'openc3/streams/tcpip_socket_stream'
@@ -119,6 +118,16 @@ module OpenC3
       @connected = false
     end
 
+    def connection_string
+      if @write_port == @read_port
+        return "listening on #{@listen_address}:#{@write_port} (R/W)"
+      end
+      result = "listening on"
+      result += " #{@listen_address}:#{@write_port} (write)" if @write_port
+      result += " #{@listen_address}:#{@read_port} (read)" if @read_port
+      return result
+    end
+
     # Create the read and write port listen threads. Incoming connections will
     # spawn separate threads to process the reads and writes.
     def connect
@@ -137,20 +146,20 @@ module OpenC3
             write_thread_body()
             break if @cancel_threads
           end
-        rescue Exception => err
+        rescue Exception => e
           shutdown_interfaces(@write_interface_infos)
           Logger.error("#{@name}: Tcpip server write thread unexpectedly died")
-          Logger.error(err.formatted)
+          Logger.error(e.formatted)
         end
         @write_raw_thread = Thread.new do
           loop do
             write_raw_thread_body()
             break if @cancel_threads
           end
-        rescue Exception => err
+        rescue Exception => e
           shutdown_interfaces(@write_interface_infos)
           Logger.error("#{@name}: Tcpip server write raw thread unexpectedly died")
-          Logger.error(err.formatted)
+          Logger.error(e.formatted)
         end
       else
         @write_thread = nil
@@ -350,9 +359,9 @@ module OpenC3
           listen_thread_body(listen_socket, listen_write, listen_read, thread_reader)
           break if @cancel_threads
         end
-      rescue => err
+      rescue => e
         Logger.error("#{@name}: Tcpip server listen thread unexpectedly died")
-        Logger.error(err.formatted)
+        Logger.error(e.formatted)
       end
     end
 
@@ -432,9 +441,9 @@ module OpenC3
         begin
           begin
             read_thread_body(interface_info.interface)
-          rescue Exception => err
+          rescue Exception => e
             Logger.error "#{@name}: Tcpip server read thread unexpectedly died"
-            Logger.error err.formatted
+            Logger.error e.formatted
           end
           Logger.info "#{@name}: Tcpip server lost read connection to #{interface_info.hostname}(#{interface_info.host_ip}):#{interface_info.port}"
           @read_threads.delete(Thread.current)
@@ -456,9 +465,9 @@ module OpenC3
               @read_interface_infos.delete_at(index_to_delete)
             end
           end
-        rescue Exception => err
+        rescue Exception => e
           Logger.error "#{@name}: Tcpip server read thread unexpectedly died"
-          Logger.error err.formatted
+          Logger.error e.formatted
         end
       end
     end
@@ -596,9 +605,9 @@ module OpenC3
           rescue Errno::EPIPE, Errno::ECONNABORTED, IOError, Errno::ECONNRESET
             # Client has normally disconnected
             need_disconnect = true
-          rescue Exception => err
-            if err.message != "Stream not connected for write_raw"
-              Logger.error "#{@name}: Error sending to client: #{err.class} #{err.message}"
+          rescue Exception => e
+            if e.message != "Stream not connected for write_raw"
+              Logger.error "#{@name}: Error sending to client: #{e.class} #{e.message}"
             end
             need_disconnect = true
           end

data/lib/openc3/interfaces/udp_interface.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -90,6 +90,16 @@ module OpenC3
       @write_raw_allowed = false unless @write_dest_port
     end
 
+    def connection_string
+      result = ''
+      result += " #{@hostname}:#{@write_dest_port} (write dest port)" if @write_dest_port
+      result += " #{@write_src_port} (write src port)" if @write_src_port
+      result += " #{@hostname}:#{@read_port} (read)" if @read_port
+      result += " #{@interface_address} (interface addr)" if @interface_address
+      result += " #{@bind_address} (bind addr)" if @bind_address != '0.0.0.0'
+      return result.strip
+    end
+
     # Creates a new {UdpWriteSocket} if the the write_dest_port was given in
     # the constructor and a new {UdpReadSocket} if the read_port was given in
     # the constructor.

data/lib/openc3/logs/packet_log_writer.rb

@@ -331,7 +331,7 @@ module OpenC3
         @entry << [length, flags, packet_index, time_nsec_since_epoch].pack(OPENC3_PACKET_PACK_DIRECTIVE)
         @entry << [received_time_nsec_since_epoch].pack(OPENC3_RECEIVED_TIME_PACK_DIRECTIVE) if received_time_nsec_since_epoch
         @entry << [extra_encoded.length].pack(OPENC3_EXTRA_LENGTH_PACK_DIRECTIVE) << extra_encoded if extra_encoded
-        @entry << data
+        @entry << data.force_encoding('ASCII-8BIT')
         @first_time = time_nsec_since_epoch if !@first_time or time_nsec_since_epoch < @first_time
         @last_time = time_nsec_since_epoch if !@last_time or time_nsec_since_epoch > @last_time
       else

data/lib/openc3/microservices/decom_microservice.rb

@@ -81,7 +81,7 @@ module OpenC3
       end
     end
 
-    def decom_packet(topic, msg_id, msg_hash, _redis)
+    def decom_packet(_topic, msg_id, msg_hash, _redis)
       OpenC3.in_span("decom_packet") do
         msgid_seconds_from_epoch = msg_id.split('-')[0].to_i / 1000.0
         delta = Time.now.to_f - msgid_seconds_from_epoch
@@ -133,7 +133,8 @@ module OpenC3
       if log_change
         case item.limits.state
         when :BLUE, :GREEN, :GREEN_LOW, :GREEN_HIGH
-          @logger.info message
+          # Only print INFO messages if we're changing ... not on initialization
+          @logger.info message if old_limits_state
         when :YELLOW, :YELLOW_LOW, :YELLOW_HIGH
           @logger.warn(message, type: Logger::NOTIFICATION)
         when :RED, :RED_LOW, :RED_HIGH

data/lib/openc3/microservices/interface_microservice.rb

@@ -450,7 +450,7 @@ module OpenC3
       @interface # Return the interface/router since we may have recreated it
     # Need to rescue Exception so we cover LoadError
     rescue Exception => e
-      @logger.error("Attempting connection failed with params #{params} due to #{e.message}")
+      @logger.error("Attempting connection #{@interface.connection_string} failed due to #{e.message}")
       if SignalException === e
         @logger.info "#{@interface.name}: Closing from signal"
         @cancel_thread = true
@@ -479,7 +479,7 @@ module OpenC3
                 connect() unless @cancel_thread
               end
             rescue Exception => e
-              handle_connection_failed(e)
+              handle_connection_failed(@interface.connection_string, e)
               break if @cancel_thread
             end
           when 'CONNECTED'
@@ -580,9 +580,9 @@ module OpenC3
       TelemetryTopic.write_packet(packet, queued: @queued, scope: @scope)
     end
 
-    def handle_connection_failed(connect_error)
+    def handle_connection_failed(connection, connect_error)
       @error = connect_error
-      @logger.error "#{@interface.name}: Connection Failed: #{connect_error.formatted(false, false)}"
+      @logger.error "#{@interface.name}: Connection #{connection} failed due to #{connect_error.formatted(false, false)}"
       case connect_error
       when SignalException
         @logger.info "#{@interface.name}: Closing from signal"
@@ -627,7 +627,7 @@ module OpenC3
     end
 
     def connect
-      @logger.info "#{@interface.name}: Connecting ..."
+      @logger.info "#{@interface.name}: Connect #{@interface.connection_string}"
       begin
         @interface.connect
       rescue Exception => e