[resolv] Simplify xfer_redirect() logic
[people/lynusvaz/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 /** A name resolution multiplexer */
154 struct resolv_mux {
155         /** Reference counter */
156         struct refcnt refcnt;
157         /** Parent name resolution interface */
158         struct resolv_interface parent;
159
160         /** Child name resolution interface */
161         struct resolv_interface child;
162         /** Current child resolver */
163         struct resolver *resolver;
164
165         /** Socket address to complete */
166         struct sockaddr sa;
167         /** Name to be resolved
168          *
169          * Must be at end of structure
170          */
171         char name[0];
172 };
173
174 /**
175  * Try current child name resolver
176  *
177  * @v mux               Name resolution multiplexer
178  * @ret rc              Return status code
179  */
180 static int resolv_mux_try ( struct resolv_mux *mux ) {
181         struct resolver *resolver = mux->resolver;
182         int rc;
183
184         DBGC ( mux, "RESOLV %p trying method %s\n", mux, resolver->name );
185
186         if ( ( rc = resolver->resolv ( &mux->child, mux->name,
187                                        &mux->sa ) ) != 0 ) {
188                 DBGC ( mux, "RESOLV %p could not use method %s: %s\n",
189                        mux, resolver->name, strerror ( rc ) );
190                 return rc;
191         }
192
193         return 0;
194 }
195
196 /**
197  * Handle done() event from child name resolver
198  *
199  * @v resolv            Child name resolution interface
200  * @v sa                Completed socket address (if successful)
201  * @v rc                Final status code
202  */
203 static void resolv_mux_done ( struct resolv_interface *resolv,
204                               struct sockaddr *sa, int rc ) {
205         struct resolv_mux *mux =
206                 container_of ( resolv, struct resolv_mux, child );
207
208         /* Unplug child */
209         resolv_unplug ( &mux->child );
210
211         /* If this resolution succeeded, stop now */
212         if ( rc == 0 ) {
213                 DBGC ( mux, "RESOLV %p succeeded using method %s\n",
214                        mux, mux->resolver->name );
215                 goto finished;
216         }
217
218         /* Attempt next child resolver, if possible */
219         mux->resolver++;
220         if ( mux->resolver >= table_end ( RESOLVERS ) ) {
221                 DBGC ( mux, "RESOLV %p failed to resolve name\n", mux );
222                 goto finished;
223         }
224         if ( ( rc = resolv_mux_try ( mux ) ) != 0 )
225                 goto finished;
226
227         /* Next resolver is now running */
228         return;
229         
230  finished:
231         resolv_done ( &mux->parent, sa, rc );
232 }
233
234 /** Name resolution multiplexer operations */
235 static struct resolv_interface_operations resolv_mux_child_ops = {
236         .done           = resolv_mux_done,
237 };
238
239 /**
240  * Start name resolution
241  *
242  * @v resolv            Name resolution interface
243  * @v name              Name to resolve
244  * @v sa                Socket address to complete
245  * @ret rc              Return status code
246  */
247 int resolv ( struct resolv_interface *resolv, const char *name,
248              struct sockaddr *sa ) {
249         struct resolv_mux *mux;
250         size_t name_len = ( strlen ( name ) + 1 );
251         int rc;
252
253         /* Allocate and initialise structure */
254         mux = zalloc ( sizeof ( *mux ) + name_len );
255         if ( ! mux )
256                 return -ENOMEM;
257         resolv_init ( &mux->parent, &null_resolv_ops, &mux->refcnt );
258         resolv_init ( &mux->child, &resolv_mux_child_ops, &mux->refcnt );
259         mux->resolver = table_start ( RESOLVERS );
260         memcpy ( &mux->sa, sa, sizeof ( mux->sa ) );
261         memcpy ( mux->name, name, name_len );
262
263         DBGC ( mux, "RESOLV %p attempting to resolve \"%s\"\n", mux, name );
264
265         /* Start first resolver in chain.  There will always be at
266          * least one resolver (the numeric resolver), so no need to
267          * check for the zero-resolvers-available case.
268          */
269         if ( ( rc = resolv_mux_try ( mux ) ) != 0 )
270                 goto err;
271
272         /* Attach parent interface, mortalise self, and return */
273         resolv_plug_plug ( &mux->parent, resolv );
274         ref_put ( &mux->refcnt );
275         return 0;
276
277  err:
278         ref_put ( &mux->refcnt );
279         return rc;      
280 }
281
282 /***************************************************************************
283  *
284  * Named socket opening
285  *
286  ***************************************************************************
287  */
288
289 /** A named socket */
290 struct named_socket {
291         /** Reference counter */
292         struct refcnt refcnt;
293         /** Data transfer interface */
294         struct xfer_interface xfer;
295         /** Name resolution interface */
296         struct resolv_interface resolv;
297         /** Communication semantics (e.g. SOCK_STREAM) */
298         int semantics;
299         /** Stored local socket address, if applicable */
300         struct sockaddr local;
301         /** Stored local socket address exists */
302         int have_local;
303 };
304
305 /**
306  * Finish using named socket
307  *
308  * @v named             Named socket
309  * @v rc                Reason for finish
310  */
311 static void named_done ( struct named_socket *named, int rc ) {
312
313         /* Close all interfaces */
314         resolv_nullify ( &named->resolv );
315         xfer_nullify ( &named->xfer );
316         xfer_close ( &named->xfer, rc );
317 }
318
319 /**
320  * Handle close() event
321  *
322  * @v xfer              Data transfer interface
323  * @v rc                Reason for close
324  */
325 static void named_xfer_close ( struct xfer_interface *xfer, int rc ) {
326         struct named_socket *named =
327                 container_of ( xfer, struct named_socket, xfer );
328
329         named_done ( named, rc );
330 }
331
332 /** Named socket opener data transfer interface operations */
333 static struct xfer_interface_operations named_xfer_ops = {
334         .close          = named_xfer_close,
335         .vredirect      = ignore_xfer_vredirect,
336         .window         = no_xfer_window,
337         .alloc_iob      = default_xfer_alloc_iob,
338         .deliver_iob    = xfer_deliver_as_raw,
339         .deliver_raw    = ignore_xfer_deliver_raw,
340 };
341
342 /**
343  * Handle done() event
344  *
345  * @v resolv            Name resolution interface
346  * @v sa                Completed socket address (if successful)
347  * @v rc                Final status code
348  */
349 static void named_resolv_done ( struct resolv_interface *resolv,
350                                 struct sockaddr *sa, int rc ) {
351         struct named_socket *named =
352                 container_of ( resolv, struct named_socket, resolv );
353
354         /* Redirect if name resolution was successful */
355         if ( rc == 0 ) {
356                 rc = xfer_redirect ( &named->xfer, LOCATION_SOCKET,
357                                      named->semantics, sa,
358                                      ( named->have_local ?
359                                        &named->local : NULL ) );
360         }
361
362         /* Terminate resolution */
363         named_done ( named, rc );
364 }
365
366 /** Named socket opener name resolution interface operations */
367 static struct resolv_interface_operations named_resolv_ops = {
368         .done           = named_resolv_done,
369 };
370
371 /**
372  * Open named socket
373  *
374  * @v semantics         Communication semantics (e.g. SOCK_STREAM)
375  * @v peer              Peer socket address to complete
376  * @v name              Name to resolve
377  * @v local             Local socket address, or NULL
378  * @ret rc              Return status code
379  */
380 int xfer_open_named_socket ( struct xfer_interface *xfer, int semantics,
381                              struct sockaddr *peer, const char *name,
382                              struct sockaddr *local ) {
383         struct named_socket *named;
384         int rc;
385
386         /* Allocate and initialise structure */
387         named = zalloc ( sizeof ( *named ) );
388         if ( ! named )
389                 return -ENOMEM;
390         xfer_init ( &named->xfer, &named_xfer_ops, &named->refcnt );
391         resolv_init ( &named->resolv, &named_resolv_ops, &named->refcnt );
392         named->semantics = semantics;
393         if ( local ) {
394                 memcpy ( &named->local, local, sizeof ( named->local ) );
395                 named->have_local = 1;
396         }
397
398         DBGC ( named, "RESOLV %p opening named socket \"%s\"\n",
399                named, name );
400
401         /* Start name resolution */
402         if ( ( rc = resolv ( &named->resolv, name, peer ) ) != 0 )
403                 goto err;
404
405         /* Attach parent interface, mortalise self, and return */
406         xfer_plug_plug ( &named->xfer, xfer );
407         ref_put ( &named->refcnt );
408         return 0;
409
410  err:
411         ref_put ( &named->refcnt );
412         return rc;
413 }