Coverage Report

Created: 2026-07-16 07:05

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
138k
                                        char **out_buff) {
111
138k
    FILE *file = NULL;
112
138k
    struct stat stats = {0};
113
138k
    VkResult res = VK_SUCCESS;
114
115
    // fprintf(stderr, "loader_get_json: Reading JSON file %s\n", filename);
116
138k
    file = fopen(filename, "rb");
117
138k
#ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
118
138k
    if (file == NULL) {
119
29.9k
        create_callback_file(filename);
120
29.9k
        file = fopen(filename, "rb");
121
29.9k
    }
122
138k
#endif
123
138k
    if (NULL == file) {
124
23.7k
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to open JSON file %s", filename);
125
23.7k
        res = VK_ERROR_INITIALIZATION_FAILED;
126
23.7k
        goto out;
127
23.7k
    }
128
114k
    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
114k
    *out_buff = (char *)loader_instance_heap_calloc(inst, stats.st_size + 1, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
134
114k
    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
114k
    if (stats.st_size != (long int)fread(*out_buff, sizeof(char), stats.st_size, file)) {
140
12.0k
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Failed to read entire JSON file %s", filename);
141
12.0k
        res = VK_ERROR_INITIALIZATION_FAILED;
142
12.0k
        goto out;
143
12.0k
    }
144
102k
    *out_len = stats.st_size + 1;
145
102k
    (*out_buff)[stats.st_size] = '\0';
146
147
138k
out:
148
138k
    if (NULL != file) {
149
114k
        fclose(file);
150
114k
    }
151
138k
    return res;
152
102k
}
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
138k
TEST_FUNCTION_EXPORT VkResult loader_get_json(const struct loader_instance *inst, const char *filename, cJSON **json) {
161
138k
    char *json_buf = NULL;
162
138k
    VkResult res = VK_SUCCESS;
163
164
138k
    assert(json != NULL);
165
166
138k
    size_t json_len = 0;
167
138k
    *json = NULL;
168
138k
    res = loader_read_entire_file(inst, filename, &json_len, &json_buf);
169
138k
    if (VK_SUCCESS != res) {
170
35.7k
        goto out;
171
35.7k
    }
172
138k
    bool out_of_memory = false;
173
    // Parse text from file
174
102k
    *json = loader_cJSON_ParseWithLength(inst ? &inst->alloc_callbacks : NULL, json_buf, json_len, &out_of_memory);
175
102k
    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
102k
    } else if (*json == NULL) {
181
34.9k
        loader_log(inst, VULKAN_LOADER_ERROR_BIT, 0, "loader_get_json: Invalid JSON file %s.", filename);
182
34.9k
        goto out;
183
34.9k
    }
184
185
138k
out:
186
138k
    loader_instance_heap_free(inst, json_buf);
187
138k
    if (res != VK_SUCCESS && *json != NULL) {
188
0
        loader_cJSON_Delete(*json);
189
0
        *json = NULL;
190
0
    }
191
192
138k
    return res;
193
102k
}
194
195
1.74M
VkResult loader_parse_json_string_to_existing_str(cJSON *object, const char *key, size_t out_str_len, char *out_string) {
196
1.74M
    if (NULL == key) {
197
0
        return VK_ERROR_INITIALIZATION_FAILED;
198
0
    }
199
1.74M
    cJSON *item = loader_cJSON_GetObjectItem(object, key);
200
1.74M
    if (NULL == item) {
201
166k
        return VK_ERROR_INITIALIZATION_FAILED;
202
166k
    }
203
204
1.57M
    if (item->type != cJSON_String || item->valuestring == NULL) {
205
79.3k
        return VK_ERROR_INITIALIZATION_FAILED;
206
79.3k
    }
207
1.57M
    bool out_of_memory = false;
208
1.50M
    bool success = loader_cJSON_PrintPreallocated(item, out_string, (int)out_str_len, cJSON_False);
209
1.50M
    if (out_of_memory) {
210
0
        return VK_ERROR_OUT_OF_HOST_MEMORY;
211
0
    }
212
1.50M
    if (!success) {
213
3.77k
        return VK_ERROR_INITIALIZATION_FAILED;
214
3.77k
    }
215
1.49M
    return VK_SUCCESS;
216
1.50M
}
217
218
1.74M
VkResult loader_parse_json_string(cJSON *object, const char *key, char **out_string) {
219
1.74M
    if (NULL == key) {
220
0
        return VK_ERROR_INITIALIZATION_FAILED;
221
0
    }
222
223
1.74M
    cJSON *item = loader_cJSON_GetObjectItem(object, key);
224
1.74M
    if (NULL == item || NULL == item->valuestring) {
225
107k
        return VK_ERROR_INITIALIZATION_FAILED;
226
107k
    }
227
228
1.74M
    bool out_of_memory = false;
229
1.63M
    char *str = loader_cJSON_Print(item, &out_of_memory);
230
1.63M
    if (out_of_memory || NULL == str) {
231
0
        return VK_ERROR_OUT_OF_HOST_MEMORY;
232
0
    }
233
1.63M
    if (NULL != out_string) {
234
1.63M
        *out_string = str;
235
1.63M
    }
236
1.63M
    return VK_SUCCESS;
237
1.63M
}
238
VkResult loader_parse_json_array_of_strings(const struct loader_instance *inst, cJSON *object, const char *key,
239
192k
                                            struct loader_string_list *string_list) {
240
192k
    if (NULL == key) {
241
0
        return VK_ERROR_INITIALIZATION_FAILED;
242
0
    }
243
192k
    cJSON *item = loader_cJSON_GetObjectItem(object, key);
244
192k
    if (NULL == item) {
245
141k
        return VK_ERROR_INITIALIZATION_FAILED;
246
141k
    }
247
248
51.3k
    uint32_t count = loader_cJSON_GetArraySize(item);
249
51.3k
    if (count == 0) {
250
12.1k
        return VK_SUCCESS;
251
12.1k
    }
252
253
39.1k
    VkResult res = create_string_list(inst, count, string_list);
254
39.1k
    if (VK_ERROR_OUT_OF_HOST_MEMORY == res) {
255
0
        goto out;
256
0
    }
257
39.1k
    cJSON *element = NULL;
258
1.87M
    cJSON_ArrayForEach(element, item) {
259
1.87M
        if (element->type != cJSON_String) {
260
6.14k
            return VK_ERROR_INITIALIZATION_FAILED;
261
6.14k
        }
262
1.87M
        bool out_of_memory = false;
263
1.87M
        char *out_data = loader_cJSON_Print(element, &out_of_memory);
264
1.87M
        if (out_of_memory) {
265
0
            res = VK_ERROR_OUT_OF_HOST_MEMORY;
266
0
            goto out;
267
0
        }
268
1.87M
        res = append_str_to_string_list(inst, string_list, out_data);
269
1.87M
        if (VK_ERROR_OUT_OF_HOST_MEMORY == res) {
270
0
            goto out;
271
0
        }
272
1.87M
    }
273
33.0k
out:
274
33.0k
    if (res == VK_ERROR_OUT_OF_HOST_MEMORY && NULL != string_list->list) {
275
0
        free_string_list(inst, string_list);
276
0
    }
277
278
33.0k
    return res;
279
39.1k
}