ssl: Linux TLS Tx Offload
[openssl.git] / doc / man3 / BIO_ctrl.pod
1 =pod
2
3 =head1 NAME
4
5 BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl, BIO_reset,
6 BIO_seek, BIO_tell, BIO_flush, BIO_eof, BIO_set_close, BIO_get_close,
7 BIO_pending, BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending,
8 BIO_get_info_callback, BIO_set_info_callback, BIO_info_cb, BIO_get_ktls_send
9 - BIO control operations
10
11 =head1 SYNOPSIS
12
13  #include <openssl/bio.h>
14
15  typedef int BIO_info_cb(BIO *b, int state, int res);
16
17  long BIO_ctrl(BIO *bp, int cmd, long larg, void *parg);
18  long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *cb);
19  char *BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
20  long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
21
22  int BIO_reset(BIO *b);
23  int BIO_seek(BIO *b, int ofs);
24  int BIO_tell(BIO *b);
25  int BIO_flush(BIO *b);
26  int BIO_eof(BIO *b);
27  int BIO_set_close(BIO *b, long flag);
28  int BIO_get_close(BIO *b);
29  int BIO_pending(BIO *b);
30  int BIO_wpending(BIO *b);
31  size_t BIO_ctrl_pending(BIO *b);
32  size_t BIO_ctrl_wpending(BIO *b);
33
34  int BIO_get_info_callback(BIO *b, BIO_info_cb **cbp);
35  int BIO_set_info_callback(BIO *b, BIO_info_cb *cb);
36
37  int BIO_get_ktls_send(BIO *b);
38
39 =head1 DESCRIPTION
40
41 BIO_ctrl(), BIO_callback_ctrl(), BIO_ptr_ctrl() and BIO_int_ctrl()
42 are BIO "control" operations taking arguments of various types.
43 These functions are not normally called directly, various macros
44 are used instead. The standard macros are described below, macros
45 specific to a particular type of BIO are described in the specific
46 BIOs manual page as well as any special features of the standard
47 calls.
48
49 BIO_reset() typically resets a BIO to some initial state, in the case
50 of file related BIOs for example it rewinds the file pointer to the
51 start of the file.
52
53 BIO_seek() resets a file related BIO's (that is file descriptor and
54 FILE BIOs) file position pointer to B<ofs> bytes from start of file.
55
56 BIO_tell() returns the current file position of a file related BIO.
57
58 BIO_flush() normally writes out any internally buffered data, in some
59 cases it is used to signal EOF and that no more data will be written.
60
61 BIO_eof() returns 1 if the BIO has read EOF, the precise meaning of
62 "EOF" varies according to the BIO type.
63
64 BIO_set_close() sets the BIO B<b> close flag to B<flag>. B<flag> can
65 take the value BIO_CLOSE or BIO_NOCLOSE. Typically BIO_CLOSE is used
66 in a source/sink BIO to indicate that the underlying I/O stream should
67 be closed when the BIO is freed.
68
69 BIO_get_close() returns the BIOs close flag.
70
71 BIO_pending(), BIO_ctrl_pending(), BIO_wpending() and BIO_ctrl_wpending()
72 return the number of pending characters in the BIOs read and write buffers.
73 Not all BIOs support these calls. BIO_ctrl_pending() and BIO_ctrl_wpending()
74 return a size_t type and are functions, BIO_pending() and BIO_wpending() are
75 macros which call BIO_ctrl().
76
77 BIO_get_ktls_send() return 1 if the BIO is using the Kernel TLS data-path for
78 sending. Otherwise, it returns zero.
79
80 =head1 RETURN VALUES
81
82 BIO_reset() normally returns 1 for success and 0 or -1 for failure. File
83 BIOs are an exception, they return 0 for success and -1 for failure.
84
85 BIO_seek() and BIO_tell() both return the current file position on success
86 and -1 for failure, except file BIOs which for BIO_seek() always return 0
87 for success and -1 for failure.
88
89 BIO_flush() returns 1 for success and 0 or -1 for failure.
90
91 BIO_eof() returns 1 if EOF has been reached 0 otherwise.
92
93 BIO_set_close() always returns 1.
94
95 BIO_get_close() returns the close flag value: BIO_CLOSE or BIO_NOCLOSE.
96
97 BIO_pending(), BIO_ctrl_pending(), BIO_wpending() and BIO_ctrl_wpending()
98 return the amount of pending data.
99
100 BIO_get_ktls_send() return 1 if the BIO is using the Kernel TLS data-path for
101 sending. Otherwise, it returns zero.
102
103 =head1 NOTES
104
105 BIO_flush(), because it can write data may return 0 or -1 indicating
106 that the call should be retried later in a similar manner to BIO_write_ex().
107 The BIO_should_retry() call should be used and appropriate action taken
108 is the call fails.
109
110 The return values of BIO_pending() and BIO_wpending() may not reliably
111 determine the amount of pending data in all cases. For example in the
112 case of a file BIO some data may be available in the FILE structures
113 internal buffers but it is not possible to determine this in a
114 portably way. For other types of BIO they may not be supported.
115
116 Filter BIOs if they do not internally handle a particular BIO_ctrl()
117 operation usually pass the operation to the next BIO in the chain.
118 This often means there is no need to locate the required BIO for
119 a particular operation, it can be called on a chain and it will
120 be automatically passed to the relevant BIO. However this can cause
121 unexpected results: for example no current filter BIOs implement
122 BIO_seek(), but this may still succeed if the chain ends in a FILE
123 or file descriptor BIO.
124
125 Source/sink BIOs return an 0 if they do not recognize the BIO_ctrl()
126 operation.
127
128 =head1 BUGS
129
130 Some of the return values are ambiguous and care should be taken. In
131 particular a return value of 0 can be returned if an operation is not
132 supported, if an error occurred, if EOF has not been reached and in
133 the case of BIO_seek() on a file BIO for a successful operation.
134
135 =head1 HISTORY
136
137 The BIO_get_ktls_send() function was added in OpenSSL 3.0.0.
138
139 =head1 COPYRIGHT
140
141 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
142
143 Licensed under the Apache License 2.0 (the "License").  You may not use
144 this file except in compliance with the License.  You can obtain a copy
145 in the file LICENSE in the source distribution or at
146 L<https://www.openssl.org/source/license.html>.
147
148 =cut