Coverage Report

Created: 2026-07-16 07:04

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/vulkan-loader/loader/loader_json.c
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
            // A path at or beyond MAX_PATH won't open unless we opt into long paths with the "\\?\" prefix, so retry with it.
63
            if (INVALID_HANDLE_VALUE == file_handle && filename_utf16_size >= MAX_PATH) {
64
                int prefixed_utf16_size = filename_utf16_size + 4;  // room for the leading "\\?\"
65
                wchar_t *prefixed_utf16 = (wchar_t *)loader_stack_alloc(prefixed_utf16_size * sizeof(wchar_t));
66
                prefixed_utf16[0] = L'\\';
67
                prefixed_utf16[1] = L'\\';
68
                prefixed_utf16[2] = L'?';
69
                prefixed_utf16[3] = L'\\';
70
                memcpy(prefixed_utf16 + 4, filename_utf16, filename_utf16_size * sizeof(wchar_t));
71
                file_handle =
72
                    CreateFileW(prefixed_utf16, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
73
            }
74
        }
75
    }
76
    if (INVALID_HANDLE_VALUE == file_handle) {
77
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to open JSON file %s", filename);
78
        res = VK_ERROR_INITIALIZATION_FAILED;
79
        goto out;
80
    }
81
    len = GetFileSize(file_handle, NULL);
82
    if (INVALID_FILE_SIZE == len) {
83
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read file size of JSON file %s", filename);
84
        res = VK_ERROR_INITIALIZATION_FAILED;
85
        goto out;
86
    }
