Coverage Report

Created: 2025-12-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl36/crypto/stack/stack.c
Line
Count
Source
1
/*
2
 * Copyright 1995-2025 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the Apache License 2.0 (the "License").  You may not use
5
 * this file except in compliance with the License.  You can obtain a copy
6
 * in the file LICENSE in the source distribution or at
7
 * https://www.openssl.org/source/license.html
8
 */
9
10
#include <stdio.h>
11
#include "internal/cryptlib.h"
12
#include "internal/numbers.h"
13
#include "internal/safe_math.h"
14
#include <openssl/stack.h>
15
#include <errno.h>
16
#include <openssl/e_os2.h> /* For ossl_inline */
17
18
OSSL_SAFE_MATH_SIGNED(int, int)
19
20
/*
21
 * The initial number of nodes in the array.
22
 */
23
static const int min_nodes = 4;
24
static const int max_nodes = SIZE_MAX / sizeof(void *) < INT_MAX
25
    ? (int)(SIZE_MAX / sizeof(void *))
26
    : INT_MAX;
27
28
struct stack_st {
29
    int num;
30
    const void **data;
31
    int sorted;
32
    int num_alloc;
33
    OPENSSL_sk_compfunc comp;
34
    OPENSSL_sk_freefunc_thunk free_thunk;
35
};
36
37
OPENSSL_sk_compfunc OPENSSL_sk_set_cmp_func(OPENSSL_STACK *sk,
38
    OPENSSL_sk_compfunc c)
39
255k
{
40
255k
    OPENSSL_sk_compfunc old = sk->comp;
41
42
255k
    if (sk->comp != c)
43
255k
        sk->sorted = 0;
44
255k
    sk->comp = c;
45
46
255k
    return old;
47
255k
}
48
49
OPENSSL_STACK *OPENSSL_sk_dup(const OPENSSL_STACK *sk)
50
40.6M
{
51
40.6M
    OPENSSL_STACK *ret;
52
53
40.6M
    if ((ret = OPENSSL_malloc(sizeof(*ret))) == NULL)
54
0
        goto err;
55
56
40.6M
    if (sk == NULL) {
57
196
        ret->num = 0;
58
196
        ret->sorted = 0;
59
196
        ret->comp = NULL;
60
40.6M
    } else {
61
        /* direct structure assignment */
62
40.6M
        *ret = *sk;
63
40.6M
    }
64
65
40.6M
    if (sk == NULL || sk->num == 0) {
66
        /* postpone |ret->data| allocation */
67
211
        ret->data = NULL;
68
211
        ret->num_alloc = 0;
69
211
        return ret;
70
211
    }
71
72
    /* duplicate |sk->data| content */
73
40.6M
    ret->data = OPENSSL_malloc_array(sk->num_alloc, sizeof(*ret->data));
74
40.6M
    if (ret->data == NULL)
75
0
        goto err;
76
40.6M
    memcpy(ret->data, sk->data, sizeof(void *) * sk->num);
77
40.6M
    return ret;
78
79
0
err:
80
0
    OPENSSL_sk_free(ret);
81
0
    return NULL;
82
40.6M
}
83
84
OPENSSL_STACK *OPENSSL_sk_deep_copy(const OPENSSL_STACK *sk,
85
    OPENSSL_sk_copyfunc copy_func,
86
    OPENSSL_sk_freefunc free_func)
