2 * {- join("\n * ", @autowarntext) -}
4 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
12 use
OpenSSL::stackhash
qw(generate_stack_macros
);
16 # define OPENSSL_BIO_H
19 # include <openssl/macros.h>
20 # ifndef OPENSSL_NO_DEPRECATED_3_0
24 # include <openssl/e_os2.h>
26 # ifndef OPENSSL_NO_STDIO
31 # include <openssl/crypto.h>
32 # include <openssl/bioerr.h>
38 /* There are the classes of BIOs */
39 # define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */
40 # define BIO_TYPE_FILTER 0x0200
41 # define BIO_TYPE_SOURCE_SINK 0x0400
43 /* These are the 'types' of BIOs */
44 # define BIO_TYPE_NONE 0
45 # define BIO_TYPE_MEM ( 1|BIO_TYPE_SOURCE_SINK)
46 # define BIO_TYPE_FILE ( 2|BIO_TYPE_SOURCE_SINK)
48 # define BIO_TYPE_FD ( 4|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
49 # define BIO_TYPE_SOCKET ( 5|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
50 # define BIO_TYPE_NULL ( 6|BIO_TYPE_SOURCE_SINK)
51 # define BIO_TYPE_SSL ( 7|BIO_TYPE_FILTER)
52 # define BIO_TYPE_MD ( 8|BIO_TYPE_FILTER)
53 # define BIO_TYPE_BUFFER ( 9|BIO_TYPE_FILTER)
54 # define BIO_TYPE_CIPHER (10|BIO_TYPE_FILTER)
55 # define BIO_TYPE_BASE64 (11|BIO_TYPE_FILTER)
56 # define BIO_TYPE_CONNECT (12|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
57 # define BIO_TYPE_ACCEPT (13|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
59 # define BIO_TYPE_NBIO_TEST (16|BIO_TYPE_FILTER)/* server proxy BIO */
60 # define BIO_TYPE_NULL_FILTER (17|BIO_TYPE_FILTER)
61 # define BIO_TYPE_BIO (19|BIO_TYPE_SOURCE_SINK)/* half a BIO pair */
62 # define BIO_TYPE_LINEBUFFER (20|BIO_TYPE_FILTER)
63 # define BIO_TYPE_DGRAM (21|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
64 # define BIO_TYPE_ASN1 (22|BIO_TYPE_FILTER)
65 # define BIO_TYPE_COMP (23|BIO_TYPE_FILTER)
66 # ifndef OPENSSL_NO_SCTP
67 # define BIO_TYPE_DGRAM_SCTP (24|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
69 # define BIO_TYPE_CORE_TO_PROV (25|BIO_TYPE_FILTER)
71 #define BIO_TYPE_START 128
74 * BIO_FILENAME_READ|BIO_CLOSE to open or close on free.
75 * BIO_set_fp(in,stdin,BIO_NOCLOSE);
77 # define BIO_NOCLOSE 0x00
78 # define BIO_CLOSE 0x01
81 * These are used in the following macros and are passed to BIO_ctrl()
83 # define BIO_CTRL_RESET 1/* opt - rewind/zero etc */
84 # define BIO_CTRL_EOF 2/* opt - are we at the eof */
85 # define BIO_CTRL_INFO 3/* opt - extra tit-bits */
86 # define BIO_CTRL_SET 4/* man - set the 'IO' type */
87 # define BIO_CTRL_GET 5/* man - get the 'IO' type */
88 # define BIO_CTRL_PUSH 6/* opt - internal, used to signify change */
89 # define BIO_CTRL_POP 7/* opt - internal, used to signify change */
90 # define BIO_CTRL_GET_CLOSE 8/* man - set the 'close' on free */
91 # define BIO_CTRL_SET_CLOSE 9/* man - set the 'close' on free */
92 # define BIO_CTRL_PENDING 10/* opt - is their more data buffered */
93 # define BIO_CTRL_FLUSH 11/* opt - 'flush' buffered output */
94 # define BIO_CTRL_DUP 12/* man - extra stuff for 'duped' BIO */
95 # define BIO_CTRL_WPENDING 13/* opt - number of bytes still to write */
96 # define BIO_CTRL_SET_CALLBACK 14/* opt - set callback function */
97 # define BIO_CTRL_GET_CALLBACK 15/* opt - set callback function */
99 # define BIO_CTRL_PEEK 29/* BIO_f_buffer special */
100 # define BIO_CTRL_SET_FILENAME 30/* BIO_s_file special */
102 /* dgram BIO stuff */
103 # define BIO_CTRL_DGRAM_CONNECT 31/* BIO dgram special */
104 # define BIO_CTRL_DGRAM_SET_CONNECTED 32/* allow for an externally connected
105 * socket to be passed in */
106 # define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33/* setsockopt, essentially */
107 # define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34/* getsockopt, essentially */
108 # define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35/* setsockopt, essentially */
109 # define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36/* getsockopt, essentially */
111 # define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37/* flag whether the last */
112 # define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38/* I/O operation tiemd out */
114 /* #ifdef IP_MTU_DISCOVER */
115 # define BIO_CTRL_DGRAM_MTU_DISCOVER 39/* set DF bit on egress packets */
118 # define BIO_CTRL_DGRAM_QUERY_MTU 40/* as kernel for current MTU */
119 # define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47
120 # define BIO_CTRL_DGRAM_GET_MTU 41/* get cached value for MTU */
121 # define BIO_CTRL_DGRAM_SET_MTU 42/* set cached value for MTU.
122 * want to use this if asking
123 * the kernel fails */
125 # define BIO_CTRL_DGRAM_MTU_EXCEEDED 43/* check whether the MTU was
126 * exceed in the previous write
129 # define BIO_CTRL_DGRAM_GET_PEER 46
130 # define BIO_CTRL_DGRAM_SET_PEER 44/* Destination for the data */
132 # define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45/* Next DTLS handshake timeout
133 * to adjust socket timeouts */
134 # define BIO_CTRL_DGRAM_SET_DONT_FRAG 48
136 # define BIO_CTRL_DGRAM_GET_MTU_OVERHEAD 49
138 /* Deliberately outside of OPENSSL_NO_SCTP - used in bss_dgram.c */
139 # define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE 50
140 # ifndef OPENSSL_NO_SCTP
142 # define BIO_CTRL_DGRAM_SCTP_ADD_AUTH_KEY 51
143 # define BIO_CTRL_DGRAM_SCTP_NEXT_AUTH_KEY 52
144 # define BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD 53
145 # define BIO_CTRL_DGRAM_SCTP_GET_SNDINFO 60
146 # define BIO_CTRL_DGRAM_SCTP_SET_SNDINFO 61
147 # define BIO_CTRL_DGRAM_SCTP_GET_RCVINFO 62
148 # define BIO_CTRL_DGRAM_SCTP_SET_RCVINFO 63
149 # define BIO_CTRL_DGRAM_SCTP_GET_PRINFO 64
150 # define BIO_CTRL_DGRAM_SCTP_SET_PRINFO 65
151 # define BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN 70
154 # define BIO_CTRL_DGRAM_SET_PEEK_MODE 71
158 * # define BIO_CTRL_SET_KTLS_SEND 72
159 * # define BIO_CTRL_SET_KTLS_SEND_CTRL_MSG 74
160 * # define BIO_CTRL_CLEAR_KTLS_CTRL_MSG 75
163 # define BIO_CTRL_GET_KTLS_SEND 73
164 # define BIO_CTRL_GET_KTLS_RECV 76
166 # define BIO_CTRL_DGRAM_SCTP_WAIT_FOR_DRY 77
167 # define BIO_CTRL_DGRAM_SCTP_MSG_WAITING 78
169 /* BIO_f_prefix controls */
170 # define BIO_CTRL_SET_PREFIX 79
171 # define BIO_CTRL_SET_INDENT 80
172 # define BIO_CTRL_GET_INDENT 81
174 # ifndef OPENSSL_NO_KTLS
175 # define BIO_get_ktls_send(b) \
176 BIO_ctrl(b, BIO_CTRL_GET_KTLS_SEND, 0, NULL)
177 # define BIO_get_ktls_recv(b) \
178 BIO_ctrl(b, BIO_CTRL_GET_KTLS_RECV, 0, NULL)
180 # define BIO_get_ktls_send(b) (0)
181 # define BIO_get_ktls_recv(b) (0)
185 # define BIO_FP_READ 0x02
186 # define BIO_FP_WRITE 0x04
187 # define BIO_FP_APPEND 0x08
188 # define BIO_FP_TEXT 0x10
190 # define BIO_FLAGS_READ 0x01
191 # define BIO_FLAGS_WRITE 0x02
192 # define BIO_FLAGS_IO_SPECIAL 0x04
193 # define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
194 # define BIO_FLAGS_SHOULD_RETRY 0x08
195 # ifndef OPENSSL_NO_DEPRECATED_3_0
196 /* This #define was replaced by an internal constant and should not be used. */
197 # define BIO_FLAGS_UPLINK 0
200 # define BIO_FLAGS_BASE64_NO_NL 0x100
203 * This is used with memory BIOs:
204 * BIO_FLAGS_MEM_RDONLY means we shouldn't free up or change the data in any way;
205 * BIO_FLAGS_NONCLEAR_RST means we shouldn't clear data on reset.
207 # define BIO_FLAGS_MEM_RDONLY 0x200
208 # define BIO_FLAGS_NONCLEAR_RST 0x400
209 # define BIO_FLAGS_IN_EOF 0x800
211 typedef union bio_addr_st BIO_ADDR
;
212 typedef struct bio_addrinfo_st BIO_ADDRINFO
;
214 int BIO_get_new_index(void);
215 void BIO_set_flags(BIO
*b
, int flags
);
216 int BIO_test_flags(const BIO
*b
, int flags
);
217 void BIO_clear_flags(BIO
*b
, int flags
);
219 # define BIO_get_flags(b) BIO_test_flags(b, ~(0x0))
220 # define BIO_set_retry_special(b) \
221 BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
222 # define BIO_set_retry_read(b) \
223 BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
224 # define BIO_set_retry_write(b) \
225 BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
227 /* These are normally used internally in BIOs */
228 # define BIO_clear_retry_flags(b) \
229 BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
230 # define BIO_get_retry_flags(b) \
231 BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
233 /* These should be used by the application to tell why we should retry */
234 # define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ)
235 # define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE)
236 # define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL)
237 # define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS)
238 # define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY)
241 * The next three are used in conjunction with the BIO_should_io_special()
242 * condition. After this returns true, BIO *BIO_get_retry_BIO(BIO *bio, int
243 * *reason); will walk the BIO stack and return the 'reason' for the special
244 * and the offending BIO. Given a BIO, BIO_get_retry_reason(bio) will return
248 * Returned from the SSL bio when the certificate retrieval code had an error
250 # define BIO_RR_SSL_X509_LOOKUP 0x01
251 /* Returned from the connect BIO when a connect would have blocked */
252 # define BIO_RR_CONNECT 0x02
253 /* Returned from the accept BIO when an accept would have blocked */
254 # define BIO_RR_ACCEPT 0x03
256 /* These are passed by the BIO callback */
257 # define BIO_CB_FREE 0x01
258 # define BIO_CB_READ 0x02
259 # define BIO_CB_WRITE 0x03
260 # define BIO_CB_PUTS 0x04
261 # define BIO_CB_GETS 0x05
262 # define BIO_CB_CTRL 0x06
265 * The callback is called before and after the underling operation, The
266 * BIO_CB_RETURN flag indicates if it is after the call
268 # define BIO_CB_RETURN 0x80
269 # define BIO_CB_return(a) ((a)|BIO_CB_RETURN)
270 # define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN))
271 # define BIO_cb_post(a) ((a)&BIO_CB_RETURN)
273 typedef long (*BIO_callback_fn
)(BIO
*b
, int oper
, const char *argp
, int argi
,
274 long argl
, long ret
);
275 typedef long (*BIO_callback_fn_ex
)(BIO
*b
, int oper
, const char *argp
,
276 size_t len
, int argi
,
277 long argl
, int ret
, size_t *processed
);
278 BIO_callback_fn
BIO_get_callback(const BIO
*b
);
279 void BIO_set_callback(BIO
*b
, BIO_callback_fn callback
);
281 BIO_callback_fn_ex
BIO_get_callback_ex(const BIO
*b
);
282 void BIO_set_callback_ex(BIO
*b
, BIO_callback_fn_ex callback
);
284 char *BIO_get_callback_arg(const BIO
*b
);
285 void BIO_set_callback_arg(BIO
*b
, char *arg
);
287 typedef struct bio_method_st BIO_METHOD
;
289 const char *BIO_method_name(const BIO
*b
);
290 int BIO_method_type(const BIO
*b
);
292 typedef int BIO_info_cb(BIO
*, int, int);
293 typedef BIO_info_cb bio_info_cb
; /* backward compatibility */
296 generate_stack_macros("BIO");
300 /* Prefix and suffix callback in ASN1 BIO */
301 typedef int asn1_ps_func (BIO
*b
, unsigned char **pbuf
, int *plen
,
304 typedef void (*BIO_dgram_sctp_notification_handler_fn
) (BIO
*b
,
307 # ifndef OPENSSL_NO_SCTP
308 /* SCTP parameter structs */
309 struct bio_dgram_sctp_sndinfo
{
313 uint32_t snd_context
;
316 struct bio_dgram_sctp_rcvinfo
{
323 uint32_t rcv_context
;
326 struct bio_dgram_sctp_prinfo
{
333 * #define BIO_CONN_get_param_hostname BIO_ctrl
336 # define BIO_C_SET_CONNECT 100
337 # define BIO_C_DO_STATE_MACHINE 101
338 # define BIO_C_SET_NBIO 102
339 /* # define BIO_C_SET_PROXY_PARAM 103 */
340 # define BIO_C_SET_FD 104
341 # define BIO_C_GET_FD 105
342 # define BIO_C_SET_FILE_PTR 106
343 # define BIO_C_GET_FILE_PTR 107
344 # define BIO_C_SET_FILENAME 108
345 # define BIO_C_SET_SSL 109
346 # define BIO_C_GET_SSL 110
347 # define BIO_C_SET_MD 111
348 # define BIO_C_GET_MD 112
349 # define BIO_C_GET_CIPHER_STATUS 113
350 # define BIO_C_SET_BUF_MEM 114
351 # define BIO_C_GET_BUF_MEM_PTR 115
352 # define BIO_C_GET_BUFF_NUM_LINES 116
353 # define BIO_C_SET_BUFF_SIZE 117
354 # define BIO_C_SET_ACCEPT 118
355 # define BIO_C_SSL_MODE 119
356 # define BIO_C_GET_MD_CTX 120
357 /* # define BIO_C_GET_PROXY_PARAM 121 */
358 # define BIO_C_SET_BUFF_READ_DATA 122/* data to read first */
359 # define BIO_C_GET_CONNECT 123
360 # define BIO_C_GET_ACCEPT 124
361 # define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
362 # define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
363 # define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
364 # define BIO_C_FILE_SEEK 128
365 # define BIO_C_GET_CIPHER_CTX 129
366 # define BIO_C_SET_BUF_MEM_EOF_RETURN 130/* return end of input
368 # define BIO_C_SET_BIND_MODE 131
369 # define BIO_C_GET_BIND_MODE 132
370 # define BIO_C_FILE_TELL 133
371 # define BIO_C_GET_SOCKS 134
372 # define BIO_C_SET_SOCKS 135
374 # define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
375 # define BIO_C_GET_WRITE_BUF_SIZE 137
376 # define BIO_C_MAKE_BIO_PAIR 138
377 # define BIO_C_DESTROY_BIO_PAIR 139
378 # define BIO_C_GET_WRITE_GUARANTEE 140
379 # define BIO_C_GET_READ_REQUEST 141
380 # define BIO_C_SHUTDOWN_WR 142
381 # define BIO_C_NREAD0 143
382 # define BIO_C_NREAD 144
383 # define BIO_C_NWRITE0 145
384 # define BIO_C_NWRITE 146
385 # define BIO_C_RESET_READ_REQUEST 147
386 # define BIO_C_SET_MD_CTX 148
388 # define BIO_C_SET_PREFIX 149
389 # define BIO_C_GET_PREFIX 150
390 # define BIO_C_SET_SUFFIX 151
391 # define BIO_C_GET_SUFFIX 152
393 # define BIO_C_SET_EX_ARG 153
394 # define BIO_C_GET_EX_ARG 154
396 # define BIO_C_SET_CONNECT_MODE 155
398 # define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg)
399 # define BIO_get_app_data(s) BIO_get_ex_data(s,0)
401 # define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
403 # ifndef OPENSSL_NO_SOCK
404 /* IP families we support, for BIO_s_connect() and BIO_s_accept() */
405 /* Note: the underlying operating system may not support some of them */
406 # define BIO_FAMILY_IPV4 4
407 # define BIO_FAMILY_IPV6 6
408 # define BIO_FAMILY_IPANY 256
410 /* BIO_s_connect() */
411 # define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0, \
413 # define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1, \
415 # define BIO_set_conn_address(b,addr) BIO_ctrl(b,BIO_C_SET_CONNECT,2, \
417 # define BIO_set_conn_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,f)
418 # define BIO_get_conn_hostname(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0))
419 # define BIO_get_conn_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1))
420 # define BIO_get_conn_address(b) ((const BIO_ADDR *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2))
421 # define BIO_get_conn_ip_family(b) BIO_ctrl(b,BIO_C_GET_CONNECT,3,NULL)
422 # define BIO_set_conn_mode(b,n) BIO_ctrl(b,BIO_C_SET_CONNECT_MODE,(n),NULL)
425 # define BIO_set_accept_name(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0, \
427 # define BIO_set_accept_port(b,port) BIO_ctrl(b,BIO_C_SET_ACCEPT,1, \
429 # define BIO_get_accept_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0))
430 # define BIO_get_accept_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,1))
431 # define BIO_get_peer_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,2))
432 # define BIO_get_peer_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,3))
433 /* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
434 # define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(n)?(void *)"a":NULL)
435 # define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,3, \
437 # define BIO_set_accept_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_ACCEPT,4,f)
438 # define BIO_get_accept_ip_family(b) BIO_ctrl(b,BIO_C_GET_ACCEPT,4,NULL)
440 /* Aliases kept for backward compatibility */
441 # define BIO_BIND_NORMAL 0
442 # define BIO_BIND_REUSEADDR BIO_SOCK_REUSEADDR
443 # define BIO_BIND_REUSEADDR_IF_UNUSED BIO_SOCK_REUSEADDR
444 # define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
445 # define BIO_get_bind_mode(b) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
447 /* BIO_s_accept() and BIO_s_connect() */
448 # define BIO_do_connect(b) BIO_do_handshake(b)
449 # define BIO_do_accept(b) BIO_do_handshake(b)
450 # endif /* OPENSSL_NO_SOCK */
452 # define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
454 /* BIO_s_datagram(), BIO_s_fd(), BIO_s_socket(), BIO_s_accept() and BIO_s_connect() */
455 # define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
456 # define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)(c))
459 # define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)(fp))
460 # define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)(fpp))
462 /* BIO_s_fd() and BIO_s_file() */
463 # define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
464 # define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
467 * name is cast to lose const, but might be better to route through a
468 * function so we can do it safely
472 * If you are wondering why this isn't defined, its because CONST_STRICT is
473 * purely a compile-time kludge to allow const to be checked.
475 int BIO_read_filename(BIO
*b
, const char *name
);
477 # define BIO_read_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
478 BIO_CLOSE|BIO_FP_READ,(char *)(name))
480 # define BIO_write_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
481 BIO_CLOSE|BIO_FP_WRITE,name)
482 # define BIO_append_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
483 BIO_CLOSE|BIO_FP_APPEND,name)
484 # define BIO_rw_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
485 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
488 * WARNING WARNING, this ups the reference count on the read bio of the SSL
489 * structure. This is because the ssl read BIO is now pointed to by the
490 * next_bio field in the bio. So when you free the BIO, make sure you are
491 * doing a BIO_free_all() to catch the underlying BIO.
493 # define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)(ssl))
494 # define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)(sslp))
495 # define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
496 # define BIO_set_ssl_renegotiate_bytes(b,num) \
497 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL)
498 # define BIO_get_num_renegotiates(b) \
499 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL)
500 # define BIO_set_ssl_renegotiate_timeout(b,seconds) \
501 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL)
503 /* defined in evp.h */
504 /* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)(md)) */
506 # define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)(pp))
507 # define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)(bm))
508 # define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0, \
510 # define BIO_set_mem_eof_return(b,v) \
511 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
513 /* For the BIO_f_buffer() type */
514 # define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
515 # define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
516 # define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
517 # define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
518 # define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
520 /* Don't use the next one unless you know what you are doing :-) */
521 # define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
523 # define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
524 # define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
525 # define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
526 # define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
527 # define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
528 # define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
529 /* ...pending macros have inappropriate return type */
530 size_t BIO_ctrl_pending(BIO
*b
);
531 size_t BIO_ctrl_wpending(BIO
*b
);
532 # define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
533 # define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
535 # define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
537 /* For the BIO_f_buffer() type */
538 # define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
539 # define BIO_buffer_peek(b,s,l) BIO_ctrl(b,BIO_CTRL_PEEK,(l),(s))
541 /* For BIO_s_bio() */
542 # define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
543 # define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
544 # define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
545 # define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
546 # define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
547 /* macros with inappropriate type -- but ...pending macros use int too: */
548 # define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
549 # define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
550 size_t BIO_ctrl_get_write_guarantee(BIO
*b
);
551 size_t BIO_ctrl_get_read_request(BIO
*b
);
552 int BIO_ctrl_reset_read_request(BIO
*b
);
554 /* ctrl macros for dgram */
555 # define BIO_ctrl_dgram_connect(b,peer) \
556 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)(peer))
557 # define BIO_ctrl_set_connected(b,peer) \
558 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, 0, (char *)(peer))
559 # define BIO_dgram_recv_timedout(b) \
560 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
561 # define BIO_dgram_send_timedout(b) \
562 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
563 # define BIO_dgram_get_peer(b,peer) \
564 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)(peer))
565 # define BIO_dgram_set_peer(b,peer) \
566 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)(peer))
567 # define BIO_dgram_get_mtu_overhead(b) \
568 (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU_OVERHEAD, 0, NULL)
570 /* ctrl macros for BIO_f_prefix */
571 # define BIO_set_prefix(b,p) BIO_ctrl((b), BIO_CTRL_SET_PREFIX, 0, (void *)(p))
572 # define BIO_set_indent(b,i) BIO_ctrl((b), BIO_CTRL_SET_INDENT, (i), NULL)
573 # define BIO_get_indent(b) BIO_ctrl((b), BIO_CTRL_GET_INDENT, 0, NULL)
575 #define BIO_get_ex_new_index(l, p, newf, dupf, freef) \
576 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_BIO, l, p, newf, dupf, freef)
577 int BIO_set_ex_data(BIO
*bio
, int idx
, void *data
);
578 void *BIO_get_ex_data(const BIO
*bio
, int idx
);
579 uint64_t BIO_number_read(BIO
*bio
);
580 uint64_t BIO_number_written(BIO
*bio
);
582 /* For BIO_f_asn1() */
583 int BIO_asn1_set_prefix(BIO
*b
, asn1_ps_func
*prefix
,
584 asn1_ps_func
*prefix_free
);
585 int BIO_asn1_get_prefix(BIO
*b
, asn1_ps_func
**pprefix
,
586 asn1_ps_func
**pprefix_free
);
587 int BIO_asn1_set_suffix(BIO
*b
, asn1_ps_func
*suffix
,
588 asn1_ps_func
*suffix_free
);
589 int BIO_asn1_get_suffix(BIO
*b
, asn1_ps_func
**psuffix
,
590 asn1_ps_func
**psuffix_free
);
592 const BIO_METHOD
*BIO_s_file(void);
593 BIO
*BIO_new_file(const char *filename
, const char *mode
);
594 # ifndef OPENSSL_NO_STDIO
595 BIO
*BIO_new_fp(FILE *stream
, int close_flag
);
597 BIO
*BIO_new(const BIO_METHOD
*type
);
598 int BIO_free(BIO
*a
);
599 void BIO_set_data(BIO
*a
, void *ptr
);
600 void *BIO_get_data(BIO
*a
);
601 void BIO_set_init(BIO
*a
, int init
);
602 int BIO_get_init(BIO
*a
);
603 void BIO_set_shutdown(BIO
*a
, int shut
);
604 int BIO_get_shutdown(BIO
*a
);
605 void BIO_vfree(BIO
*a
);
606 int BIO_up_ref(BIO
*a
);
607 int BIO_read(BIO
*b
, void *data
, int dlen
);
608 int BIO_read_ex(BIO
*b
, void *data
, size_t dlen
, size_t *readbytes
);
609 int BIO_gets(BIO
*bp
, char *buf
, int size
);
610 int BIO_write(BIO
*b
, const void *data
, int dlen
);
611 int BIO_write_ex(BIO
*b
, const void *data
, size_t dlen
, size_t *written
);
612 int BIO_puts(BIO
*bp
, const char *buf
);
613 int BIO_indent(BIO
*b
, int indent
, int max
);
614 long BIO_ctrl(BIO
*bp
, int cmd
, long larg
, void *parg
);
615 long BIO_callback_ctrl(BIO
*b
, int cmd
, BIO_info_cb
*fp
);
616 void *BIO_ptr_ctrl(BIO
*bp
, int cmd
, long larg
);
617 long BIO_int_ctrl(BIO
*bp
, int cmd
, long larg
, int iarg
);
618 BIO
*BIO_push(BIO
*b
, BIO
*append
);
619 BIO
*BIO_pop(BIO
*b
);
620 void BIO_free_all(BIO
*a
);
621 BIO
*BIO_find_type(BIO
*b
, int bio_type
);
622 BIO
*BIO_next(BIO
*b
);
623 void BIO_set_next(BIO
*b
, BIO
*next
);
624 BIO
*BIO_get_retry_BIO(BIO
*bio
, int *reason
);
625 int BIO_get_retry_reason(BIO
*bio
);
626 void BIO_set_retry_reason(BIO
*bio
, int reason
);
627 BIO
*BIO_dup_chain(BIO
*in
);
629 int BIO_nread0(BIO
*bio
, char **buf
);
630 int BIO_nread(BIO
*bio
, char **buf
, int num
);
631 int BIO_nwrite0(BIO
*bio
, char **buf
);
632 int BIO_nwrite(BIO
*bio
, char **buf
, int num
);
634 long BIO_debug_callback(BIO
*bio
, int cmd
, const char *argp
, int argi
,
635 long argl
, long ret
);
637 const BIO_METHOD
*BIO_s_mem(void);
638 const BIO_METHOD
*BIO_s_secmem(void);
639 BIO
*BIO_new_mem_buf(const void *buf
, int len
);
640 # ifndef OPENSSL_NO_SOCK
641 const BIO_METHOD
*BIO_s_socket(void);
642 const BIO_METHOD
*BIO_s_connect(void);
643 const BIO_METHOD
*BIO_s_accept(void);
645 const BIO_METHOD
*BIO_s_fd(void);
646 const BIO_METHOD
*BIO_s_log(void);
647 const BIO_METHOD
*BIO_s_bio(void);
648 const BIO_METHOD
*BIO_s_null(void);
649 const BIO_METHOD
*BIO_f_null(void);
650 const BIO_METHOD
*BIO_f_buffer(void);
651 const BIO_METHOD
*BIO_f_linebuffer(void);
652 const BIO_METHOD
*BIO_f_nbio_test(void);
653 const BIO_METHOD
*BIO_f_prefix(void);
654 # ifndef OPENSSL_NO_DGRAM
655 const BIO_METHOD
*BIO_s_datagram(void);
656 int BIO_dgram_non_fatal_error(int error
);
657 BIO
*BIO_new_dgram(int fd
, int close_flag
);
658 # ifndef OPENSSL_NO_SCTP
659 const BIO_METHOD
*BIO_s_datagram_sctp(void);
660 BIO
*BIO_new_dgram_sctp(int fd
, int close_flag
);
661 int BIO_dgram_is_sctp(BIO
*bio
);
662 int BIO_dgram_sctp_notification_cb(BIO
*b
,
663 BIO_dgram_sctp_notification_handler_fn handle_notifications
,
665 int BIO_dgram_sctp_wait_for_dry(BIO
*b
);
666 int BIO_dgram_sctp_msg_waiting(BIO
*b
);
670 # ifndef OPENSSL_NO_SOCK
671 int BIO_sock_should_retry(int i
);
672 int BIO_sock_non_fatal_error(int error
);
673 int BIO_socket_wait(int fd
, int for_read
, time_t max_time
);
675 int BIO_wait(BIO
*bio
, time_t max_time
, unsigned int nap_milliseconds
);
676 int BIO_do_connect_retry(BIO
*bio
, int timeout
, int nap_milliseconds
);
678 int BIO_fd_should_retry(int i
);
679 int BIO_fd_non_fatal_error(int error
);
680 int BIO_dump_cb(int (*cb
) (const void *data
, size_t len
, void *u
),
681 void *u
, const void *s
, int len
);
682 int BIO_dump_indent_cb(int (*cb
) (const void *data
, size_t len
, void *u
),
683 void *u
, const void *s
, int len
, int indent
);
684 int BIO_dump(BIO
*b
, const void *bytes
, int len
);
685 int BIO_dump_indent(BIO
*b
, const void *bytes
, int len
, int indent
);
686 # ifndef OPENSSL_NO_STDIO
687 int BIO_dump_fp(FILE *fp
, const void *s
, int len
);
688 int BIO_dump_indent_fp(FILE *fp
, const void *s
, int len
, int indent
);
690 int BIO_hex_string(BIO
*out
, int indent
, int width
, const void *data
,
693 # ifndef OPENSSL_NO_SOCK
694 BIO_ADDR
*BIO_ADDR_new(void);
695 int BIO_ADDR_rawmake(BIO_ADDR
*ap
, int family
,
696 const void *where
, size_t wherelen
, unsigned short port
);
697 void BIO_ADDR_free(BIO_ADDR
*);
698 void BIO_ADDR_clear(BIO_ADDR
*ap
);
699 int BIO_ADDR_family(const BIO_ADDR
*ap
);
700 int BIO_ADDR_rawaddress(const BIO_ADDR
*ap
, void *p
, size_t *l
);
701 unsigned short BIO_ADDR_rawport(const BIO_ADDR
*ap
);
702 char *BIO_ADDR_hostname_string(const BIO_ADDR
*ap
, int numeric
);
703 char *BIO_ADDR_service_string(const BIO_ADDR
*ap
, int numeric
);
704 char *BIO_ADDR_path_string(const BIO_ADDR
*ap
);
706 const BIO_ADDRINFO
*BIO_ADDRINFO_next(const BIO_ADDRINFO
*bai
);
707 int BIO_ADDRINFO_family(const BIO_ADDRINFO
*bai
);
708 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO
*bai
);
709 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO
*bai
);
710 const BIO_ADDR
*BIO_ADDRINFO_address(const BIO_ADDRINFO
*bai
);
711 void BIO_ADDRINFO_free(BIO_ADDRINFO
*bai
);
713 enum BIO_hostserv_priorities
{
714 BIO_PARSE_PRIO_HOST
, BIO_PARSE_PRIO_SERV
716 int BIO_parse_hostserv(const char *hostserv
, char **host
, char **service
,
717 enum BIO_hostserv_priorities hostserv_prio
);
718 enum BIO_lookup_type
{
719 BIO_LOOKUP_CLIENT
, BIO_LOOKUP_SERVER
721 int BIO_lookup(const char *host
, const char *service
,
722 enum BIO_lookup_type lookup_type
,
723 int family
, int socktype
, BIO_ADDRINFO
**res
);
724 int BIO_lookup_ex(const char *host
, const char *service
,
725 int lookup_type
, int family
, int socktype
, int protocol
,
727 int BIO_sock_error(int sock
);
728 int BIO_socket_ioctl(int fd
, long type
, void *arg
);
729 int BIO_socket_nbio(int fd
, int mode
);
730 int BIO_sock_init(void);
731 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
732 # define BIO_sock_cleanup() while(0) continue
734 int BIO_set_tcp_ndelay(int sock
, int turn_on
);
736 DEPRECATEDIN_1_1_0(struct hostent
*BIO_gethostbyname(const char *name
))
737 DEPRECATEDIN_1_1_0(int BIO_get_port(const char *str
, unsigned short *port_ptr
))
738 DEPRECATEDIN_1_1_0(int BIO_get_host_ip(const char *str
, unsigned char *ip
))
739 DEPRECATEDIN_1_1_0(int BIO_get_accept_socket(char *host_port
, int mode
))
740 DEPRECATEDIN_1_1_0(int BIO_accept(int sock
, char **ip_port
))
742 union BIO_sock_info_u
{
745 enum BIO_sock_info_type
{
746 BIO_SOCK_INFO_ADDRESS
748 int BIO_sock_info(int sock
,
749 enum BIO_sock_info_type type
, union BIO_sock_info_u
*info
);
751 # define BIO_SOCK_REUSEADDR 0x01
752 # define BIO_SOCK_V6_ONLY 0x02
753 # define BIO_SOCK_KEEPALIVE 0x04
754 # define BIO_SOCK_NONBLOCK 0x08
755 # define BIO_SOCK_NODELAY 0x10
757 int BIO_socket(int domain
, int socktype
, int protocol
, int options
);
758 int BIO_connect(int sock
, const BIO_ADDR
*addr
, int options
);
759 int BIO_bind(int sock
, const BIO_ADDR
*addr
, int options
);
760 int BIO_listen(int sock
, const BIO_ADDR
*addr
, int options
);
761 int BIO_accept_ex(int accept_sock
, BIO_ADDR
*addr
, int options
);
762 int BIO_closesocket(int sock
);
764 BIO
*BIO_new_socket(int sock
, int close_flag
);
765 BIO
*BIO_new_connect(const char *host_port
);
766 BIO
*BIO_new_accept(const char *host_port
);
767 # endif /* OPENSSL_NO_SOCK*/
769 BIO
*BIO_new_fd(int fd
, int close_flag
);
771 int BIO_new_bio_pair(BIO
**bio1
, size_t writebuf1
,
772 BIO
**bio2
, size_t writebuf2
);
774 * If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
775 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. Size 0 uses default
779 void BIO_copy_next_retry(BIO
*b
);
782 * long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
785 # define ossl_bio__attr__(x)
786 # if defined(__GNUC__) && defined(__STDC_VERSION__) \
787 && !defined(__APPLE__)
789 * Because we support the 'z' modifier, which made its appearance in C99,
790 * we can't use __attribute__ with pre C99 dialects.
792 # if __STDC_VERSION__ >= 199901L
793 # undef ossl_bio__attr__
794 # define ossl_bio__attr__ __attribute__
795 # if __GNUC__*10 + __GNUC_MINOR__ >= 44
796 # define ossl_bio__printf__ __gnu_printf__
798 # define ossl_bio__printf__ __printf__
802 int BIO_printf(BIO
*bio
, const char *format
, ...)
803 ossl_bio__attr__((__format__(ossl_bio__printf__
, 2, 3)));
804 int BIO_vprintf(BIO
*bio
, const char *format
, va_list args
)
805 ossl_bio__attr__((__format__(ossl_bio__printf__
, 2, 0)));
806 int BIO_snprintf(char *buf
, size_t n
, const char *format
, ...)
807 ossl_bio__attr__((__format__(ossl_bio__printf__
, 3, 4)));
808 int BIO_vsnprintf(char *buf
, size_t n
, const char *format
, va_list args
)
809 ossl_bio__attr__((__format__(ossl_bio__printf__
, 3, 0)));
810 # undef ossl_bio__attr__
811 # undef ossl_bio__printf__
814 BIO_METHOD
*BIO_meth_new(int type
, const char *name
);
815 void BIO_meth_free(BIO_METHOD
*biom
);
816 int (*BIO_meth_get_write(const BIO_METHOD
*biom
)) (BIO
*, const char *, int);
817 int (*BIO_meth_get_write_ex(const BIO_METHOD
*biom
)) (BIO
*, const char *, size_t,
819 int BIO_meth_set_write(BIO_METHOD
*biom
,
820 int (*write
) (BIO
*, const char *, int));
821 int BIO_meth_set_write_ex(BIO_METHOD
*biom
,
822 int (*bwrite
) (BIO
*, const char *, size_t, size_t *));
823 int (*BIO_meth_get_read(const BIO_METHOD
*biom
)) (BIO
*, char *, int);
824 int (*BIO_meth_get_read_ex(const BIO_METHOD
*biom
)) (BIO
*, char *, size_t, size_t *);
825 int BIO_meth_set_read(BIO_METHOD
*biom
,
826 int (*read
) (BIO
*, char *, int));
827 int BIO_meth_set_read_ex(BIO_METHOD
*biom
,
828 int (*bread
) (BIO
*, char *, size_t, size_t *));
829 int (*BIO_meth_get_puts(const BIO_METHOD
*biom
)) (BIO
*, const char *);
830 int BIO_meth_set_puts(BIO_METHOD
*biom
,
831 int (*puts
) (BIO
*, const char *));
832 int (*BIO_meth_get_gets(const BIO_METHOD
*biom
)) (BIO
*, char *, int);
833 int BIO_meth_set_gets(BIO_METHOD
*biom
,
834 int (*gets
) (BIO
*, char *, int));
835 long (*BIO_meth_get_ctrl(const BIO_METHOD
*biom
)) (BIO
*, int, long, void *);
836 int BIO_meth_set_ctrl(BIO_METHOD
*biom
,
837 long (*ctrl
) (BIO
*, int, long, void *));
838 int (*BIO_meth_get_create(const BIO_METHOD
*bion
)) (BIO
*);
839 int BIO_meth_set_create(BIO_METHOD
*biom
, int (*create
) (BIO
*));
840 int (*BIO_meth_get_destroy(const BIO_METHOD
*biom
)) (BIO
*);
841 int BIO_meth_set_destroy(BIO_METHOD
*biom
, int (*destroy
) (BIO
*));
842 long (*BIO_meth_get_callback_ctrl(const BIO_METHOD
*biom
))
843 (BIO
*, int, BIO_info_cb
*);
844 int BIO_meth_set_callback_ctrl(BIO_METHOD
*biom
,
845 long (*callback_ctrl
) (BIO
*, int,