Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 1 | /* |
Willy Tarreau | 8e89b84 | 2009-10-18 23:56:35 +0200 | [diff] [blame] | 2 | * include/proto/stream_interface.h |
| 3 | * This file contains stream_interface function prototypes |
| 4 | * |
Willy Tarreau | f873d75 | 2012-05-11 17:47:17 +0200 | [diff] [blame] | 5 | * Copyright (C) 2000-2012 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 8e89b84 | 2009-10-18 23:56:35 +0200 | [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 | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 21 | |
| 22 | #ifndef _PROTO_STREAM_INTERFACE_H |
| 23 | #define _PROTO_STREAM_INTERFACE_H |
| 24 | |
| 25 | #include <stdlib.h> |
| 26 | |
| 27 | #include <common/config.h> |
Willy Tarreau | 2c6be84 | 2012-07-06 17:12:34 +0200 | [diff] [blame] | 28 | #include <types/session.h> |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 29 | #include <types/stream_interface.h> |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 30 | #include <proto/channel.h> |
Willy Tarreau | f9dabec | 2012-08-17 17:33:53 +0200 | [diff] [blame] | 31 | #include <proto/connection.h> |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 32 | |
| 33 | |
| 34 | /* main event functions used to move data between sockets and buffers */ |
Willy Tarreau | 269358d | 2009-09-20 20:14:49 +0200 | [diff] [blame] | 35 | int stream_int_check_timeouts(struct stream_interface *si); |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 36 | void stream_int_report_error(struct stream_interface *si); |
Willy Tarreau | dded32d | 2008-11-30 19:48:07 +0100 | [diff] [blame] | 37 | void stream_int_retnclose(struct stream_interface *si, const struct chunk *msg); |
Willy Tarreau | 2c6be84 | 2012-07-06 17:12:34 +0200 | [diff] [blame] | 38 | int conn_si_send_proxy(struct connection *conn, unsigned int flag); |
Willy Tarreau | 9bf9c14 | 2012-08-20 15:38:41 +0200 | [diff] [blame] | 39 | void stream_sock_read0(struct stream_interface *si); |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 40 | |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 41 | extern struct si_ops si_embedded_ops; |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 42 | extern struct si_ops si_conn_ops; |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 43 | extern struct data_cb si_conn_cb; |
Willy Tarreau | 5c979a9 | 2012-05-07 17:15:39 +0200 | [diff] [blame] | 44 | |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 45 | struct task *stream_int_register_handler(struct stream_interface *si, |
Willy Tarreau | b24281b | 2011-02-13 13:16:36 +0100 | [diff] [blame] | 46 | struct si_applet *app); |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 47 | void stream_int_unregister_handler(struct stream_interface *si); |
| 48 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 49 | static inline const struct protocol *si_ctrl(struct stream_interface *si) |
| 50 | { |
Willy Tarreau | f2943dc | 2012-10-26 20:10:28 +0200 | [diff] [blame] | 51 | return si->conn->ctrl; |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 52 | } |
| 53 | |
Willy Tarreau | 372d670 | 2013-09-29 17:19:56 +0200 | [diff] [blame^] | 54 | static inline void si_prepare_none(struct stream_interface *si) |
| 55 | { |
| 56 | si->ops = &si_embedded_ops; |
| 57 | conn_prepare(si->conn, NULL, NULL, NULL, si); |
| 58 | si->conn->target = NULL; |
| 59 | } |
| 60 | |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 61 | static inline void si_prepare_conn(struct stream_interface *si, const struct protocol *ctrl, const struct xprt_ops *xprt) |
Willy Tarreau | 5c979a9 | 2012-05-07 17:15:39 +0200 | [diff] [blame] | 62 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 63 | si->ops = &si_conn_ops; |
Willy Tarreau | f2943dc | 2012-10-26 20:10:28 +0200 | [diff] [blame] | 64 | conn_prepare(si->conn, &si_conn_cb, ctrl, xprt, si); |
Willy Tarreau | 5c979a9 | 2012-05-07 17:15:39 +0200 | [diff] [blame] | 65 | } |
| 66 | |
Willy Tarreau | bd99aab | 2012-10-02 20:57:19 +0200 | [diff] [blame] | 67 | static inline void si_takeover_conn(struct stream_interface *si, const struct protocol *ctrl, const struct xprt_ops *xprt) |
| 68 | { |
| 69 | si->ops = &si_conn_ops; |
Willy Tarreau | f2943dc | 2012-10-26 20:10:28 +0200 | [diff] [blame] | 70 | conn_assign(si->conn, &si_conn_cb, ctrl, xprt, si); |
Willy Tarreau | bd99aab | 2012-10-02 20:57:19 +0200 | [diff] [blame] | 71 | } |
| 72 | |
Willy Tarreau | 372d670 | 2013-09-29 17:19:56 +0200 | [diff] [blame^] | 73 | static inline void si_prepare_applet(struct stream_interface *si, struct si_applet *applet) |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 74 | { |
| 75 | si->ops = &si_embedded_ops; |
Willy Tarreau | f2943dc | 2012-10-26 20:10:28 +0200 | [diff] [blame] | 76 | conn_prepare(si->conn, NULL, NULL, NULL, si); |
Willy Tarreau | 372d670 | 2013-09-29 17:19:56 +0200 | [diff] [blame^] | 77 | si->conn->target = &applet->obj_type; |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 78 | } |
| 79 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 80 | /* Sends a shutr to the connection using the data layer */ |
| 81 | static inline void si_shutr(struct stream_interface *si) |
| 82 | { |
Willy Tarreau | 6fe1541 | 2013-09-29 15:16:03 +0200 | [diff] [blame] | 83 | si->ops->shutr(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 84 | } |
| 85 | |
| 86 | /* Sends a shutw to the connection using the data layer */ |
| 87 | static inline void si_shutw(struct stream_interface *si) |
| 88 | { |
Willy Tarreau | 6fe1541 | 2013-09-29 15:16:03 +0200 | [diff] [blame] | 89 | si->ops->shutw(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | /* Calls the data state update on the stream interfaace */ |
| 93 | static inline void si_update(struct stream_interface *si) |
| 94 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 95 | si->ops->update(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 96 | } |
| 97 | |
| 98 | /* Calls chk_rcv on the connection using the data layer */ |
| 99 | static inline void si_chk_rcv(struct stream_interface *si) |
| 100 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 101 | si->ops->chk_rcv(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 102 | } |
| 103 | |
| 104 | /* Calls chk_snd on the connection using the data layer */ |
| 105 | static inline void si_chk_snd(struct stream_interface *si) |
| 106 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 107 | si->ops->chk_snd(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 108 | } |
| 109 | |
| 110 | /* Calls chk_snd on the connection using the ctrl layer */ |
| 111 | static inline int si_connect(struct stream_interface *si) |
| 112 | { |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 113 | int ret; |
| 114 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 115 | if (unlikely(!si_ctrl(si) || !si_ctrl(si)->connect)) |
| 116 | return SN_ERR_INTERNAL; |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 117 | |
Willy Tarreau | f0837b2 | 2012-11-24 10:24:27 +0100 | [diff] [blame] | 118 | ret = si_ctrl(si)->connect(si->conn, !channel_is_empty(si->ob), !!si->send_proxy_ofs); |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 119 | if (ret != SN_ERR_NONE) |
| 120 | return ret; |
| 121 | |
| 122 | /* needs src ip/port for logging */ |
| 123 | if (si->flags & SI_FL_SRC_ADDR) |
Willy Tarreau | f2943dc | 2012-10-26 20:10:28 +0200 | [diff] [blame] | 124 | conn_get_from_addr(si->conn); |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 125 | |
| 126 | /* Prepare to send a few handshakes related to the on-wire protocol. */ |
| 127 | if (si->send_proxy_ofs) |
Willy Tarreau | f2943dc | 2012-10-26 20:10:28 +0200 | [diff] [blame] | 128 | si->conn->flags |= CO_FL_SI_SEND_PROXY; |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 129 | |
| 130 | /* we need to be notified about connection establishment */ |
Willy Tarreau | f2943dc | 2012-10-26 20:10:28 +0200 | [diff] [blame] | 131 | si->conn->flags |= CO_FL_WAKE_DATA; |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 132 | |
| 133 | /* we're in the process of establishing a connection */ |
| 134 | si->state = SI_ST_CON; |
| 135 | |
| 136 | return ret; |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 137 | } |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 138 | |
Willy Tarreau | 55e4ecd | 2012-12-08 17:48:47 +0100 | [diff] [blame] | 139 | /* for debugging, reports the stream interface state name */ |
| 140 | static inline const char *si_state_str(int state) |
| 141 | { |
| 142 | switch (state) { |
| 143 | case SI_ST_INI: return "INI"; |
| 144 | case SI_ST_REQ: return "REQ"; |
| 145 | case SI_ST_QUE: return "QUE"; |
| 146 | case SI_ST_TAR: return "TAR"; |
| 147 | case SI_ST_ASS: return "ASS"; |
| 148 | case SI_ST_CON: return "CON"; |
| 149 | case SI_ST_CER: return "CER"; |
| 150 | case SI_ST_EST: return "EST"; |
| 151 | case SI_ST_DIS: return "DIS"; |
| 152 | case SI_ST_CLO: return "CLO"; |
| 153 | default: return "???"; |
| 154 | } |
| 155 | } |
| 156 | |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 157 | #endif /* _PROTO_STREAM_INTERFACE_H */ |
| 158 | |
| 159 | /* |
| 160 | * Local variables: |
| 161 | * c-indent-level: 8 |
| 162 | * c-basic-offset: 8 |
| 163 | * End: |
| 164 | */ |