openc3 5.17.1 → 5.19.0

data/ext/openc3/ext/structure/structure.c

@@ -15,7 +15,7 @@
 
 /*
 # 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
@@ -69,7 +69,9 @@ static ID id_method_class2 = 0;
 
 static ID id_ivar_buffer = 0;
 static ID id_ivar_bit_offset = 0;
+static ID id_ivar_original_bit_offset = 0;
 static ID id_ivar_bit_size = 0;
+static ID id_ivar_variable_bit_size = 0;
 static ID id_ivar_array_size = 0;
 static ID id_ivar_endianness = 0;
 static ID id_ivar_data_type = 0;
@@ -384,7 +386,7 @@ static void write_bitfield(int lower_bound, int upper_bound, int bit_offset, int
   memcpy(&buffer[lower_bound], write_value, num_bytes);
 }
 
-/* Check the bit size and bit offset for problems. Recalulate the bit offset
+/* Check the bit size and bit offset for problems. Recalculate the bit offset
  * and return back through the passed in pointer. */
 static void check_bit_offset_and_size(VALUE self, VALUE type_param, VALUE bit_offset_param, VALUE bit_size_param, VALUE data_type_param, VALUE buffer_param, int *new_bit_offset)
 {
@@ -1140,7 +1142,7 @@ static VALUE binary_accessor_write(VALUE self, VALUE value, VALUE param_bit_offs
         c_value = NUM2ULL(value);
         break;
       }
-      /* If the passed endianess doesn't match the host we reverse the bytes.
+      /* If the passed endianness doesn't match the host we reverse the bytes.
        * Then shift the result over so it's at the bottom of the long long value. */
       if (param_endianness != HOST_ENDIANNESS)
       {
@@ -1360,92 +1362,86 @@ static VALUE read_item(int argc, VALUE *argv, VALUE self)
  */
 static VALUE structure_item_spaceship(VALUE self, VALUE other_item)
 {
-  int bit_offset = 0;
-  int other_bit_offset = 0;
-  int bit_size = 0;
-  int other_bit_size = 0;
+  int original_bit_offset = 0;
+  int other_original_bit_offset = 0;
   int create_index = 0;
   int other_create_index = 0;
-  int have_create_index = 0;
-  volatile VALUE v_create_index = Qnil;
-  volatile VALUE v_other_create_index = Qnil;
+  volatile VALUE data_type = Qnil;
+  volatile VALUE other_data_type = Qnil;
+  volatile VALUE variable_bit_size = Qnil;
+  volatile VALUE other_variable_bit_size = Qnil;
 
   if (!RTEST(rb_funcall(other_item, id_method_kind_of, 1, cStructureItem)))
   {
     return Qnil;
   }
 
-  bit_offset = FIX2INT(rb_ivar_get(self, id_ivar_bit_offset));
-  other_bit_offset = FIX2INT(rb_ivar_get(other_item, id_ivar_bit_offset));
+  original_bit_offset = FIX2INT(rb_ivar_get(self, id_ivar_original_bit_offset));
+  other_original_bit_offset = FIX2INT(rb_ivar_get(other_item, id_ivar_original_bit_offset));
 
-  v_create_index = rb_ivar_get(self, id_ivar_create_index);
-  v_other_create_index = rb_ivar_get(other_item, id_ivar_create_index);
-  if (RTEST(v_create_index) && RTEST(v_other_create_index))
-  {
-    create_index = FIX2INT(v_create_index);
-    other_create_index = FIX2INT(v_other_create_index);
-    have_create_index = 1;
-  }
+  create_index = FIX2INT(rb_ivar_get(self, id_ivar_create_index));
+  other_create_index = FIX2INT(rb_ivar_get(other_item, id_ivar_create_index));
+
+  data_type = rb_ivar_get(self, id_ivar_data_type);
+  other_data_type = rb_ivar_get(other_item, id_ivar_data_type);
 
-  /* Handle same bit offset case */
-  if ((bit_offset == 0) && (other_bit_offset == 0))
+  variable_bit_size = rb_ivar_get(self, id_ivar_variable_bit_size);
+  other_variable_bit_size = rb_ivar_get(other_item, id_ivar_variable_bit_size);
+
+  /* Derived items should be first in the list with multiple derived sorted
+   * by create_index */
+  if (data_type == symbol_DERIVED)
   {
-    /* Both bit_offsets are 0 so sort by bit_size
-     * This allows derived items with bit_size of 0 to be listed first
-     * Compare based on bit size */
-    bit_size = FIX2INT(rb_ivar_get(self, id_ivar_bit_size));
-    other_bit_size = FIX2INT(rb_ivar_get(other_item, id_ivar_bit_size));
-    if (bit_size == other_bit_size)
+    if (other_data_type != symbol_DERIVED)
     {
-      if (have_create_index)
+      return INT2FIX(-1);
+    }
+    else
+    {
+      if (create_index <= other_create_index)
       {
-        if (create_index <= other_create_index)
-        {
-          return INT2FIX(-1);
-        }
-        else
-        {
-          return INT2FIX(1);
-        }
+        return INT2FIX(-1);
       }
       else
       {
-        return INT2FIX(0);
+        return INT2FIX(1);
       }
     }
-    if (bit_size < other_bit_size)
-    {
-      return INT2FIX(-1);
-    }
-    else
-    {
-      return INT2FIX(1);
-    }
+  }
+  else if (other_data_type == symbol_DERIVED)
+  {
+    return INT2FIX(1);
   }
 
-  /* Handle different bit offsets */
-  if (((bit_offset >= 0) && (other_bit_offset >= 0)) || ((bit_offset < 0) && (other_bit_offset < 0)))
+  /* Handle non-derived items */
+  if (((original_bit_offset >= 0) && (other_original_bit_offset >= 0)) || ((original_bit_offset < 0) && (other_original_bit_offset < 0)))
   {
     /* Both Have Same Sign */
-    if (bit_offset == other_bit_offset)
+    if (original_bit_offset == other_original_bit_offset)
     {
-      if (have_create_index)
+      if (RTEST(variable_bit_size))
       {
-        if (create_index <= other_create_index)
+        if (!RTEST(other_variable_bit_size))
         {
           return INT2FIX(-1);
         }
-        else
-        {
-          return INT2FIX(1);
-        }
+        /* If both variable_bit_size use create index */
+      }
+      else if (RTEST(other_variable_bit_size))
+      {
+        return INT2FIX(1);
+      }
+
+      if (create_index <= other_create_index)
+      {
+        return INT2FIX(-1);
       }
       else
       {
-        return INT2FIX(0);
+        return INT2FIX(1);
       }
     }
-    else if (bit_offset < other_bit_offset)
+    else if (original_bit_offset <= other_original_bit_offset)
     {
       return INT2FIX(-1);
     }
@@ -1457,25 +1453,7 @@ static VALUE structure_item_spaceship(VALUE self, VALUE other_item)
   else
   {
     /* Different Signs */
-    if (bit_offset == other_bit_offset)
-    {
-      if (have_create_index)
-      {
-        if (create_index <= other_create_index)
-        {
-          return INT2FIX(-1);
-        }
-        else
-        {
-          return INT2FIX(1);
-        }
-      }
-      else
-      {
-        return INT2FIX(0);
-      }
-    }
-    else if (bit_offset < other_bit_offset)
+    if (original_bit_offset < other_original_bit_offset)
     {
       return INT2FIX(1);
     }
@@ -1649,7 +1627,9 @@ void Init_structure(void)
 
   id_ivar_buffer = rb_intern("@buffer");
   id_ivar_bit_offset = rb_intern("@bit_offset");
+  id_ivar_original_bit_offset = rb_intern("@original_bit_offset");
   id_ivar_bit_size = rb_intern("@bit_size");
+  id_ivar_variable_bit_size = rb_intern("@variable_bit_size");
   id_ivar_array_size = rb_intern("@array_size");
   id_ivar_endianness = rb_intern("@endianness");
   id_ivar_data_type = rb_intern("@data_type");

data/lib/openc3/accessors/accessor.rb

@@ -104,6 +104,7 @@ module OpenC3
     end
 
     def self.convert_to_type(value, item)
+      return value if value.nil?
       case item.data_type
       when :OBJECT, :ARRAY
         # Do nothing for complex object types

data/lib/openc3/accessors/binary_accessor.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
@@ -85,8 +85,6 @@ module OpenC3
     # Valid overflow types
     OVERFLOW_TYPES = [:TRUNCATE, :SATURATE, :ERROR, :ERROR_ALLOW_HEX]
 
-    protected
-
     # Determines the endianness of the host running this code
     #
     # This method is protected to force the use of the constant
@@ -108,13 +106,175 @@ module OpenC3
       raise ArgumentError, "#{buffer.length} byte buffer insufficient to #{read_write} #{data_type} at bit_offset #{given_bit_offset} with bit_size #{given_bit_size}"
     end
 
-    public
-
     # Store the host endianness so that it only has to be determined once
     HOST_ENDIANNESS = get_host_endianness()
-    # Valid endianess
+    # Valid endianness
     ENDIANNESS = [:BIG_ENDIAN, :LITTLE_ENDIAN]
 
+    def handle_read_variable_bit_size(item, _buffer)
+      length_value = @packet.read(item.variable_bit_size['length_item_name'], :CONVERTED)
+      if item.array_size
+        item.array_size = (length_value * item.variable_bit_size['length_bits_per_count']) + item.variable_bit_size['length_value_bit_offset']
+      else
+        if item.data_type == :INT or item.data_type == :UINT
+          # QUIC encoding is currently assumed for individual variable sized integers
+          # see https://datatracker.ietf.org/doc/html/rfc9000#name-variable-length-integer-enc
+          case length_value
+          when 0
+            item.bit_size = 6
+          when 1
+            item.bit_size = 14
+          when 2
+            item.bit_size = 30
+          else
+            item.bit_size = 62
+          end
+        else
+          item.bit_size = (length_value * item.variable_bit_size['length_bits_per_count']) + item.variable_bit_size['length_value_bit_offset']
+        end
+      end
+    end
+
+    def read_item(item, buffer)
+      return nil if item.data_type == :DERIVED
+      handle_read_variable_bit_size(item, buffer) if item.variable_bit_size
+      self.class.read_item(item, buffer)
+    end
+
+    def handle_write_variable_bit_size(item, value, buffer)
+      # Update length field to new size
+      if (item.data_type == :INT or item.data_type == :UINT) and not item.original_array_size
+        # QUIC encoding is currently assumed for individual variable sized integers
+        # see https://datatracker.ietf.org/doc/html/rfc9000#name-variable-length-integer-enc
+
+        # Calculate current bit size so we can preserve bytes after the item
+        length_item_value = @packet.read(item.variable_bit_size['length_item_name'], :CONVERTED)
+        case length_item_value
+        when 0
+          current_bit_size = 6
+        when 1
+          current_bit_size = 14
+        when 2
+          current_bit_size = 30
+        when 3
+          current_bit_size = 62
+        else
+          raise "Value #{item.variable_bit_size['length_item_name']} has unknown QUIC bit size encoding: #{length_item_value}"
+        end
+
+        if item.data_type == :UINT
+          if value <= 63
+            # Length = 0, value up to 6-bits
+            new_bit_size = 6
+            item.bit_size = new_bit_size
+            @packet.write(item.variable_bit_size['length_item_name'], 0)
+          elsif value <= 16383
+            # Length = 1, value up to 14-bits
+            new_bit_size = 14
+            item.bit_size = new_bit_size
+            @packet.write(item.variable_bit_size['length_item_name'], 1)
+          elsif value <= 1073741823
+            # Length = 2, value up to 30-bits
+            new_bit_size = 30
+            item.bit_size = new_bit_size
+            @packet.write(item.variable_bit_size['length_item_name'], 2)
+          else
+            # Length = 3, value up to 62-bits
+            new_bit_size = 62
+            item.bit_size = new_bit_size
+            @packet.write(item.variable_bit_size['length_item_name'], 3)
+          end
+        else
+          if value <= 31 and value >= -32
+            # Length = 0, value up to 6-bits
+            new_bit_size = 6
+            item.bit_size = new_bit_size
+            @packet.write(item.variable_bit_size['length_item_name'], 0)
+          elsif value <= 8191 and value >= -8192
+            # Length = 1, value up to 14-bits
+            new_bit_size = 14
+            item.bit_size = new_bit_size
+            @packet.write(item.variable_bit_size['length_item_name'], 1)
+          elsif value <= 536870911 and value >= -536870912
+            # Length = 2, value up to 30-bits
+            new_bit_size = 30
+            item.bit_size = new_bit_size
+            @packet.write(item.variable_bit_size['length_item_name'], 2)
+          else
+            # Length = 3, value up to 62-bits
+            new_bit_size = 62
+            item.bit_size = new_bit_size
+            @packet.write(item.variable_bit_size['length_item_name'], 3)
+          end
+        end
+
+        # Later items need their bit_offset adjusted by the change in this item
+        adjustment = new_bit_size - current_bit_size
+        bytes = (adjustment / 8)
+        item_offset = item.bit_offset / 8
+        if bytes > 0
+          original_length = buffer.length
+          # Add extra bytes because we're adjusting larger
+          buffer << ("\000" * bytes)
+          # We added bytes to the end so now we have to shift the buffer over
+          #   NOTE: buffer[offset, length]
+          # We copy to the shifted offset location with the remaining buffer length
+          buffer[item_offset + bytes, buffer.length - (item_offset + bytes)] =
+              # We copy from the original offset location with the original length minus the offset
+              buffer[item_offset, original_length - item_offset]
+        elsif bytes < 0
+          # Remove extra bytes because we're adjusting smaller
+          buffer[item_offset + 1, -bytes] = ''
+        end
+      # Probably not possible to get this condition because we don't allow 0 sized floats
+      # but check for it just to cover all the possible data_types
+      elsif item.data_type == :FLOAT
+        raise "Variable bit size not currently supported for FLOAT data type"
+      else
+        # STRING, BLOCK, or array types
+
+        # Calculate current bit size so we can preserve bytes after the item
+        length_item_value = @packet.read(item.variable_bit_size['length_item_name'], :CONVERTED)
+        current_bit_size = (length_item_value * item.variable_bit_size['length_bits_per_count']) + item.variable_bit_size['length_value_bit_offset']
+
+        # Calculate bits after this item
+        bits_with_item = item.bit_offset + current_bit_size
+        bits_after_item = (buffer.length * 8) - bits_with_item
+        if item.original_array_size
+          item.array_size = -bits_after_item
+        else
+          item.bit_size = -bits_after_item
+        end
+
+        new_bit_size = value.length * 8
+        length_value = (new_bit_size - item.variable_bit_size['length_value_bit_offset']) / item.variable_bit_size['length_bits_per_count']
+        @packet.write(item.variable_bit_size['length_item_name'], length_value)
+
+        # Later items need their bit_offset adjusted by the change in this item
+        adjustment = new_bit_size - current_bit_size
+      end
+
+      # Recalculate bit offsets after this item
+      if adjustment != 0 and item.bit_offset >= 0
+        @packet.sorted_items.each do |sitem|
+          if sitem.data_type == :DERIVED or sitem.bit_offset < item.bit_offset
+            # Skip items before this item and derived items and items with negative bit offsets
+            next
+          end
+          if sitem != item
+            sitem.bit_offset += adjustment
+          end
+        end
+      end
+    end
+
+    def write_item(item, value, buffer)
+      return nil if item.data_type == :DERIVED
+      handle_write_variable_bit_size(item, value, buffer) if item.variable_bit_size
+      self.class.write_item(item, value, buffer)
+    end
+
+    # Note: do not use directly - use instance read_item
     def self.read_item(item, buffer)
       return nil if item.data_type == :DERIVED
       if item.array_size
@@ -124,6 +284,7 @@ module OpenC3
       end
     end
 
+    # Note: do not use directly - use instance write_item
     def self.write_item(item, value, buffer)
       return nil if item.data_type == :DERIVED
       if item.array_size
@@ -388,7 +549,7 @@ module OpenC3
                 # String was completely empty
                 if end_bytes > 0
                   # Preserve bytes at end of buffer
-                  buffer << "\000" * value.length
+                  buffer << ("\000" * value.length)
                   buffer[lower_bound + value.length, end_bytes] = buffer[lower_bound, end_bytes]
                 end
               elsif bit_size == 0
@@ -400,7 +561,7 @@ module OpenC3
               elsif (upper_bound > old_upper_bound) && (end_bytes > 0)
                 # Preserve bytes at end of buffer
                 diff = upper_bound - old_upper_bound
-                buffer << "\000" * diff
+                buffer << ("\000" * diff)
                 buffer[upper_bound + 1, end_bytes] = buffer[old_upper_bound + 1, end_bytes]
               end
             else # given_bit_size > 0
@@ -587,9 +748,8 @@ module OpenC3
         return value
       end
 
-      protected
 
-      # Check the bit size and bit offset for problems. Recalulate the bit offset
+      # Check the bit size and bit offset for problems. Recalculate the bit offset
       # and return back through the passed in pointer.
       def self.check_bit_offset_and_size(read_or_write, given_bit_offset, given_bit_size, data_type, buffer)
         bit_offset = given_bit_offset
@@ -705,7 +865,6 @@ module OpenC3
         (bit_size == 8) || (bit_size == 16) || (bit_size == 32) || (bit_size == 64)
       end
 
-      public
 
     end
 
@@ -945,10 +1104,10 @@ module OpenC3
             # Remove extra bytes from old buffer
             buffer[(upper_bound + 1)..old_upper_bound] = ''
           elsif upper_bound > old_upper_bound
-            # Grow buffer and preserve bytes at end of buffer if necesssary
+            # Grow buffer and preserve bytes at end of buffer if necessary
             buffer_length = buffer.length
             diff = upper_bound - old_upper_bound
-            buffer << ZERO_STRING * diff
+            buffer << (ZERO_STRING * diff)
             if end_bytes > 0
               buffer[(upper_bound + 1)..(buffer.length - 1)] = buffer[(old_upper_bound + 1)..(buffer_length - 1)]
             end
@@ -975,7 +1134,7 @@ module OpenC3
       end
 
       # Ensure the buffer has enough room
-      if bit_offset + num_writes * bit_size > buffer.length * 8
+      if bit_offset + (num_writes * bit_size) > buffer.length * 8
         raise_buffer_error(:write, buffer, data_type, given_bit_offset, given_bit_size)
       end
 
@@ -1249,7 +1408,7 @@ module OpenC3
       return false
     end
 
-    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # If this is true it will enforce that COSMOS DERIVED items must have a
     # write_conversion to be written
     def enforce_derived_write_conversion(_item)
       return true

data/lib/openc3/accessors/form_accessor.rb

@@ -45,7 +45,7 @@ module OpenC3
       ary = URI.decode_www_form(buffer)
 
       # Remove existing item and bad keys from array
-      ary.reject! {|key, ary_value| (key == item.key) or (key.to_s[0] == "\u0000")}
+      ary.reject! {|key, _ary_value| (key == item.key) or (key.to_s[0] == "\u0000")}
 
       if Array === value
         value.each do |value_value|
@@ -79,7 +79,7 @@ module OpenC3
       return true
     end
 
-    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # If this is true it will enforce that COSMOS DERIVED items must have a
     # write_conversion to be written
     def enforce_derived_write_conversion(_item)
       return true

data/lib/openc3/accessors/http_accessor.rb

@@ -169,7 +169,7 @@ module OpenC3
       return @body_accessor.enforce_short_buffer_allowed
     end
 
-    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # If this is true it will enforce that COSMOS DERIVED items must have a
     # write_conversion to be written
     def enforce_derived_write_conversion(item)
       case item.name

data/lib/openc3/accessors/json_accessor.rb

@@ -22,9 +22,11 @@ require 'openc3/io/json_rpc'
 require 'openc3/accessors/accessor'
 
 # Monkey patch JsonPath to enable create_additions and allow_nan to support binary strings, and NaN, Infinity, -Infinity
-class JsonPath
-  def self.process_object(obj_or_str, opts = {})
-    obj_or_str.is_a?(String) ? MultiJson.decode(obj_or_str, max_nesting: opts[:max_nesting], create_additions: true, allow_nan: true) : obj_or_str
+OpenC3.disable_warnings do
+  class JsonPath
+    def self.process_object(obj_or_str, opts = {})
+      obj_or_str.is_a?(String) ? MultiJson.decode(obj_or_str, max_nesting: opts[:max_nesting], create_additions: true, allow_nan: true) : obj_or_str
+    end
   end
 end
 
@@ -161,7 +163,7 @@ module OpenC3
       return true
     end
 
-    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # If this is true it will enforce that COSMOS DERIVED items must have a
     # write_conversion to be written
     def enforce_derived_write_conversion(_item)
       return true

data/lib/openc3/accessors/template_accessor.rb

@@ -38,21 +38,18 @@ module OpenC3
       # Convert the template into a Regexp for reading each item
       template = @packet.template.dup
       template_items = template.scan(Regexp.new("#{escaped_left_char}.*?#{escaped_right_char}"))
-      escaped_read_template = template
-      if @left_char != '('
-        escaped_read_template = escaped_read_template.gsub('(', '\(')
-      end
-      if @right_char != ')'
-        escaped_read_template = escaped_read_template.gsub(')', '\)')
-      end
+      escaped_read_template = Regexp.escape(template)
 
       @item_keys = []
       template_items.each do |item|
         @item_keys << item[1..-2]
+        # If they're using parens we have to escape them
+        # since we're working with the already escaped template
+        item = "\\#{item}" if @left_char == '('
+        item = "#{item[0..-2]}\\)" if @right_char == ')'
         escaped_read_template.gsub!(item, "(.*)")
       end
       @read_regexp = Regexp.new(escaped_read_template)
-
       @configured = true
     end
 
@@ -141,7 +138,7 @@ module OpenC3
       return true
     end
 
-    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # If this is true it will enforce that COSMOS DERIVED items must have a
     # write_conversion to be written
     def enforce_derived_write_conversion(_item)
       return true

data/lib/openc3/accessors/xml_accessor.rb

@@ -88,7 +88,7 @@ module OpenC3
       return true
     end
 
-    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # If this is true it will enforce that COSMOS DERIVED items must have a
     # write_conversion to be written
     def enforce_derived_write_conversion(_item)
       return true