doc/crypto/BIO_should_retry.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BIO_should_read, BIO_should_write,
   6 BIO_should_io_special, BIO_retry_type, BIO_should_retry,
   7 BIO_get_retry_BIO, BIO_get_retry_reason, BIO_set_retry_reason - BIO retry
   8 functions
   9
  10 =head1 SYNOPSIS
  11
  12  #include <openssl/bio.h>
  13
  14  #define BIO_should_read(a)             ((a)->flags & BIO_FLAGS_READ)
  15  #define BIO_should_write(a)            ((a)->flags & BIO_FLAGS_WRITE)
  16  #define BIO_should_io_special(a)       ((a)->flags & BIO_FLAGS_IO_SPECIAL)
  17  #define BIO_retry_type(a)              ((a)->flags & BIO_FLAGS_RWS)
  18  #define BIO_should_retry(a)            ((a)->flags & BIO_FLAGS_SHOULD_RETRY)
  19
  20  #define BIO_FLAGS_READ         0x01
  21  #define BIO_FLAGS_WRITE        0x02
  22  #define BIO_FLAGS_IO_SPECIAL   0x04
  23  #define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
  24  #define BIO_FLAGS_SHOULD_RETRY 0x08
  25
  26  BIO *BIO_get_retry_BIO(BIO *bio, int *reason);
  27  int BIO_get_retry_reason(BIO *bio);
  28  void BIO_set_retry_reason(BIO *bio, int reason);
  29
  30 =head1 DESCRIPTION
  31
  32 These functions determine why a BIO is not able to read or write data.
  33 They will typically be called after a failed BIO_read() or BIO_write()
  34 call.
  35
  36 BIO_should_retry() is true if the call that produced this condition
  37 should then be retried at a later time.
  38
  39 If BIO_should_retry() is false then the cause is an error condition.
  40
  41 BIO_should_read() is true if the cause of the condition is that a BIO
  42 needs to read data.
  43
  44 BIO_should_write() is true if the cause of the condition is that a BIO
  45 needs to read data.
  46
  47 BIO_should_io_special() is true if some "special" condition, that is a
  48 reason other than reading or writing is the cause of the condition.
  49
  50 BIO_retry_type() returns a mask of the cause of a retry condition
  51 consisting of the values B<BIO_FLAGS_READ>, B<BIO_FLAGS_WRITE>,
  52 B<BIO_FLAGS_IO_SPECIAL> though current BIO types will only set one of
  53 these.
  54
  55 BIO_get_retry_BIO() determines the precise reason for the special
  56 condition, it returns the BIO that caused this condition and if
  57 B<reason> is not NULL it contains the reason code. The meaning of
  58 the reason code and the action that should be taken depends on
  59 the type of BIO that resulted in this condition.
  60
  61 BIO_get_retry_reason() returns the reason for a special condition if
  62 passed the relevant BIO, for example as returned by BIO_get_retry_BIO().
  63
  64 BIO_set_retry_reason() sets the retry reason for a special condition for a given
  65 BIO. This would usually only be called by BIO implementations.
  66
  67 =head1 NOTES
  68
  69 If BIO_should_retry() returns false then the precise "error condition"
  70 depends on the BIO type that caused it and the return code of the BIO
  71 operation. For example if a call to BIO_read() on a socket BIO returns
  72 0 and BIO_should_retry() is false then the cause will be that the
  73 connection closed. A similar condition on a file BIO will mean that it
  74 has reached EOF. Some BIO types may place additional information on
  75 the error queue. For more details see the individual BIO type manual
  76 pages.
  77
  78 If the underlying I/O structure is in a blocking mode almost all current
  79 BIO types will not request a retry, because the underlying I/O
  80 calls will not. If the application knows that the BIO type will never
  81 signal a retry then it need not call BIO_should_retry() after a failed
  82 BIO I/O call. This is typically done with file BIOs.
  83
  84 SSL BIOs are the only current exception to this rule: they can request a
  85 retry even if the underlying I/O structure is blocking, if a handshake
  86 occurs during a call to BIO_read(). An application can retry the failed
  87 call immediately or avoid this situation by setting SSL_MODE_AUTO_RETRY
  88 on the underlying SSL structure.
  89
  90 While an application may retry a failed non blocking call immediately
  91 this is likely to be very inefficient because the call will fail
  92 repeatedly until data can be processed or is available. An application
  93 will normally wait until the necessary condition is satisfied. How
  94 this is done depends on the underlying I/O structure.
  95
  96 For example if the cause is ultimately a socket and BIO_should_read()
  97 is true then a call to select() may be made to wait until data is
  98 available and then retry the BIO operation. By combining the retry
  99 conditions of several non blocking BIOs in a single select() call
 100 it is possible to service several BIOs in a single thread, though
 101 the performance may be poor if SSL BIOs are present because long delays
 102 can occur during the initial handshake process.
 103
 104 It is possible for a BIO to block indefinitely if the underlying I/O
 105 structure cannot process or return any data. This depends on the behaviour of
 106 the platforms I/O functions. This is often not desirable: one solution
 107 is to use non blocking I/O and use a timeout on the select() (or
 108 equivalent) call.
 109
 110 =head1 BUGS
 111
 112 The OpenSSL ASN1 functions cannot gracefully deal with non blocking I/O:
 113 that is they cannot retry after a partial read or write. This is usually
 114 worked around by only passing the relevant data to ASN1 functions when
 115 the entire structure can be read or written.
 116
 117 =head1 SEE ALSO
 118
 119 L<bio>
 120
 121 =head1 HISTORY
 122
 123 The BIO_get_retry_reason() and BIO_set_retry_reason() functions were added in
 124 OpenSSL version 1.1.0.
 125
 126 =head1 COPYRIGHT
 127
 128 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 129
 130 Licensed under the OpenSSL license (the "License").  You may not use
 131 this file except in compliance with the License.  You can obtain a copy
 132 in the file LICENSE in the source distribution or at
 133 L<https://www.openssl.org/source/license.html>.
 134
 135 =cut