Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 1 | /* |
Willy Tarreau | 4c283dc | 2009-12-29 14:36:34 +0100 | [diff] [blame] | 2 | * include/types/stream_interface.h |
| 3 | * This file describes the stream_interface struct and associated constants. |
| 4 | * |
Willy Tarreau | a2df3fa | 2014-11-28 11:53:35 +0100 | [diff] [blame] | 5 | * Copyright (C) 2000-2014 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 4c283dc | 2009-12-29 14:36:34 +0100 | [diff] [blame] | 6 | * |
| 7 | * This library is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU Lesser General Public |
| 9 | * License as published by the Free Software Foundation, version 2.1 |
| 10 | * exclusively. |
| 11 | * |
| 12 | * This library is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | * Lesser General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU Lesser General Public |
| 18 | * License along with this library; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 21 | |
| 22 | #ifndef _TYPES_STREAM_INTERFACE_H |
| 23 | #define _TYPES_STREAM_INTERFACE_H |
| 24 | |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 25 | #include <types/obj_type.h> |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 26 | #include <common/config.h> |
| 27 | |
Jamie Gloudon | 801a0a3 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 28 | /* A stream interface must have its own errors independently of the buffer's, |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 29 | * so that applications can rely on what the buffer reports while the stream |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 30 | * interface is performing some retries (eg: connection error). Some states are |
| 31 | * transient and do not last beyond process_session(). |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 32 | */ |
Willy Tarreau | 721854f | 2013-12-06 23:31:58 +0100 | [diff] [blame] | 33 | enum si_state { |
Willy Tarreau | efb453c | 2008-10-26 20:49:47 +0100 | [diff] [blame] | 34 | SI_ST_INI = 0, /* interface not sollicitated yet */ |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 35 | SI_ST_REQ, /* [transient] connection initiation desired and not started yet */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 36 | SI_ST_QUE, /* interface waiting in queue */ |
| 37 | SI_ST_TAR, /* interface in turn-around state after failed connect attempt */ |
| 38 | SI_ST_ASS, /* server just assigned to this interface */ |
| 39 | SI_ST_CON, /* initiated connection request (resource exists) */ |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 40 | SI_ST_CER, /* [transient] previous connection attempt failed (resource released) */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 41 | SI_ST_EST, /* connection established (resource exists) */ |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 42 | SI_ST_DIS, /* [transient] disconnected from other side, but cleanup not done yet */ |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 43 | SI_ST_CLO, /* stream intf closed, might not existing anymore. Buffers shut. */ |
Willy Tarreau | 721854f | 2013-12-06 23:31:58 +0100 | [diff] [blame] | 44 | } __attribute__((packed)); |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 45 | |
| 46 | /* error types reported on the streams interface for more accurate reporting */ |
| 47 | enum { |
Willy Tarreau | e5ed406 | 2008-08-30 03:17:31 +0200 | [diff] [blame] | 48 | SI_ET_NONE = 0x0000, /* no error yet, leave it to zero */ |
| 49 | SI_ET_QUEUE_TO = 0x0001, /* queue timeout */ |
| 50 | SI_ET_QUEUE_ERR = 0x0002, /* queue error (eg: full) */ |
| 51 | SI_ET_QUEUE_ABRT = 0x0004, /* aborted in queue by external cause */ |
| 52 | SI_ET_CONN_TO = 0x0008, /* connection timeout */ |
| 53 | SI_ET_CONN_ERR = 0x0010, /* connection error (eg: no server available) */ |
| 54 | SI_ET_CONN_ABRT = 0x0020, /* connection aborted by external cause (eg: abort) */ |
Willy Tarreau | 2d400bb | 2012-05-14 12:11:47 +0200 | [diff] [blame] | 55 | SI_ET_CONN_RES = 0x0040, /* connection aborted due to lack of resources */ |
| 56 | SI_ET_CONN_OTHER = 0x0080, /* connection aborted for other reason (eg: 500) */ |
| 57 | SI_ET_DATA_TO = 0x0100, /* timeout during data phase */ |
| 58 | SI_ET_DATA_ERR = 0x0200, /* error during data phase */ |
| 59 | SI_ET_DATA_ABRT = 0x0400, /* data phase aborted by external cause */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 60 | }; |
| 61 | |
Willy Tarreau | a44e576 | 2018-11-14 10:53:42 +0100 | [diff] [blame] | 62 | /* flags set after I/O (32 bit) */ |
Willy Tarreau | d7704b5 | 2008-09-04 11:51:16 +0200 | [diff] [blame] | 63 | enum { |
Willy Tarreau | a44e576 | 2018-11-14 10:53:42 +0100 | [diff] [blame] | 64 | SI_FL_NONE = 0x00000000, /* nothing */ |
| 65 | SI_FL_EXP = 0x00000001, /* timeout has expired */ |
| 66 | SI_FL_ERR = 0x00000002, /* a non-recoverable error has occurred */ |
Willy Tarreau | 0f9cd7b | 2019-01-31 19:02:43 +0100 | [diff] [blame] | 67 | SI_FL_KILL_CONN = 0x00000004, /* next shutw must kill the whole conn, not just the stream */ |
Willy Tarreau | a44e576 | 2018-11-14 10:53:42 +0100 | [diff] [blame] | 68 | SI_FL_WAIT_DATA = 0x00000008, /* stream-int waits for more outgoing data to send */ |
| 69 | SI_FL_ISBACK = 0x00000010, /* 0 for front-side SI, 1 for back-side */ |
| 70 | SI_FL_DONT_WAKE = 0x00000020, /* resync in progress, don't wake up */ |
| 71 | SI_FL_INDEP_STR = 0x00000040, /* independent streams = don't update rex on write */ |
| 72 | SI_FL_NOLINGER = 0x00000080, /* may close without lingering. One-shot. */ |
| 73 | SI_FL_NOHALF = 0x00000100, /* no half close, close both sides at once */ |
| 74 | SI_FL_SRC_ADDR = 0x00001000, /* get the source ip/port with getsockname */ |
Willy Tarreau | 05b9b64 | 2018-11-14 13:43:35 +0100 | [diff] [blame] | 75 | /* unused: 0x00002000 */ |
Willy Tarreau | a44e576 | 2018-11-14 10:53:42 +0100 | [diff] [blame] | 76 | SI_FL_WANT_GET = 0x00004000, /* a stream-int would like to get some data from the buffer */ |
| 77 | SI_FL_CLEAN_ABRT = 0x00008000, /* SI_FL_ERR is used to report aborts, and not SHUTR */ |
Willy Tarreau | 94f7907 | 2018-11-14 11:24:08 +0100 | [diff] [blame] | 78 | |
| 79 | SI_FL_RXBLK_CHAN = 0x00010000, /* the channel doesn't want the stream-int to introduce data */ |
| 80 | SI_FL_RXBLK_BUFF = 0x00020000, /* stream-int waits for a buffer allocation to complete */ |
| 81 | SI_FL_RXBLK_ROOM = 0x00040000, /* stream-int waits for more buffer room to store incoming data */ |
| 82 | SI_FL_RXBLK_SHUT = 0x00080000, /* input is now closed, nothing new will ever come */ |
Willy Tarreau | a3b62d3 | 2018-12-06 15:24:01 +0100 | [diff] [blame] | 83 | SI_FL_RXBLK_CONN = 0x00100000, /* other side is not connected */ |
| 84 | SI_FL_RXBLK_ANY = 0x001F0000, /* any of the RXBLK flags above */ |
| 85 | SI_FL_RX_WAIT_EP = 0x00200000, /* stream-int waits for more data from the end point */ |
Willy Tarreau | d7704b5 | 2008-09-04 11:51:16 +0200 | [diff] [blame] | 86 | }; |
| 87 | |
Willy Tarreau | d414f8e | 2015-04-06 11:43:45 +0200 | [diff] [blame] | 88 | /* A stream interface has 3 parts : |
| 89 | * - the buffer side, which interfaces to the buffers. |
| 90 | * - the remote side, which describes the state and address of the other side. |
| 91 | * - the functions, which are used by the buffer side to communicate with the |
| 92 | * remote side from the buffer side. |
| 93 | */ |
| 94 | |
| 95 | /* Note that if an applet is registered, the update function will not be called |
| 96 | * by the session handler, so it may be used to resync flags at the end of the |
Willy Tarreau | 14bfe9a | 2018-12-19 15:19:27 +0100 | [diff] [blame] | 97 | * applet handler. See si_update() for reference. |
Willy Tarreau | d414f8e | 2015-04-06 11:43:45 +0200 | [diff] [blame] | 98 | */ |
| 99 | struct stream_interface { |
| 100 | /* struct members used by the "buffer" side */ |
| 101 | enum si_state state; /* SI_ST* */ |
| 102 | enum si_state prev_state;/* SI_ST*, copy of previous state */ |
Willy Tarreau | a44e576 | 2018-11-14 10:53:42 +0100 | [diff] [blame] | 103 | /* 16-bit hole here */ |
| 104 | unsigned int flags; /* SI_FL_* */ |
Willy Tarreau | d414f8e | 2015-04-06 11:43:45 +0200 | [diff] [blame] | 105 | enum obj_type *end; /* points to the end point (connection or appctx) */ |
| 106 | struct si_ops *ops; /* general operations at the stream interface layer */ |
Willy Tarreau | a44e576 | 2018-11-14 10:53:42 +0100 | [diff] [blame] | 107 | unsigned int exp; /* wake up time for connect, queue, turn-around, ... */ |
Willy Tarreau | d414f8e | 2015-04-06 11:43:45 +0200 | [diff] [blame] | 108 | |
| 109 | /* struct members below are the "remote" part, as seen from the buffer side */ |
| 110 | unsigned int err_type; /* first error detected, one of SI_ET_* */ |
| 111 | int conn_retries; /* number of connect retries left */ |
Hongbo Long | e39683c | 2017-03-10 18:41:51 +0100 | [diff] [blame] | 112 | unsigned int hcto; /* half-closed timeout (0 = unset) */ |
Olivier Houchard | fa8aa86 | 2018-10-10 18:25:41 +0200 | [diff] [blame] | 113 | struct wait_event wait_event; /* We're in a wait list */ |
Willy Tarreau | d414f8e | 2015-04-06 11:43:45 +0200 | [diff] [blame] | 114 | }; |
| 115 | |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 116 | /* operations available on a stream-interface */ |
| 117 | struct si_ops { |
Willy Tarreau | 57f08bb | 2018-11-07 11:28:12 +0100 | [diff] [blame] | 118 | void (*chk_rcv)(struct stream_interface *); /* chk_rcv function, may not be null */ |
| 119 | void (*chk_snd)(struct stream_interface *); /* chk_snd function, may not be null */ |
| 120 | void (*shutr)(struct stream_interface *); /* shut read function, may not be null */ |
| 121 | void (*shutw)(struct stream_interface *); /* shut write function, may not be null */ |
Willy Tarreau | 060781f | 2012-05-07 16:50:03 +0200 | [diff] [blame] | 122 | }; |
| 123 | |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 124 | #endif /* _TYPES_STREAM_INTERFACE_H */ |
| 125 | |
| 126 | /* |
| 127 | * Local variables: |
| 128 | * c-indent-level: 8 |
| 129 | * c-basic-offset: 8 |
| 130 | * End: |
| 131 | */ |