/src/boringssl/crypto/stack/stack.cc

Source (jump to first uncovered line)
// Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include <openssl/stack.h>

#include <assert.h>
#include <limits.h>

#include <openssl/err.h>
#include <openssl/mem.h>

#include "../internal.h"


struct stack_st {
  // num contains the number of valid pointers in |data|.
  size_t num;
  void **data;
  // sorted is non-zero if the values pointed to by |data| are in ascending
  // order, based on |comp|.
  int sorted;
  // num_alloc contains the number of pointers allocated in the buffer pointed
  // to by |data|, which may be larger than |num|.
  size_t num_alloc;
  // comp is an optional comparison function.
  OPENSSL_sk_cmp_func comp;
};

// kMinSize is the number of pointers that will be initially allocated in a new
// stack.
static const size_t kMinSize = 4;

OPENSSL_STACK *OPENSSL_sk_new(OPENSSL_sk_cmp_func comp) {
  OPENSSL_STACK *ret =
      reinterpret_cast<OPENSSL_STACK *>(OPENSSL_zalloc(sizeof(OPENSSL_STACK)));
  if (ret == NULL) {
    return NULL;
  }

  ret->data =
      reinterpret_cast<void **>(OPENSSL_calloc(kMinSize, sizeof(void *)));
  if (ret->data == NULL) {
    goto err;
  }

  ret->comp = comp;
  ret->num_alloc = kMinSize;

  return ret;

err:
  OPENSSL_free(ret);
  return NULL;
}

OPENSSL_STACK *OPENSSL_sk_new_null(void) { return OPENSSL_sk_new(NULL); }

size_t OPENSSL_sk_num(const OPENSSL_STACK *sk) {
  if (sk == NULL) {
    return 0;
  }
  return sk->num;
}

void OPENSSL_sk_zero(OPENSSL_STACK *sk) {
  if (sk == NULL || sk->num == 0) {
    return;
  }
  OPENSSL_memset(sk->data, 0, sizeof(void *) * sk->num);
  sk->num = 0;
  sk->sorted = 0;
}

void *OPENSSL_sk_value(const OPENSSL_STACK *sk, size_t i) {
  if (!sk || i >= sk->num) {
    return NULL;
  }
  return sk->data[i];
}

void *OPENSSL_sk_set(OPENSSL_STACK *sk, size_t i, void *value) {
  if (!sk || i >= sk->num) {
    return NULL;
  }
  return sk->data[i] = value;
}

void OPENSSL_sk_free(OPENSSL_STACK *sk) {
  if (sk == NULL) {
    return;
  }
  OPENSSL_free(sk->data);
  OPENSSL_free(sk);
}

void OPENSSL_sk_pop_free_ex(OPENSSL_STACK *sk,
                            OPENSSL_sk_call_free_func call_free_func,
                            OPENSSL_sk_free_func free_func) {
  if (sk == NULL) {
    return;
  }

  for (size_t i = 0; i < sk->num; i++) {
    if (sk->data[i] != NULL) {
      call_free_func(free_func, sk->data[i]);
    }
  }
  OPENSSL_sk_free(sk);
}

// Historically, |sk_pop_free| called the function as |OPENSSL_sk_free_func|
// directly. This is undefined in C. Some callers called |sk_pop_free| directly,
// so we must maintain a compatibility version for now.
static void call_free_func_legacy(OPENSSL_sk_free_func func, void *ptr) {
  func(ptr);
}

void sk_pop_free(OPENSSL_STACK *sk, OPENSSL_sk_free_func free_func) {
  OPENSSL_sk_pop_free_ex(sk, call_free_func_legacy, free_func);
}

size_t OPENSSL_sk_insert(OPENSSL_STACK *sk, void *p, size_t where) {
  if (sk == NULL) {
    return 0;
  }

  if (sk->num >= INT_MAX) {
    OPENSSL_PUT_ERROR(CRYPTO, ERR_R_OVERFLOW);
    return 0;
  }

  if (sk->num_alloc <= sk->num + 1) {
    // Attempt to double the size of the array.
    size_t new_alloc = sk->num_alloc << 1;
    size_t alloc_size = new_alloc * sizeof(void *);
    void **data;

    // If the doubling overflowed, try to increment.
    if (new_alloc < sk->num_alloc || alloc_size / sizeof(void *) != new_alloc) {
      new_alloc = sk->num_alloc + 1;
      alloc_size = new_alloc * sizeof(void *);
    }

    // If the increment also overflowed, fail.
    if (new_alloc < sk->num_alloc || alloc_size / sizeof(void *) != new_alloc) {
      return 0;
    }

    data = reinterpret_cast<void **>(OPENSSL_realloc(sk->data, alloc_size));
    if (data == NULL) {
      return 0;
    }

    sk->data = data;
    sk->num_alloc = new_alloc;
  }

  if (where >= sk->num) {
    sk->data[sk->num] = p;
  } else {
    OPENSSL_memmove(&sk->data[where + 1], &sk->data[where],
                    sizeof(void *) * (sk->num - where));
    sk->data[where] = p;
  }

  sk->num++;
  sk->sorted = 0;

  return sk->num;
}