87
1.53M
{
88
1.53M
    OPENSSL_STACK *ret;
89
1.53M
    int i;
90
91
1.53M
    if ((ret = OPENSSL_malloc(sizeof(*ret))) == NULL)
92
0
        goto err;
93
94
1.53M
    if (sk == NULL) {
95
188
        ret->num = 0;
96
188
        ret->sorted = 0;
97
188
        ret->comp = NULL;
98
1.53M
    } else {
99
        /* direct structure assignment */
100
1.53M
        *ret = *sk;
101
1.53M
    }
102
103
1.53M
    if (sk == NULL || sk->num == 0) {
104
        /* postpone |ret| data allocation */
105
188
        ret->data = NULL;
106
188
        ret->num_alloc = 0;
107
188
        return ret;
108
188
    }
109
110
1.53M
    ret->num_alloc = sk->num > min_nodes ? sk->num : min_nodes;
111
1.53M
    ret->data = OPENSSL_calloc(ret->num_alloc, sizeof(*ret->data));
112
1.53M
    if (ret->data == NULL)
113
0
        goto err;
114
115
16.6M
    for (i = 0; i < ret->num; ++i) {
116
15.0M
        if (sk->data[i] == NULL)
117
0
            continue;
118
15.0M
        if ((ret->data[i] = copy_func(sk->data[i])) == NULL) {
119
0
            while (--i >= 0)
120
0
                if (ret->data[i] != NULL)
121
0
                    free_func((void *)ret->data[i]);
122
0
            goto err;
123
0
        }
124
15.0M
    }
125
1.53M
    return ret;
126
127
0
err:
128
0
    OPENSSL_sk_free(ret);
129
0
    return NULL;
130
1.53M
}
131
132
OPENSSL_STACK *OPENSSL_sk_new_null(void)
133
164M
{
134
164M
    return OPENSSL_sk_new_reserve(NULL, 0);
135
164M
}
136
137
OPENSSL_STACK *OPENSSL_sk_new(OPENSSL_sk_compfunc c)
138
23.1M
{
139
23.1M
    return OPENSSL_sk_new_reserve(c, 0);
140
23.1M
}
141
142
/*
143
 * Calculate the array growth based on the target size.
144
 *
145
 * The growth factor is a rational number and is defined by a numerator
146
 * and a denominator.  According to Andrew Koenig in his paper "Why Are
147
 * Vectors Efficient?" from JOOP 11(5) 1998, this factor should be less
148
 * than the golden ratio (1.618...).
149
 *
150
 * Considering only the Fibonacci ratios less than the golden ratio, the
151
 * number of steps from the minimum allocation to integer overflow is:
152
 *      factor  decimal    growths
153
 *       3/2     1.5          51
154
 *       8/5     1.6          45
155
 *      21/13    1.615...     44
156
 *
157
 * All larger factors have the same number of growths.
158
 *
159
 * 3/2 and 8/5 have nice power of two shifts, so seem like a good choice.
160
 */
161
static ossl_inline int compute_growth(int target, int current)
162
5.04M
{
163
5.04M
    int err = 0;
164
165
10.0M
    while (current < target) {
166
5.04M
        if (current >= max_nodes)
167
0
            return 0;
168
169
5.04M
        current = safe_muldiv_int(current, 8, 5, &err);
170
5.04M
        if (err != 0)
171
0
            return 0;
172
5.04M
        if (current >= max_nodes)
173
0
            current = max_nodes;
174
5.04M
    }
175
5.04M
    return current;
176
5.04M
}
177
178
/* internal STACK storage allocation */
179
static int sk_reserve(OPENSSL_STACK *st, int n, int exact)
180
407M
{
181
407M
    const void **tmpdata;
182
407M
    int num_alloc;
183
184
    /* Check to see the reservation isn't exceeding the hard limit */
185
407M
    if (n > max_nodes - st->num) {
186
0
        ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_TOO_MANY_RECORDS);
187
0
        return 0;
188
0
    }
189
190
    /* Figure out the new size */
191
407M
    num_alloc = st->num + n;
192
407M
    if (num_alloc < min_nodes)
193
38.5M
        num_alloc = min_nodes;
194
195
    /* If |st->data| allocation was postponed */
196
407M
    if (st->data == NULL) {
197
        /*
198
         * At this point, |st->num_alloc| and |st->num| are 0;
199
         * so |num_alloc| value is |n| or |min_nodes| if greater than |n|.
200
         */
201
27.0M
        if ((st->data = OPENSSL_calloc(num_alloc, sizeof(void *))) == NULL)
202
0
            return 0;
203
27.0M
        st->num_alloc = num_alloc;
204
27.0M
        return 1;
205
27.0M
    }
