1 /* 2 * include/types/stream_interface.h 3 * This file describes the stream_interface struct and associated constants. 4 * 5 * Copyright (C) 2000-2014 Willy Tarreau - w@1wt.eu 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 */ 21 22 #ifndef _TYPES_STREAM_INTERFACE_H 23 #define _TYPES_STREAM_INTERFACE_H 24 25 #include <types/obj_type.h> 26 #include <common/config.h> 27 28 /* A stream interface must have its own errors independently of the buffer's, 29 * so that applications can rely on what the buffer reports while the stream 30 * interface is performing some retries (eg: connection error). Some states are 31 * transient and do not last beyond process_session(). 32 */ 33 enum si_state { 34 SI_ST_INI = 0, /* interface not sollicitated yet */ 35 SI_ST_REQ, /* [transient] connection initiation desired and not started yet */ 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) */ 40 SI_ST_CER, /* [transient] previous connection attempt failed (resource released) */ 41 SI_ST_EST, /* connection established (resource exists) */ 42 SI_ST_DIS, /* [transient] disconnected from other side, but cleanup not done yet */ 43 SI_ST_CLO, /* stream intf closed, might not existing anymore. Buffers shut. */ 44 } __attribute__((packed)); 45 46 /* error types reported on the streams interface for more accurate reporting */ 47 enum { 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) */ 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 */ 60 }; 61 62 /* flags set after I/O (32 bit) */ 63 enum { 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 */ 67 SI_FL_KILL_CONN = 0x00000004, /* next shutw must kill the whole conn, not just the stream */ 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 */ 75 /* unused: 0x00000200 */ 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 */ 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 */ 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 */ 86 }; 87 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 97 * applet handler. See si_update() for reference. 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 */ 103 /* 16-bit hole here */ 104 unsigned int flags; /* SI_FL_* */ 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 */ 107 unsigned int exp; /* wake up time for connect, queue, turn-around, ... */ 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 */ 112 unsigned int hcto; /* half-closed timeout (0 = unset) */ 113 struct wait_event wait_event; /* We're in a wait list */ 114 }; 115 116 /* operations available on a stream-interface */ 117 struct si_ops { 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 */ 122 }; 123 124 #endif /* _TYPES_STREAM_INTERFACE_H */ 125 126 /* 127 * Local variables: 128 * c-indent-level: 8 129 * c-basic-offset: 8 130 * End: 131 */ 132