/src/vulkan-loader/loader/loader_json.c

Source
/*
  Copyright (c) 2015-2021 The Khronos Group Inc.
  Copyright (c) 2015-2021 Valve Corporation
  Copyright (c) 2015-2021 LunarG, Inc.

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  THE SOFTWARE.
*/

#include "loader_json.h"

#include <assert.h>
#include <float.h>
#include <limits.h>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "cJSON.h"

#include "allocation.h"
#include "loader.h"
#include "log.h"

extern void create_callback_file(const char *filename);

#if COMMON_UNIX_PLATFORMS
#include <fcntl.h>
#include <sys/stat.h>
#endif

#ifdef _WIN32
static VkResult loader_read_entire_file(const struct loader_instance *inst, const char *filename, size_t *out_len,
                                        char **out_buff) {
    HANDLE file_handle = INVALID_HANDLE_VALUE;
    DWORD len = 0, read_len = 0;
    VkResult res = VK_SUCCESS;
    BOOL read_ok = false;

    int filename_utf16_size = MultiByteToWideChar(CP_UTF8, 0, filename, -1, NULL, 0);
    if (filename_utf16_size > 0) {
        wchar_t *filename_utf16 = (wchar_t *)loader_stack_alloc(filename_utf16_size * sizeof(wchar_t));
        if (MultiByteToWideChar(CP_UTF8, 0, filename, -1, filename_utf16, filename_utf16_size) == filename_utf16_size) {
            file_handle =
                CreateFileW(filename_utf16, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
        }
    }
    if (INVALID_HANDLE_VALUE == file_handle) {
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to open JSON file %s", filename);
        res = VK_ERROR_INITIALIZATION_FAILED;
        goto out;
    }
    len = GetFileSize(file_handle, NULL);
    if (INVALID_FILE_SIZE == len) {
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read file size of JSON file %s", filename);
        res = VK_ERROR_INITIALIZATION_FAILED;
        goto out;
    }
    *out_buff = (char *)loader_instance_heap_calloc(inst, len + 1, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
    if (NULL == *out_buff) {
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to allocate memory to read JSON file %s", filename);
        res = VK_ERROR_OUT_OF_HOST_MEMORY;
        goto out;
    }
    read_ok = ReadFile(file_handle, *out_buff, len, &read_len, NULL);
    if (len != read_len || false == read_ok) {
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read entire JSON file %s", filename);
        res = VK_ERROR_INITIALIZATION_FAILED;
        goto out;
    }
    *out_len = len + 1;
    (*out_buff)[len] = '\0';

out:
    if (INVALID_HANDLE_VALUE != file_handle) {
        CloseHandle(file_handle);
    }
    return res;
}
#elif COMMON_UNIX_PLATFORMS
static VkResult loader_read_entire_file(const struct loader_instance *inst, const char *filename, size_t *out_len,
                                        char **out_buff) {
    FILE *file = NULL;
    struct stat stats = {0};
    VkResult res = VK_SUCCESS;

    // fprintf(stderr, "loader_get_json: Reading JSON file %s\n", filename);
    file = fopen(filename, "rb");
#ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
    if (file == NULL) {
        create_callback_file(filename);
        file = fopen(filename, "rb");
    }
#endif
    if (NULL == file) {
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to open JSON file %s", filename);
        res = VK_ERROR_INITIALIZATION_FAILED;
        goto out;
    }
    if (-1 == fstat(fileno(file), &stats)) {
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read file size of JSON file %s", filename);
        res = VK_ERROR_INITIALIZATION_FAILED;
        goto out;
    }
    *out_buff = (char *)loader_instance_heap_calloc(inst, stats.st_size + 1, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
    if (NULL == *out_buff) {
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to allocate memory to read JSON file %s", filename);
        res = VK_ERROR_OUT_OF_HOST_MEMORY;
        goto out;
    }
    if (stats.st_size != (long int)fread(*out_buff, sizeof(char), stats.st_size, file)) {
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read entire JSON file %s", filename);
        res = VK_ERROR_INITIALIZATION_FAILED;
        goto out;
    }
    *out_len = stats.st_size + 1;
    (*out_buff)[stats.st_size] = '\0';

out:
    if (NULL != file) {
        fclose(file);
    }
    return res;
}
#else
#warning fopen not available on this platform
VkResult loader_read_entire_file(const struct loader_instance *inst, const char *filename, size_t *out_len, char **out_buff) {
    return VK_ERROR_INITIALIZATION_FAILED;
}
#endif

TEST_FUNCTION_EXPORT VkResult loader_get_json(const struct loader_instance *inst, const char *filename, cJSON **json) {
    char *json_buf = NULL;
    VkResult res = VK_SUCCESS;

    assert(json != NULL);

    size_t json_len = 0;
    *json = NULL;
    res = loader_read_entire_file(inst, filename, &json_len, &json_buf);
    if (VK_SUCCESS != res) {
        goto out;
    }
    bool out_of_memory = false;
    // Parse text from file
    *json = loader_cJSON_ParseWithLength(inst ? &inst->alloc_callbacks : NULL, json_buf, json_len, &out_of_memory);
    if (out_of_memory) {
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Out of Memory error occurred while parsing JSON file %s.",
                   filename);
        res = VK_ERROR_OUT_OF_HOST_MEMORY;
        goto out;
    } else if (*json == NULL) {
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Invalid JSON file %s.", filename);
        goto out;
    }

out:
    loader_instance_heap_free(inst, json_buf);
    if (res != VK_SUCCESS && *json != NULL) {
        loader_cJSON_Delete(*json);
        *json = NULL;
    }

    return res;
}

VkResult loader_parse_json_string_to_existing_str(cJSON *object, const char *key, size_t out_str_len, char *out_string) {
    if (NULL == key) {
        return VK_ERROR_INITIALIZATION_FAILED;
    }
    cJSON *item = loader_cJSON_GetObjectItem(object, key);
    if (NULL == item) {
        return VK_ERROR_INITIALIZATION_FAILED;
    }

    if (item->type != cJSON_String || item->valuestring == NULL) {
        return VK_ERROR_INITIALIZATION_FAILED;
    }
    bool out_of_memory = false;
    bool success = loader_cJSON_PrintPreallocated(item, out_string, (int)out_str_len, cJSON_False);
    if (out_of_memory) {
        return VK_ERROR_OUT_OF_HOST_MEMORY;
    }
    if (!success) {
        return VK_ERROR_INITIALIZATION_FAILED;
    }
    return VK_SUCCESS;
}

VkResult loader_parse_json_string(cJSON *object, const char *key, char **out_string) {
    if (NULL == key) {
        return VK_ERROR_INITIALIZATION_FAILED;
    }

    cJSON *item = loader_cJSON_GetObjectItem(object, key);
    if (NULL == item || NULL == item->valuestring) {
        return VK_ERROR_INITIALIZATION_FAILED;
    }

    bool out_of_memory = false;
    char *str = loader_cJSON_Print(item, &out_of_memory);
    if (out_of_memory || NULL == str) {
        return VK_ERROR_OUT_OF_HOST_MEMORY;
    }
    if (NULL != out_string) {
        *out_string = str;
    }
    return VK_SUCCESS;
}
VkResult loader_parse_json_array_of_strings(const struct loader_instance *inst, cJSON *object, const char *key,
                                            struct loader_string_list *string_list) {
    if (NULL == key) {
        return VK_ERROR_INITIALIZATION_FAILED;
    }
    cJSON *item = loader_cJSON_GetObjectItem(object, key);
    if (NULL == item) {
        return VK_ERROR_INITIALIZATION_FAILED;
    }

    uint32_t count = loader_cJSON_GetArraySize(item);
    if (count == 0) {
        return VK_SUCCESS;
    }

    VkResult res = create_string_list(inst, count, string_list);
    if (VK_ERROR_OUT_OF_HOST_MEMORY == res) {
        goto out;
    }
    cJSON *element = NULL;
    cJSON_ArrayForEach(element, item) {
        if (element->type != cJSON_String) {
            return VK_ERROR_INITIALIZATION_FAILED;
        }
        bool out_of_memory = false;
        char *out_data = loader_cJSON_Print(element, &out_of_memory);
        if (out_of_memory) {
            res = VK_ERROR_OUT_OF_HOST_MEMORY;
            goto out;
        }
        res = append_str_to_string_list(inst, string_list, out_data);
        if (VK_ERROR_OUT_OF_HOST_MEMORY == res) {
            goto out;
        }
    }
out:
    if (res == VK_ERROR_OUT_OF_HOST_MEMORY && NULL != string_list->list) {
        free_string_list(inst, string_list);
    }

    return res;
}

Coverage Report

Created: 2025-09-27 06:44

Line	Count	Source
1		/*
2		Copyright (c) 2015-2021 The Khronos Group Inc.
3		Copyright (c) 2015-2021 Valve Corporation
4		Copyright (c) 2015-2021 LunarG, Inc.
5
6		Permission is hereby granted, free of charge, to any person obtaining a copy
7		of this software and associated documentation files (the "Software"), to deal
8		in the Software without restriction, including without limitation the rights
9		to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10		copies of the Software, and to permit persons to whom the Software is
11		furnished to do so, subject to the following conditions:
12
13		The above copyright notice and this permission notice shall be included in
14		all copies or substantial portions of the Software.
15
16		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17		IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18		FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19		AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20		LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21		OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22		THE SOFTWARE.
23		*/
24
25		#include "loader_json.h"
26
27		#include <assert.h>
28		#include <float.h>
29		#include <limits.h>
30		#include <math.h>
31		#include <stdio.h>
32		#include <stdlib.h>
33		#include <string.h>
34
35		#include "cJSON.h"
36
37		#include "allocation.h"
38		#include "loader.h"
39		#include "log.h"
40
41		extern void create_callback_file(const char *filename);
42
43		#if COMMON_UNIX_PLATFORMS
44		#include <fcntl.h>
45		#include <sys/stat.h>
46		#endif
47
48		#ifdef _WIN32
49		static VkResult loader_read_entire_file(const struct loader_instance inst, const char filename, size_t *out_len,
50		char **out_buff) {
51		HANDLE file_handle = INVALID_HANDLE_VALUE;
52		DWORD len = 0, read_len = 0;
53		VkResult res = VK_SUCCESS;
54		BOOL read_ok = false;
55
56		int filename_utf16_size = MultiByteToWideChar(CP_UTF8, 0, filename, -1, NULL, 0);
57		if (filename_utf16_size > 0) {
58		wchar_t filename_utf16 = (wchar_t )loader_stack_alloc(filename_utf16_size * sizeof(wchar_t));
59		if (MultiByteToWideChar(CP_UTF8, 0, filename, -1, filename_utf16, filename_utf16_size) == filename_utf16_size) {
60		file_handle =
61		CreateFileW(filename_utf16, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
62		}
63		}
64		if (INVALID_HANDLE_VALUE == file_handle) {
65		loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to open JSON file %s", filename);
66		res = VK_ERROR_INITIALIZATION_FAILED;
67		goto out;
68		}
69		len = GetFileSize(file_handle, NULL);
70		if (INVALID_FILE_SIZE == len) {
71		loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read file size of JSON file %s", filename);
72		res = VK_ERROR_INITIALIZATION_FAILED;
73		goto out;
74		}
75		out_buff = (char )loader_instance_heap_calloc(inst, len + 1, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
76		if (NULL == *out_buff) {
77		loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to allocate memory to read JSON file %s", filename);
78		res = VK_ERROR_OUT_OF_HOST_MEMORY;
79		goto out;
80		}
81		read_ok = ReadFile(file_handle, *out_buff, len, &read_len, NULL);
82		if (len != read_len \|\| false == read_ok) {
83		loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read entire JSON file %s", filename);
84		res = VK_ERROR_INITIALIZATION_FAILED;
85		goto out;
86		}
87		*out_len = len + 1;
88		(*out_buff)[len] = '\0';
89
90		out:
91		if (INVALID_HANDLE_VALUE != file_handle) {
92		CloseHandle(file_handle);
93		}
94		return res;
95		}
96		#elif COMMON_UNIX_PLATFORMS
97		static VkResult loader_read_entire_file(const struct loader_instance inst, const char filename, size_t *out_len,
98	94.1k	char **out_buff) {
99	94.1k	FILE *file = NULL;
100	94.1k	struct stat stats = {0};
101	94.1k	VkResult res = VK_SUCCESS;
102
103		// fprintf(stderr, "loader_get_json: Reading JSON file %s\n", filename);
104	94.1k	file = fopen(filename, "rb");
105	94.1k	#ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
106	94.1k	if (file == NULL) {
107	14.4k	create_callback_file(filename);
108	14.4k	file = fopen(filename, "rb");
109	14.4k	}
110	94.1k	#endif
111	94.1k	if (NULL == file) {
112	9.12k	loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to open JSON file %s", filename);
113	9.12k	res = VK_ERROR_INITIALIZATION_FAILED;
114	9.12k	goto out;
115	9.12k	}
116	85.0k	if (-1 == fstat(fileno(file), &stats)) {
117	0	loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read file size of JSON file %s", filename);
118	0	res = VK_ERROR_INITIALIZATION_FAILED;
119	0	goto out;
120	0	}
121	85.0k	out_buff = (char )loader_instance_heap_calloc(inst, stats.st_size + 1, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
122	85.0k	if (NULL == *out_buff) {
123	0	loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to allocate memory to read JSON file %s", filename);
124	0	res = VK_ERROR_OUT_OF_HOST_MEMORY;
125	0	goto out;
126	0	}
127	85.0k	if (stats.st_size != (long int)fread(*out_buff, sizeof(char), stats.st_size, file)) {
128	6.00k	loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read entire JSON file %s", filename);
129	6.00k	res = VK_ERROR_INITIALIZATION_FAILED;
130	6.00k	goto out;
131	6.00k	}
132	79.0k	*out_len = stats.st_size + 1;
133	79.0k	(*out_buff)[stats.st_size] = '\0';
134
135	94.1k	out:
136	94.1k	if (NULL != file) {
137	85.0k	fclose(file);
138	85.0k	}
139	94.1k	return res;
140	79.0k	}
141		#else
142		#warning fopen not available on this platform
143		VkResult loader_read_entire_file(const struct loader_instance inst, const char filename, size_t out_len, char *out_buff) {
144		return VK_ERROR_INITIALIZATION_FAILED;
145		}
146		#endif
147
148	94.1k	TEST_FUNCTION_EXPORT VkResult loader_get_json(const struct loader_instance inst, const char filename, cJSON **json) {
149	94.1k	char *json_buf = NULL;
150	94.1k	VkResult res = VK_SUCCESS;
151
152	94.1k	assert(json != NULL);
153
154	94.1k	size_t json_len = 0;
155	94.1k	*json = NULL;
156	94.1k	res = loader_read_entire_file(inst, filename, &json_len, &json_buf);
157	94.1k	if (VK_SUCCESS != res) {
158	15.1k	goto out;
159	15.1k	}
160	94.1k	bool out_of_memory = false;
161		// Parse text from file
162	79.0k	*json = loader_cJSON_ParseWithLength(inst ? &inst->alloc_callbacks : NULL, json_buf, json_len, &out_of_memory);
163	79.0k	if (out_of_memory) {
164	0	loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Out of Memory error occurred while parsing JSON file %s.",
165	0	filename);
166	0	res = VK_ERROR_OUT_OF_HOST_MEMORY;
167	0	goto out;
168	79.0k	} else if (*json == NULL) {
169	24.0k	loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Invalid JSON file %s.", filename);
170	24.0k	goto out;
171	24.0k	}
172
173	94.1k	out:
174	94.1k	loader_instance_heap_free(inst, json_buf);
175	94.1k	if (res != VK_SUCCESS && *json != NULL) {
176	0	loader_cJSON_Delete(*json);
177	0	*json = NULL;
178	0	}
179
180	94.1k	return res;
181	79.0k	}
182
183	2.12M	VkResult loader_parse_json_string_to_existing_str(cJSON object, const char key, size_t out_str_len, char *out_string) {
184	2.12M	if (NULL == key) {
185	0	return VK_ERROR_INITIALIZATION_FAILED;
186	0	}
187	2.12M	cJSON *item = loader_cJSON_GetObjectItem(object, key);
188	2.12M	if (NULL == item) {
189	199k	return VK_ERROR_INITIALIZATION_FAILED;
190	199k	}
191
192	1.92M	if (item->type != cJSON_String \|\| item->valuestring == NULL) {
193	724	return VK_ERROR_INITIALIZATION_FAILED;
194	724	}
195	1.92M	bool out_of_memory = false;
196	1.92M	bool success = loader_cJSON_PrintPreallocated(item, out_string, (int)out_str_len, cJSON_False);
197	1.92M	if (out_of_memory) {
198	0	return VK_ERROR_OUT_OF_HOST_MEMORY;
199	0	}
200	1.92M	if (!success) {
201	5.14k	return VK_ERROR_INITIALIZATION_FAILED;
202	5.14k	}
203	1.92M	return VK_SUCCESS;
204	1.92M	}
205
206	868k	VkResult loader_parse_json_string(cJSON object, const char key, char **out_string) {
207	868k	if (NULL == key) {
208	0	return VK_ERROR_INITIALIZATION_FAILED;
209	0	}
210
211	868k	cJSON *item = loader_cJSON_GetObjectItem(object, key);
212	868k	if (NULL == item \|\| NULL == item->valuestring) {
213	123k	return VK_ERROR_INITIALIZATION_FAILED;
214	123k	}
215
216	868k	bool out_of_memory = false;
217	744k	char *str = loader_cJSON_Print(item, &out_of_memory);
218	744k	if (out_of_memory \|\| NULL == str) {
219	0	return VK_ERROR_OUT_OF_HOST_MEMORY;
220	0	}
221	744k	if (NULL != out_string) {
222	744k	*out_string = str;
223	744k	}
224	744k	return VK_SUCCESS;
225	744k	}
226		VkResult loader_parse_json_array_of_strings(const struct loader_instance inst, cJSON object, const char *key,
227	146k	struct loader_string_list *string_list) {
228	146k	if (NULL == key) {
229	0	return VK_ERROR_INITIALIZATION_FAILED;
230	0	}
231	146k	cJSON *item = loader_cJSON_GetObjectItem(object, key);
232	146k	if (NULL == item) {
233	86.3k	return VK_ERROR_INITIALIZATION_FAILED;
234	86.3k	}
235
236	59.8k	uint32_t count = loader_cJSON_GetArraySize(item);
237	59.8k	if (count == 0) {
238	13.9k	return VK_SUCCESS;
239	13.9k	}
240
241	45.9k	VkResult res = create_string_list(inst, count, string_list);
242	45.9k	if (VK_ERROR_OUT_OF_HOST_MEMORY == res) {
243	0	goto out;
244	0	}
245	45.9k	cJSON *element = NULL;
246	1.84M	cJSON_ArrayForEach(element, item) {
247	1.84M	if (element->type != cJSON_String) {
248	5.17k	return VK_ERROR_INITIALIZATION_FAILED;
249	5.17k	}
250	1.84M	bool out_of_memory = false;
251	1.84M	char *out_data = loader_cJSON_Print(element, &out_of_memory);
252	1.84M	if (out_of_memory) {
253	0	res = VK_ERROR_OUT_OF_HOST_MEMORY;
254	0	goto out;
255	0	}
256	1.84M	res = append_str_to_string_list(inst, string_list, out_data);
257	1.84M	if (VK_ERROR_OUT_OF_HOST_MEMORY == res) {
258	0	goto out;
259	0	}
260	1.84M	}
261	40.8k	out:
262	40.8k	if (res == VK_ERROR_OUT_OF_HOST_MEMORY && NULL != string_list->list) {
263	0	free_string_list(inst, string_list);
264	0	}
265
266	40.8k	return res;
267	45.9k	}