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