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 | ee28de0 | 2010-06-01 09:51:00 +0200 | [diff] [blame] | 5 | * Copyright (C) 2000-2010 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 | |
| 25 | #include <stdlib.h> |
Emeric Brun | 129c590 | 2010-01-04 14:47:58 +0100 | [diff] [blame] | 26 | #include <sys/socket.h> |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 27 | |
Willy Tarreau | 48adac5 | 2008-08-30 04:58:38 +0200 | [diff] [blame] | 28 | #include <types/buffers.h> |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 29 | #include <common/config.h> |
| 30 | |
| 31 | /* A stream interface must have its own errors independantly of the buffer's, |
| 32 | * 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] | 33 | * interface is performing some retries (eg: connection error). Some states are |
| 34 | * transient and do not last beyond process_session(). |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 35 | */ |
| 36 | enum { |
Willy Tarreau | efb453c | 2008-10-26 20:49:47 +0100 | [diff] [blame] | 37 | SI_ST_INI = 0, /* interface not sollicitated yet */ |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 38 | SI_ST_REQ, /* [transient] connection initiation desired and not started yet */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 39 | SI_ST_QUE, /* interface waiting in queue */ |
| 40 | SI_ST_TAR, /* interface in turn-around state after failed connect attempt */ |
| 41 | SI_ST_ASS, /* server just assigned to this interface */ |
| 42 | SI_ST_CON, /* initiated connection request (resource exists) */ |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 43 | SI_ST_CER, /* [transient] previous connection attempt failed (resource released) */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 44 | SI_ST_EST, /* connection established (resource exists) */ |
Willy Tarreau | 74ab2ac | 2008-11-23 17:23:07 +0100 | [diff] [blame] | 45 | 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] | 46 | SI_ST_CLO, /* stream intf closed, might not existing anymore. Buffers shut. */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 47 | }; |
| 48 | |
| 49 | /* error types reported on the streams interface for more accurate reporting */ |
| 50 | enum { |
Willy Tarreau | e5ed406 | 2008-08-30 03:17:31 +0200 | [diff] [blame] | 51 | SI_ET_NONE = 0x0000, /* no error yet, leave it to zero */ |
| 52 | SI_ET_QUEUE_TO = 0x0001, /* queue timeout */ |
| 53 | SI_ET_QUEUE_ERR = 0x0002, /* queue error (eg: full) */ |
| 54 | SI_ET_QUEUE_ABRT = 0x0004, /* aborted in queue by external cause */ |
| 55 | SI_ET_CONN_TO = 0x0008, /* connection timeout */ |
| 56 | SI_ET_CONN_ERR = 0x0010, /* connection error (eg: no server available) */ |
| 57 | SI_ET_CONN_ABRT = 0x0020, /* connection aborted by external cause (eg: abort) */ |
| 58 | SI_ET_CONN_OTHER = 0x0040, /* connection aborted for other reason (eg: 500) */ |
| 59 | SI_ET_DATA_TO = 0x0080, /* timeout during data phase */ |
| 60 | SI_ET_DATA_ERR = 0x0100, /* error during data phase */ |
| 61 | SI_ET_DATA_ABRT = 0x0200, /* data phase aborted by external cause */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 62 | }; |
| 63 | |
Willy Tarreau | d7704b5 | 2008-09-04 11:51:16 +0200 | [diff] [blame] | 64 | /* flags set after I/O */ |
| 65 | enum { |
| 66 | SI_FL_NONE = 0x0000, /* nothing */ |
| 67 | SI_FL_EXP = 0x0001, /* timeout has expired */ |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 68 | SI_FL_ERR = 0x0002, /* a non-recoverable error has occurred */ |
Willy Tarreau | b0ef735 | 2008-12-14 13:26:20 +0100 | [diff] [blame] | 69 | SI_FL_WAIT_ROOM = 0x0004, /* waiting for space to store incoming data */ |
| 70 | SI_FL_WAIT_DATA = 0x0008, /* waiting for more data to send */ |
Willy Tarreau | dc340a9 | 2009-06-28 23:10:19 +0200 | [diff] [blame] | 71 | SI_FL_CAP_SPLTCP = 0x0010, /* splicing possible from/to TCP */ |
Willy Tarreau | 89f7ef2 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 72 | SI_FL_DONT_WAKE = 0x0020, /* resync in progress, don't wake up */ |
Willy Tarreau | f27b5ea | 2009-10-03 22:01:18 +0200 | [diff] [blame] | 73 | SI_FL_INDEP_STR = 0x0040, /* independant streams = don't update rex on write */ |
Willy Tarreau | 4c283dc | 2009-12-29 14:36:34 +0100 | [diff] [blame] | 74 | SI_FL_NOLINGER = 0x0080, /* may close without lingering. One-shot. */ |
Willy Tarreau | d7704b5 | 2008-09-04 11:51:16 +0200 | [diff] [blame] | 75 | }; |
| 76 | |
Willy Tarreau | dc340a9 | 2009-06-28 23:10:19 +0200 | [diff] [blame] | 77 | #define SI_FL_CAP_SPLICE (SI_FL_CAP_SPLTCP) |
| 78 | |
Willy Tarreau | 9650f37 | 2009-08-16 14:02:45 +0200 | [diff] [blame] | 79 | struct server; |
| 80 | struct proxy; |
| 81 | |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 82 | /* Note that if an iohandler is set, the update function will not be called by |
| 83 | * the session handler, so it may be used to resync flags at the end of the I/O |
| 84 | * handler. See stream_int_update_embedded() for reference. |
Willy Tarreau | ee28de0 | 2010-06-01 09:51:00 +0200 | [diff] [blame] | 85 | * This struct could be optimized, because : |
| 86 | * - connect(), fd, conn_retries are only used in stream_sock mode |
| 87 | * - iohandler(), private, st0, st1 are only used in iohandler mode |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 88 | */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 89 | struct stream_interface { |
| 90 | unsigned int state; /* SI_ST* */ |
Willy Tarreau | e5ed406 | 2008-08-30 03:17:31 +0200 | [diff] [blame] | 91 | unsigned int prev_state;/* SI_ST*, copy of previous state */ |
| 92 | void *owner; /* generally a (struct task*) */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 93 | int fd; /* file descriptor for a stream driver when known */ |
Willy Tarreau | dc340a9 | 2009-06-28 23:10:19 +0200 | [diff] [blame] | 94 | unsigned int flags; |
Willy Tarreau | 3537467 | 2008-09-03 18:11:02 +0200 | [diff] [blame] | 95 | unsigned int exp; /* wake up time for connect, queue, turn-around, ... */ |
Willy Tarreau | b029f8c | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 96 | void (*update)(struct stream_interface *); /* I/O update function */ |
Willy Tarreau | 0a5d5dd | 2008-11-23 19:31:35 +0100 | [diff] [blame] | 97 | void (*shutr)(struct stream_interface *); /* shutr function */ |
| 98 | void (*shutw)(struct stream_interface *); /* shutw function */ |
Willy Tarreau | 3ffeba1 | 2008-12-14 14:42:35 +0100 | [diff] [blame] | 99 | void (*chk_rcv)(struct stream_interface *);/* chk_rcv function */ |
| 100 | void (*chk_snd)(struct stream_interface *);/* chk_snd function */ |
Willy Tarreau | dc85b39 | 2009-08-18 07:38:19 +0200 | [diff] [blame] | 101 | int (*connect)(struct stream_interface *, struct proxy *, struct server *, |
| 102 | struct sockaddr *, struct sockaddr *); /* connect function if any */ |
Willy Tarreau | b029f8c | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 103 | void (*iohandler)(struct stream_interface *); /* internal I/O handler when embedded */ |
Willy Tarreau | 48adac5 | 2008-08-30 04:58:38 +0200 | [diff] [blame] | 104 | struct buffer *ib, *ob; /* input and output buffers */ |
Willy Tarreau | ee28de0 | 2010-06-01 09:51:00 +0200 | [diff] [blame] | 105 | int conn_retries; /* number of connect retries left */ |
Willy Tarreau | e5ed406 | 2008-08-30 03:17:31 +0200 | [diff] [blame] | 106 | unsigned int err_type; /* first error detected, one of SI_ET_* */ |
| 107 | void *err_loc; /* commonly the server, NULL when SI_ET_NONE */ |
Willy Tarreau | eecc8ee | 2009-09-20 21:43:50 +0200 | [diff] [blame] | 108 | void *private; /* may be used by any function above */ |
| 109 | unsigned int st0, st1; /* may be used by any function above */ |
Willy Tarreau | fa7e102 | 2008-10-19 07:30:41 +0200 | [diff] [blame] | 110 | }; |
| 111 | |
| 112 | |
| 113 | #endif /* _TYPES_STREAM_INTERFACE_H */ |
| 114 | |
| 115 | /* |
| 116 | * Local variables: |
| 117 | * c-indent-level: 8 |
| 118 | * c-basic-offset: 8 |
| 119 | * End: |
| 120 | */ |