xref: /freebsd/crypto/openssl/include/crypto/sparse_array.h (revision f25b8c9fb4f58cf61adb47d7570abe7caa6d385d)
1 /*
2  * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright (c) 2019, Oracle and/or its affiliates.  All rights reserved.
4  *
5  * Licensed under the Apache License 2.0 (the "License").  You may not use
6  * this file except in compliance with the License.  You can obtain a copy
7  * in the file LICENSE in the source distribution or at
8  * https://www.openssl.org/source/license.html
9  */
10 
11 #ifndef OSSL_CRYPTO_SPARSE_ARRAY_H
12 #define OSSL_CRYPTO_SPARSE_ARRAY_H
13 #pragma once
14 
15 #include <openssl/e_os2.h>
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 #define SPARSE_ARRAY_OF(type) struct sparse_array_st_##type
22 
23 #define DEFINE_SPARSE_ARRAY_OF_INTERNAL(type, ctype)                                                               \
24     SPARSE_ARRAY_OF(type);                                                                                         \
25     static ossl_unused ossl_inline SPARSE_ARRAY_OF(type) * ossl_sa_##type##_new(void)                              \
26     {                                                                                                              \
27         return (SPARSE_ARRAY_OF(type) *)ossl_sa_new();                                                             \
28     }                                                                                                              \
29     static ossl_unused ossl_inline void                                                                            \
30     ossl_sa_##type##_free(SPARSE_ARRAY_OF(type) * sa)                                                              \
31     {                                                                                                              \
32         ossl_sa_free((OPENSSL_SA *)sa);                                                                            \
33     }                                                                                                              \
34     static ossl_unused ossl_inline void                                                                            \
35     ossl_sa_##type##_free_leaves(SPARSE_ARRAY_OF(type) * sa)                                                       \
36     {                                                                                                              \
37         ossl_sa_free_leaves((OPENSSL_SA *)sa);                                                                     \
38     }                                                                                                              \
39     static ossl_unused ossl_inline size_t                                                                          \
40     ossl_sa_##type##_num(const SPARSE_ARRAY_OF(type) * sa)                                                         \
41     {                                                                                                              \
42         return ossl_sa_num((OPENSSL_SA *)sa);                                                                      \
43     }                                                                                                              \
44     static ossl_unused ossl_inline void                                                                            \
45     ossl_sa_##type##_doall(const SPARSE_ARRAY_OF(type) * sa,                                                       \
46         void (*leaf)(ossl_uintmax_t, type *))                                                                      \
47     {                                                                                                              \
48         ossl_sa_doall((OPENSSL_SA *)sa,                                                                            \
49             (void (*)(ossl_uintmax_t, void *))leaf);                                                               \
50     }                                                                                                              \
51     static ossl_unused ossl_inline void                                                                            \
52     ossl_sa_##type##_doall_arg(const SPARSE_ARRAY_OF(type) * sa,                                                   \
53         void (*leaf)(ossl_uintmax_t, type *, void *),                                                              \
54         void *arg)                                                                                                 \
55     {                                                                                                              \
56         ossl_sa_doall_arg((OPENSSL_SA *)sa,                                                                        \
57             (void (*)(ossl_uintmax_t, void *, void *))leaf, arg);                                                  \
58     }                                                                                                              \
59     static ossl_unused ossl_inline ctype *ossl_sa_##type##_get(const SPARSE_ARRAY_OF(type) * sa, ossl_uintmax_t n) \
60     {                                                                                                              \
61         return (type *)ossl_sa_get((OPENSSL_SA *)sa, n);                                                           \
62     }                                                                                                              \
63     static ossl_unused ossl_inline int                                                                             \
64     ossl_sa_##type##_set(SPARSE_ARRAY_OF(type) * sa,                                                               \
65         ossl_uintmax_t n, ctype * val)                                                                             \
66     {                                                                                                              \
67         return ossl_sa_set((OPENSSL_SA *)sa, n, (void *)val);                                                      \
68     }                                                                                                              \
69     SPARSE_ARRAY_OF(type)
70 
71 #define DEFINE_SPARSE_ARRAY_OF(type) \
72     DEFINE_SPARSE_ARRAY_OF_INTERNAL(type, type)
73 #define DEFINE_SPARSE_ARRAY_OF_CONST(type) \
74     DEFINE_SPARSE_ARRAY_OF_INTERNAL(type, const type)
75 
76 typedef struct sparse_array_st OPENSSL_SA;
77 OPENSSL_SA *ossl_sa_new(void);
78 void ossl_sa_free(OPENSSL_SA *sa);
79 void ossl_sa_free_leaves(OPENSSL_SA *sa);
80 size_t ossl_sa_num(const OPENSSL_SA *sa);
81 void ossl_sa_doall(const OPENSSL_SA *sa, void (*leaf)(ossl_uintmax_t, void *));
82 void ossl_sa_doall_arg(const OPENSSL_SA *sa,
83     void (*leaf)(ossl_uintmax_t, void *, void *), void *);
84 void *ossl_sa_get(const OPENSSL_SA *sa, ossl_uintmax_t n);
85 int ossl_sa_set(OPENSSL_SA *sa, ossl_uintmax_t n, void *val);
86 
87 #ifdef __cplusplus
88 }
89 #endif
90 #endif
91