void *OPENSSL_sk_delete(OPENSSL_STACK *sk, size_t where) {
  void *ret;

  if (!sk || where >= sk->num) {
    return NULL;
  }

  ret = sk->data[where];

  if (where != sk->num - 1) {
    OPENSSL_memmove(&sk->data[where], &sk->data[where + 1],
                    sizeof(void *) * (sk->num - where - 1));
  }

  sk->num--;
  return ret;
}

void *OPENSSL_sk_delete_ptr(OPENSSL_STACK *sk, const void *p) {
  if (sk == NULL) {
    return NULL;
  }

  for (size_t i = 0; i < sk->num; i++) {
    if (sk->data[i] == p) {
      return OPENSSL_sk_delete(sk, i);
    }
  }

  return NULL;
}

void OPENSSL_sk_delete_if(OPENSSL_STACK *sk,
                          OPENSSL_sk_call_delete_if_func call_func,
                          OPENSSL_sk_delete_if_func func, void *data) {
  if (sk == NULL) {
    return;
  }

  size_t new_num = 0;
  for (size_t i = 0; i < sk->num; i++) {
    if (!call_func(func, sk->data[i], data)) {
      sk->data[new_num] = sk->data[i];
      new_num++;
    }
  }
  sk->num = new_num;
}

int OPENSSL_sk_find(const OPENSSL_STACK *sk, size_t *out_index, const void *p,
                    OPENSSL_sk_call_cmp_func call_cmp_func) {
  if (sk == NULL) {
    return 0;
  }

  if (sk->comp == NULL) {
    // Use pointer equality when no comparison function has been set.
    for (size_t i = 0; i < sk->num; i++) {
      if (sk->data[i] == p) {
        if (out_index) {
          *out_index = i;
        }
        return 1;
      }
    }
    return 0;
  }

  if (p == NULL) {
    return 0;
  }

  if (!OPENSSL_sk_is_sorted(sk)) {
    for (size_t i = 0; i < sk->num; i++) {
      if (call_cmp_func(sk->comp, p, sk->data[i]) == 0) {
        if (out_index) {
          *out_index = i;
        }
        return 1;
      }
    }
    return 0;
  }

  // The stack is sorted, so binary search to find the element.
  //
  // |lo| and |hi| maintain a half-open interval of where the answer may be. All
  // indices such that |lo <= idx < hi| are candidates.
  size_t lo = 0, hi = sk->num;
  while (lo < hi) {
    // Bias |mid| towards |lo|. See the |r == 0| case below.
    size_t mid = lo + (hi - lo - 1) / 2;
    assert(lo <= mid && mid < hi);
    int r = call_cmp_func(sk->comp, p, sk->data[mid]);
    if (r > 0) {
      lo = mid + 1;  // |mid| is too low.
    } else if (r < 0) {
      hi = mid;  // |mid| is too high.
    } else {
      // |mid| matches. However, this function returns the earliest match, so we
      // can only return if the range has size one.
      if (hi - lo == 1) {
        if (out_index != NULL) {
          *out_index = mid;
        }
        return 1;
      }
      // The sample is biased towards |lo|. |mid| can only be |hi - 1| if
      // |hi - lo| was one, so this makes forward progress.
      assert(mid + 1 < hi);
      hi = mid + 1;
    }
  }

  assert(lo == hi);
  return 0;  // Not found.
}

void *OPENSSL_sk_shift(OPENSSL_STACK *sk) {
  if (sk == NULL) {
    return NULL;
  }
  if (sk->num == 0) {
    return NULL;
  }
  return OPENSSL_sk_delete(sk, 0);
}

size_t OPENSSL_sk_push(OPENSSL_STACK *sk, void *p) {
  return OPENSSL_sk_insert(sk, p, sk->num);
}

