blob: c43ef57a192748b31a412cfb3040cc6f36b9779f [file] [log] [blame]
Willy Tarreaucff64112008-11-03 06:26:53 +01001/*
Willy Tarreau8e89b842009-10-18 23:56:35 +02002 * include/proto/stream_interface.h
3 * This file contains stream_interface function prototypes
4 *
Willy Tarreauf873d752012-05-11 17:47:17 +02005 * Copyright (C) 2000-2012 Willy Tarreau - w@1wt.eu
Willy Tarreau8e89b842009-10-18 23:56:35 +02006 *
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 Tarreaucff64112008-11-03 06:26:53 +010021
22#ifndef _PROTO_STREAM_INTERFACE_H
23#define _PROTO_STREAM_INTERFACE_H
24
25#include <stdlib.h>
26
27#include <common/config.h>
Willy Tarreau2c6be842012-07-06 17:12:34 +020028#include <types/session.h>
Willy Tarreaucff64112008-11-03 06:26:53 +010029#include <types/stream_interface.h>
Willy Tarreau14f8e862012-08-30 22:23:13 +020030#include <proto/channel.h>
Willy Tarreauf9dabec2012-08-17 17:33:53 +020031#include <proto/connection.h>
Willy Tarreaucff64112008-11-03 06:26:53 +010032
33
34/* main event functions used to move data between sockets and buffers */
Willy Tarreau269358d2009-09-20 20:14:49 +020035int stream_int_check_timeouts(struct stream_interface *si);
Willy Tarreaucff64112008-11-03 06:26:53 +010036void stream_int_report_error(struct stream_interface *si);
Willy Tarreaudded32d2008-11-30 19:48:07 +010037void stream_int_retnclose(struct stream_interface *si, const struct chunk *msg);
Willy Tarreau2c6be842012-07-06 17:12:34 +020038int conn_si_send_proxy(struct connection *conn, unsigned int flag);
Willy Tarreau4a36b562012-08-06 19:31:45 +020039int stream_int_shutr(struct stream_interface *si);
40int stream_int_shutw(struct stream_interface *si);
Willy Tarreau9bf9c142012-08-20 15:38:41 +020041void stream_sock_read0(struct stream_interface *si);
Willy Tarreaucff64112008-11-03 06:26:53 +010042
Willy Tarreauc5788912012-08-24 18:12:41 +020043extern struct si_ops si_embedded_ops;
Willy Tarreauc5788912012-08-24 18:12:41 +020044extern struct si_ops si_conn_ops;
Willy Tarreau74beec32012-10-03 00:41:04 +020045extern struct data_cb si_conn_cb;
Willy Tarreau5c979a92012-05-07 17:15:39 +020046
Willy Tarreaufb90d942009-09-05 20:57:35 +020047struct task *stream_int_register_handler(struct stream_interface *si,
Willy Tarreaub24281b2011-02-13 13:16:36 +010048 struct si_applet *app);
Willy Tarreaufb90d942009-09-05 20:57:35 +020049void stream_int_unregister_handler(struct stream_interface *si);
50
Willy Tarreau73b013b2012-05-21 16:31:45 +020051static inline const struct protocol *si_ctrl(struct stream_interface *si)
52{
Willy Tarreauf2943dc2012-10-26 20:10:28 +020053 return si->conn->ctrl;
Willy Tarreau73b013b2012-05-21 16:31:45 +020054}
55
Willy Tarreauf7bc57c2012-10-03 00:19:48 +020056static inline void si_prepare_conn(struct stream_interface *si, const struct protocol *ctrl, const struct xprt_ops *xprt)
Willy Tarreau5c979a92012-05-07 17:15:39 +020057{
Willy Tarreauc5788912012-08-24 18:12:41 +020058 si->ops = &si_conn_ops;
Willy Tarreauf2943dc2012-10-26 20:10:28 +020059 conn_prepare(si->conn, &si_conn_cb, ctrl, xprt, si);
Willy Tarreau5c979a92012-05-07 17:15:39 +020060}
61
Willy Tarreaubd99aab2012-10-02 20:57:19 +020062static inline void si_takeover_conn(struct stream_interface *si, const struct protocol *ctrl, const struct xprt_ops *xprt)
63{
64 si->ops = &si_conn_ops;
Willy Tarreauf2943dc2012-10-26 20:10:28 +020065 conn_assign(si->conn, &si_conn_cb, ctrl, xprt, si);
Willy Tarreaubd99aab2012-10-02 20:57:19 +020066}
67
Willy Tarreauc5788912012-08-24 18:12:41 +020068static inline void si_prepare_embedded(struct stream_interface *si)
69{
70 si->ops = &si_embedded_ops;
Willy Tarreauf2943dc2012-10-26 20:10:28 +020071 conn_prepare(si->conn, NULL, NULL, NULL, si);
Willy Tarreauc5788912012-08-24 18:12:41 +020072}
73
Willy Tarreau73b013b2012-05-21 16:31:45 +020074/* Sends a shutr to the connection using the data layer */
75static inline void si_shutr(struct stream_interface *si)
76{
Willy Tarreau4a36b562012-08-06 19:31:45 +020077 if (stream_int_shutr(si))
Willy Tarreauf2943dc2012-10-26 20:10:28 +020078 conn_data_stop_recv(si->conn);
Willy Tarreau73b013b2012-05-21 16:31:45 +020079}
80
81/* Sends a shutw to the connection using the data layer */
82static inline void si_shutw(struct stream_interface *si)
83{
Willy Tarreau4a36b562012-08-06 19:31:45 +020084 if (stream_int_shutw(si))
Willy Tarreauf2943dc2012-10-26 20:10:28 +020085 conn_data_stop_send(si->conn);
Willy Tarreau73b013b2012-05-21 16:31:45 +020086}
87
88/* Calls the data state update on the stream interfaace */
89static inline void si_update(struct stream_interface *si)
90{
Willy Tarreauc5788912012-08-24 18:12:41 +020091 si->ops->update(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +020092}
93
94/* Calls chk_rcv on the connection using the data layer */
95static inline void si_chk_rcv(struct stream_interface *si)
96{
Willy Tarreauc5788912012-08-24 18:12:41 +020097 si->ops->chk_rcv(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +020098}
99
100/* Calls chk_snd on the connection using the data layer */
101static inline void si_chk_snd(struct stream_interface *si)
102{
Willy Tarreauc5788912012-08-24 18:12:41 +0200103 si->ops->chk_snd(si);
Willy Tarreau73b013b2012-05-21 16:31:45 +0200104}
105
106/* Calls chk_snd on the connection using the ctrl layer */
107static inline int si_connect(struct stream_interface *si)
108{
Willy Tarreau14f8e862012-08-30 22:23:13 +0200109 int ret;
110
Willy Tarreau73b013b2012-05-21 16:31:45 +0200111 if (unlikely(!si_ctrl(si) || !si_ctrl(si)->connect))
112 return SN_ERR_INTERNAL;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200113
Willy Tarreauf0837b22012-11-24 10:24:27 +0100114 ret = si_ctrl(si)->connect(si->conn, !channel_is_empty(si->ob), !!si->send_proxy_ofs);
Willy Tarreau14f8e862012-08-30 22:23:13 +0200115 if (ret != SN_ERR_NONE)
116 return ret;
117
118 /* needs src ip/port for logging */
119 if (si->flags & SI_FL_SRC_ADDR)
Willy Tarreauf2943dc2012-10-26 20:10:28 +0200120 conn_get_from_addr(si->conn);
Willy Tarreau14f8e862012-08-30 22:23:13 +0200121
122 /* Prepare to send a few handshakes related to the on-wire protocol. */
123 if (si->send_proxy_ofs)
Willy Tarreauf2943dc2012-10-26 20:10:28 +0200124 si->conn->flags |= CO_FL_SI_SEND_PROXY;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200125
126 /* we need to be notified about connection establishment */
Willy Tarreauf2943dc2012-10-26 20:10:28 +0200127 si->conn->flags |= CO_FL_WAKE_DATA;
Willy Tarreau14f8e862012-08-30 22:23:13 +0200128
129 /* we're in the process of establishing a connection */
130 si->state = SI_ST_CON;
131
132 return ret;
Willy Tarreau73b013b2012-05-21 16:31:45 +0200133}
Willy Tarreau59b94792012-05-11 16:16:40 +0200134
Willy Tarreau55e4ecd2012-12-08 17:48:47 +0100135/* for debugging, reports the stream interface state name */
136static inline const char *si_state_str(int state)
137{
138 switch (state) {
139 case SI_ST_INI: return "INI";
140 case SI_ST_REQ: return "REQ";
141 case SI_ST_QUE: return "QUE";
142 case SI_ST_TAR: return "TAR";
143 case SI_ST_ASS: return "ASS";
144 case SI_ST_CON: return "CON";
145 case SI_ST_CER: return "CER";
146 case SI_ST_EST: return "EST";
147 case SI_ST_DIS: return "DIS";
148 case SI_ST_CLO: return "CLO";
149 default: return "???";
150 }
151}
152
Willy Tarreaucff64112008-11-03 06:26:53 +0100153#endif /* _PROTO_STREAM_INTERFACE_H */
154
155/*
156 * Local variables:
157 * c-indent-level: 8
158 * c-basic-offset: 8
159 * End:
160 */