[xfer] Implement xfer_vreopen() to properly handle redirections
[people/lynusvaz/gpxe.git] / src / core / open.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stdarg.h>
20 #include <string.h>
21 #include <errno.h>
22 #include <gpxe/xfer.h>
23 #include <gpxe/uri.h>
24 #include <gpxe/socket.h>
25 #include <gpxe/open.h>
26
27 /** @file
28  *
29  * Data transfer interface opening
30  *
31  */
32
33 /**
34  * Open URI
35  *
36  * @v xfer              Data transfer interface
37  * @v uri               URI
38  * @ret rc              Return status code
39  *
40  * The URI will be regarded as being relative to the current working
41  * URI (see churi()).
42  */
43 int xfer_open_uri ( struct xfer_interface *xfer, struct uri *uri ) {
44         struct uri_opener *opener;
45         struct uri *resolved_uri;
46         int rc = -ENOTSUP;
47
48         /* Resolve URI */
49         resolved_uri = resolve_uri ( cwuri, uri );
50         if ( ! resolved_uri )
51                 return -ENOMEM;
52
53         /* Find opener which supports this URI scheme */
54         for_each_table_entry ( opener, URI_OPENERS ) {
55                 if ( strcmp ( resolved_uri->scheme, opener->scheme ) == 0 ) {
56                         DBGC ( xfer, "XFER %p opening %s URI\n",
57                                xfer, opener->scheme );
58                         rc = opener->open ( xfer, resolved_uri );
59                         goto done;
60                 }
61         }
62         DBGC ( xfer, "XFER %p attempted to open unsupported URI scheme "
63                "\"%s\"\n", xfer, resolved_uri->scheme );
64
65  done:
66         uri_put ( resolved_uri );
67         return rc;
68 }
69
70 /**
71  * Open URI string
72  *
73  * @v xfer              Data transfer interface
74  * @v uri_string        URI string (e.g. "http://etherboot.org/kernel")
75  * @ret rc              Return status code
76  *
77  * The URI will be regarded as being relative to the current working
78  * URI (see churi()).
79  */
80 int xfer_open_uri_string ( struct xfer_interface *xfer,
81                            const char *uri_string ) {
82         struct uri *uri;
83         int rc;
84
85         DBGC ( xfer, "XFER %p opening URI %s\n", xfer, uri_string );
86
87         uri = parse_uri ( uri_string );
88         if ( ! uri )
89                 return -ENOMEM;
90
91         rc = xfer_open_uri ( xfer, uri );
92
93         uri_put ( uri );
94         return rc;
95 }
96
97 /**
98  * Open socket
99  *
100  * @v xfer              Data transfer interface
101  * @v semantics         Communication semantics (e.g. SOCK_STREAM)
102  * @v peer              Peer socket address
103  * @v local             Local socket address, or NULL
104  * @ret rc              Return status code
105  */
106 int xfer_open_socket ( struct xfer_interface *xfer, int semantics,
107                        struct sockaddr *peer, struct sockaddr *local ) {
108         struct socket_opener *opener;
109
110         DBGC ( xfer, "XFER %p opening (%s,%s) socket\n", xfer,
111                socket_semantics_name ( semantics ),
112                socket_family_name ( peer->sa_family ) );
113
114         for_each_table_entry ( opener, SOCKET_OPENERS ) {
115                 if ( ( opener->semantics == semantics ) &&
116                      ( opener->family == peer->sa_family ) ) {
117                         return opener->open ( xfer, peer, local );
118                 }
119         }
120
121         DBGC ( xfer, "XFER %p attempted to open unsupported socket type "
122                "(%s,%s)\n", xfer, socket_semantics_name ( semantics ),
123                socket_family_name ( peer->sa_family ) );
124         return -ENOTSUP;
125 }
126
127 /**
128  * Open location
129  *
130  * @v xfer              Data transfer interface
131  * @v type              Location type
132  * @v args              Remaining arguments depend upon location type
133  * @ret rc              Return status code
134  */
135 int xfer_vopen ( struct xfer_interface *xfer, int type, va_list args ) {
136         switch ( type ) {
137         case LOCATION_URI_STRING: {
138                 const char *uri_string = va_arg ( args, const char * );
139
140                 return xfer_open_uri_string ( xfer, uri_string ); }
141         case LOCATION_URI: {
142                 struct uri *uri = va_arg ( args, struct uri * );
143
144                 return xfer_open_uri ( xfer, uri ); }
145         case LOCATION_SOCKET: {
146                 int semantics = va_arg ( args, int );
147                 struct sockaddr *peer = va_arg ( args, struct sockaddr * );
148                 struct sockaddr *local = va_arg ( args, struct sockaddr * );
149
150                 return xfer_open_socket ( xfer, semantics, peer, local ); }
151         default:
152                 DBGC ( xfer, "XFER %p attempted to open unsupported location "
153                        "type %d\n", xfer, type );
154                 return -ENOTSUP;
155         }
156 }
157
158 /**
159  * Open location
160  *
161  * @v xfer              Data transfer interface
162  * @v type              Location type
163  * @v ...               Remaining arguments depend upon location type
164  * @ret rc              Return status code
165  */
166 int xfer_open ( struct xfer_interface *xfer, int type, ... ) {
167         va_list args;
168         int rc;
169
170         va_start ( args, type );
171         rc = xfer_vopen ( xfer, type, args );
172         va_end ( args );
173         return rc;
174 }
175
176 /**
177  * Reopen location
178  *
179  * @v xfer              Data transfer interface
180  * @v type              Location type
181  * @v args              Remaining arguments depend upon location type
182  * @ret rc              Return status code
183  *
184  * This will close the existing connection and open a new connection
185  * using xfer_vopen().  It is intended to be used as a .vredirect
186  * method handler.
187  */
188 int xfer_vreopen ( struct xfer_interface *xfer, int type, va_list args ) {
189         struct xfer_interface_operations *op = xfer->op;
190
191         /* Close existing connection */
192         xfer_nullify ( xfer );
193         xfer_close ( xfer, 0 );
194
195         /* Restore to operational status */
196         xfer->op = op;
197
198         /* Open new location */
199         return xfer_vopen ( xfer, type, args );
200 }