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 | 4a36b56 | 2012-08-06 19:31:45 +0200 | [diff] [blame] | 39 | int stream_int_shutr(struct stream_interface *si); |
| 40 | int stream_int_shutw(struct stream_interface *si); |
Willy Tarreau | 9bf9c14 | 2012-08-20 15:38:41 +0200 | [diff] [blame] | 41 | void stream_sock_read0(struct stream_interface *si); |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 42 | |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 43 | extern struct si_ops si_embedded_ops; |
| 44 | extern struct si_ops si_task_ops; |
| 45 | extern struct si_ops si_conn_ops; |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 46 | extern struct data_cb si_conn_cb; |
Willy Tarreau | 5c979a9 | 2012-05-07 17:15:39 +0200 | [diff] [blame] | 47 | |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 48 | struct task *stream_int_register_handler(struct stream_interface *si, |
Willy Tarreau | b24281b | 2011-02-13 13:16:36 +0100 | [diff] [blame] | 49 | struct si_applet *app); |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 50 | struct task *stream_int_register_handler_task(struct stream_interface *si, |
| 51 | struct task *(*fct)(struct task *)); |
| 52 | void stream_int_unregister_handler(struct stream_interface *si); |
| 53 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 54 | static inline const struct protocol *si_ctrl(struct stream_interface *si) |
| 55 | { |
| 56 | return si->conn.ctrl; |
| 57 | } |
| 58 | |
Willy Tarreau | fb7508a | 2012-05-21 16:47:54 +0200 | [diff] [blame] | 59 | static inline int si_fd(struct stream_interface *si) |
| 60 | { |
| 61 | return si->conn.t.sock.fd; |
| 62 | } |
| 63 | |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 64 | 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] | 65 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 66 | si->ops = &si_conn_ops; |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 67 | conn_prepare(&si->conn, &si_conn_cb, ctrl, xprt, si); |
Willy Tarreau | 5c979a9 | 2012-05-07 17:15:39 +0200 | [diff] [blame] | 68 | } |
| 69 | |
Willy Tarreau | bd99aab | 2012-10-02 20:57:19 +0200 | [diff] [blame] | 70 | static inline void si_takeover_conn(struct stream_interface *si, const struct protocol *ctrl, const struct xprt_ops *xprt) |
| 71 | { |
| 72 | si->ops = &si_conn_ops; |
| 73 | conn_assign(&si->conn, &si_conn_cb, ctrl, xprt, si); |
| 74 | } |
| 75 | |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 76 | static inline void si_prepare_embedded(struct stream_interface *si) |
| 77 | { |
| 78 | si->ops = &si_embedded_ops; |
Willy Tarreau | cd37995 | 2012-09-27 22:14:33 +0200 | [diff] [blame] | 79 | conn_prepare(&si->conn, NULL, NULL, NULL, si); |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 80 | } |
| 81 | |
| 82 | static inline void si_prepare_task(struct stream_interface *si) |
| 83 | { |
| 84 | si->ops = &si_task_ops; |
Willy Tarreau | cd37995 | 2012-09-27 22:14:33 +0200 | [diff] [blame] | 85 | conn_prepare(&si->conn, NULL, NULL, NULL, si); |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 86 | } |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 87 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 88 | /* Sends a shutr to the connection using the data layer */ |
| 89 | static inline void si_shutr(struct stream_interface *si) |
| 90 | { |
Willy Tarreau | 4a36b56 | 2012-08-06 19:31:45 +0200 | [diff] [blame] | 91 | if (stream_int_shutr(si)) |
Willy Tarreau | f9dabec | 2012-08-17 17:33:53 +0200 | [diff] [blame] | 92 | conn_data_stop_recv(&si->conn); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | /* Sends a shutw to the connection using the data layer */ |
| 96 | static inline void si_shutw(struct stream_interface *si) |
| 97 | { |
Willy Tarreau | 4a36b56 | 2012-08-06 19:31:45 +0200 | [diff] [blame] | 98 | if (stream_int_shutw(si)) |
Willy Tarreau | f9dabec | 2012-08-17 17:33:53 +0200 | [diff] [blame] | 99 | conn_data_stop_send(&si->conn); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | /* Calls the data state update on the stream interfaace */ |
| 103 | static inline void si_update(struct stream_interface *si) |
| 104 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 105 | si->ops->update(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 106 | } |
| 107 | |
| 108 | /* Calls chk_rcv on the connection using the data layer */ |
| 109 | static inline void si_chk_rcv(struct stream_interface *si) |
| 110 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 111 | si->ops->chk_rcv(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | /* Calls chk_snd on the connection using the data layer */ |
| 115 | static inline void si_chk_snd(struct stream_interface *si) |
| 116 | { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 117 | si->ops->chk_snd(si); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 118 | } |
| 119 | |
| 120 | /* Calls chk_snd on the connection using the ctrl layer */ |
| 121 | static inline int si_connect(struct stream_interface *si) |
| 122 | { |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 123 | int ret; |
| 124 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 125 | if (unlikely(!si_ctrl(si) || !si_ctrl(si)->connect)) |
| 126 | return SN_ERR_INTERNAL; |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 127 | |
| 128 | ret = si_ctrl(si)->connect(&si->conn, !channel_is_empty(si->ob)); |
| 129 | if (ret != SN_ERR_NONE) |
| 130 | return ret; |
| 131 | |
| 132 | /* needs src ip/port for logging */ |
| 133 | if (si->flags & SI_FL_SRC_ADDR) |
| 134 | conn_get_from_addr(&si->conn); |
| 135 | |
| 136 | /* Prepare to send a few handshakes related to the on-wire protocol. */ |
| 137 | if (si->send_proxy_ofs) |
| 138 | si->conn.flags |= CO_FL_SI_SEND_PROXY; |
| 139 | |
| 140 | /* we need to be notified about connection establishment */ |
Willy Tarreau | 4aa3683 | 2012-10-02 20:07:22 +0200 | [diff] [blame] | 141 | si->conn.flags |= CO_FL_WAKE_DATA; |
Willy Tarreau | 14f8e86 | 2012-08-30 22:23:13 +0200 | [diff] [blame] | 142 | |
| 143 | /* we're in the process of establishing a connection */ |
| 144 | si->state = SI_ST_CON; |
| 145 | |
| 146 | return ret; |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 147 | } |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 148 | |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 149 | #endif /* _PROTO_STREAM_INTERFACE_H */ |
| 150 | |
| 151 | /* |
| 152 | * Local variables: |
| 153 | * c-indent-level: 8 |
| 154 | * c-basic-offset: 8 |
| 155 | * End: |
| 156 | */ |