2 * Copyright 1999-2017 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
10 #ifndef HEADER_SAFESTACK_H
11 # define HEADER_SAFESTACK_H
13 # include <openssl/stack.h>
14 # include <openssl/e_os2.h>
20 # define STACK_OF(type) struct stack_st_##type
22 # define SKM_DEFINE_STACK_OF(t1, t2, t3) \
24 typedef int (*sk_##t1##_compfunc)(const t3 * const *a, const t3 *const *b); \
25 typedef void (*sk_##t1##_freefunc)(t3 *a); \
26 typedef t3 * (*sk_##t1##_copyfunc)(const t3 *a); \
27 static ossl_inline int sk_##t1##_num(const STACK_OF(t1) *sk) \
29 return OPENSSL_sk_num((const OPENSSL_STACK *)sk); \
31 static ossl_inline t2 *sk_##t1##_value(const STACK_OF(t1) *sk, int idx) \
33 return (t2 *)OPENSSL_sk_value((const OPENSSL_STACK *)sk, idx); \
35 static ossl_inline STACK_OF(t1) *sk_##t1##_new(sk_##t1##_compfunc compare) \
37 return (STACK_OF(t1) *)OPENSSL_sk_new((OPENSSL_sk_compfunc)compare); \
39 static ossl_inline STACK_OF(t1) *sk_##t1##_new_null(void) \
41 return (STACK_OF(t1) *)OPENSSL_sk_new_null(); \
43 static ossl_inline int sk_##t1##_reserve(STACK_OF(t1) *sk, int n) \
45 return OPENSSL_sk_reserve((OPENSSL_STACK *)sk, n); \
47 static ossl_inline void sk_##t1##_free(STACK_OF(t1) *sk) \
49 OPENSSL_sk_free((OPENSSL_STACK *)sk); \
51 static ossl_inline void sk_##t1##_zero(STACK_OF(t1) *sk) \
53 OPENSSL_sk_zero((OPENSSL_STACK *)sk); \
55 static ossl_inline t2 *sk_##t1##_delete(STACK_OF(t1) *sk, int i) \
57 return (t2 *)OPENSSL_sk_delete((OPENSSL_STACK *)sk, i); \
59 static ossl_inline t2 *sk_##t1##_delete_ptr(STACK_OF(t1) *sk, t2 *ptr) \
61 return (t2 *)OPENSSL_sk_delete_ptr((OPENSSL_STACK *)sk, \
64 static ossl_inline int sk_##t1##_push(STACK_OF(t1) *sk, t2 *ptr) \
66 return OPENSSL_sk_push((OPENSSL_STACK *)sk, (const void *)ptr); \
68 static ossl_inline int sk_##t1##_unshift(STACK_OF(t1) *sk, t2 *ptr) \
70 return OPENSSL_sk_unshift((OPENSSL_STACK *)sk, (const void *)ptr); \
72 static ossl_inline t2 *sk_##t1##_pop(STACK_OF(t1) *sk) \
74 return (t2 *)OPENSSL_sk_pop((OPENSSL_STACK *)sk); \
76 static ossl_inline t2 *sk_##t1##_shift(STACK_OF(t1) *sk) \
78 return (t2 *)OPENSSL_sk_shift((OPENSSL_STACK *)sk); \
80 static ossl_inline void sk_##t1##_pop_free(STACK_OF(t1) *sk, sk_##t1##_freefunc freefunc) \
82 OPENSSL_sk_pop_free((OPENSSL_STACK *)sk, (OPENSSL_sk_freefunc)freefunc); \
84 static ossl_inline int sk_##t1##_insert(STACK_OF(t1) *sk, t2 *ptr, int idx) \
86 return OPENSSL_sk_insert((OPENSSL_STACK *)sk, (const void *)ptr, idx); \
88 static ossl_inline t2 *sk_##t1##_set(STACK_OF(t1) *sk, int idx, t2 *ptr) \
90 return (t2 *)OPENSSL_sk_set((OPENSSL_STACK *)sk, idx, (const void *)ptr); \
92 static ossl_inline int sk_##t1##_find(STACK_OF(t1) *sk, t2 *ptr) \
94 return OPENSSL_sk_find((OPENSSL_STACK *)sk, (const void *)ptr); \
96 static ossl_inline int sk_##t1##_find_ex(STACK_OF(t1) *sk, t2 *ptr) \
98 return OPENSSL_sk_find_ex((OPENSSL_STACK *)sk, (const void *)ptr); \
100 static ossl_inline void sk_##t1##_sort(STACK_OF(t1) *sk) \
102 OPENSSL_sk_sort((OPENSSL_STACK *)sk); \
104 static ossl_inline int sk_##t1##_is_sorted(const STACK_OF(t1) *sk) \
106 return OPENSSL_sk_is_sorted((const OPENSSL_STACK *)sk); \
108 static ossl_inline STACK_OF(t1) * sk_##t1##_dup(const STACK_OF(t1) *sk) \
110 return (STACK_OF(t1) *)OPENSSL_sk_dup((const OPENSSL_STACK *)sk); \
112 static ossl_inline STACK_OF(t1) *sk_##t1##_deep_copy(const STACK_OF(t1) *sk, \
113 sk_##t1##_copyfunc copyfunc, \
114 sk_##t1##_freefunc freefunc) \
116 return (STACK_OF(t1) *)OPENSSL_sk_deep_copy((const OPENSSL_STACK *)sk, \
117 (OPENSSL_sk_copyfunc)copyfunc, \
118 (OPENSSL_sk_freefunc)freefunc); \
120 static ossl_inline sk_##t1##_compfunc sk_##t1##_set_cmp_func(STACK_OF(t1) *sk, sk_##t1##_compfunc compare) \
122 return (sk_##t1##_compfunc)OPENSSL_sk_set_cmp_func((OPENSSL_STACK *)sk, (OPENSSL_sk_compfunc)compare); \
125 # define DEFINE_SPECIAL_STACK_OF(t1, t2) SKM_DEFINE_STACK_OF(t1, t2, t2)
126 # define DEFINE_STACK_OF(t) SKM_DEFINE_STACK_OF(t, t, t)
127 # define DEFINE_SPECIAL_STACK_OF_CONST(t1, t2) \
128 SKM_DEFINE_STACK_OF(t1, const t2, t2)
129 # define DEFINE_STACK_OF_CONST(t) SKM_DEFINE_STACK_OF(t, const t, t)
132 * Strings are special: normally an lhash entry will point to a single
133 * (somewhat) mutable object. In the case of strings:
135 * a) Instead of a single char, there is an array of chars, NUL-terminated.
136 * b) The string may have be immutable.
138 * So, they need their own declarations. Especially important for
139 * type-checking tools, such as Deputy.
141 * In practice, however, it appears to be hard to have a const
142 * string. For now, I'm settling for dealing with the fact it is a
145 typedef char *OPENSSL_STRING;
146 typedef const char *OPENSSL_CSTRING;
149 * Confusingly, LHASH_OF(STRING) deals with char ** throughout, but
150 * STACK_OF(STRING) is really more like STACK_OF(char), only, as mentioned
151 * above, instead of a single char each entry is a NUL-terminated array of
152 * chars. So, we have to implement STRING specially for STACK_OF. This is
153 * dealt with in the autogenerated macros below.
155 DEFINE_SPECIAL_STACK_OF(OPENSSL_STRING, char)
156 DEFINE_SPECIAL_STACK_OF_CONST(OPENSSL_CSTRING, char)
159 * Similarly, we sometimes use a block of characters, NOT nul-terminated.
160 * These should also be distinguished from "normal" stacks.
162 typedef void *OPENSSL_BLOCK;
163 DEFINE_SPECIAL_STACK_OF(OPENSSL_BLOCK, void)