void *OPENSSL_sk_pop(OPENSSL_STACK *sk) {
  if (sk == NULL) {
    return NULL;
  }
  if (sk->num == 0) {
    return NULL;
  }
  return OPENSSL_sk_delete(sk, sk->num - 1);
}

OPENSSL_STACK *OPENSSL_sk_dup(const OPENSSL_STACK *sk) {
  if (sk == NULL) {
    return NULL;
  }

  OPENSSL_STACK *ret =
      reinterpret_cast<OPENSSL_STACK *>(OPENSSL_zalloc(sizeof(OPENSSL_STACK)));
  if (ret == NULL) {
    return NULL;
  }

  ret->data = reinterpret_cast<void **>(
      OPENSSL_memdup(sk->data, sizeof(void *) * sk->num_alloc));
  if (ret->data == NULL) {
    goto err;
  }

  ret->num = sk->num;
  ret->sorted = sk->sorted;
  ret->num_alloc = sk->num_alloc;
  ret->comp = sk->comp;
  return ret;

err:
  OPENSSL_sk_free(ret);
  return NULL;
}

static size_t parent_idx(size_t idx) {
  assert(idx > 0);
  return (idx - 1) / 2;
}

static size_t left_idx(size_t idx) {
  // The largest possible index is |PTRDIFF_MAX|, not |SIZE_MAX|. If
  // |ptrdiff_t|, a signed type, is the same size as |size_t|, this cannot
  // overflow.
  assert(idx <= PTRDIFF_MAX);
  static_assert(PTRDIFF_MAX <= (SIZE_MAX - 1) / 2, "2 * idx + 1 may oveflow");
  return 2 * idx + 1;
}

// down_heap fixes the subtree rooted at |i|. |i|'s children must each satisfy
// the heap property. Only the first |num| elements of |sk| are considered.
static void down_heap(OPENSSL_STACK *sk, OPENSSL_sk_call_cmp_func call_cmp_func,
                      size_t i, size_t num) {
  assert(i < num && num <= sk->num);
  for (;;) {
    size_t left = left_idx(i);
    if (left >= num) {
      break;  // No left child.
    }

    // Swap |i| with the largest of its children.
    size_t next = i;
    if (call_cmp_func(sk->comp, sk->data[next], sk->data[left]) < 0) {
      next = left;
    }
    size_t right = left + 1;  // Cannot overflow because |left < num|.
    if (right < num &&
        call_cmp_func(sk->comp, sk->data[next], sk->data[right]) < 0) {
      next = right;
    }

    if (i == next) {
      break;  // |i| is already larger than its children.
    }

    void *tmp = sk->data[i];
    sk->data[i] = sk->data[next];
    sk->data[next] = tmp;
    i = next;
  }
}

void OPENSSL_sk_sort(OPENSSL_STACK *sk,
                     OPENSSL_sk_call_cmp_func call_cmp_func) {
  if (sk == NULL || sk->comp == NULL || sk->sorted) {
    return;
  }

  if (sk->num >= 2) {
    // |qsort| lacks a context parameter in the comparison function for us to
    // pass in |call_cmp_func| and |sk->comp|. While we could cast |sk->comp| to
    // the expected type, it is undefined behavior in C can trip sanitizers.
    // |qsort_r| and |qsort_s| avoid this, but using them is impractical. See
    // https://stackoverflow.com/a/39561369
    //
    // Use our own heap sort instead. This is not performance-sensitive, so we
    // optimize for simplicity and size. First, build a max-heap in place.
    for (size_t i = parent_idx(sk->num - 1); i < sk->num; i--) {
      down_heap(sk, call_cmp_func, i, sk->num);
    }

    // Iteratively remove the maximum element to populate the result in reverse.
    for (size_t i = sk->num - 1; i > 0; i--) {
      void *tmp = sk->data[0];
      sk->data[0] = sk->data[i];
      sk->data[i] = tmp;
      down_heap(sk, call_cmp_func, 0, i);
    }
  }
  sk->sorted = 1;
}

int OPENSSL_sk_is_sorted(const OPENSSL_STACK *sk) {
  if (!sk) {
    return 1;
  }
  // Zero- and one-element lists are always sorted.
  return sk->sorted || (sk->comp != NULL && sk->num < 2);
}

