[dhcp] Accept filename via DHCP option 67 as well as BOOTP filename field
[people/oremanj/gpxe.git] / src / net / dhcppkt.c
1 /*
2  * Copyright (C) 2008 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 <stdio.h>
22 #include <errno.h>
23 #include <string.h>
24 #include <gpxe/netdevice.h>
25 #include <gpxe/dhcp.h>
26 #include <gpxe/dhcpopts.h>
27 #include <gpxe/dhcppkt.h>
28
29 /** @file
30  *
31  * DHCP packets
32  *
33  */
34
35 /****************************************************************************
36  *
37  * DHCP packet raw interface
38  *
39  */
40
41 /**
42  * Calculate used length of an IPv4 field within a DHCP packet
43  *
44  * @v data              Field data
45  * @v len               Length of field
46  * @ret used            Used length of field
47  */
48 static size_t used_len_ipv4 ( const void *data, size_t len __unused ) {
49         const struct in_addr *in = data;
50
51         return ( in->s_addr ? sizeof ( *in ) : 0 );
52 }
53
54 /**
55  * Calculate used length of a string field within a DHCP packet
56  *
57  * @v data              Field data
58  * @v len               Length of field
59  * @ret used            Used length of field
60  */
61 static size_t used_len_string ( const void *data, size_t len ) {
62         return strnlen ( data, len );
63 }
64
65 /** A dedicated field within a DHCP packet */
66 struct dhcp_packet_field {
67         /** Settings tag number */
68         unsigned int tag;
69         /** Offset within DHCP packet */
70         uint16_t offset;
71         /** Length of field */
72         uint16_t len;
73         /** Calculate used length of field
74          *
75          * @v data      Field data
76          * @v len       Length of field
77          * @ret used    Used length of field
78          */
79         size_t ( * used_len ) ( const void *data, size_t len );
80 };
81
82 /** Declare a dedicated field within a DHCP packet
83  *
84  * @v _tag              Settings tag number
85  * @v _field            Field name
86  * @v _used_len         Function to calculate used length of field
87  */
88 #define DHCP_PACKET_FIELD( _tag, _field, _used_len ) {                  \
89                 .tag = (_tag),                                          \
90                 .offset = offsetof ( struct dhcphdr, _field ),          \
91                 .len = sizeof ( ( ( struct dhcphdr * ) 0 )->_field ),   \
92                 .used_len = _used_len,                                  \
93         }
94
95 /** Dedicated fields within a DHCP packet */
96 static struct dhcp_packet_field dhcp_packet_fields[] = {
97         DHCP_PACKET_FIELD ( DHCP_EB_YIADDR, yiaddr, used_len_ipv4 ),
98         DHCP_PACKET_FIELD ( DHCP_EB_SIADDR, siaddr, used_len_ipv4 ),
99         DHCP_PACKET_FIELD ( DHCP_TFTP_SERVER_NAME, sname, used_len_string ),
100         DHCP_PACKET_FIELD ( DHCP_BOOTFILE_NAME, file, used_len_string ),
101 };
102
103 /**
104  * Get address of a DHCP packet field
105  *
106  * @v dhcphdr           DHCP packet header
107  * @v field             DHCP packet field
108  * @ret data            Packet field data
109  */
110 static inline void * dhcp_packet_field ( struct dhcphdr *dhcphdr,
111                                          struct dhcp_packet_field *field ) {
112         return ( ( ( void * ) dhcphdr ) + field->offset );
113 }
114
115 /**
116  * Find DHCP packet field corresponding to settings tag number
117  *
118  * @v tag               Settings tag number
119  * @ret field           DHCP packet field, or NULL
120  */
121 static struct dhcp_packet_field *
122 find_dhcp_packet_field ( unsigned int tag ) {
123         struct dhcp_packet_field *field;
124         unsigned int i;
125
126         for ( i = 0 ; i < ( sizeof ( dhcp_packet_fields ) /
127                             sizeof ( dhcp_packet_fields[0] ) ) ; i++ ) {
128                 field = &dhcp_packet_fields[i];
129                 if ( field->tag == tag )
130                         return field;
131         }
132         return NULL;
133 }
134
135 /**
136  * Store value of DHCP packet setting
137  *
138  * @v dhcppkt           DHCP packet
139  * @v tag               Setting tag number
140  * @v data              Setting data, or NULL to clear setting
141  * @v len               Length of setting data
142  * @ret rc              Return status code
143  */
144 int dhcppkt_store ( struct dhcp_packet *dhcppkt, unsigned int tag,
145                     const void *data, size_t len ) {
146         struct dhcp_packet_field *field;
147         void *field_data;
148         int rc;
149
150         /* If this is a special field, fill it in */
151         if ( ( field = find_dhcp_packet_field ( tag ) ) != NULL ) {
152                 if ( len > field->len )
153                         return -ENOSPC;
154                 field_data = dhcp_packet_field ( dhcppkt->dhcphdr, field );
155                 memset ( field_data, 0, field->len );
156                 memcpy ( dhcp_packet_field ( dhcppkt->dhcphdr, field ),
157                          data, len );
158                 /* Erase any equivalent option from the options block */
159                 dhcpopt_store ( &dhcppkt->options, tag, NULL, 0 );
160                 return 0;
161         }
162
163         /* Otherwise, use the generic options block */
164         rc = dhcpopt_store ( &dhcppkt->options, tag, data, len );
165
166         /* Update our used-length field */
167         dhcppkt->len = ( offsetof ( struct dhcphdr, options ) +
168                          dhcppkt->options.len );
169
170         return rc;
171 }
172
173 /**
174  * Fetch value of DHCP packet setting
175  *
176  * @v dhcppkt           DHCP packet
177  * @v tag               Setting tag number
178  * @v data              Buffer to fill with setting data
179  * @v len               Length of buffer
180  * @ret len             Length of setting data, or negative error
181  */
182 int dhcppkt_fetch ( struct dhcp_packet *dhcppkt, unsigned int tag,
183                     void *data, size_t len ) {
184         struct dhcp_packet_field *field;
185         void *field_data;
186         size_t field_len = 0;
187         
188         /* Identify special field, if any */
189         if ( ( field = find_dhcp_packet_field ( tag ) ) != NULL ) {
190                 field_data = dhcp_packet_field ( dhcppkt->dhcphdr, field );
191                 field_len = field->used_len ( field_data, field->len );
192         }
193
194         /* Return special field, if it exists and is populated */
195         if ( field_len ) {
196                 if ( len > field_len )
197                         len = field_len;
198                 memcpy ( data, field_data, len );
199                 return field_len;
200         }
201
202         /* Otherwise, use the generic options block */
203         return dhcpopt_fetch ( &dhcppkt->options, tag, data, len );
204 }
205
206 /****************************************************************************
207  *
208  * DHCP packet settings interface
209  *
210  */
211
212 /**
213  * Store value of DHCP setting
214  *
215  * @v settings          Settings block
216  * @v setting           Setting to store
217  * @v data              Setting data, or NULL to clear setting
218  * @v len               Length of setting data
219  * @ret rc              Return status code
220  */
221 static int dhcppkt_settings_store ( struct settings *settings,
222                                     struct setting *setting,
223                                     const void *data, size_t len ) {
224         struct dhcp_packet *dhcppkt =
225                 container_of ( settings, struct dhcp_packet, settings );
226
227         return dhcppkt_store ( dhcppkt, setting->tag, data, len );
228 }
229
230 /**
231  * Fetch value of DHCP setting
232  *
233  * @v settings          Settings block, or NULL to search all blocks
234  * @v setting           Setting to fetch
235  * @v data              Buffer to fill with setting data
236  * @v len               Length of buffer
237  * @ret len             Length of setting data, or negative error
238  */
239 static int dhcppkt_settings_fetch ( struct settings *settings,
240                                     struct setting *setting,
241                                     void *data, size_t len ) {
242         struct dhcp_packet *dhcppkt =
243                 container_of ( settings, struct dhcp_packet, settings );
244
245         return dhcppkt_fetch ( dhcppkt, setting->tag, data, len );
246 }
247
248 /** DHCP settings operations */
249 static struct settings_operations dhcppkt_settings_operations = {
250         .store = dhcppkt_settings_store,
251         .fetch = dhcppkt_settings_fetch,
252 };
253
254 /****************************************************************************
255  *
256  * Constructor
257  *
258  */
259
260 /**
261  * Initialise DHCP packet
262  *
263  * @v dhcppkt           DHCP packet structure to fill in
264  * @v data              DHCP packet raw data
265  * @v max_len           Length of raw data buffer
266  *
267  * Initialise a DHCP packet structure from a data buffer containing a
268  * DHCP packet.
269  */
270 void dhcppkt_init ( struct dhcp_packet *dhcppkt, struct dhcphdr *data,
271                     size_t len ) {
272         dhcppkt->dhcphdr = data;
273         dhcppkt->max_len = len;
274         dhcpopt_init ( &dhcppkt->options, &dhcppkt->dhcphdr->options,
275                        ( len - offsetof ( struct dhcphdr, options ) ) );
276         dhcppkt->len = ( offsetof ( struct dhcphdr, options ) +
277                          dhcppkt->options.len );
278         settings_init ( &dhcppkt->settings,
279                         &dhcppkt_settings_operations, &dhcppkt->refcnt,
280                         DHCP_SETTINGS_NAME, 0 );
281 }