87
    *out_buff = (char *)loader_instance_heap_calloc(inst, len + 1, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
88
    if (NULL == *out_buff) {
89
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to allocate memory to read JSON file %s", filename);
90
        res = VK_ERROR_OUT_OF_HOST_MEMORY;
91
        goto out;
92
    }
93
    read_ok = ReadFile(file_handle, *out_buff, len, &read_len, NULL);
94
    if (len != read_len || false == read_ok) {
95
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read entire JSON file %s", filename);
96
        res = VK_ERROR_INITIALIZATION_FAILED;
97
        goto out;
98
    }
99
    *out_len = len + 1;
100
    (*out_buff)[len] = '\0';
101
102
out:
103
    if (INVALID_HANDLE_VALUE != file_handle) {
104
        CloseHandle(file_handle);
105
    }
106
    return res;
107
}
108
#elif COMMON_UNIX_PLATFORMS
109
static VkResult loader_read_entire_file(const struct loader_instance *inst, const char *filename, size_t *out_len,
110
14.9k
                                        char **out_buff) {
111
14.9k
    FILE *file = NULL;
112
14.9k
    struct stat stats = {0};
113
14.9k
    VkResult res = VK_SUCCESS;
114
115
    // fprintf(stderr, "loader_get_json: Reading JSON file %s\n", filename);
116
14.9k
    file = fopen(filename, "rb");
117
14.9k
#ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
118
14.9k
    if (file == NULL) {
119
3.72k
        create_callback_file(filename);
120
3.72k
        file = fopen(filename, "rb");
121
3.72k
    }
122
14.9k
#endif
123
14.9k
    if (NULL == file) {
124
3.72k
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to open JSON file %s", filename);
125
3.72k
        res = VK_ERROR_INITIALIZATION_FAILED;
126
3.72k
        goto out;
127
3.72k
    }
128
11.2k
    if (-1 == fstat(fileno(file), &stats)) {
129
0
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read file size of JSON file %s", filename);
130
0
        res = VK_ERROR_INITIALIZATION_FAILED;
131
0
        goto out;
132
0
    }
133
11.2k
    *out_buff = (char *)loader_instance_heap_calloc(inst, stats.st_size + 1, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
134
11.2k
    if (NULL == *out_buff) {
135
0
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to allocate memory to read JSON file %s", filename);
136
0
        res = VK_ERROR_OUT_OF_HOST_MEMORY;
137
0
        goto out;
138
0
    }
139
11.2k
    if (stats.st_size != (long int)fread(*out_buff, sizeof(char), stats.st_size, file)) {
140
2.09k
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read entire JSON file %s", filename);
141
2.09k
        res = VK_ERROR_INITIALIZATION_FAILED;
142
2.09k
        goto out;
143
2.09k
    }
144
9.13k
    *out_len = stats.st_size + 1;
145
9.13k
    (*out_buff)[stats.st_size] = '\0';
146
147
14.9k
out:
148
14.9k
    if (NULL != file) {
149
11.2k
        fclose(file);
150
11.2k
    }
151
14.9k
    return res;
152
9.13k
}
153
#else
154
#warning fopen not available on this platform
155
VkResult loader_read_entire_file(const struct loader_instance *inst, const char *filename, size_t *out_len, char **out_buff) {
156
    return VK_ERROR_INITIALIZATION_FAILED;
157
}
158
#endif
159
160
14.9k
TEST_FUNCTION_EXPORT VkResult loader_get_json(const struct loader_instance *inst, const char *filename, cJSON **json) {
161
14.9k
    char *json_buf = NULL;
162
14.9k
    VkResult res = VK_SUCCESS;
163
164
14.9k
    assert(json != NULL);
165
166
14.9k
    size_t json_len = 0;
167
14.9k
    *json = NULL;
168
14.9k
    res = loader_read_entire_file(inst, filename, &json_len, &json_buf);
169
14.9k
    if (VK_SUCCESS != res) {
170
5.81k
        goto out;
171
5.81k
    }
172
14.9k
    bool out_of_memory = false;
173
    // Parse text from file
174
9.13k
    *json = loader_cJSON_ParseWithLength(inst ? &inst->alloc_callbacks : NULL, json_buf, json_len, &out_of_memory);
175
9.13k
    if (out_of_memory) {
176
0
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Out of Memory error occurred while parsing JSON file %s.",
177
0
                   filename);
178
0
        res = VK_ERROR_OUT_OF_HOST_MEMORY;
179
0
        goto out;
180
9.13k
    } else if (*json == NULL) {
181
4.19k
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Invalid JSON file %s.", filename);
182
4.19k
        goto out;
183
4.19k
    }
184
185
14.9k
out:
186
14.9k
    loader_instance_heap_free(inst, json_buf);
187
14.9k
    if (res != VK_SUCCESS && *json != NULL) {
188
0
        loader_cJSON_Delete(*json);
189
0
        *json = NULL;
190
0
    }
191
192
14.9k
    return res;
193
9.13k
}
194
195
26.9k
VkResult loader_parse_json_string_to_existing_str(cJSON *object, const char *key, size_t out_str_len, char *out_string) {
196
26.9k
    if (NULL == key) {
197
0
        return VK_ERROR_INITIALIZATION_FAILED;
198
0
    }
199
26.9k
    cJSON *item = loader_cJSON_GetObjectItem(object, key);
200
26.9k
    if (NULL == item) {
201
4.46k
        return VK_ERROR_INITIALIZATION_FAILED;
202
4.46k
    }
203
204
22.5k
    if (item->type != cJSON_String || item->valuestring == NULL) {
205
3.93k
        return VK_ERROR_INITIALIZATION_FAILED;
206
3.93k
    }
207
22.5k
    bool out_of_memory = false;
208
18.5k
    bool success = loader_cJSON_PrintPreallocated(item, out_string, (int)out_str_len, cJSON_False);
209
18.5k
    if (out_of_memory) {
210
0
        return VK_ERROR_OUT_OF_HOST_MEMORY;
211
0
    }
212
18.5k
    if (!success) {
213
127
        return VK_ERROR_INITIALIZATION_FAILED;
214
127
    }
215
18.4k
    return VK_SUCCESS;
216
18.5k
}
217
218
1.22M
VkResult loader_parse_json_string(cJSON *object, const char *key, char **out_string) {
219
1.22M
    if (NULL == key) {
220
0
        return VK_ERROR_INITIALIZATION_FAILED;
221
0
    }
222
223
1.22M
    cJSON *item = loader_cJSON_GetObjectItem(object, key);
224
1.22M
    if (NULL == item || NULL == item->valuestring) {
225
2.02k
        return VK_ERROR_INITIALIZATION_FAILED;
226
2.02k
    }
227
228
1.22M
    bool out_of_memory = false;
229
1.22M
    char *str = loader_cJSON_Print(item, &out_of_memory);
230
1.22M
    if (out_of_memory || NULL == str) {
231
0
        return VK_ERROR_OUT_OF_HOST_MEMORY;
232
0
    }
233
1.22M
    if (NULL != out_string) {
234
1.22M
        *out_string = str;
235
1.22M
    }
236
1.22M
    return VK_SUCCESS;
237
1.22M
}
238
VkResult loader_parse_json_array_of_strings(const struct loader_instance *inst, cJSON *object, const char *key,
239
14.9k
                                            struct loader_string_list *string_list) {
240
14.9k
    if (NULL == key) {
241
0
        return VK_ERROR_INITIALIZATION_FAILED;
242
0
    }
243
14.9k
    cJSON *item = loader_cJSON_GetObjectItem(object, key);
244
14.9k
    if (NULL == item) {
245
9.88k
        return VK_ERROR_INITIALIZATION_FAILED;
246
9.88k
    }
247
248
5.02k
    uint32_t count = loader_cJSON_GetArraySize(item);
249
5.02k
    if (count == 0) {
250
492
        return VK_SUCCESS;
251
492
    }
252
253
4.53k
    VkResult res = create_string_list(inst, count, string_list);
254
4.53k
    if (VK_ERROR_OUT_OF_HOST_MEMORY == res) {
255
0
        goto out;
256
0
    }
257
4.53k
    cJSON *element = NULL;
258
669k
    cJSON_ArrayForEach(element, item) {
259
669k
        if (element->type != cJSON_String) {
260
2.58k
            return VK_ERROR_INITIALIZATION_FAILED;
261
2.58k
        }
262
669k
        bool out_of_memory = false;
263
666k
        char *out_data = loader_cJSON_Print(element, &out_of_memory);
264
666k
        if (out_of_memory) {
265
0
            res = VK_ERROR_OUT_OF_HOST_MEMORY;
266
0
            goto out;
267
0
        }
268
666k
        res = append_str_to_string_list(inst, string_list, out_data);
269
666k
        if (VK_ERROR_OUT_OF_HOST_MEMORY == res) {
270
0
            goto out;
271
0
        }
272
666k
    }
273
1.94k
out:
274
1.94k
    if (res == VK_ERROR_OUT_OF_HOST_MEMORY && NULL != string_list->list) {
275
0
        free_string_list(inst, string_list);
276
0
    }
277
278
1.94k
    return res;
279
4.53k
}