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 | f9dabec | 2012-08-17 17:33:53 +0200 | [diff] [blame] | 30 | #include <proto/connection.h> |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 31 | |
| 32 | |
| 33 | /* main event functions used to move data between sockets and buffers */ |
Willy Tarreau | 269358d | 2009-09-20 20:14:49 +0200 | [diff] [blame] | 34 | int stream_int_check_timeouts(struct stream_interface *si); |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 35 | void stream_int_report_error(struct stream_interface *si); |
Willy Tarreau | dded32d | 2008-11-30 19:48:07 +0100 | [diff] [blame] | 36 | void stream_int_retnclose(struct stream_interface *si, const struct chunk *msg); |
Willy Tarreau | 2c6be84 | 2012-07-06 17:12:34 +0200 | [diff] [blame] | 37 | int conn_si_send_proxy(struct connection *conn, unsigned int flag); |
Willy Tarreau | 100c467 | 2012-08-20 12:06:26 +0200 | [diff] [blame] | 38 | void conn_notify_si(struct connection *conn); |
| 39 | void stream_int_update_conn(struct stream_interface *si); |
Willy Tarreau | 4a36b56 | 2012-08-06 19:31:45 +0200 | [diff] [blame] | 40 | int stream_int_shutr(struct stream_interface *si); |
| 41 | int stream_int_shutw(struct stream_interface *si); |
Willy Tarreau | 46a8d92 | 2012-08-20 12:38:36 +0200 | [diff] [blame^] | 42 | void stream_int_chk_rcv_conn(struct stream_interface *si); |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 43 | |
Willy Tarreau | 5c979a9 | 2012-05-07 17:15:39 +0200 | [diff] [blame] | 44 | extern struct sock_ops stream_int_embedded; |
| 45 | extern struct sock_ops stream_int_task; |
| 46 | |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 47 | struct task *stream_int_register_handler(struct stream_interface *si, |
Willy Tarreau | b24281b | 2011-02-13 13:16:36 +0100 | [diff] [blame] | 48 | struct si_applet *app); |
Willy Tarreau | fb90d94 | 2009-09-05 20:57:35 +0200 | [diff] [blame] | 49 | struct task *stream_int_register_handler_task(struct stream_interface *si, |
| 50 | struct task *(*fct)(struct task *)); |
| 51 | void stream_int_unregister_handler(struct stream_interface *si); |
| 52 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 53 | static inline const struct protocol *si_ctrl(struct stream_interface *si) |
| 54 | { |
| 55 | return si->conn.ctrl; |
| 56 | } |
| 57 | |
| 58 | static inline const struct sock_ops *si_data(struct stream_interface *si) |
| 59 | { |
| 60 | return si->conn.data; |
| 61 | } |
| 62 | |
Willy Tarreau | fb7508a | 2012-05-21 16:47:54 +0200 | [diff] [blame] | 63 | static inline int si_fd(struct stream_interface *si) |
| 64 | { |
| 65 | return si->conn.t.sock.fd; |
| 66 | } |
| 67 | |
Willy Tarreau | 9e000c6 | 2011-03-10 14:03:36 +0100 | [diff] [blame] | 68 | static inline void clear_target(struct target *dest) |
| 69 | { |
| 70 | dest->type = TARG_TYPE_NONE; |
| 71 | dest->ptr.v = NULL; |
| 72 | } |
| 73 | |
Emeric Brun | 21adb02 | 2012-05-18 16:32:13 +0200 | [diff] [blame] | 74 | static inline void set_target_client(struct target *dest, struct listener *l) |
Willy Tarreau | 1539a01 | 2012-05-11 14:47:34 +0200 | [diff] [blame] | 75 | { |
| 76 | dest->type = TARG_TYPE_CLIENT; |
Emeric Brun | 21adb02 | 2012-05-18 16:32:13 +0200 | [diff] [blame] | 77 | dest->ptr.l = l; |
Willy Tarreau | 1539a01 | 2012-05-11 14:47:34 +0200 | [diff] [blame] | 78 | } |
| 79 | |
Willy Tarreau | 9e000c6 | 2011-03-10 14:03:36 +0100 | [diff] [blame] | 80 | static inline void set_target_server(struct target *dest, struct server *s) |
| 81 | { |
| 82 | dest->type = TARG_TYPE_SERVER; |
| 83 | dest->ptr.s = s; |
| 84 | } |
| 85 | |
| 86 | static inline void set_target_proxy(struct target *dest, struct proxy *p) |
| 87 | { |
| 88 | dest->type = TARG_TYPE_PROXY; |
| 89 | dest->ptr.p = p; |
| 90 | } |
| 91 | |
| 92 | static inline void set_target_applet(struct target *dest, struct si_applet *a) |
| 93 | { |
| 94 | dest->type = TARG_TYPE_APPLET; |
| 95 | dest->ptr.a = a; |
| 96 | } |
| 97 | |
| 98 | static inline void set_target_task(struct target *dest, struct task *t) |
| 99 | { |
| 100 | dest->type = TARG_TYPE_TASK; |
| 101 | dest->ptr.t = t; |
| 102 | } |
| 103 | |
| 104 | static inline struct target *copy_target(struct target *dest, struct target *src) |
| 105 | { |
| 106 | *dest = *src; |
| 107 | return dest; |
| 108 | } |
| 109 | |
| 110 | static inline int target_match(struct target *a, struct target *b) |
| 111 | { |
| 112 | return a->type == b->type && a->ptr.v == b->ptr.v; |
| 113 | } |
| 114 | |
Willy Tarreau | 827aee9 | 2011-03-10 16:55:02 +0100 | [diff] [blame] | 115 | static inline struct server *target_srv(struct target *t) |
| 116 | { |
| 117 | if (!t || t->type != TARG_TYPE_SERVER) |
| 118 | return NULL; |
| 119 | return t->ptr.s; |
| 120 | } |
| 121 | |
Emeric Brun | 21adb02 | 2012-05-18 16:32:13 +0200 | [diff] [blame] | 122 | static inline struct listener *target_client(struct target *t) |
| 123 | { |
| 124 | if (!t || t->type != TARG_TYPE_CLIENT) |
| 125 | return NULL; |
| 126 | return t->ptr.l; |
| 127 | } |
| 128 | |
Willy Tarreau | 5c979a9 | 2012-05-07 17:15:39 +0200 | [diff] [blame] | 129 | static inline void stream_interface_prepare(struct stream_interface *si, const struct sock_ops *ops) |
| 130 | { |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 131 | si->conn.data = ops; |
Willy Tarreau | 9498113 | 2012-05-21 17:09:48 +0200 | [diff] [blame] | 132 | si->conn.data_st = 0; |
| 133 | si->conn.data_ctx = NULL; |
Willy Tarreau | 5c979a9 | 2012-05-07 17:15:39 +0200 | [diff] [blame] | 134 | } |
| 135 | |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 136 | |
| 137 | /* Retrieves the source address for the stream interface. */ |
| 138 | static inline void si_get_from_addr(struct stream_interface *si) |
| 139 | { |
| 140 | if (si->flags & SI_FL_FROM_SET) |
| 141 | return; |
| 142 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 143 | if (!si_ctrl(si) || !si_ctrl(si)->get_src) |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 144 | return; |
| 145 | |
Willy Tarreau | fb7508a | 2012-05-21 16:47:54 +0200 | [diff] [blame] | 146 | if (si_ctrl(si)->get_src(si_fd(si), (struct sockaddr *)&si->addr.from, |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 147 | sizeof(si->addr.from), |
| 148 | si->target.type != TARG_TYPE_CLIENT) == -1) |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 149 | return; |
| 150 | si->flags |= SI_FL_FROM_SET; |
| 151 | } |
| 152 | |
| 153 | /* Retrieves the original destination address for the stream interface. */ |
| 154 | static inline void si_get_to_addr(struct stream_interface *si) |
| 155 | { |
| 156 | if (si->flags & SI_FL_TO_SET) |
| 157 | return; |
| 158 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 159 | if (!si_ctrl(si) || !si_ctrl(si)->get_dst) |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 160 | return; |
| 161 | |
Willy Tarreau | fb7508a | 2012-05-21 16:47:54 +0200 | [diff] [blame] | 162 | if (si_ctrl(si)->get_dst(si_fd(si), (struct sockaddr *)&si->addr.to, |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 163 | sizeof(si->addr.to), |
| 164 | si->target.type != TARG_TYPE_CLIENT) == -1) |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 165 | return; |
| 166 | si->flags |= SI_FL_TO_SET; |
| 167 | } |
| 168 | |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 169 | /* Sends a shutr to the connection using the data layer */ |
| 170 | static inline void si_shutr(struct stream_interface *si) |
| 171 | { |
Willy Tarreau | 4a36b56 | 2012-08-06 19:31:45 +0200 | [diff] [blame] | 172 | if (stream_int_shutr(si)) |
Willy Tarreau | f9dabec | 2012-08-17 17:33:53 +0200 | [diff] [blame] | 173 | conn_data_stop_recv(&si->conn); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | /* Sends a shutw to the connection using the data layer */ |
| 177 | static inline void si_shutw(struct stream_interface *si) |
| 178 | { |
Willy Tarreau | 4a36b56 | 2012-08-06 19:31:45 +0200 | [diff] [blame] | 179 | if (stream_int_shutw(si)) |
Willy Tarreau | f9dabec | 2012-08-17 17:33:53 +0200 | [diff] [blame] | 180 | conn_data_stop_send(&si->conn); |
Willy Tarreau | 73b013b | 2012-05-21 16:31:45 +0200 | [diff] [blame] | 181 | } |
| 182 | |
| 183 | /* Calls the data state update on the stream interfaace */ |
| 184 | static inline void si_update(struct stream_interface *si) |
| 185 | { |
| 186 | si_data(si)->update(si); |
| 187 | } |
| 188 | |
| 189 | /* Calls chk_rcv on the connection using the data layer */ |
| 190 | static inline void si_chk_rcv(struct stream_interface *si) |
| 191 | { |
| 192 | si_data(si)->chk_rcv(si); |
| 193 | } |
| 194 | |
| 195 | /* Calls chk_snd on the connection using the data layer */ |
| 196 | static inline void si_chk_snd(struct stream_interface *si) |
| 197 | { |
| 198 | si_data(si)->chk_snd(si); |
| 199 | } |
| 200 | |
| 201 | /* Calls chk_snd on the connection using the ctrl layer */ |
| 202 | static inline int si_connect(struct stream_interface *si) |
| 203 | { |
| 204 | if (unlikely(!si_ctrl(si) || !si_ctrl(si)->connect)) |
| 205 | return SN_ERR_INTERNAL; |
| 206 | return si_ctrl(si)->connect(si); |
| 207 | } |
Willy Tarreau | 59b9479 | 2012-05-11 16:16:40 +0200 | [diff] [blame] | 208 | |
Willy Tarreau | cff6411 | 2008-11-03 06:26:53 +0100 | [diff] [blame] | 209 | #endif /* _PROTO_STREAM_INTERFACE_H */ |
| 210 | |
| 211 | /* |
| 212 | * Local variables: |
| 213 | * c-indent-level: 8 |
| 214 | * c-basic-offset: 8 |
| 215 | * End: |
| 216 | */ |