ubsan: Add some missing handlers

keith-packard · keith-packard · commit 8c9085d7ad7d · 2025-04-13T12:17:35.000-07:00
One missing handler for GCC and three for clang.

Signed-off-by: Keith Packard &lt;keithp@keithp.com&gt;
diff --git a/newlib/libc/ubsan/CMakeLists.txt b/newlib/libc/ubsan/CMakeLists.txt
@@ -33,11 +33,15 @@
 # OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 picolibc_sources(
+  ubsan_cfi_type_check_to_string.c
   ubsan_error.c
   ubsan_handle_add_overflow.c
   ubsan_handle_alignment_assumption.c
   ubsan_handle_builtin_unreachable.c
+  ubsan_handle_cfi_bad_type.c
+  ubsan_handle_cfi_check_fail.c
   ubsan_handle_divrem_overflow.c
+  ubsan_handle_dynamic_type_cache_miss.c
   ubsan_handle_float_cast_overflow.c
   ubsan_handle_function_type_mismatch.c
   ubsan_handle_implicit_conversion.c
diff --git a/newlib/libc/ubsan/meson.build b/newlib/libc/ubsan/meson.build
@@ -33,11 +33,15 @@
 # OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 srcs_ubsan = [
+  'ubsan_cfi_type_check_to_string.c',
   'ubsan_error.c',
   'ubsan_handle_add_overflow.c',
   'ubsan_handle_alignment_assumption.c',
   'ubsan_handle_builtin_unreachable.c',
+  'ubsan_handle_cfi_bad_type.c',
+  'ubsan_handle_cfi_check_fail.c',
   'ubsan_handle_divrem_overflow.c',
+  'ubsan_handle_dynamic_type_cache_miss.c',
   'ubsan_handle_float_cast_overflow.c',
   'ubsan_handle_function_type_mismatch.c',
   'ubsan_handle_implicit_conversion.c',
diff --git a/newlib/libc/ubsan/ubsan.h b/newlib/libc/ubsan/ubsan.h
@@ -76,6 +76,16 @@ enum {
     implicit_conversion_signed_integer_truncation_or_sign_change = 4,
 };
 
