]> git.saurik.com Git - apple/xnu.git/blobdiff - san/ubsan.c
xnu-6153.61.1.tar.gz
[apple/xnu.git] / san / ubsan.c
index 0364a411f3514a1db0099a5b653841d873eec066..0259027d1c5bcc3c712f48c53b5be4d68bedb6de 100644 (file)
 
 static const bool ubsan_print = false;
 static const uint32_t line_acquired = 0x80000000UL;
-
+static const char *get_type_check_kind(uint8_t kind);
 static size_t
 format_loc(struct san_src_loc *loc, char *dst, size_t sz)
 {
-       return snprintf(dst, sz, "  loc: %s:%d:%d\n",
-                       loc->filename,
-                       loc->line & ~line_acquired,
-                       loc->col
-               );
+       return scnprintf(dst, sz, "  loc: %s:%d:%d\n",
+                  loc->filename,
+                  loc->line & ~line_acquired,
+                  loc->col
+                  );
 }
 
 /*
@@ -73,15 +73,15 @@ static size_t
 format_overflow(struct ubsan_violation *v, char *buf, size_t sz)
 {
        struct san_type_desc *ty = v->overflow->ty;
-       return snprintf(buf, sz,
-                       "%s overflow, op = %s, ty = %s, width = %d, lhs = 0x%llx, rhs = 0x%llx\n",
-                       ty->issigned ? "signed" : "unsigned",
-                       overflow_str[v->ubsan_type],
-                       ty->name,
-                       1 << ty->width,
-                       v->lhs,
-                       v->rhs
-               );
+       return scnprintf(buf, sz,
+                  "%s overflow, op = %s, ty = %s, width = %d, lhs = 0x%llx, rhs = 0x%llx\n",
+                  ty->issigned ? "signed" : "unsigned",
+                  overflow_str[v->ubsan_type],
+                  ty->name,
+                  1 << ty->width,
+                  v->lhs,
+                  v->rhs
+                  );
 }
 
 static size_t
@@ -91,31 +91,48 @@ format_shift(struct ubsan_violation *v, char *buf, size_t sz)
        struct san_type_desc *l = v->shift->lhs_t;
        struct san_type_desc *r = v->shift->rhs_t;
 
-       n += snprintf(buf+n, sz-n, "bad shift\n");
-       n += snprintf(buf+n, sz-n, "  lhs: 0x%llx, ty = %s, signed = %d, width = %d\n", v->lhs, l->name, l->issigned, 1 << l->width);
-       n += snprintf(buf+n, sz-n, "  rhs: 0x%llx, ty = %s, signed = %d, width = %d\n", v->rhs, r->name, r->issigned, 1 << r->width);
+       n += scnprintf(buf + n, sz - n, "bad shift\n");
+       n += scnprintf(buf + n, sz - n, "  lhs: 0x%llx, ty = %s, signed = %d, width = %d\n", v->lhs, l->name, l->issigned, 1 << l->width);
+       n += scnprintf(buf + n, sz - n, "  rhs: 0x%llx, ty = %s, signed = %d, width = %d\n", v->rhs, r->name, r->issigned, 1 << r->width);
 
        return n;
 }
 
-static const char *const
-align_kinds[] = {
-       "load",
-       "store",
-       "<unknown>",
-       "member access",
-       "<unknown>",
+static const char * const
+type_check_kinds[] = {
+       "load of", "store to", "reference binding to", "member access within",
+       "member call on", "constructor call on", "downcast of", "downcast of",
+       "upcast of", "cast to virtual base of", "_Nonnull binding to"
 };
 
+static const char *
+get_type_check_kind(uint8_t kind)
+{
+       return (kind < (sizeof(type_check_kinds) / sizeof(type_check_kinds[0])))
+              ? type_check_kinds[kind]
+              : "some";
+}
+
 static size_t
-format_alignment(struct ubsan_violation *v, char *buf, size_t sz)
+format_type_mismatch(struct ubsan_violation *v, char *buf, size_t sz)
 {
        size_t n = 0;
-       struct san_type_desc *ty = v->align->ty;
+       size_t alignment = 1 << v->align->align;
+       void *ptr = (void*)v->lhs;
+       const char * kind = get_type_check_kind(v->align->kind);
+       if (NULL == ptr) {
+               //null pointer use
+               n += scnprintf(buf + n, sz - n, "%s NULL pointer of type %s\n", kind, v->align->ty->name);
+       } else if (alignment && ((uintptr_t)ptr & (alignment - 1))) {
+               //misaligned pointer use
+               n += scnprintf(buf + n, sz - n, "%s mis-aligned address %p for type %s ", kind, (void*)v->lhs, v->align->ty->name);
+               n += scnprintf(buf + n, sz - n, "which requires %d byte alignment\n", 1 << v->align->align);
+       } else {
+               //insufficient object size
+               n += scnprintf(buf + n, sz - n, "%s address %p with insufficient space for an object of type %s\n",
+                   kind, ptr, v->align->ty->name);
+       }
 
-       n += snprintf(buf+n, sz-n, "mis-aligned %s of 0x%llx\n", align_kinds[v->align->kind], v->lhs);
-       n += snprintf(buf+n, sz-n, "  expected %d-byte alignment, type = %s\n",
-                       1 << v->align->align, ty->name);
        return n;
 }
 
@@ -127,10 +144,10 @@ format_oob(struct ubsan_violation *v, char *buf, size_t sz)
        struct san_type_desc *ity = v->oob->index_ty;
        uintptr_t idx = v->lhs;
 
-       n += snprintf(buf+n, sz-n, "OOB array access\n");
-       n += snprintf(buf+n, sz-n, "  idx %ld\n", idx);
-       n += snprintf(buf+n, sz-n, "  aty: ty = %s, signed = %d, width = %d\n", aty->name, aty->issigned, 1 << aty->width);
-       n += snprintf(buf+n, sz-n, "  ity: ty = %s, signed = %d, width = %d\n", ity->name, ity->issigned, 1 << ity->width);
+       n += scnprintf(buf + n, sz - n, "OOB array access\n");
+       n += scnprintf(buf + n, sz - n, "  idx %ld\n", idx);
+       n += scnprintf(buf + n, sz - n, "  aty: ty = %s, signed = %d, width = %d\n", aty->name, aty->issigned, 1 << aty->width);
+       n += scnprintf(buf + n, sz - n, "  ity: ty = %s, signed = %d, width = %d\n", ity->name, ity->issigned, 1 << ity->width);
 
        return n;
 }
@@ -142,28 +159,31 @@ ubsan_format(struct ubsan_violation *v, char *buf, size_t sz)
 
        switch (v->ubsan_type) {
        case UBSAN_OVERFLOW_add ... UBSAN_OVERFLOW_negate:
-               n += format_overflow(v, buf+n, sz-n);
+               n += format_overflow(v, buf + n, sz - n);
                break;
        case UBSAN_UNREACHABLE:
-               n += snprintf(buf+n, sz-n, "unreachable\n");
+               n += scnprintf(buf + n, sz - n, "unreachable\n");
                break;
        case UBSAN_SHIFT:
-               n += format_shift(v, buf+n, sz-n);
+               n += format_shift(v, buf + n, sz - n);
                break;
-       case UBSAN_ALIGN:
-               n += format_alignment(v, buf+n, sz-n);
+       case UBSAN_TYPE_MISMATCH:
+               n += format_type_mismatch(v, buf + n, sz - n);
                break;
        case UBSAN_POINTER_OVERFLOW:
-               n += snprintf(buf+n, sz-n, "pointer overflow, before = 0x%llx, after = 0x%llx\n", v->lhs, v->rhs);
+               n += scnprintf(buf + n, sz - n, "pointer overflow, before = 0x%llx, after = 0x%llx\n", v->lhs, v->rhs);
                break;
        case UBSAN_OOB:
-               n += format_oob(v, buf+n, sz-n);
+               n += format_oob(v, buf + n, sz - n);
+               break;
+       case UBSAN_GENERIC:
+               n += scnprintf(buf + n, sz - n, "%s\n", v->func);
                break;
        default:
                panic("unknown violation");
        }
 
-       n += format_loc(v->loc, buf+n, sz-n);
+       n += format_loc(v->loc, buf + n, sz - n);
 
        return n;
 }
@@ -184,7 +204,7 @@ ubsan_handle(struct ubsan_violation *v, bool fatal)
        ubsan_log_append(v);
 
        if (ubsan_print || fatal) {
-               n += ubsan_format(v, buf+n, sz-n);
+               n += ubsan_format(v, buf + n, sz - n);
        }
 
        if (ubsan_print) {
@@ -219,12 +239,12 @@ __ubsan_handle_shift_out_of_bounds_abort(struct ubsan_shift_desc *desc, uint64_t
 
 #define DEFINE_OVERFLOW(op) \
        void __ubsan_handle_##op##_overflow(struct ubsan_overflow_desc *desc, uint64_t lhs, uint64_t rhs) { \
-               struct ubsan_violation v = { UBSAN_OVERFLOW_##op, lhs, rhs, .overflow = desc, &desc->loc }; \
-               ubsan_handle(&v, false); \
+               struct ubsan_violation v = { UBSAN_OVERFLOW_##op, lhs, rhs, .overflow = desc, &desc->loc }; \
+               ubsan_handle(&v, false); \
        } \
        void __ubsan_handle_##op##_overflow_abort(struct ubsan_overflow_desc *desc, uint64_t lhs, uint64_t rhs) { \
-               struct ubsan_violation v = { UBSAN_OVERFLOW_##op, lhs, rhs, .overflow = desc, &desc->loc }; \
-               ubsan_handle(&v, true); \
+               struct ubsan_violation v = { UBSAN_OVERFLOW_##op, lhs, rhs, .overflow = desc, &desc->loc }; \
+               ubsan_handle(&v, true); \
        }
 
 DEFINE_OVERFLOW(add)
@@ -233,38 +253,68 @@ DEFINE_OVERFLOW(mul)
 DEFINE_OVERFLOW(divrem)
 DEFINE_OVERFLOW(negate)
 
-void __ubsan_handle_type_mismatch_v1(struct ubsan_align_desc *desc, uint64_t val)
+void
+__ubsan_handle_type_mismatch_v1(struct ubsan_align_desc *desc, uint64_t val)
 {
-       struct ubsan_violation v = { UBSAN_ALIGN, val, 0, .align = desc, &desc->loc };
+       struct ubsan_violation v = { UBSAN_TYPE_MISMATCH, val, 0, .align = desc, &desc->loc };
        ubsan_handle(&v, false);
 }
 
-void __ubsan_handle_type_mismatch_v1_abort(struct ubsan_align_desc *desc, uint64_t val)
+void
+__ubsan_handle_type_mismatch_v1_abort(struct ubsan_align_desc *desc, uint64_t val)
 {
-       struct ubsan_violation v = { UBSAN_ALIGN, val, 0, .align = desc, &desc->loc };
+       struct ubsan_violation v = { UBSAN_TYPE_MISMATCH, val, 0, .align = desc, &desc->loc };
        ubsan_handle(&v, true);
 }
 
-void __ubsan_handle_pointer_overflow(struct ubsan_ptroverflow_desc *desc, uint64_t before, uint64_t after)
+void
+__ubsan_handle_pointer_overflow(struct ubsan_ptroverflow_desc *desc, uint64_t before, uint64_t after)
 {
        struct ubsan_violation v = { UBSAN_POINTER_OVERFLOW, before, after, .ptroverflow = desc, &desc->loc };
        ubsan_handle(&v, false);
 }
 
-void __ubsan_handle_pointer_overflow_abort(struct ubsan_ptroverflow_desc *desc, uint64_t before, uint64_t after)
+void
+__ubsan_handle_pointer_overflow_abort(struct ubsan_ptroverflow_desc *desc, uint64_t before, uint64_t after)
 {
        struct ubsan_violation v = { UBSAN_POINTER_OVERFLOW, before, after, .ptroverflow = desc, &desc->loc };
        ubsan_handle(&v, true);
 }
 
-void __ubsan_handle_out_of_bounds(struct ubsan_oob_desc *desc, uint64_t idx)
+void
+__ubsan_handle_out_of_bounds(struct ubsan_oob_desc *desc, uint64_t idx)
 {
        struct ubsan_violation v = { UBSAN_OOB, idx, 0, .oob = desc, &desc->loc };
        ubsan_handle(&v, false);
 }
 
-void __ubsan_handle_out_of_bounds_abort(struct ubsan_oob_desc *desc, uint64_t idx)
+void
+__ubsan_handle_out_of_bounds_abort(struct ubsan_oob_desc *desc, uint64_t idx)
 {
        struct ubsan_violation v = { UBSAN_OOB, idx, 0, .oob = desc, &desc->loc };
        ubsan_handle(&v, true);
 }
+
+#define DEFINE_GENERIC(check) \
+       void __ubsan_handle_##check (struct san_src_loc* loc) \
+       { \
+               struct ubsan_violation v = { UBSAN_GENERIC, 0, 0, .func = __func__, loc }; \
+               ubsan_handle(&v, false); \
+       } \
+       void __ubsan_handle_##check##_abort(struct san_src_loc* loc) \
+       { \
+               struct ubsan_violation v = { UBSAN_GENERIC, 0, 0, .func = __func__, loc }; \
+               ubsan_handle(&v, true); \
+       }
+
+DEFINE_GENERIC(invalid_builtin)
+DEFINE_GENERIC(load_invalid_value)
+DEFINE_GENERIC(nonnull_arg)
+DEFINE_GENERIC(vla_bound_not_positive)
+DEFINE_GENERIC(float_cast_overflow)
+DEFINE_GENERIC(function_type_mismatch)
+DEFINE_GENERIC(missing_return)
+DEFINE_GENERIC(nonnull_return)
+DEFINE_GENERIC(nullability_arg)
+DEFINE_GENERIC(nullability_return)
+DEFINE_GENERIC(implicit_conversion)