Prefix all the open()-family routines with xfer_, to disambiguate them
[people/dverkamp/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 /** Registered URI openers */
34 static struct uri_opener uri_openers[0]
35         __table_start ( struct uri_opener, uri_openers );
36 static struct uri_opener uri_openers_end[0]
37         __table_end ( struct uri_opener, uri_openers );
38
39 /** Registered socket openers */
40 static struct socket_opener socket_openers[0]
41         __table_start ( struct socket_opener, socket_openers );
42 static struct socket_opener socket_openers_end[0]
43         __table_end ( struct socket_opener, socket_openers );
44
45 /**
46  * Open URI
47  *
48  * @v xfer              Data transfer interface
49  * @v uri_string        URI string (e.g. "http://etherboot.org/kernel")
50  * @ret rc              Return status code
51  */
52 int xfer_open_uri ( struct xfer_interface *xfer, const char *uri_string ) {
53         struct uri *uri;
54         struct uri_opener *opener;
55
56         DBGC ( xfer, "XFER %p opening URI %s\n", xfer, uri_string );
57
58         uri = parse_uri ( uri_string );
59         if ( ! uri )
60                 return -ENOMEM;
61
62         for ( opener = uri_openers ; opener < uri_openers_end ; opener++ ) {
63                 if ( strcmp ( uri->scheme, opener->scheme ) == 0 ) {
64                         return opener->open ( xfer, uri );
65                 }
66         }
67
68         DBGC ( xfer, "XFER %p attempted to open unsupported URI scheme "
69                "\"%s\"\n", xfer, uri->scheme );
70         free_uri ( uri );
71         return -ENOTSUP;
72 }
73
74 /**
75  * Open socket
76  *
77  * @v xfer              Data transfer interface
78  * @v domain            Communication domain (e.g. PF_INET)
79  * @v type              Communication semantics (e.g. SOCK_STREAM)
80  */
81 int xfer_open_socket ( struct xfer_interface *xfer,
82                        int domain, int type, struct sockaddr *sa ) {
83         struct socket_opener *opener;
84
85         DBGC ( xfer, "XFER %p opening (%s,%s) socket\n", xfer,
86                socket_domain_name ( domain ), socket_type_name ( type ) );
87
88         for ( opener = socket_openers; opener < socket_openers_end; opener++ ){
89                 if ( ( opener->domain == domain ) &&
90                      ( opener->type == type ) ) {
91                         return opener->open ( xfer, sa );
92                 }
93         }
94
95         DBGC ( xfer, "XFER %p attempted to open unsupported socket type "
96                "(%s,%s)\n", xfer, socket_domain_name ( domain ),
97                socket_type_name ( type ) );
98         return -ENOTSUP;
99 }
100
101 /**
102  * Open location
103  *
104  * @v xfer              Data transfer interface
105  * @v type              Location type
106  * @v args              Remaining arguments depend upon location type
107  * @ret rc              Return status code
108  */
109 int xfer_vopen ( struct xfer_interface *xfer, int type, va_list args ) {
110         switch ( type ) {
111         case LOCATION_URI: {
112                 const char *uri_string = va_arg ( args, const char * );
113
114                 return xfer_open_uri ( xfer, uri_string ); }
115         case LOCATION_SOCKET: {
116                 int domain = va_arg ( args, int );
117                 int type = va_arg ( args, int );
118                 struct sockaddr *sa = va_arg ( args, struct sockaddr * );
119
120                 return xfer_open_socket ( xfer, domain, type, sa ); }
121         default:
122                 DBGC ( xfer, "XFER %p attempted to open unsupported location "
123                        "type %d\n", xfer, type );
124                 return -ENOTSUP;
125         }
126 }
127
128 /**
129  * Open location
130  *
131  * @v xfer              Data transfer interface
132  * @v type              Location type
133  * @v ...               Remaining arguments depend upon location type
134  * @ret rc              Return status code
135  */
136 int xfer_open ( struct xfer_interface *xfer, int type, ... ) {
137         va_list args;
138         int rc;
139
140         va_start ( args, type );
141         rc = xfer_vopen ( xfer, type, args );
142         va_end ( args );
143         return rc;
144 }