OPENSSL_sk_cmp_func OPENSSL_sk_set_cmp_func(OPENSSL_STACK *sk,
                                            OPENSSL_sk_cmp_func comp) {
  OPENSSL_sk_cmp_func old = sk->comp;

  if (sk->comp != comp) {
    sk->sorted = 0;
  }
  sk->comp = comp;

  return old;
}

OPENSSL_STACK *OPENSSL_sk_deep_copy(const OPENSSL_STACK *sk,
                                    OPENSSL_sk_call_copy_func call_copy_func,
                                    OPENSSL_sk_copy_func copy_func,
                                    OPENSSL_sk_call_free_func call_free_func,
                                    OPENSSL_sk_free_func free_func) {
  OPENSSL_STACK *ret = OPENSSL_sk_dup(sk);
  if (ret == NULL) {
    return NULL;
  }

  for (size_t i = 0; i < ret->num; i++) {
    if (ret->data[i] == NULL) {
      continue;
    }
    ret->data[i] = call_copy_func(copy_func, ret->data[i]);
    if (ret->data[i] == NULL) {
      for (size_t j = 0; j < i; j++) {
        if (ret->data[j] != NULL) {
          call_free_func(free_func, ret->data[j]);
        }
      }
      OPENSSL_sk_free(ret);
      return NULL;
    }
  }

  return ret;
}

OPENSSL_STACK *sk_new_null(void) { return OPENSSL_sk_new_null(); }

size_t sk_num(const OPENSSL_STACK *sk) { return OPENSSL_sk_num(sk); }

void *sk_value(const OPENSSL_STACK *sk, size_t i) {
  return OPENSSL_sk_value(sk, i);
}

void sk_free(OPENSSL_STACK *sk) { OPENSSL_sk_free(sk); }

size_t sk_push(OPENSSL_STACK *sk, void *p) { return OPENSSL_sk_push(sk, p); }

void *sk_pop(OPENSSL_STACK *sk) { return OPENSSL_sk_pop(sk); }

void sk_pop_free_ex(OPENSSL_STACK *sk, OPENSSL_sk_call_free_func call_free_func,
                    OPENSSL_sk_free_func free_func) {
  OPENSSL_sk_pop_free_ex(sk, call_free_func, free_func);
}

Coverage Report

Created: 2025-08-28 06:59