+enum {
+    cfi_type_check_v_call,
+    cfi_type_check_nv_call,
+    cfi_type_check_derived_cast,
+    cfi_type_check_unrelated_cast,
+    cfi_type_check_i_call,
+    cfi_type_check_nvmf_call,
+    cfi_type_check_vmf_call,
+};
+
 struct type_descriptor {
     uint16_t type_kind;
     uint16_t type_info;
@@ -121,6 +131,13 @@ struct float_cast_overflow_data {
     struct type_descriptor *to_type;
 };
 
+struct dynamic_type_cache_miss_data {
+    struct source_location location;
+    struct type_descriptor *type;
+    void *type_info;
+    unsigned char type_check_kind;
+};
+
 struct type_mismatch_data {
     struct source_location location;
     struct type_descriptor *type;
@@ -201,6 +218,12 @@ struct alignment_assumption_data {
     struct type_descriptor *type;
 };
 
+struct cfi_check_fail_data {
+    unsigned char cfi_type_check_kind;
+    struct source_location location;
+    struct type_descriptor *type;
+};
+
 struct vla_bound_not_positive_data {
     struct source_location location;
     struct type_descriptor *type;
@@ -221,19 +244,27 @@ void
 __ubsan_handle_builtin_unreachable(void *data);
 
 void
-__ubsan_cfi_bad_icall(void *data,
-                      void *function);
+__ubsan_handle_cfi_bad_type(void *data,
+                            void *vtable,
+                            void *valid_vtable,
+                            void *opts);
+
 
 void
-__ubsan_cfi_check_fail(void *data,
-                       void *function,
-                       uintptr_t vtable_is_valid);
+__ubsan_handle_cfi_check_fail(void *data,
+                              void *function,
+                              void *vtable_is_valid);
 
 void
 __ubsan_handle_divrem_overflow(void *data,
                                void *lhs,
                                void *rhs);
 
+void
+__ubsan_handle_dynamic_type_cache_miss(void *data,
+                                       void *pointer,
+                                       void *hash);
+
 void
 __ubsan_handle_float_cast_overflow(void *data,
                                    void *from);
@@ -258,6 +289,10 @@ void
 __ubsan_handle_load_invalid_value(void *data,
                                   void *val);
 
+void
+__ubsan_handle_local_out_of_bounds(
+    );
+
 void
 __ubsan_handle_missing_return(void *data);
 
@@ -357,4 +392,7 @@ __ubsan_val_to_umax(struct type_descriptor *type,
 const char*
 __ubsan_type_check_to_string(unsigned char type_check_kind);
 
+const char*
+__ubsan_cfi_type_check_to_string(unsigned char cfi_type_check_kind);
+
 #endif /* _UBSAN_H_ */
diff --git a/newlib/libc/ubsan/ubsan_cfi_type_check_to_string.c b/newlib/libc/ubsan/ubsan_cfi_type_check_to_string.c
@@ -0,0 +1,54 @@
+/*
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Copyright © 2025 Keith Packard
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above
+ *    copyright notice, this list of conditions and the following
+ *    disclaimer in the documentation and/or other materials provided
+ *    with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "ubsan.h"
+
+static const char *const cfi_type_check_kinds[] = {
+    [cfi_type_check_v_call] = "cfi_type_check_v_call",
+    [cfi_type_check_nv_call] = "cfi_type_check_nv_call",
+    [cfi_type_check_derived_cast] = "cfi_type_check_derived_cast",
+    [cfi_type_check_unrelated_cast] = "cfi_type_check_unrelated_cast",
+    [cfi_type_check_i_call] = "cfi_type_check_i_call",
+    [cfi_type_check_nvmf_call] = "cfi_type_check_nvmf_call",
+    [cfi_type_check_vmf_call] = "cfi_type_check_vmf_call",
+};
+
+const char*
+__ubsan_cfi_type_check_to_string(unsigned char cfi_type_check_kind)
+{
+    if (cfi_type_check_kind < sizeof(cfi_type_check_kinds)/sizeof(cfi_type_check_kinds[0]))
+        return cfi_type_check_kinds[cfi_type_check_kind];
+    return "unknown";
+}
diff --git a/newlib/libc/ubsan/ubsan_handle_cfi_bad_type.c b/newlib/libc/ubsan/ubsan_handle_cfi_bad_type.c
@@ -0,0 +1,51 @@
+/*
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Copyright © 2025 Keith Packard
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above
+ *    copyright notice, this list of conditions and the following
+ *    disclaimer in the documentation and/or other materials provided
+ *    with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "ubsan.h"
+
+void
+__ubsan_handle_cfi_bad_type(void *_data,
+                            void *vtable,
+                            void *valid_vtable,
+                            void *opts)
+{
+    struct cfi_check_fail_data *data = _data;
+    __ubsan_error(&data->location, "cfi_bad_type", "(%s) %p valid %p opts %p %s\n",
+                  data->type->type_name,
+                  vtable,
+                  valid_vtable,
+                  opts,
+                  __ubsan_cfi_type_check_to_string(data->cfi_type_check_kind));
+}
diff --git a/newlib/libc/ubsan/ubsan_handle_cfi_check_fail.c b/newlib/libc/ubsan/ubsan_handle_cfi_check_fail.c
@@ -0,0 +1,49 @@
+/*
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Copyright © 2025 Keith Packard
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above
+ *    copyright notice, this list of conditions and the following
+ *    disclaimer in the documentation and/or other materials provided
+ *    with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "ubsan.h"
+
+void
+__ubsan_handle_cfi_check_fail(void *_data,
+                              void *function,
+                              void *vtable_is_valid)
+{
+    struct cfi_check_fail_data *data = _data;
+    __ubsan_error(&data->location, "cfi_check_fail", "(%s) %p valid %p %s\n",
+                  data->type->type_name,
+                  function,
+                  vtable_is_valid,
+                  __ubsan_cfi_type_check_to_string(data->cfi_type_check_kind));
+}
diff --git a/newlib/libc/ubsan/ubsan_handle_dynamic_type_cache_miss.c b/newlib/libc/ubsan/ubsan_handle_dynamic_type_cache_miss.c
@@ -0,0 +1,47 @@
+/*
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Copyright © 2025 Keith Packard
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above
+ *    copyright notice, this list of conditions and the following
+ *    disclaimer in the documentation and/or other materials provided
+ *    with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "ubsan.h"
+
+void
+__ubsan_handle_dynamic_type_cache_miss(void *_data,
+                                       void *pointer,
+                                       void *hash)
+{
+    struct dynamic_type_cache_miss_data *data = _data;
+    __ubsan_error(&data->location, "dynamic_type_cache_miss", "(%s) %p (hash %p)\n",
+                  data->type->type_name, pointer, hash);
+}
+
