xref: /aosp_15_r20/external/boringssl/src/crypto/bio/internal.h (revision 8fb009dc861624b67b6cdb62ea21f0f22d0c584b)
1 /* Copyright (C) 1995-1998 Eric Young ([email protected])
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young ([email protected]).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson ([email protected]).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young ([email protected])"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson ([email protected])"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.] */
56 
57 #ifndef OPENSSL_HEADER_BIO_INTERNAL_H
58 #define OPENSSL_HEADER_BIO_INTERNAL_H
59 
60 #include <openssl/base.h>
61 
62 #if !defined(OPENSSL_NO_SOCK)
63 #if !defined(OPENSSL_WINDOWS)
64 #if defined(OPENSSL_PNACL)
65 // newlib uses u_short in socket.h without defining it.
66 typedef unsigned short u_short;
67 #endif
68 #include <sys/types.h>
69 #include <sys/socket.h>
70 #else
71 OPENSSL_MSVC_PRAGMA(warning(push, 3))
72 #include <winsock2.h>
73 OPENSSL_MSVC_PRAGMA(warning(pop))
74 typedef int socklen_t;
75 #endif
76 #endif  // !OPENSSL_NO_SOCK
77 
78 #if defined(__cplusplus)
79 extern "C" {
80 #endif
81 
82 
83 #if !defined(OPENSSL_NO_SOCK)
84 
85 // bio_ip_and_port_to_socket_and_addr creates a socket and fills in |*out_addr|
86 // and |*out_addr_length| with the correct values for connecting to |hostname|
87 // on |port_str|. It returns one on success or zero on error.
88 int bio_ip_and_port_to_socket_and_addr(int *out_sock,
89                                        struct sockaddr_storage *out_addr,
90                                        socklen_t *out_addr_length,
91                                        const char *hostname,
92                                        const char *port_str);
93 
94 // bio_socket_nbio sets whether |sock| is non-blocking. It returns one on
95 // success and zero otherwise.
96 int bio_socket_nbio(int sock, int on);
97 
98 // bio_clear_socket_error clears the last system socket error.
99 //
100 // TODO(fork): remove all callers of this.
101 void bio_clear_socket_error(void);
102 
103 // bio_sock_error returns the last socket error on |sock|.
104 int bio_sock_error(int sock);
105 
106 // bio_socket_should_retry returns non-zero if |return_value| indicates an error
107 // and the last socket error indicates that it's non-fatal.
108 int bio_socket_should_retry(int return_value);
109 
110 #endif  // !OPENSSL_NO_SOCK
111 
112 // bio_errno_should_retry returns non-zero if |return_value| indicates an error
113 // and |errno| indicates that it's non-fatal.
114 int bio_errno_should_retry(int return_value);
115 
116 
117 #if defined(__cplusplus)
118 }  // extern C
119 #endif
120 
121 #endif  // OPENSSL_HEADER_BIO_INTERNAL_H
122