206
207
380M
    if (!exact) {
208
380M
        if (num_alloc <= st->num_alloc)
209
370M
            return 1;
210
9.14M
        num_alloc = compute_growth(num_alloc, st->num_alloc);
211
9.14M
        if (num_alloc == 0) {
212
0
            ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_TOO_MANY_RECORDS);
213
0
            return 0;
214
0
        }
215
9.14M
    } else if (num_alloc == st->num_alloc) {
216
0
        return 1;
217
0
    }
218
219
9.14M
    tmpdata = OPENSSL_realloc_array((void *)st->data, num_alloc, sizeof(void *));
220
9.14M
    if (tmpdata == NULL)
221
0
        return 0;
222
223
9.14M
    st->data = tmpdata;
224
9.14M
    st->num_alloc = num_alloc;
225
9.14M
    return 1;
226
9.14M
}
227
228
OPENSSL_STACK *OPENSSL_sk_new_reserve(OPENSSL_sk_compfunc c, int n)
229
188M
{
230
188M
    OPENSSL_STACK *st = OPENSSL_zalloc(sizeof(OPENSSL_STACK));
231
232
188M
    if (st == NULL)
233
0
        return NULL;
234
235
188M
    st->comp = c;
236
237
188M
    if (n <= 0)
238
187M
        return st;
239
240
1.09M
    if (!sk_reserve(st, n, 1)) {
241
0
        OPENSSL_sk_free(st);
242
0
        return NULL;
243
0
    }
244
245
1.09M
    return st;
246
1.09M
}
247
248
int OPENSSL_sk_reserve(OPENSSL_STACK *st, int n)
249
0
{
250
0
    if (st == NULL) {
251
0
        ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
252
0
        return 0;
253
0
    }
254
255
0
    if (n < 0)
256
0
        return 1;
257
0
    return sk_reserve(st, n, 1);
258
0
}
259
260
OPENSSL_STACK *OPENSSL_sk_set_thunks(OPENSSL_STACK *st, OPENSSL_sk_freefunc_thunk f_thunk)
261
19.3M
{
262
19.3M
    if (st != NULL)
263
18.1M
        st->free_thunk = f_thunk;
264
265
19.3M
    return st;
266
19.3M
}
267
268
int OPENSSL_sk_insert(OPENSSL_STACK *st, const void *data, int loc)
269
320M
{
270
320M
    if (st == NULL) {
271
0
        ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
272
0
        return 0;
273
0
    }
274
320M
    if (st->num == max_nodes) {
275
0
        ERR_raise(ERR_LIB_CRYPTO, CRYPTO_R_TOO_MANY_RECORDS);
276
0
        return 0;
277
0
    }
278
279
320M
    if (!sk_reserve(st, 1, 0))
280
0
        return 0;
281
282
320M
    if ((loc >= st->num) || (loc < 0)) {
283
320M
        st->data[st->num] = data;
284
320M
    } else {
285
5.62k
        memmove(&st->data[loc + 1], &st->data[loc],
286
5.62k
            sizeof(st->data[0]) * (st->num - loc));
287
5.62k
        st->data[loc] = data;
288
5.62k
    }
289
320M
    st->num++;
290
320M
    st->sorted = 0;
291
320M
    return st->num;
292
320M
}
293
294
static ossl_inline void *internal_delete(OPENSSL_STACK *st, int loc)
295
2.29M
{
296
2.29M
    const void *ret = st->data[loc];
297
298
2.29M
    if (loc != st->num - 1)
299
236k
        memmove(&st->data[loc], &st->data[loc + 1],
300
236k
            sizeof(st->data[0]) * (st->num - loc - 1));
301
2.29M
    st->num--;
302
303
2.29M
    return (void *)ret;
304
2.29M
}
305
306
void *OPENSSL_sk_delete_ptr(OPENSSL_STACK *st, const void *p)
307
148k
{
308
148k
    int i;
309
310
148k
    if (st == NULL)
311
0
        return NULL;
312
313
452k
    for (i = 0; i < st->num; i++)
314
452k
        if (st->data[i] == p)
315
148k
            return internal_delete(st, i);
316
0
    return NULL;
317
148k
}
318
319
void *OPENSSL_sk_delete(OPENSSL_STACK *st, int loc)
320
341k
{
321
341k
    if (st == NULL || loc < 0 || loc >= st->num)
322
0
        return NULL;
323
324
341k
    return internal_delete(st, loc);
325
341k
}
326
327
static int internal_find(OPENSSL_STACK *st, const void *data,
328
    int ret_val_options, int *pnum_matched)
