(RISCV) fix handling of fixed-point type return values
authorJoel Brobecker <brobecker@adacore.com>
Thu, 7 Mar 2019 07:25:33 +0000 (02:25 -0500)
committerTom Tromey <tromey@adacore.com>
Thu, 2 Dec 2021 16:08:50 +0000 (09:08 -0700)
This commit adds support for TYPE_CODE_FIXED_POINT types for
"finish" and "return" commands.

Consider the following Ada code...

   type FP1_Type is delta 0.1 range -1.0 .. +1.0; --  Ordinary
   function Call_FP1 (F : FP1_Type) return FP1_Type is
   begin
      FP1_Arg := F;
      return FP1_Arg;
   end Call_FP1;

... used as follow:

   F1 : FP1_Type := 1.0;
   F1 := Call_FP1 (F1);

"finish" currently behaves as follow:

    | (gdb) finish
    | [...]
    | Value returned is $1 = 0

We expect the returned value to be "1".

Similarly, "return" makes the function return the wrong value:

    | (gdb) return 1.0
    | Make pck.call_fp1 return now? (y or n) y
    | [...]
    | 9          F1 := Call_FP1 (F1);
    | (gdb) next
    | (gdb) print f1
    | $1 = 0.0625

(we expect it to print "1" instead).

This problem comes from the handling of integral return values
when the return value is actually fixed point type. Our type
here is actually a range of a fixed point type, but the same
principles should also apply to pure fixed-point types. For
the record, here is what the debugging info looks like:

 <1><238>: Abbrev Number: 2 (DW_TAG_subrange_type)
    <239>   DW_AT_lower_bound : -16
    <23a>   DW_AT_upper_bound : 16
    <23b>   DW_AT_name        : pck__fp1_type
    <23f>   DW_AT_type        : <0x248>

 <1><248>: Abbrev Number: 4 (DW_TAG_base_type)
    <249>   DW_AT_byte_size   : 1
    <24a>   DW_AT_encoding    : 13      (signed_fixed)
    <24b>   DW_AT_binary_scale: -4
    <24c>   DW_AT_name        : pck__Tfp1_typeB
    <250>   DW_AT_artificial  : 1

... where the scaling factor is 1/16.

Looking at the "finish" command, what happens is that riscv_arg_location
determines that our return value should be returned by parameter using
an integral convention (via builtin type long). And then,
riscv_return_value uses a cast to that builtin type long to
store the value of into a buffer with the right register size.
This doesn't work in our case, because the underlying value
returned by the function is unscaled, which means it is 16,
and thus the cast is like doing:

   arg_val = (FP1_Type) 16

... In other words, it is trying to create an FP1_Type enty whose
value is 16. Applying the scaling factor, that's 256, and because
the size of FP1_Type is 1 byte, we overflow and thus it ends up
being zero.

The same happen with the "return" function, but the other way around.

The fix consists in handling fixed-point types separately from
integral types.

gdb/riscv-tdep.c

index 4d87a899063e55b274088d8c04a86bace931a812..b29a23ee70bb87830c29b7941b3bb4fd6ab83445 100644 (file)
@@ -2770,6 +2770,7 @@ riscv_arg_location (struct gdbarch *gdbarch,
     case TYPE_CODE_RANGE:
     case TYPE_CODE_ENUM:
     case TYPE_CODE_PTR:
+    case TYPE_CODE_FIXED_POINT:
       if (ainfo->length <= cinfo->xlen)
        {
          ainfo->type = builtin_type (gdbarch)->builtin_long;
@@ -3144,8 +3145,30 @@ riscv_return_value (struct gdbarch  *gdbarch,
           buffers of sufficient size.  */
        if (writebuf != nullptr)
          {
-           struct value *arg_val = value_from_contents (arg_type, writebuf);
-           abi_val = value_cast (info.type, arg_val);
+           struct value *arg_val;
+
+           if (is_fixed_point_type (arg_type))
+             {
+               /* Convert the argument to the type used to pass
+                  the return value, but being careful to preserve
+                  the fact that the value needs to be returned
+                  unscaled.  */
+               gdb_mpz unscaled;
+
+               unscaled.read (gdb::make_array_view (writebuf,
+                                                    TYPE_LENGTH (arg_type)),
+                              type_byte_order (arg_type),
+                              arg_type->is_unsigned ());
+               abi_val = allocate_value (info.type);
+               unscaled.write (value_contents_raw (abi_val),
+                               type_byte_order (info.type),
+                               info.type->is_unsigned ());
+             }
+           else
+             {
+               arg_val = value_from_contents (arg_type, writebuf);
+               abi_val = value_cast (info.type, arg_val);
+             }
            writebuf = value_contents_raw (abi_val).data ();
          }
        else
@@ -3249,7 +3272,25 @@ riscv_return_value (struct gdbarch  *gdbarch,
           comment at the head of this block for more details.  */
        if (readbuf != nullptr)
          {
-           struct value *arg_val = value_cast (arg_type, abi_val);
+           struct value *arg_val;
+
+           if (is_fixed_point_type (arg_type))
+             {
+               /* Convert abi_val to the actual return type, but
+                  being careful to preserve the fact that abi_val
+                  is unscaled.  */
+               gdb_mpz unscaled;
+
+               unscaled.read (value_contents (abi_val),
+                              type_byte_order (info.type),
+                              info.type->is_unsigned ());
+               arg_val = allocate_value (arg_type);
+               unscaled.write (value_contents_raw (arg_val),
+                               type_byte_order (arg_type),
+                               arg_type->is_unsigned ());
+             }
+           else
+             arg_val = value_cast (arg_type, abi_val);
            memcpy (old_readbuf, value_contents_raw (arg_val).data (),
                    TYPE_LENGTH (arg_type));
          }