blob: 065b69bafd81601931b37810aa6f1bbeb1aec954 [file] [log] [blame]
Damien Miller5428f641999-11-25 11:54:57 +11001/*
2 * Copyright (c) 1999 Markus Friedl. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. All advertising materials mentioning features or use of this software
13 * must display the following acknowledgement:
14 * This product includes software developed by Markus Friedl.
15 * 4. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
Damien Millerd4a8b7e1999-10-27 13:42:43 +100030#include "includes.h"
Damien Miller5428f641999-11-25 11:54:57 +110031RCSID("$Id: nchan.c,v 1.3 1999/11/25 00:54:59 damien Exp $");
Damien Millerd4a8b7e1999-10-27 13:42:43 +100032
33#include "ssh.h"
34
35#include "buffer.h"
36#include "packet.h"
37#include "channels.h"
38#include "nchan.h"
39
40static void chan_send_ieof(Channel *c);
41static void chan_send_oclose(Channel *c);
42static void chan_shutdown_write(Channel *c);
43static void chan_shutdown_read(Channel *c);
44static void chan_delele_if_full_closed(Channel *c);
45
46/*
Damien Miller95def091999-11-25 00:26:21 +110047 * EVENTS update channel input/output states execute ACTIONS
Damien Millerd4a8b7e1999-10-27 13:42:43 +100048 */
Damien Miller95def091999-11-25 00:26:21 +110049
Damien Millerd4a8b7e1999-10-27 13:42:43 +100050/* events concerning the INPUT from socket for channel (istate) */
51void
Damien Miller95def091999-11-25 00:26:21 +110052chan_rcvd_oclose(Channel *c)
53{
54 switch (c->istate) {
Damien Millerd4a8b7e1999-10-27 13:42:43 +100055 case CHAN_INPUT_WAIT_OCLOSE:
56 debug("channel %d: INPUT_WAIT_OCLOSE -> INPUT_CLOSED [rcvd OCLOSE]", c->self);
Damien Miller95def091999-11-25 00:26:21 +110057 c->istate = CHAN_INPUT_CLOSED;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100058 chan_delele_if_full_closed(c);
59 break;
60 case CHAN_INPUT_OPEN:
61 debug("channel %d: INPUT_OPEN -> INPUT_CLOSED [rvcd OCLOSE, send IEOF]", c->self);
62 chan_shutdown_read(c);
63 chan_send_ieof(c);
Damien Miller95def091999-11-25 00:26:21 +110064 c->istate = CHAN_INPUT_CLOSED;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100065 chan_delele_if_full_closed(c);
66 break;
67 default:
Damien Miller95def091999-11-25 00:26:21 +110068 debug("protocol error: chan_rcvd_oclose %d for istate %d", c->self, c->istate);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100069 break;
70 }
71}
72void
Damien Miller95def091999-11-25 00:26:21 +110073chan_read_failed(Channel *c)
74{
75 switch (c->istate) {
Damien Millerd4a8b7e1999-10-27 13:42:43 +100076 case CHAN_INPUT_OPEN:
77 debug("channel %d: INPUT_OPEN -> INPUT_WAIT_DRAIN [read failed]", c->self);
78 chan_shutdown_read(c);
Damien Miller95def091999-11-25 00:26:21 +110079 c->istate = CHAN_INPUT_WAIT_DRAIN;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100080 break;
81 default:
82 debug("internal error: we do not read, but chan_read_failed %d for istate %d",
Damien Miller95def091999-11-25 00:26:21 +110083 c->self, c->istate);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100084 break;
85 }
86}
87void
Damien Miller95def091999-11-25 00:26:21 +110088chan_ibuf_empty(Channel *c)
89{
90 if (buffer_len(&c->input)) {
91 debug("internal error: chan_ibuf_empty %d for non empty buffer", c->self);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100092 return;
93 }
Damien Miller95def091999-11-25 00:26:21 +110094 switch (c->istate) {
Damien Millerd4a8b7e1999-10-27 13:42:43 +100095 case CHAN_INPUT_WAIT_DRAIN:
96 debug("channel %d: INPUT_WAIT_DRAIN -> INPUT_WAIT_OCLOSE [inbuf empty, send IEOF]", c->self);
97 chan_send_ieof(c);
Damien Miller95def091999-11-25 00:26:21 +110098 c->istate = CHAN_INPUT_WAIT_OCLOSE;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100099 break;
100 default:
Damien Miller95def091999-11-25 00:26:21 +1100101 debug("internal error: chan_ibuf_empty %d for istate %d", c->self, c->istate);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000102 break;
103 }
104}
Damien Miller95def091999-11-25 00:26:21 +1100105
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000106/* events concerning the OUTPUT from channel for socket (ostate) */
107void
Damien Miller95def091999-11-25 00:26:21 +1100108chan_rcvd_ieof(Channel *c)
109{
110 switch (c->ostate) {
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000111 case CHAN_OUTPUT_OPEN:
112 debug("channel %d: OUTPUT_OPEN -> OUTPUT_WAIT_DRAIN [rvcd IEOF]", c->self);
Damien Miller95def091999-11-25 00:26:21 +1100113 c->ostate = CHAN_OUTPUT_WAIT_DRAIN;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000114 break;
115 case CHAN_OUTPUT_WAIT_IEOF:
116 debug("channel %d: OUTPUT_WAIT_IEOF -> OUTPUT_CLOSED [rvcd IEOF]", c->self);
Damien Miller95def091999-11-25 00:26:21 +1100117 c->ostate = CHAN_OUTPUT_CLOSED;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000118 chan_delele_if_full_closed(c);
119 break;
120 default:
Damien Miller95def091999-11-25 00:26:21 +1100121 debug("protocol error: chan_rcvd_ieof %d for ostate %d", c->self, c->ostate);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000122 break;
123 }
124}
125void
Damien Miller95def091999-11-25 00:26:21 +1100126chan_write_failed(Channel *c)
127{
128 switch (c->ostate) {
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000129 case CHAN_OUTPUT_OPEN:
130 debug("channel %d: OUTPUT_OPEN -> OUTPUT_WAIT_IEOF [write failed]", c->self);
131 chan_send_oclose(c);
Damien Miller95def091999-11-25 00:26:21 +1100132 c->ostate = CHAN_OUTPUT_WAIT_IEOF;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000133 break;
134 case CHAN_OUTPUT_WAIT_DRAIN:
135 debug("channel %d: OUTPUT_WAIT_DRAIN -> OUTPUT_CLOSED [write failed]", c->self);
136 chan_send_oclose(c);
Damien Miller95def091999-11-25 00:26:21 +1100137 c->ostate = CHAN_OUTPUT_CLOSED;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000138 chan_delele_if_full_closed(c);
139 break;
140 default:
Damien Miller95def091999-11-25 00:26:21 +1100141 debug("internal error: chan_write_failed %d for ostate %d", c->self, c->ostate);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000142 break;
143 }
144}
145void
Damien Miller95def091999-11-25 00:26:21 +1100146chan_obuf_empty(Channel *c)
147{
148 if (buffer_len(&c->output)) {
149 debug("internal error: chan_obuf_empty %d for non empty buffer", c->self);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000150 return;
151 }
Damien Miller95def091999-11-25 00:26:21 +1100152 switch (c->ostate) {
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000153 case CHAN_OUTPUT_WAIT_DRAIN:
154 debug("channel %d: OUTPUT_WAIT_DRAIN -> OUTPUT_CLOSED [obuf empty, send OCLOSE]", c->self);
155 chan_send_oclose(c);
Damien Miller95def091999-11-25 00:26:21 +1100156 c->ostate = CHAN_OUTPUT_CLOSED;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000157 chan_delele_if_full_closed(c);
158 break;
159 default:
Damien Miller95def091999-11-25 00:26:21 +1100160 debug("internal error: chan_obuf_empty %d for ostate %d", c->self, c->ostate);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000161 break;
162 }
163}
Damien Miller95def091999-11-25 00:26:21 +1100164
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000165/*
Damien Miller95def091999-11-25 00:26:21 +1100166 * ACTIONS: should never update the channel states: c->istate or c->ostate
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000167 */
168static void
Damien Miller95def091999-11-25 00:26:21 +1100169chan_send_ieof(Channel *c)
170{
171 switch (c->istate) {
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000172 case CHAN_INPUT_OPEN:
173 case CHAN_INPUT_WAIT_DRAIN:
174 packet_start(SSH_MSG_CHANNEL_INPUT_EOF);
175 packet_put_int(c->remote_id);
176 packet_send();
177 break;
178 default:
Damien Miller95def091999-11-25 00:26:21 +1100179 debug("internal error: channel %d: cannot send IEOF for istate %d", c->self, c->istate);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000180 break;
181 }
182}
183static void
Damien Miller95def091999-11-25 00:26:21 +1100184chan_send_oclose(Channel *c)
185{
186 switch (c->ostate) {
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000187 case CHAN_OUTPUT_OPEN:
188 case CHAN_OUTPUT_WAIT_DRAIN:
189 chan_shutdown_write(c);
190 buffer_consume(&c->output, buffer_len(&c->output));
191 packet_start(SSH_MSG_CHANNEL_OUTPUT_CLOSE);
192 packet_put_int(c->remote_id);
193 packet_send();
194 break;
195 default:
Damien Miller95def091999-11-25 00:26:21 +1100196 debug("internal error: channel %d: cannot send OCLOSE for ostate %d", c->self, c->istate);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000197 break;
198 }
199}
Damien Miller95def091999-11-25 00:26:21 +1100200
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000201/* helper */
202static void
Damien Miller95def091999-11-25 00:26:21 +1100203chan_shutdown_write(Channel *c)
204{
Damien Miller5428f641999-11-25 11:54:57 +1100205 /* shutdown failure is allowed if write failed already */
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000206 debug("channel %d: shutdown_write", c->self);
Damien Miller95def091999-11-25 00:26:21 +1100207 if (shutdown(c->sock, SHUT_WR) < 0)
Damien Miller5428f641999-11-25 11:54:57 +1100208 debug("chan_shutdown_write failed for #%d/fd%d: %.100s",
Damien Miller95def091999-11-25 00:26:21 +1100209 c->self, c->sock, strerror(errno));
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000210}
211static void
Damien Miller95def091999-11-25 00:26:21 +1100212chan_shutdown_read(Channel *c)
213{
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000214 debug("channel %d: shutdown_read", c->self);
Damien Miller95def091999-11-25 00:26:21 +1100215 if (shutdown(c->sock, SHUT_RD) < 0)
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000216 error("chan_shutdown_read failed for #%d/fd%d: %.100s",
Damien Miller95def091999-11-25 00:26:21 +1100217 c->self, c->sock, strerror(errno));
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000218}
219static void
Damien Miller95def091999-11-25 00:26:21 +1100220chan_delele_if_full_closed(Channel *c)
221{
222 if (c->istate == CHAN_INPUT_CLOSED && c->ostate == CHAN_OUTPUT_CLOSED) {
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000223 debug("channel %d: closing", c->self);
224 channel_free(c->self);
225 }
226}
227void
Damien Miller95def091999-11-25 00:26:21 +1100228chan_init_iostates(Channel *c)
229{
230 c->ostate = CHAN_OUTPUT_OPEN;
231 c->istate = CHAN_INPUT_OPEN;
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000232}