Line	Count	Source (jump to first uncovered line)
1		// Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
2		//
3		// Licensed under the Apache License, Version 2.0 (the "License");
4		// you may not use this file except in compliance with the License.
5		// You may obtain a copy of the License at
6		//
7		// https://www.apache.org/licenses/LICENSE-2.0
8		//
9		// Unless required by applicable law or agreed to in writing, software
10		// distributed under the License is distributed on an "AS IS" BASIS,
11		// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12		// See the License for the specific language governing permissions and
13		// limitations under the License.
14
15		#include <openssl/stack.h>
16
17		#include <assert.h>
18		#include <limits.h>
19
20		#include <openssl/err.h>
21		#include <openssl/mem.h>
22
23		#include "../internal.h"
24
25
26		struct stack_st {
27		// num contains the number of valid pointers in \|data\|.
28		size_t num;
29		void **data;
30		// sorted is non-zero if the values pointed to by \|data\| are in ascending
31		// order, based on \|comp\|.
32		int sorted;
33		// num_alloc contains the number of pointers allocated in the buffer pointed
34		// to by \|data\|, which may be larger than \|num\|.
35		size_t num_alloc;
36		// comp is an optional comparison function.
37		OPENSSL_sk_cmp_func comp;
38		};
39
40		// kMinSize is the number of pointers that will be initially allocated in a new
41		// stack.
42		static const size_t kMinSize = 4;
43
44	4.82M	OPENSSL_STACK *OPENSSL_sk_new(OPENSSL_sk_cmp_func comp) {
45	4.82M	OPENSSL_STACK *ret =
46	4.82M	reinterpret_cast<OPENSSL_STACK *>(OPENSSL_zalloc(sizeof(OPENSSL_STACK)));
47	4.82M	if (ret == NULL) {
48	0	return NULL;
49	0	}
50
51	4.82M	ret->data =
52	4.82M	reinterpret_cast<void *>(OPENSSL_calloc(kMinSize, sizeof(void )));
53	4.82M	if (ret->data == NULL) {
54	0	goto err;
55	0	}
56
57	4.82M	ret->comp = comp;
58	4.82M	ret->num_alloc = kMinSize;
59
60	4.82M	return ret;
61
62	0	err:
63	0	OPENSSL_free(ret);
64	0	return NULL;
65	4.82M	}
66
67	4.81M	OPENSSL_STACK *OPENSSL_sk_new_null(void) { return OPENSSL_sk_new(NULL); }
68
69	23.7M	size_t OPENSSL_sk_num(const OPENSSL_STACK *sk) {
70	23.7M	if (sk == NULL) {
71	773k	return 0;
72	773k	}
73	22.9M	return sk->num;
74	23.7M	}
75
76	0	void OPENSSL_sk_zero(OPENSSL_STACK *sk) {
77	0	if (sk == NULL \|\| sk->num == 0) {
78	0	return;
79	0	}
80	0	OPENSSL_memset(sk->data, 0, sizeof(void ) sk->num);
81	0	sk->num = 0;
82	0	sk->sorted = 0;
83	0	}
84
85	14.7M	void OPENSSL_sk_value(const OPENSSL_STACK sk, size_t i) {
86	14.7M	if (!sk \|\| i >= sk->num) {
87	0	return NULL;
88	0	}
89	14.7M	return sk->data[i];
90	14.7M	}
91
92	1.33M	void OPENSSL_sk_set(OPENSSL_STACK sk, size_t i, void *value) {
93	1.33M	if (!sk \|\| i >= sk->num) {
94	0	return NULL;
95	0	}
96	1.33M	return sk->data[i] = value;
97	1.33M	}
98
99	5.68M	void OPENSSL_sk_free(OPENSSL_STACK *sk) {
100	5.68M	if (sk == NULL) {
101	635k	return;
102	635k	}
103	5.04M	OPENSSL_free(sk->data);
104	5.04M	OPENSSL_free(sk);
105	5.04M	}
106
107		void OPENSSL_sk_pop_free_ex(OPENSSL_STACK *sk,
108		OPENSSL_sk_call_free_func call_free_func,
109	5.18M	OPENSSL_sk_free_func free_func) {
110	5.18M	if (sk == NULL) {
111	1.59M	return;
112	1.59M	}
113
114	9.05M	for (size_t i = 0; i < sk->num; i++) {
115	5.46M	if (sk->data[i] != NULL) {
116	5.46M	call_free_func(free_func, sk->data[i]);
117	5.46M	}
118	5.46M	}
119	3.59M	OPENSSL_sk_free(sk);
120	3.59M	}
121
122		// Historically, \|sk_pop_free\| called the function as \|OPENSSL_sk_free_func\|
123		// directly. This is undefined in C. Some callers called \|sk_pop_free\| directly,
124		// so we must maintain a compatibility version for now.
125	0	static void call_free_func_legacy(OPENSSL_sk_free_func func, void *ptr) {
126	0	func(ptr);
127	0	}
128
129	0	void sk_pop_free(OPENSSL_STACK *sk, OPENSSL_sk_free_func free_func) {
130	0	OPENSSL_sk_pop_free_ex(sk, call_free_func_legacy, free_func);
131	0	}
132
133	7.84M	size_t OPENSSL_sk_insert(OPENSSL_STACK sk, void p, size_t where) {
134	7.84M	if (sk == NULL) {
135	0	return 0;
136	0	}
137
138	7.84M	if (sk->num >= INT_MAX) {
139	0	OPENSSL_PUT_ERROR(CRYPTO, ERR_R_OVERFLOW);
140	0	return 0;
141	0	}
142
143	7.84M	if (sk->num_alloc <= sk->num + 1) {
144		// Attempt to double the size of the array.
145	183k	size_t new_alloc = sk->num_alloc << 1;
146	183k	size_t alloc_size = new_alloc * sizeof(void *);
147	183k	void **data;
148
149		// If the doubling overflowed, try to increment.
150	183k	if (new_alloc < sk->num_alloc \|\| alloc_size / sizeof(void *) != new_alloc) {
151	0	new_alloc = sk->num_alloc + 1;
152	0	alloc_size = new_alloc * sizeof(void *);
153	0	}
154
155		// If the increment also overflowed, fail.
156	183k	if (new_alloc < sk->num_alloc \|\| alloc_size / sizeof(void *) != new_alloc) {
157	0	return 0;
158	0	}
159
160	183k	data = reinterpret_cast<void **>(OPENSSL_realloc(sk->data, alloc_size));
161	183k	if (data == NULL) {
162	0	return 0;
163	0	}
164
165	183k	sk->data = data;
166	183k	sk->num_alloc = new_alloc;
167	183k	}
168
169	7.84M	if (where >= sk->num) {
170	7.84M	sk->data[sk->num] = p;
171	7.84M	} else {
172	0	OPENSSL_memmove(&sk->data[where + 1], &sk->data[where],
173	0	sizeof(void ) (sk->num - where));
174	0	sk->data[where] = p;
175	0	}
176
177	7.84M	sk->num++;
178	7.84M	sk->sorted = 0;
179
180	7.84M	return sk->num;
181	7.84M	}
182
183	9.83k	void OPENSSL_sk_delete(OPENSSL_STACK sk, size_t where) {
184	9.83k	void *ret;
185
186	9.83k	if (!sk \|\| where >= sk->num) {
187	0	return NULL;
188	0	}
189
190	9.83k	ret = sk->data[where];
191
192	9.83k	if (where != sk->num - 1) {
193	3.65k	OPENSSL_memmove(&sk->data[where], &sk->data[where + 1],
194	3.65k	sizeof(void ) (sk->num - where - 1));
195	3.65k	}
196
197	9.83k	sk->num--;
198	9.83k	return ret;
199	9.83k	}
200
201	3.65k	void OPENSSL_sk_delete_ptr(OPENSSL_STACK sk, const void *p) {
202	3.65k	if (sk == NULL) {
203	0	return NULL;
204	0	}
205
206	21.7k	for (size_t i = 0; i < sk->num; i++) {
207	21.7k	if (sk->data[i] == p) {
208	3.65k	return OPENSSL_sk_delete(sk, i);
209	3.65k	}
210	21.7k	}
211
212	0	return NULL;
213	3.65k	}
214
215		void OPENSSL_sk_delete_if(OPENSSL_STACK *sk,
216		OPENSSL_sk_call_delete_if_func call_func,
217	0	OPENSSL_sk_delete_if_func func, void *data) {
218	0	if (sk == NULL) {
219	0	return;
220	0	}
221
222	0	size_t new_num = 0;
223	0	for (size_t i = 0; i < sk->num; i++) {
224	0	if (!call_func(func, sk->data[i], data)) {
225	0	sk->data[new_num] = sk->data[i];
226	0	new_num++;
227	0	}
228	0	}
229	0	sk->num = new_num;
230	0	}
231
232		int OPENSSL_sk_find(const OPENSSL_STACK sk, size_t out_index, const void *p,
233	69.3k	OPENSSL_sk_call_cmp_func call_cmp_func) {
234	69.3k	if (sk == NULL) {
235	0	return 0;
236	0	}
237
238	69.3k	if (sk->comp == NULL) {
239		// Use pointer equality when no comparison function has been set.
240	602k	for (size_t i = 0; i < sk->num; i++) {
241	601k	if (sk->data[i] == p) {
242	69.1k	if (out_index) {
243	7.34k	*out_index = i;
244	7.34k	}
245	69.1k	return 1;
246	69.1k	}
247	601k	}
248	225	return 0;
249	69.3k	}
250
251	0	if (p == NULL) {
252	0	return 0;
253	0	}
254
255	0	if (!OPENSSL_sk_is_sorted(sk)) {
256	0	for (size_t i = 0; i < sk->num; i++) {
257	0	if (call_cmp_func(sk->comp, p, sk->data[i]) == 0) {
258	0	if (out_index) {
259	0	*out_index = i;
260	0	}
261	0	return 1;
262	0	}
263	0	}
264	0	return 0;
265	0	}
266
267		// The stack is sorted, so binary search to find the element.
268		//
269		// \|lo\| and \|hi\| maintain a half-open interval of where the answer may be. All
270		// indices such that \|lo <= idx < hi\| are candidates.
271	0	size_t lo = 0, hi = sk->num;
272	0	while (lo < hi) {
273		// Bias \|mid\| towards \|lo\|. See the \|r == 0\| case below.
274	0	size_t mid = lo + (hi - lo - 1) / 2;
275	0	assert(lo <= mid && mid < hi);
276	0	int r = call_cmp_func(sk->comp, p, sk->data[mid]);
277	0	if (r > 0) {
278	0	lo = mid + 1; // \|mid\| is too low.
279	0	} else if (r < 0) {
280	0	hi = mid; // \|mid\| is too high.
281	0	} else {
282		// \|mid\| matches. However, this function returns the earliest match, so we
283		// can only return if the range has size one.
284	0	if (hi - lo == 1) {
285	0	if (out_index != NULL) {
286	0	*out_index = mid;
287	0	}
288	0	return 1;
289	0	}
290		// The sample is biased towards \|lo\|. \|mid\| can only be \|hi - 1\| if
291		// \|hi - lo\| was one, so this makes forward progress.
292	0	assert(mid + 1 < hi);
293	0	hi = mid + 1;
294	0	}
295	0	}
296
297	0	assert(lo == hi);
298	0	return 0; // Not found.
299	0	}
300
301	0	void OPENSSL_sk_shift(OPENSSL_STACK sk) {
302	0	if (sk == NULL) {
303	0	return NULL;
304	0	}
305	0	if (sk->num == 0) {
306	0	return NULL;
307	0	}
308	0	return OPENSSL_sk_delete(sk, 0);
309	0	}
310
311	7.81M	size_t OPENSSL_sk_push(OPENSSL_STACK sk, void p) {
312	7.81M	return OPENSSL_sk_insert(sk, p, sk->num);
313	7.81M	}
314
315	6.18k	void OPENSSL_sk_pop(OPENSSL_STACK sk) {
316	6.18k	if (sk == NULL) {
317	0	return NULL;
318	0	}
319	6.18k	if (sk->num == 0) {
320	0	return NULL;
321	0	}
322	6.18k	return OPENSSL_sk_delete(sk, sk->num - 1);
323	6.18k	}
324
325	227k	OPENSSL_STACK OPENSSL_sk_dup(const OPENSSL_STACK sk) {
326	227k	if (sk == NULL) {
327	0	return NULL;
328	0	}
329
330	227k	OPENSSL_STACK *ret =
331	227k	reinterpret_cast<OPENSSL_STACK *>(OPENSSL_zalloc(sizeof(OPENSSL_STACK)));
332	227k	if (ret == NULL) {
333	0	return NULL;
334	0	}
335
336	227k	ret->data = reinterpret_cast<void **>(
337	227k	OPENSSL_memdup(sk->data, sizeof(void ) sk->num_alloc));
338	227k	if (ret->data == NULL) {
339	0	goto err;
340	0	}
341
342	227k	ret->num = sk->num;
343	227k	ret->sorted = sk->sorted;
344	227k	ret->num_alloc = sk->num_alloc;
345	227k	ret->comp = sk->comp;
346	227k	return ret;
347
348	0	err:
349	0	OPENSSL_sk_free(ret);
350	0	return NULL;
351	227k	}
352
353	0	static size_t parent_idx(size_t idx) {
354	0	assert(idx > 0);
355	0	return (idx - 1) / 2;
356	0	}
357
358	0	static size_t left_idx(size_t idx) {
359		// The largest possible index is \|PTRDIFF_MAX\|, not \|SIZE_MAX\|. If
360		// \|ptrdiff_t\|, a signed type, is the same size as \|size_t\|, this cannot
361		// overflow.
362	0	assert(idx <= PTRDIFF_MAX);
363	0	static_assert(PTRDIFF_MAX <= (SIZE_MAX - 1) / 2, "2 * idx + 1 may oveflow");
364	0	return 2 * idx + 1;
365	0	}
366
367		// down_heap fixes the subtree rooted at \|i\|. \|i\|'s children must each satisfy
368		// the heap property. Only the first \|num\| elements of \|sk\| are considered.
369		static void down_heap(OPENSSL_STACK *sk, OPENSSL_sk_call_cmp_func call_cmp_func,
370	0	size_t i, size_t num) {
371	0	assert(i < num && num <= sk->num);
372	0	for (;;) {
373	0	size_t left = left_idx(i);
374	0	if (left >= num) {
375	0	break; // No left child.
376	0	}
377
378		// Swap \|i\| with the largest of its children.
379	0	size_t next = i;
380	0	if (call_cmp_func(sk->comp, sk->data[next], sk->data[left]) < 0) {
381	0	next = left;
382	0	}
383	0	size_t right = left + 1; // Cannot overflow because \|left < num\|.
384	0	if (right < num &&
385	0	call_cmp_func(sk->comp, sk->data[next], sk->data[right]) < 0) {
386	0	next = right;
387	0	}
388
389	0	if (i == next) {
390	0	break; // \|i\| is already larger than its children.
391	0	}
392
393	0	void *tmp = sk->data[i];
394	0	sk->data[i] = sk->data[next];
395	0	sk->data[next] = tmp;
396	0	i = next;
397	0	}
398	0	}
399
400		void OPENSSL_sk_sort(OPENSSL_STACK *sk,
401	0	OPENSSL_sk_call_cmp_func call_cmp_func) {
402	0	if (sk == NULL \|\| sk->comp == NULL \|\| sk->sorted) {
403	0	return;
404	0	}
405
406	0	if (sk->num >= 2) {
407		// \|qsort\| lacks a context parameter in the comparison function for us to
408		// pass in \|call_cmp_func\| and \|sk->comp\|. While we could cast \|sk->comp\| to
409		// the expected type, it is undefined behavior in C can trip sanitizers.
410		// \|qsort_r\| and \|qsort_s\| avoid this, but using them is impractical. See
411		// https://stackoverflow.com/a/39561369
412		//
413		// Use our own heap sort instead. This is not performance-sensitive, so we
414		// optimize for simplicity and size. First, build a max-heap in place.
415	0	for (size_t i = parent_idx(sk->num - 1); i < sk->num; i--) {
416	0	down_heap(sk, call_cmp_func, i, sk->num);
417	0	}
418
419		// Iteratively remove the maximum element to populate the result in reverse.
420	0	for (size_t i = sk->num - 1; i > 0; i--) {
421	0	void *tmp = sk->data[0];
422	0	sk->data[0] = sk->data[i];
423	0	sk->data[i] = tmp;
424	0	down_heap(sk, call_cmp_func, 0, i);
425	0	}
426	0	}
427	0	sk->sorted = 1;
428	0	}
429
430	0	int OPENSSL_sk_is_sorted(const OPENSSL_STACK *sk) {
431	0	if (!sk) {
432	0	return 1;
433	0	}
434		// Zero- and one-element lists are always sorted.
435	0	return sk->sorted \|\| (sk->comp != NULL && sk->num < 2);
436	0	}
437
438		OPENSSL_sk_cmp_func OPENSSL_sk_set_cmp_func(OPENSSL_STACK *sk,
439	0	OPENSSL_sk_cmp_func comp) {
440	0	OPENSSL_sk_cmp_func old = sk->comp;
441
442	0	if (sk->comp != comp) {
443	0	sk->sorted = 0;
444	0	}
445	0	sk->comp = comp;
446
447	0	return old;
448	0	}
449
450		OPENSSL_STACK OPENSSL_sk_deep_copy(const OPENSSL_STACK sk,
451		OPENSSL_sk_call_copy_func call_copy_func,
452		OPENSSL_sk_copy_func copy_func,
453		OPENSSL_sk_call_free_func call_free_func,
454	170k	OPENSSL_sk_free_func free_func) {
455	170k	OPENSSL_STACK *ret = OPENSSL_sk_dup(sk);
456	170k	if (ret == NULL) {
457	0	return NULL;
458	0	}
459
460	347k	for (size_t i = 0; i < ret->num; i++) {
461	176k	if (ret->data[i] == NULL) {
462	361	continue;
463	361	}
464	175k	ret->data[i] = call_copy_func(copy_func, ret->data[i]);
465	175k	if (ret->data[i] == NULL) {
466	0	for (size_t j = 0; j < i; j++) {
467	0	if (ret->data[j] != NULL) {
468	0	call_free_func(free_func, ret->data[j]);
469	0	}
470	0	}
471	0	OPENSSL_sk_free(ret);
472	0	return NULL;
473	0	}
474	175k	}
475
476	170k	return ret;
477	170k	}
478
479	0	OPENSSL_STACK *sk_new_null(void) { return OPENSSL_sk_new_null(); }
480
481	0	size_t sk_num(const OPENSSL_STACK *sk) { return OPENSSL_sk_num(sk); }
482
483	0	void sk_value(const OPENSSL_STACK sk, size_t i) {
484	0	return OPENSSL_sk_value(sk, i);
485	0	}
486
487	0	void sk_free(OPENSSL_STACK *sk) { OPENSSL_sk_free(sk); }
488
489	0	size_t sk_push(OPENSSL_STACK sk, void p) { return OPENSSL_sk_push(sk, p); }
490
491	0	void sk_pop(OPENSSL_STACK sk) { return OPENSSL_sk_pop(sk); }
492
493		void sk_pop_free_ex(OPENSSL_STACK *sk, OPENSSL_sk_call_free_func call_free_func,
494	0	OPENSSL_sk_free_func free_func) {
495	0	OPENSSL_sk_pop_free_ex(sk, call_free_func, free_func);
496	0	}