329
248k
{
330
248k
    const void *r;
331
248k
    int i, count = 0;
332
248k
    int *pnum = pnum_matched;
333
334
248k
    if (st == NULL || st->num == 0)
335
97.3k
        return -1;
336
337
150k
    if (pnum == NULL)
338
143k
        pnum = &count;
339
340
150k
    if (st->comp == NULL) {
341
3.10M
        for (i = 0; i < st->num; i++)
342
3.10M
            if (st->data[i] == data) {
343
29.7k
                *pnum = 1;
344
29.7k
                return i;
345
29.7k
            }
346
2.39k
        *pnum = 0;
347
2.39k
        return -1;
348
32.1k
    }
349
350
118k
    if (data == NULL)
351
0
        return -1;
352
353
118k
    if (!st->sorted) {
354
0
        int res = -1;
355
356
0
        for (i = 0; i < st->num; i++)
357
0
            if (st->comp(&data, st->data + i) == 0) {
358
0
                if (res == -1)
359
0
                    res = i;
360
0
                ++*pnum;
361
                /* Check if only one result is wanted and exit if so */
362
0
                if (pnum_matched == NULL)
363
0
                    return i;
364
0
            }
365
0
        if (res == -1)
366
0
            *pnum = 0;
367
0
        return res;
368
0
    }
369
370
118k
    if (pnum_matched != NULL)
371
7.33k
        ret_val_options |= OSSL_BSEARCH_FIRST_VALUE_ON_MATCH;
372
118k
    r = ossl_bsearch(&data, st->data, st->num, sizeof(void *), st->comp,
373
118k
        ret_val_options);
374
375
118k
    if (pnum_matched != NULL) {
376
7.33k
        *pnum = 0;
377
7.33k
        if (r != NULL) {
378
4.56k
            const void **p = (const void **)r;
379
380
9.12k
            while (p < st->data + st->num) {
381
4.56k
                if (st->comp(&data, p) != 0)
382
0
                    break;
383
4.56k
                ++*pnum;
384
4.56k
                ++p;
385
4.56k
            }
386
4.56k
        }
387
7.33k
    }
388
389
118k
    return r == NULL ? -1 : (int)((const void **)r - st->data);
390
118k
}
391
392
int OPENSSL_sk_find(OPENSSL_STACK *st, const void *data)
393
171k
{
394
171k
    return internal_find(st, data, OSSL_BSEARCH_FIRST_VALUE_ON_MATCH, NULL);
395
171k
}
396
397
int OPENSSL_sk_find_ex(OPENSSL_STACK *st, const void *data)
398
0
{
399
0
    return internal_find(st, data, OSSL_BSEARCH_VALUE_ON_NOMATCH, NULL);
400
0
}
401
402
int OPENSSL_sk_find_all(OPENSSL_STACK *st, const void *data, int *pnum)
403
101k
{
404
101k
    return internal_find(st, data, OSSL_BSEARCH_FIRST_VALUE_ON_MATCH, pnum);
405
101k
}
406
407
int OPENSSL_sk_push(OPENSSL_STACK *st, const void *data)
408
405M
{
409
405M
    if (st == NULL)
410
0
        return 0;
411
405M
    return OPENSSL_sk_insert(st, data, st->num);
412
405M
}
413
414
int OPENSSL_sk_unshift(OPENSSL_STACK *st, const void *data)
415
0
{
416
0
    return OPENSSL_sk_insert(st, data, 0);
417
0
}
418
419
void *OPENSSL_sk_shift(OPENSSL_STACK *st)
420
0
{
421
0
    if (st == NULL || st->num == 0)
422
0
        return NULL;
423
0
    return internal_delete(st, 0);
424
0
}
425
426
void *OPENSSL_sk_pop(OPENSSL_STACK *st)
427
2.38M
{
428
2.38M
    if (st == NULL || st->num == 0)
429
10.0k
        return NULL;
430
2.37M
    return internal_delete(st, st->num - 1);
431
2.38M
}
432
433
void OPENSSL_sk_zero(OPENSSL_STACK *st)
434
0
{
435
0
    if (st == NULL || st->num == 0)
436
0
        return;
437
0
    memset(st->data, 0, sizeof(*st->data) * st->num);
438
0
    st->num = 0;
439
0
}
440
441
void OPENSSL_sk_pop_free(OPENSSL_STACK *st, OPENSSL_sk_freefunc func)
442
26.7M
{
443
26.7M
    int i;
444
445
26.7M
    if (st == NULL)
446
6.04M
        return;
447
448
96.0M
    for (i = 0; i < st->num; i++) {
449
75.3M
        if (st->data[i] != NULL) {
450
75.1M
            if (st->free_thunk != NULL)
451
57.1M
                st->free_thunk(func, (void *)st->data[i]);
452
18.0M
            else
453
18.0M
                func((void *)st->data[i]);
454
75.1M
        }
455
75.3M
    }
456
20.7M
    OPENSSL_sk_free(st);
457
20.7M
}
458
459
void OPENSSL_sk_free(OPENSSL_STACK *st)
460
283M
{
461
283M
    if (st == NULL)
462
53.0M
        return;
463
230M
    OPENSSL_free(st->data);
464
230M
    OPENSSL_free(st);
465
230M
}
466
467
int OPENSSL_sk_num(const OPENSSL_STACK *st)
468
1.25G
{
469
1.25G
    return st == NULL ? -1 : st->num;
470
1.25G
}
471
472
void *OPENSSL_sk_value(const OPENSSL_STACK *st, int i)
473
1.40G
{
474
1.40G
    if (st == NULL || i < 0 || i >= st->num)
475
4.88k
        return NULL;
476
1.40G
    return (void *)st->data[i];
477
1.40G
}
478
479
void *OPENSSL_sk_set(OPENSSL_STACK *st, int i, const void *data)
480
12.9M
{
481
12.9M
    if (st == NULL) {
482
0
        ERR_raise(ERR_LIB_CRYPTO, ERR_R_PASSED_NULL_PARAMETER);
483
0
        return NULL;
484
0
    }
485
12.9M
    if (i < 0 || i >= st->num) {
486
0
        ERR_raise_data(ERR_LIB_CRYPTO, ERR_R_PASSED_INVALID_ARGUMENT,
487
0
            "i=%d", i);
488
0
        return NULL;
489
0
    }
490
12.9M
    st->data[i] = data;
491
12.9M
    st->sorted = 0;
492
12.9M
    return (void *)st->data[i];
493
12.9M
}
494
495
void OPENSSL_sk_sort(OPENSSL_STACK *st)
496
23.3M
{
497
23.3M
    if (st != NULL && !st->sorted && st->comp != NULL) {
498
18.9M
        if (st->num > 1)
499
298k
            qsort(st->data, st->num, sizeof(void *), st->comp);
500
18.9M
        st->sorted = 1; /* empty or single-element stack is considered sorted */
501
18.9M
    }
502
23.3M
}
503
504
int OPENSSL_sk_is_sorted(const OPENSSL_STACK *st)
505
81.1k
{
506
81.1k
    return st == NULL ? 1 : st->sorted;
507
81.1k
}