Applied a modified version of holger's regparm patches.
[people/adir/gpxe.git] / src / core / resolv.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 <stdint.h>
20 #include <stdlib.h>
21 #include <string.h>
22 #include <errno.h>
23 #include <gpxe/in.h>
24 #include <gpxe/xfer.h>
25 #include <gpxe/open.h>
26 #include <gpxe/process.h>
27 #include <gpxe/resolv.h>
28
29 /** @file
30  *
31  * Name resolution
32  *
33  */
34
35 /***************************************************************************
36  *
37  * Name resolution interfaces
38  *
39  ***************************************************************************
40  */
41
42 /**
43  * Name resolution completed
44  *
45  * @v resolv            Name resolution interface
46  * @v sa                Completed socket address (if successful)
47  * @v rc                Final status code
48  */
49 void resolv_done ( struct resolv_interface *resolv, struct sockaddr *sa,
50                    int rc ) {
51         struct resolv_interface *dest = resolv_get_dest ( resolv );
52
53         resolv_unplug ( resolv );
54         dest->op->done ( dest, sa, rc );
55         resolv_put ( dest );
56 }
57
58 /**
59  * Ignore name resolution done() event
60  *
61  * @v resolv            Name resolution interface
62  * @v sa                Completed socket address (if successful)
63  * @v rc                Final status code
64  */
65 void ignore_resolv_done ( struct resolv_interface *resolv __unused,
66                           struct sockaddr *sa __unused, int rc __unused ) {
67         /* Do nothing */
68 }
69
70 /** Null name resolution interface operations */
71 struct resolv_interface_operations null_resolv_ops = {
72         .done           = ignore_resolv_done,
73 };
74
75 /** Null name resolution interface */
76 struct resolv_interface null_resolv = {
77         .intf = {
78                 .dest = &null_resolv.intf,
79                 .refcnt = NULL,
80         },
81         .op = &null_resolv_ops,
82 };
83
84 /***************************************************************************
85  *
86  * Numeric name resolver
87  *
88  ***************************************************************************
89  */
90
91 /** A numeric name resolver */
92 struct numeric_resolv {
93         /** Reference counter */
94         struct refcnt refcnt;
95         /** Name resolution interface */
96         struct resolv_interface resolv;
97         /** Process */
98         struct process process;
99         /** Completed socket address */
100         struct sockaddr sa;
101         /** Overall status code */
102         int rc;
103 };
104
105 static void numeric_step ( struct process *process ) {
106         struct numeric_resolv *numeric =
107                 container_of ( process, struct numeric_resolv, process );
108         
109         resolv_done ( &numeric->resolv, &numeric->sa, numeric->rc );
110         process_del ( process );
111 }
112
113 static int numeric_resolv ( struct resolv_interface *resolv,
114                             const char *name, struct sockaddr *sa ) {
115         struct numeric_resolv *numeric;
116         struct sockaddr_in *sin;
117
118         /* Allocate and initialise structure */
119         numeric = zalloc ( sizeof ( *numeric ) );
120         if ( ! numeric )
121                 return -ENOMEM;
122         resolv_init ( &numeric->resolv, &null_resolv_ops, &numeric->refcnt );
123         process_init ( &numeric->process, numeric_step, &numeric->refcnt );
124         memcpy ( &numeric->sa, sa, sizeof ( numeric->sa ) );
125
126         DBGC ( numeric, "NUMERIC %p attempting to resolve \"%s\"\n",
127                numeric, name );
128
129         /* Attempt to resolve name */
130         sin = ( ( struct sockaddr_in * ) &numeric->sa );
131         sin->sin_family = AF_INET;
132         if ( inet_aton ( name, &sin->sin_addr ) == 0 )
133                 numeric->rc = -EINVAL;
134
135         /* Attach to parent interface, mortalise self, and return */
136         resolv_plug_plug ( &numeric->resolv, resolv );
137         ref_put ( &numeric->refcnt );
138         return 0;
139 }
140
141 struct resolver numeric_resolver __resolver ( RESOLV_NUMERIC ) = {
142         .name = "NUMERIC",
143         .resolv = numeric_resolv,
144 };
145
146 /***************************************************************************
147  *
148  * Name resolution multiplexer
149  *
150  ***************************************************************************
151  */
152
153 /** Registered name resolvers */
154 static struct resolver resolvers[0]
155         __table_start ( struct resolver, resolvers );
156 static struct resolver resolvers_end[0]
157         __table_end ( struct resolver, resolvers );
158
159 /** A name resolution multiplexer */
160 struct resolv_mux {
161         /** Reference counter */
162         struct refcnt refcnt;
163         /** Parent name resolution interface */
164         struct resolv_interface parent;
165
166         /** Child name resolution interface */
167         struct resolv_interface child;
168         /** Current child resolver */
169         struct resolver *resolver;
170
171         /** Socket address to complete */
172         struct sockaddr sa;
173         /** Name to be resolved
174          *
175          * Must be at end of structure
176          */
177         char name[0];
178 };
179
180 /**
181  * Try current child name resolver
182  *
183  * @v mux               Name resolution multiplexer
184  * @ret rc              Return status code
185  */
186 static int resolv_mux_try ( struct resolv_mux *mux ) {
187         struct resolver *resolver = mux->resolver;
188         int rc;
189
190         DBGC ( mux, "RESOLV %p trying method %s\n", mux, resolver->name );
191
192         if ( ( rc = resolver->resolv ( &mux->child, mux->name,
193                                        &mux->sa ) ) != 0 ) {
194                 DBGC ( mux, "RESOLV %p could not use method %s: %s\n",
195                        mux, resolver->name, strerror ( rc ) );
196                 return rc;
197         }
198
199         return 0;
200 }
201
202 /**
203  * Handle done() event from child name resolver
204  *
205  * @v resolv            Child name resolution interface
206  * @v sa                Completed socket address (if successful)
207  * @v rc                Final status code
208  */
209 static void resolv_mux_done ( struct resolv_interface *resolv,
210                               struct sockaddr *sa, int rc ) {
211         struct resolv_mux *mux =
212                 container_of ( resolv, struct resolv_mux, child );
213
214         /* Unplug child */
215         resolv_unplug ( &mux->child );
216
217         /* If this resolution succeeded, stop now */
218         if ( rc == 0 ) {
219                 DBGC ( mux, "RESOLV %p succeeded using method %s\n",
220                        mux, mux->resolver->name );
221                 goto finished;
222         }
223
224         /* Attempt next child resolver, if possible */
225         mux->resolver++;
226         if ( mux->resolver >= resolvers_end ) {
227                 DBGC ( mux, "RESOLV %p failed to resolve name\n", mux );
228                 goto finished;
229         }
230         if ( ( rc = resolv_mux_try ( mux ) ) != 0 )
231                 goto finished;
232
233         /* Next resolver is now running */
234         return;
235         
236  finished:
237         resolv_done ( &mux->parent, sa, rc );
238 }
239
240 /** Name resolution multiplexer operations */
241 static struct resolv_interface_operations resolv_mux_child_ops = {
242         .done           = resolv_mux_done,
243 };
244
245 /**
246  * Start name resolution
247  *
248  * @v resolv            Name resolution interface
249  * @v name              Name to resolve
250  * @v sa                Socket address to complete
251  * @ret rc              Return status code
252  */
253 int resolv ( struct resolv_interface *resolv, const char *name,
254              struct sockaddr *sa ) {
255         struct resolv_mux *mux;
256         size_t name_len = ( strlen ( name ) + 1 );
257         int rc;
258
259         /* Allocate and initialise structure */
260         mux = zalloc ( sizeof ( *mux ) + name_len );
261         if ( ! mux )
262                 return -ENOMEM;
263         resolv_init ( &mux->parent, &null_resolv_ops, &mux->refcnt );
264         resolv_init ( &mux->child, &resolv_mux_child_ops, &mux->refcnt );
265         mux->resolver = resolvers;
266         memcpy ( &mux->sa, sa, sizeof ( mux->sa ) );
267         memcpy ( mux->name, name, name_len );
268
269         DBGC ( mux, "RESOLV %p attempting to resolve \"%s\"\n", mux, name );
270
271         /* Start first resolver in chain.  There will always be at
272          * least one resolver (the numeric resolver), so no need to
273          * check for the zero-resolvers-available case.
274          */
275         if ( ( rc = resolv_mux_try ( mux ) ) != 0 )
276                 goto err;
277
278         /* Attach parent interface, mortalise self, and return */
279         resolv_plug_plug ( &mux->parent, resolv );
280         ref_put ( &mux->refcnt );
281         return 0;
282
283  err:
284         ref_put ( &mux->refcnt );
285         return rc;      
286 }
287
288 /***************************************************************************
289  *
290  * Named socket opening
291  *
292  ***************************************************************************
293  */
294
295 /** A named socket */
296 struct named_socket {
297         /** Reference counter */
298         struct refcnt refcnt;
299         /** Data transfer interface */
300         struct xfer_interface xfer;
301         /** Name resolution interface */
302         struct resolv_interface resolv;
303         /** Communication semantics (e.g. SOCK_STREAM) */
304         int semantics;
305         /** Stored local socket address, if applicable */
306         struct sockaddr local;
307         /** Stored local socket address exists */
308         int have_local;
309 };
310
311 /** Named socket opener data transfer interface operations */
312 static struct xfer_interface_operations named_xfer_ops = {
313         .close          = ignore_xfer_close,
314         .vredirect      = ignore_xfer_vredirect,
315         .seek           = ignore_xfer_seek,
316         .window         = no_xfer_window,
317         .alloc_iob      = default_xfer_alloc_iob,
318         .deliver_iob    = xfer_deliver_as_raw,
319         .deliver_raw    = ignore_xfer_deliver_raw,
320 };
321
322 /**
323  * Handle done() event
324  *
325  * @v resolv            Name resolution interface
326  * @v sa                Completed socket address (if successful)
327  * @v rc                Final status code
328  */
329 static void named_resolv_done ( struct resolv_interface *resolv,
330                                 struct sockaddr *sa, int rc ) {
331         struct named_socket *named =
332                 container_of ( resolv, struct named_socket, resolv );
333
334         /* Unplug resolver and nullify data transfer interface */
335         resolv_unplug ( &named->resolv );
336         xfer_nullify ( &named->xfer );
337
338         /* Redirect if name resolution was successful */
339         if ( rc == 0 ) {
340                 rc = xfer_redirect ( &named->xfer, LOCATION_SOCKET,
341                                      named->semantics, sa,
342                                      ( named->have_local ?
343                                        &named->local : NULL ) );
344         }
345
346         /* Close data transfer interface if redirection failed */
347         if ( rc != 0 )
348                 xfer_close ( &named->xfer, rc );
349
350         /* Unplug data transfer interface */
351         xfer_unplug ( &named->xfer );
352 }
353
354 /** Named socket opener name resolution interface operations */
355 static struct resolv_interface_operations named_resolv_ops = {
356         .done           = named_resolv_done,
357 };
358
359 /**
360  * Open named socket
361  *
362  * @v semantics         Communication semantics (e.g. SOCK_STREAM)
363  * @v peer              Peer socket address to complete
364  * @v name              Name to resolve
365  * @v local             Local socket address, or NULL
366  * @ret rc              Return status code
367  */
368 int xfer_open_named_socket ( struct xfer_interface *xfer, int semantics,
369                              struct sockaddr *peer, const char *name,
370                              struct sockaddr *local ) {
371         struct named_socket *named;
372         int rc;
373
374         /* Allocate and initialise structure */
375         named = zalloc ( sizeof ( *named ) );
376         if ( ! named )
377                 return -ENOMEM;
378         xfer_init ( &named->xfer, &named_xfer_ops, &named->refcnt );
379         resolv_init ( &named->resolv, &named_resolv_ops, &named->refcnt );
380         named->semantics = semantics;
381         if ( local ) {
382                 memcpy ( &named->local, local, sizeof ( named->local ) );
383                 named->have_local = 1;
384         }
385
386         DBGC ( named, "RESOLV %p opening named socket \"%s\"\n",
387                named, name );
388
389         /* Start name resolution */
390         if ( ( rc = resolv ( &named->resolv, name, peer ) ) != 0 )
391                 goto err;
392
393         /* Attach parent interface, mortalise self, and return */
394         xfer_plug_plug ( &named->xfer, xfer );
395         ref_put ( &named->refcnt );
396         return 0;
397
398  err:
399         ref_put ( &named->refcnt );
400         return rc;
401 }