blender
/
blender
136
404
Fork 586
Code Issues 6.2k Pull Requests 755 Projects 19 Wiki Activity

DNA: add error for DNA computed struct sizes and member offsets mismatch. 

Ref T63164, there was a hidden bug like this on Windows 32 bit.
This commit is contained in:
Brecht Van Lommel 2019-04-02 12:32:21 +02:00
parent 1abd909a92
commit 964b5f02ca
Notes: blender-bot 2023-02-14 03:09:52 +01:00 
Referenced by issue #63219, Compilation errors on dna_verify.c
Referenced by issue #63220, Cannot make object single user after Duplicate Scene with Link Object Data
Referenced by issue #63164, makesdna structure size mismatch on 32 bit.
4 changed files with 58 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/blender/makesdna/DNA_windowmanager_types.h
View File

@ -189,7 +189,7 @@ enum {
#define WM_KEYCONFIG_STR_DEFAULT "blender"
/* IME is win32 only! */
#ifndef WIN32
#if !defined(WIN32) && !defined(DNA_DEPRECATED)
# ifdef __GNUC__
# define ime_data ime_data __attribute__ ((deprecated))
# endif

4
source/blender/makesdna/intern/CMakeLists.txt
View File

@ -63,10 +63,12 @@ add_custom_command(
OUTPUT
${CMAKE_CURRENT_BINARY_DIR}/dna.c
${CMAKE_CURRENT_BINARY_DIR}/dna_type_offsets.h
${CMAKE_CURRENT_BINARY_DIR}/dna_verify.c
COMMAND
"$<TARGET_FILE:makesdna>"
${CMAKE_CURRENT_BINARY_DIR}/dna.c
${CMAKE_CURRENT_BINARY_DIR}/dna_type_offsets.h
${CMAKE_CURRENT_BINARY_DIR}/dna_verify.c
${CMAKE_SOURCE_DIR}/source/blender/makesdna/
DEPENDS makesdna
)
@ -86,6 +88,7 @@ set(SRC
dna_utils.c
dna_genfile.c
${CMAKE_CURRENT_BINARY_DIR}/dna.c
${CMAKE_CURRENT_BINARY_DIR}/dna_verify.c
${SRC_DNA_INC}
dna_utils.h
@ -93,6 +96,7 @@ set(SRC
set_source_files_properties(
${CMAKE_CURRENT_BINARY_DIR}/dna.c
${CMAKE_CURRENT_BINARY_DIR}/dna_verify.c
${CMAKE_CURRENT_BINARY_DIR}/dna_type_offsets.h
PROPERTIES GENERATED TRUE
)

1
source/blender/makesdna/intern/dna_genfile.c
View File

@ -122,6 +122,7 @@
* - float: 4 aligned
* - double: 8 aligned
* - long: 8 aligned
* - int64: 8 aligned
* - struct: 8 aligned
* - the sdna functions have several error prints builtin, always check blender running from a console.
*/

97
source/blender/makesdna/intern/makesdna.c
View File

@ -168,6 +168,7 @@ static short **structs, *structdata;
static struct {
GHash *struct_map_alias_from_static;
GHash *struct_map_static_from_alias;
GHash *elem_map_alias_from_static;
GHash *elem_map_static_from_alias;
} g_version_data = {NULL};
@ -235,7 +236,7 @@ static int convert_include(const char *filename);
/**
* Determine how many bytes are needed for each struct.
*/
static int calculate_struct_sizes(int);
static int calculate_struct_sizes(int firststruct, FILE *file_verify, const char *base_directory);
/**
* Construct the DNA.c file
@ -293,6 +294,17 @@ static const char *version_elem_static_from_alias(
return elem_alias_full;
}
static const char *version_elem_name_alias_from_static(
const int strct, const char *elem_static_full)
{
const uint elem_static_full_len = strlen(elem_static_full);
char *elem_static = alloca(elem_static_full_len + 1);
DNA_elem_id_strip_copy(elem_static, elem_static_full);
const char *str_pair[2] = {types[strct], elem_static};
const char *elem_alias = BLI_ghash_lookup(g_version_data.elem_map_alias_from_static, str_pair);
return (elem_alias) ? elem_alias : elem_static; /* TODO: alloca */
}
/**
* Enforce '_pad123' naming convention, disallow 'pad123' or 'pad_123',
* special exception for [a-z] after since there is a 'pad_rot_angle' preference.
@ -861,11 +873,21 @@ static bool check_field_alignment(int firststruct, int structtype, int type, int
return result;
}
static int calculate_struct_sizes(int firststruct)
static int calculate_struct_sizes(int firststruct, FILE *file_verify, const char *base_directory)
{
int unknown = nr_structs, lastunknown;
bool dna_error = false;
/* Write test to verify sizes are accurate. */
fprintf(file_verify, "/* Verify struct sizes and member offsets are as expected by DNA. */\n");
fprintf(file_verify, "#include \"BLI_assert.h\"\n\n");
fprintf(file_verify, "#define DNA_DEPRECATED\n");
for (int i = 0; *(includefiles[i]) != '\0'; i++) {
fprintf(file_verify, "#include \"%s%s\"\n", base_directory, includefiles[i]);
}
fprintf(file_verify, "\n");
/* Multiple iterations to handle nested structs. */
while (unknown) {
lastunknown = unknown;
unknown = 0;
@ -874,6 +896,7 @@ static int calculate_struct_sizes(int firststruct)
for (int a = 0; a < nr_structs; a++) {
const short *structpoin = structs[a];
const int structtype = structpoin[0];
const char *structname = version_struct_alias_from_static(types[structtype]);
/* when length is not known... */
if (types_size_native[structtype] == 0) {
@ -888,8 +911,12 @@ static int calculate_struct_sizes(int firststruct)
for (int b = 0; b < structpoin[1]; b++, sp += 2) {
int type = sp[0];
const char *cp = names[sp[1]];
int namelen = (int)strlen(cp);
/* Write size verification to file. */
const char *name_alias = version_elem_name_alias_from_static(structtype, cp);
fprintf(file_verify, "BLI_STATIC_ASSERT(offsetof(struct %s, %s) == %d, \"DNA member offset verify\");\n", structname, name_alias, size_native);
/* is it a pointer or function pointer? */
if (cp[0] == '*' || cp[1] == '*') {
has_pointer = 1;
@ -1005,6 +1032,8 @@ static int calculate_struct_sizes(int firststruct)
dna_error = 1;
}
/* Write size verification to file. */
fprintf(file_verify, "BLI_STATIC_ASSERT(sizeof(struct %s) == %d, \"DNA struct size verify\");\n\n", structname, size_native);
}
}
}
@ -1094,7 +1123,7 @@ void print_struct_sizes(void)
}
static int make_structDNA(const char *baseDirectory, FILE *file, FILE *file_offsets)
static int make_structDNA(const char *base_directory, FILE *file, FILE *file_offsets, FILE *file_verify)
{
int i;
const short *sp;
@ -1125,7 +1154,7 @@ static int make_structDNA(const char *baseDirectory, FILE *file, FILE *file_offs
DNA_alias_maps(
DNA_RENAME_ALIAS_FROM_STATIC,
&g_version_data.struct_map_alias_from_static,
NULL);
&g_version_data.elem_map_alias_from_static);
DNA_alias_maps(
DNA_RENAME_STATIC_FROM_ALIAS,
&g_version_data.struct_map_static_from_alias,
@ -1164,7 +1193,7 @@ static int make_structDNA(const char *baseDirectory, FILE *file, FILE *file_offs
/* Mind the breaking condition here! */
DEBUG_PRINTF(0, "\tStart of header scan:\n");
for (i = 0; *(includefiles[i]) != '\0'; i++) {
sprintf(str, "%s%s", baseDirectory, includefiles[i]);
sprintf(str, "%s%s", base_directory, includefiles[i]);
DEBUG_PRINTF(0, "\t|-- Converting %s\n", str);
if (convert_include(str)) {
return 1;
@ -1172,7 +1201,7 @@ static int make_structDNA(const char *baseDirectory, FILE *file, FILE *file_offs
}
DEBUG_PRINTF(0, "\tFinished scanning %d headers.\n", i);
if (calculate_struct_sizes(firststruct)) {
if (calculate_struct_sizes(firststruct, file_verify, base_directory)) {
/* error */
return 1;
}
@ -1274,37 +1303,6 @@ static int make_structDNA(const char *baseDirectory, FILE *file, FILE *file_offs
dna_write(file, structs[0], len);
/* a simple dna padding test */
if (0) {
FILE *fp;
int a;
fp = fopen("padding.c", "w");
if (fp == NULL) {
/* pass */
}
else {
/* add all include files defined in the global array */
for (i = 0; *(includefiles[i]) != '\0'; i++) {
fprintf(fp, "#include \"%s%s\"\n", baseDirectory, includefiles[i]);
}
fprintf(fp, "main() {\n");
sp = types_size_native;
sp += firststruct;
for (a = firststruct; a < nr_types; a++, sp++) {
if (*sp) {
fprintf(fp, "\tif (sizeof(struct %s) - %d) printf(\"ALIGN ERROR:", types[a], *sp);
fprintf(fp, "%%d %s %d ", types[a], *sp);
fprintf(fp, "\\n\", sizeof(struct %s) - %d);\n", types[a], *sp);
}
}
fprintf(fp, "}\n");
fclose(fp);
}
}
/* end end padding test */
}
/* write a simple enum with all structs offsets,
@ -1318,7 +1316,7 @@ static int make_structDNA(const char *baseDirectory, FILE *file, FILE *file_offs
fprintf(file_offsets, "\t_SDNA_TYPE_%s = %d,\n", version_struct_alias_from_static(types[structtype]), i);
}
fprintf(file_offsets, "\tSDNA_TYPE_MAX = %d,\n", nr_structs);
fprintf(file_offsets, "};\n");
fprintf(file_offsets, "};\n\n");
}
/* Check versioning errors which could cause duplicate names,
@ -1358,6 +1356,7 @@ static int make_structDNA(const char *baseDirectory, FILE *file, FILE *file_offs
BLI_ghash_free(g_version_data.struct_map_alias_from_static, NULL, NULL);
BLI_ghash_free(g_version_data.struct_map_static_from_alias, NULL, NULL);
BLI_ghash_free(g_version_data.elem_map_static_from_alias, MEM_freeN, NULL);
BLI_ghash_free(g_version_data.elem_map_alias_from_static, MEM_freeN, NULL);
DEBUG_PRINTF(0, "done.\n");
@ -1389,13 +1388,14 @@ int main(int argc, char **argv)
{
int return_status = 0;
if (argc != 3 && argc != 4) {
if (argc != 4 && argc != 5) {
printf("Usage: %s dna.c dna_struct_offsets.h [base directory]\n", argv[0]);
return_status = 1;
}
else {
FILE *file_dna = fopen(argv[1], "w");
FILE *file_dna_offsets = fopen(argv[2], "w");
FILE *file_dna_verify = fopen(argv[3], "w");
if (!file_dna) {
printf("Unable to open file: %s\n", argv[1]);
return_status = 1;
@ -1404,19 +1404,23 @@ int main(int argc, char **argv)
printf("Unable to open file: %s\n", argv[2]);
return_status = 1;
}
else if (!file_dna_verify) {
printf("Unable to open file: %s\n", argv[3]);
return_status = 1;
}
else {
const char *baseDirectory;
const char *base_directory;
if (argc == 4) {
baseDirectory = argv[3];
if (argc == 5) {
base_directory = argv[4];
}
else {
baseDirectory = BASE_HEADER;
base_directory = BASE_HEADER;
}
fprintf(file_dna, "extern const unsigned char DNAstr[];\n");
fprintf(file_dna, "const unsigned char DNAstr[] = {\n");
if (make_structDNA(baseDirectory, file_dna, file_dna_offsets)) {
if (make_structDNA(base_directory, file_dna, file_dna_offsets, file_dna_verify)) {
/* error */
fclose(file_dna);
file_dna = NULL;
@ -1436,6 +1440,9 @@ int main(int argc, char **argv)
if (file_dna_offsets) {
fclose(file_dna_offsets);
}
if (file_dna_verify) {
fclose(file_dna_verify);
}
}