From f81deb6b6ed823d72301ea2487a0dddf12b80a4e Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Thu, 19 Oct 2023 19:16:16 +1100 Subject: [PATCH] base: have empty_foo() functions use non-NULL ptr Fixes #135 --- internal/cgen/base/all-impl.c | 6 ++ internal/cgen/base/fundamental-private.h | 14 --- internal/cgen/base/fundamental-public.h | 74 ++++++++++++-- internal/cgen/base/io-public.h | 3 +- internal/cgen/base/token-public.h | 25 ++++- release/c/wuffs-unsupported-snapshot.c | 122 ++++++++++++++++++----- 6 files changed, 194 insertions(+), 50 deletions(-) diff --git a/internal/cgen/base/all-impl.c b/internal/cgen/base/all-impl.c index 4a9ed532..0306780b 100644 --- a/internal/cgen/base/all-impl.c +++ b/internal/cgen/base/all-impl.c @@ -111,6 +111,12 @@ const uint32_t wuffs_base__pixel_format__bits_per_channel[16] = { 0x08, 0x0A, 0x0C, 0x10, 0x18, 0x20, 0x30, 0x40, }; +const wuffs_base__int_types // + wuffs_base__placeholder_int_types_with_non_null_address = {0}; + +const wuffs_base__token // + wuffs_base__placeholder_token_with_non_null_address = {0}; + // ¡ INSERT wuffs_base__status strings. // ¡ INSERT vtable names. diff --git a/internal/cgen/base/fundamental-private.h b/internal/cgen/base/fundamental-private.h index 315d11cf..be5ea481 100644 --- a/internal/cgen/base/fundamental-private.h +++ b/internal/cgen/base/fundamental-private.h @@ -57,20 +57,6 @@ // -------- -#if defined(__GNUC__) -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wcast-qual" -#endif -static inline uint8_t* // -wuffs_base__strip_const_from_u8_ptr(const uint8_t* ptr) { - return (uint8_t*)ptr; -} -#if defined(__GNUC__) -#pragma GCC diagnostic pop -#endif - -// -------- - static inline wuffs_base__empty_struct // wuffs_base__ignore_status(wuffs_base__status z) { return wuffs_base__make_empty_struct(); diff --git a/internal/cgen/base/fundamental-public.h b/internal/cgen/base/fundamental-public.h index 367385a0..5cc01a7c 100644 --- a/internal/cgen/base/fundamental-public.h +++ b/internal/cgen/base/fundamental-public.h @@ -358,6 +358,56 @@ struct wuffs_unique_ptr_deleter { // -------- +#if defined(__GNUC__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wcast-qual" +#endif + +static inline uint8_t* // +wuffs_base__strip_const_from_u8_ptr(const uint8_t* ptr) { + return (uint8_t*)ptr; +} + +static inline uint16_t* // +wuffs_base__strip_const_from_u16_ptr(const uint16_t* ptr) { + return (uint16_t*)ptr; +} + +static inline uint32_t* // +wuffs_base__strip_const_from_u32_ptr(const uint32_t* ptr) { + return (uint32_t*)ptr; +} + +static inline uint64_t* // +wuffs_base__strip_const_from_u64_ptr(const uint64_t* ptr) { + return (uint64_t*)ptr; +} + +#if defined(__GNUC__) +#pragma GCC diagnostic pop +#endif + +// -------- + +typedef struct wuffs_base__int_types__struct { + uint8_t u8; + uint16_t u16; + uint32_t u32; + uint64_t u64; +} wuffs_base__int_types; + +// wuffs_base__placeholder_int_types_with_non_null_address provides non-NULL +// pointers to various integer types. These values aren't intended to ever be +// modified and their addresses aren't intended to ever be dereferenced. +// +// It's just that adding 0 to a NULL pointer can be undefined behavior (and +// UBSAN will complain), so functions like wuffs_base__empty_slice_u8 need some +// arbitrary non-NULL placeholder pointer, even though the slice has 0 length. +extern const wuffs_base__int_types // + wuffs_base__placeholder_int_types_with_non_null_address; + +// -------- + // wuffs_base__empty_struct is used when a Wuffs function returns an empty // struct. In C, if a function f returns void, you can't say "x = f()", but in // Wuffs, if a function g returns empty, you can say "y = g()". @@ -1310,7 +1360,8 @@ wuffs_base__make_slice_u64_ij(uint64_t* ptr, size_t i, size_t j) { static inline wuffs_base__slice_u8 // wuffs_base__empty_slice_u8(void) { wuffs_base__slice_u8 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u8_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u8); ret.len = 0; return ret; } @@ -1318,7 +1369,8 @@ wuffs_base__empty_slice_u8(void) { static inline wuffs_base__slice_u16 // wuffs_base__empty_slice_u16(void) { wuffs_base__slice_u16 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u16_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u16); ret.len = 0; return ret; } @@ -1326,7 +1378,8 @@ wuffs_base__empty_slice_u16(void) { static inline wuffs_base__slice_u32 // wuffs_base__empty_slice_u32(void) { wuffs_base__slice_u32 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u32_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u32); ret.len = 0; return ret; } @@ -1334,7 +1387,8 @@ wuffs_base__empty_slice_u32(void) { static inline wuffs_base__slice_u64 // wuffs_base__empty_slice_u64(void) { wuffs_base__slice_u64 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u64_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u64); ret.len = 0; return ret; } @@ -1394,7 +1448,8 @@ wuffs_base__make_table_u64(uint64_t* ptr, static inline wuffs_base__table_u8 // wuffs_base__empty_table_u8(void) { wuffs_base__table_u8 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u8_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u8); ret.width = 0; ret.height = 0; ret.stride = 0; @@ -1404,7 +1459,8 @@ wuffs_base__empty_table_u8(void) { static inline wuffs_base__table_u16 // wuffs_base__empty_table_u16(void) { wuffs_base__table_u16 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u16_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u16); ret.width = 0; ret.height = 0; ret.stride = 0; @@ -1414,7 +1470,8 @@ wuffs_base__empty_table_u16(void) { static inline wuffs_base__table_u32 // wuffs_base__empty_table_u32(void) { wuffs_base__table_u32 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u32_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u32); ret.width = 0; ret.height = 0; ret.stride = 0; @@ -1424,7 +1481,8 @@ wuffs_base__empty_table_u32(void) { static inline wuffs_base__table_u64 // wuffs_base__empty_table_u64(void) { wuffs_base__table_u64 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u64_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u64); ret.width = 0; ret.height = 0; ret.stride = 0; diff --git a/internal/cgen/base/io-public.h b/internal/cgen/base/io-public.h index 4a5bbf21..8fb887eb 100644 --- a/internal/cgen/base/io-public.h +++ b/internal/cgen/base/io-public.h @@ -118,7 +118,8 @@ wuffs_base__slice_u8__writer(wuffs_base__slice_u8 s) { static inline wuffs_base__io_buffer // wuffs_base__empty_io_buffer(void) { wuffs_base__io_buffer ret; - ret.data.ptr = NULL; + ret.data.ptr = wuffs_base__strip_const_from_u8_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u8); ret.data.len = 0; ret.meta.wi = 0; ret.meta.ri = 0; diff --git a/internal/cgen/base/token-public.h b/internal/cgen/base/token-public.h index 6e1fdab4..3f6142ea 100644 --- a/internal/cgen/base/token-public.h +++ b/internal/cgen/base/token-public.h @@ -277,6 +277,25 @@ wuffs_base__token::length() const { // -------- +extern const wuffs_base__token // + wuffs_base__placeholder_token_with_non_null_address; + +#if defined(__GNUC__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wcast-qual" +#endif + +static inline wuffs_base__token* // +wuffs_base__strip_const_from_token_ptr(const wuffs_base__token* ptr) { + return (wuffs_base__token*)ptr; +} + +#if defined(__GNUC__) +#pragma GCC diagnostic pop +#endif + +// -------- + typedef WUFFS_BASE__SLICE(wuffs_base__token) wuffs_base__slice_token; static inline wuffs_base__slice_token // @@ -290,7 +309,8 @@ wuffs_base__make_slice_token(wuffs_base__token* ptr, size_t len) { static inline wuffs_base__slice_token // wuffs_base__empty_slice_token(void) { wuffs_base__slice_token ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_token_ptr( + &wuffs_base__placeholder_token_with_non_null_address); ret.len = 0; return ret; } @@ -379,7 +399,8 @@ wuffs_base__slice_token__writer(wuffs_base__slice_token s) { static inline wuffs_base__token_buffer // wuffs_base__empty_token_buffer(void) { wuffs_base__token_buffer ret; - ret.data.ptr = NULL; + ret.data.ptr = wuffs_base__strip_const_from_token_ptr( + &wuffs_base__placeholder_token_with_non_null_address); ret.data.len = 0; ret.meta.wi = 0; ret.meta.ri = 0; diff --git a/release/c/wuffs-unsupported-snapshot.c b/release/c/wuffs-unsupported-snapshot.c index b8f60cd3..44e57f2a 100644 --- a/release/c/wuffs-unsupported-snapshot.c +++ b/release/c/wuffs-unsupported-snapshot.c @@ -414,6 +414,56 @@ struct wuffs_unique_ptr_deleter { // -------- +#if defined(__GNUC__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wcast-qual" +#endif + +static inline uint8_t* // +wuffs_base__strip_const_from_u8_ptr(const uint8_t* ptr) { + return (uint8_t*)ptr; +} + +static inline uint16_t* // +wuffs_base__strip_const_from_u16_ptr(const uint16_t* ptr) { + return (uint16_t*)ptr; +} + +static inline uint32_t* // +wuffs_base__strip_const_from_u32_ptr(const uint32_t* ptr) { + return (uint32_t*)ptr; +} + +static inline uint64_t* // +wuffs_base__strip_const_from_u64_ptr(const uint64_t* ptr) { + return (uint64_t*)ptr; +} + +#if defined(__GNUC__) +#pragma GCC diagnostic pop +#endif + +// -------- + +typedef struct wuffs_base__int_types__struct { + uint8_t u8; + uint16_t u16; + uint32_t u32; + uint64_t u64; +} wuffs_base__int_types; + +// wuffs_base__placeholder_int_types_with_non_null_address provides non-NULL +// pointers to various integer types. These values aren't intended to ever be +// modified and their addresses aren't intended to ever be dereferenced. +// +// It's just that adding 0 to a NULL pointer can be undefined behavior (and +// UBSAN will complain), so functions like wuffs_base__empty_slice_u8 need some +// arbitrary non-NULL placeholder pointer, even though the slice has 0 length. +extern const wuffs_base__int_types // + wuffs_base__placeholder_int_types_with_non_null_address; + +// -------- + // wuffs_base__empty_struct is used when a Wuffs function returns an empty // struct. In C, if a function f returns void, you can't say "x = f()", but in // Wuffs, if a function g returns empty, you can say "y = g()". @@ -1581,7 +1631,8 @@ wuffs_base__make_slice_u64_ij(uint64_t* ptr, size_t i, size_t j) { static inline wuffs_base__slice_u8 // wuffs_base__empty_slice_u8(void) { wuffs_base__slice_u8 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u8_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u8); ret.len = 0; return ret; } @@ -1589,7 +1640,8 @@ wuffs_base__empty_slice_u8(void) { static inline wuffs_base__slice_u16 // wuffs_base__empty_slice_u16(void) { wuffs_base__slice_u16 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u16_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u16); ret.len = 0; return ret; } @@ -1597,7 +1649,8 @@ wuffs_base__empty_slice_u16(void) { static inline wuffs_base__slice_u32 // wuffs_base__empty_slice_u32(void) { wuffs_base__slice_u32 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u32_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u32); ret.len = 0; return ret; } @@ -1605,7 +1658,8 @@ wuffs_base__empty_slice_u32(void) { static inline wuffs_base__slice_u64 // wuffs_base__empty_slice_u64(void) { wuffs_base__slice_u64 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u64_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u64); ret.len = 0; return ret; } @@ -1665,7 +1719,8 @@ wuffs_base__make_table_u64(uint64_t* ptr, static inline wuffs_base__table_u8 // wuffs_base__empty_table_u8(void) { wuffs_base__table_u8 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u8_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u8); ret.width = 0; ret.height = 0; ret.stride = 0; @@ -1675,7 +1730,8 @@ wuffs_base__empty_table_u8(void) { static inline wuffs_base__table_u16 // wuffs_base__empty_table_u16(void) { wuffs_base__table_u16 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u16_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u16); ret.width = 0; ret.height = 0; ret.stride = 0; @@ -1685,7 +1741,8 @@ wuffs_base__empty_table_u16(void) { static inline wuffs_base__table_u32 // wuffs_base__empty_table_u32(void) { wuffs_base__table_u32 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u32_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u32); ret.width = 0; ret.height = 0; ret.stride = 0; @@ -1695,7 +1752,8 @@ wuffs_base__empty_table_u32(void) { static inline wuffs_base__table_u64 // wuffs_base__empty_table_u64(void) { wuffs_base__table_u64 ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_u64_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u64); ret.width = 0; ret.height = 0; ret.stride = 0; @@ -2981,7 +3039,8 @@ wuffs_base__slice_u8__writer(wuffs_base__slice_u8 s) { static inline wuffs_base__io_buffer // wuffs_base__empty_io_buffer(void) { wuffs_base__io_buffer ret; - ret.data.ptr = NULL; + ret.data.ptr = wuffs_base__strip_const_from_u8_ptr( + &wuffs_base__placeholder_int_types_with_non_null_address.u8); ret.data.len = 0; ret.meta.wi = 0; ret.meta.ri = 0; @@ -3441,6 +3500,25 @@ wuffs_base__token::length() const { // -------- +extern const wuffs_base__token // + wuffs_base__placeholder_token_with_non_null_address; + +#if defined(__GNUC__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wcast-qual" +#endif + +static inline wuffs_base__token* // +wuffs_base__strip_const_from_token_ptr(const wuffs_base__token* ptr) { + return (wuffs_base__token*)ptr; +} + +#if defined(__GNUC__) +#pragma GCC diagnostic pop +#endif + +// -------- + typedef WUFFS_BASE__SLICE(wuffs_base__token) wuffs_base__slice_token; static inline wuffs_base__slice_token // @@ -3454,7 +3532,8 @@ wuffs_base__make_slice_token(wuffs_base__token* ptr, size_t len) { static inline wuffs_base__slice_token // wuffs_base__empty_slice_token(void) { wuffs_base__slice_token ret; - ret.ptr = NULL; + ret.ptr = wuffs_base__strip_const_from_token_ptr( + &wuffs_base__placeholder_token_with_non_null_address); ret.len = 0; return ret; } @@ -3543,7 +3622,8 @@ wuffs_base__slice_token__writer(wuffs_base__slice_token s) { static inline wuffs_base__token_buffer // wuffs_base__empty_token_buffer(void) { wuffs_base__token_buffer ret; - ret.data.ptr = NULL; + ret.data.ptr = wuffs_base__strip_const_from_token_ptr( + &wuffs_base__placeholder_token_with_non_null_address); ret.data.len = 0; ret.meta.wi = 0; ret.meta.ri = 0; @@ -14200,20 +14280,6 @@ extern "C" { // -------- -#if defined(__GNUC__) -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wcast-qual" -#endif -static inline uint8_t* // -wuffs_base__strip_const_from_u8_ptr(const uint8_t* ptr) { - return (uint8_t*)ptr; -} -#if defined(__GNUC__) -#pragma GCC diagnostic pop -#endif - -// -------- - static inline wuffs_base__empty_struct // wuffs_base__ignore_status(wuffs_base__status z) { return wuffs_base__make_empty_struct(); @@ -14963,6 +15029,12 @@ const uint32_t wuffs_base__pixel_format__bits_per_channel[16] = { 0x08, 0x0A, 0x0C, 0x10, 0x18, 0x20, 0x30, 0x40, }; +const wuffs_base__int_types // + wuffs_base__placeholder_int_types_with_non_null_address = {0}; + +const wuffs_base__token // + wuffs_base__placeholder_token_with_non_null_address = {0}; + const char wuffs_base__note__i_o_redirect[] = "@base: I/O redirect"; const char wuffs_base__note__end_of_data[] = "@base: end of data"; const char wuffs_base__note__metadata_reported[] = "@base: metadata reported";