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