1
/* pxe.c - Driver to provide access to the pxe filesystem */
3
* GRUB -- GRand Unified Bootloader
4
* Copyright (C) 2008,2009 Free Software Foundation, Inc.
6
* GRUB is free software: you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation, either version 3 of the License, or
9
* (at your option) any later version.
11
* GRUB is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with GRUB. If not, see <http://www.gnu.org/licenses/>.
23
#include <grub/disk.h>
24
#include <grub/file.h>
25
#include <grub/misc.h>
26
#include <grub/bufio.h>
29
#include <grub/machine/pxe.h>
30
#include <grub/machine/memory.h>
32
#define SEGMENT(x) ((x) >> 4)
33
#define OFFSET(x) ((x) & 0xF)
34
#define SEGOFS(x) ((SEGMENT(x) << 16) + OFFSET(x))
35
#define LINEAR(x) (void *) (((x >> 16) <<4) + (x & 0xFFFF))
37
struct grub_pxe_disk_data
39
grub_uint32_t server_ip;
40
grub_uint32_t gateway_ip;
43
struct grub_pxenv *grub_pxe_pxenv;
44
static grub_uint32_t grub_pxe_your_ip;
45
static grub_uint32_t grub_pxe_default_server_ip;
46
static grub_uint32_t grub_pxe_default_gateway_ip;
47
static unsigned grub_pxe_blksize = GRUB_PXE_MIN_BLKSIZE;
49
static grub_file_t curr_file = 0;
53
grub_uint32_t packet_number;
54
grub_uint32_t block_size;
59
grub_pxe_iterate (int (*hook) (const char *name))
67
parse_ip (const char *val, grub_uint32_t *ip, const char **rest)
69
grub_uint32_t newip = 0;
72
const char *ptr = val;
74
for (i = 0; i < 4; i++)
76
t = grub_strtoul (ptr, (char **) &ptr, 0);
80
return grub_error (GRUB_ERR_OUT_OF_RANGE, "Invalid IP.");
83
if (i != 3 && *ptr != '.')
84
return grub_error (GRUB_ERR_OUT_OF_RANGE, "Invalid IP.");
94
grub_pxe_open (const char *name, grub_disk_t disk)
96
struct grub_pxe_disk_data *data;
98
if (grub_strcmp (name, "pxe") != 0
99
&& grub_strncmp (name, "pxe:", sizeof ("pxe:") - 1) != 0)
100
return grub_error (GRUB_ERR_UNKNOWN_DEVICE, "not a pxe disk");
102
data = grub_malloc (sizeof (*data));
106
if (grub_strncmp (name, "pxe:", sizeof ("pxe:") - 1) == 0)
111
ptr = name + sizeof ("pxe:") - 1;
112
err = parse_ip (ptr, &(data->server_ip), &ptr);
117
err = parse_ip (ptr + 1, &(data->server_ip), 0);
122
data->gateway_ip = grub_pxe_default_gateway_ip;
126
data->server_ip = grub_pxe_default_server_ip;
127
data->gateway_ip = grub_pxe_default_gateway_ip;
130
disk->total_sectors = 0;
131
disk->id = (unsigned long) data;
133
disk->has_partitions = 0;
136
return GRUB_ERR_NONE;
140
grub_pxe_close (grub_disk_t disk)
142
grub_free (disk->data);
146
grub_pxe_read (grub_disk_t disk __attribute((unused)),
147
grub_disk_addr_t sector __attribute((unused)),
148
grub_size_t size __attribute((unused)),
149
char *buf __attribute((unused)))
151
return GRUB_ERR_OUT_OF_RANGE;
155
grub_pxe_write (grub_disk_t disk __attribute((unused)),
156
grub_disk_addr_t sector __attribute((unused)),
157
grub_size_t size __attribute((unused)),
158
const char *buf __attribute((unused)))
160
return GRUB_ERR_OUT_OF_RANGE;
163
static struct grub_disk_dev grub_pxe_dev =
166
.id = GRUB_DISK_DEVICE_PXE_ID,
167
.iterate = grub_pxe_iterate,
168
.open = grub_pxe_open,
169
.close = grub_pxe_close,
170
.read = grub_pxe_read,
171
.write = grub_pxe_write,
176
grub_pxefs_dir (grub_device_t device __attribute__ ((unused)),
177
const char *path __attribute__ ((unused)),
178
int (*hook) (const char *filename,
179
const struct grub_dirhook_info *info)
180
__attribute__ ((unused)))
182
return GRUB_ERR_NONE;
186
grub_pxefs_open (struct grub_file *file, const char *name)
190
struct grub_pxenv_tftp_get_fsize c1;
191
struct grub_pxenv_tftp_open c2;
193
struct grub_pxe_data *data;
194
struct grub_pxe_disk_data *disk_data = file->device->disk->data;
195
grub_file_t file_int, bufio;
199
grub_pxe_call (GRUB_PXENV_TFTP_CLOSE, &c.c2);
203
c.c1.server_ip = disk_data->server_ip;
204
c.c1.gateway_ip = disk_data->gateway_ip;
205
grub_strcpy ((char *)&c.c1.filename[0], name);
206
grub_pxe_call (GRUB_PXENV_TFTP_GET_FSIZE, &c.c1);
208
return grub_error (GRUB_ERR_FILE_NOT_FOUND, "file not found");
210
file->size = c.c1.file_size;
212
c.c2.tftp_port = grub_cpu_to_be16 (GRUB_PXE_TFTP_PORT);
213
c.c2.packet_size = grub_pxe_blksize;
214
grub_pxe_call (GRUB_PXENV_TFTP_OPEN, &c.c2);
216
return grub_error (GRUB_ERR_BAD_FS, "open fails");
218
data = grub_zalloc (sizeof (struct grub_pxe_data) + grub_strlen (name) + 1);
222
data->block_size = c.c2.packet_size;
223
grub_strcpy (data->filename, name);
225
file_int = grub_malloc (sizeof (*file_int));
233
grub_memcpy (file_int, file, sizeof (struct grub_file));
234
curr_file = file_int;
236
bufio = grub_bufio_open (file_int, data->block_size);
239
grub_free (file_int);
244
grub_memcpy (file, bufio, sizeof (struct grub_file));
246
return GRUB_ERR_NONE;
250
grub_pxefs_read (grub_file_t file, char *buf, grub_size_t len)
252
struct grub_pxenv_tftp_read c;
253
struct grub_pxe_data *data;
254
struct grub_pxe_disk_data *disk_data = file->device->disk->data;
259
pn = grub_divmod64 (file->offset, data->block_size, &r);
262
grub_error (GRUB_ERR_BAD_FS,
263
"read access must be aligned to packet size");
267
if ((curr_file != file) || (data->packet_number > pn))
269
struct grub_pxenv_tftp_open o;
272
grub_pxe_call (GRUB_PXENV_TFTP_CLOSE, &o);
274
o.server_ip = disk_data->server_ip;
275
o.gateway_ip = disk_data->gateway_ip;
276
grub_strcpy ((char *)&o.filename[0], data->filename);
277
o.tftp_port = grub_cpu_to_be16 (GRUB_PXE_TFTP_PORT);
278
o.packet_size = grub_pxe_blksize;
279
grub_pxe_call (GRUB_PXENV_TFTP_OPEN, &o);
282
grub_error (GRUB_ERR_BAD_FS, "open fails");
285
data->block_size = o.packet_size;
286
data->packet_number = 0;
290
c.buffer = SEGOFS (GRUB_MEMORY_MACHINE_SCRATCH_ADDR);
291
while (pn >= data->packet_number)
293
c.buffer_size = data->block_size;
294
grub_pxe_call (GRUB_PXENV_TFTP_READ, &c);
297
grub_error (GRUB_ERR_BAD_FS, "read fails");
300
data->packet_number++;
303
grub_memcpy (buf, (char *) GRUB_MEMORY_MACHINE_SCRATCH_ADDR, len);
309
grub_pxefs_close (grub_file_t file)
311
struct grub_pxenv_tftp_close c;
313
if (curr_file == file)
315
grub_pxe_call (GRUB_PXENV_TFTP_CLOSE, &c);
319
grub_free (file->data);
321
return GRUB_ERR_NONE;
325
grub_pxefs_label (grub_device_t device __attribute ((unused)),
326
char **label __attribute ((unused)))
329
return GRUB_ERR_NONE;
332
static struct grub_fs grub_pxefs_fs =
335
.dir = grub_pxefs_dir,
336
.open = grub_pxefs_open,
337
.read = grub_pxefs_read,
338
.close = grub_pxefs_close,
339
.label = grub_pxefs_label,
344
grub_env_write_readonly (struct grub_env_var *var __attribute__ ((unused)),
345
const char *val __attribute__ ((unused)))
351
set_mac_env (grub_uint8_t *mac_addr, grub_size_t mac_len)
353
char buf[(sizeof ("XX:") - 1) * mac_len + 1];
357
for (i = 0; i < mac_len; i++)
359
grub_snprintf (ptr, sizeof (buf) - (ptr - buf),
360
"%02x:", mac_addr[i] & 0xff);
361
ptr += (sizeof ("XX:") - 1);
368
grub_env_set ("net_pxe_mac", buf);
369
/* XXX: Is it possible to change MAC in PXE? */
370
grub_register_variable_hook ("net_pxe_mac", 0, grub_env_write_readonly);
374
set_env_limn_ro (const char *varname, char *value, grub_size_t len)
379
grub_env_set (varname, value);
381
grub_register_variable_hook (varname, 0, grub_env_write_readonly);
385
parse_dhcp_vendor (void *vend, int limit)
387
grub_uint8_t *ptr, *ptr0;
391
if (grub_be_to_cpu32 (*(grub_uint32_t *) ptr) != 0x63825363)
393
ptr = ptr + sizeof (grub_uint32_t);
394
while (ptr - ptr0 < limit)
396
grub_uint8_t tagtype;
397
grub_uint8_t taglength;
414
set_env_limn_ro ("net_pxe_hostname", (char *) ptr, taglength);
418
set_env_limn_ro ("net_pxe_domain", (char *) ptr, taglength);
422
set_env_limn_ro ("net_pxe_rootpath", (char *) ptr, taglength);
426
set_env_limn_ro ("net_pxe_extensionspath", (char *) ptr, taglength);
429
/* If you need any other options please contact GRUB
430
developpement team. */
438
grub_pxe_detect (void)
440
struct grub_pxenv *pxenv;
441
struct grub_pxenv_get_cached_info ci;
442
struct grub_pxenv_boot_player *bp;
444
pxenv = grub_pxe_scan ();
448
ci.packet_type = GRUB_PXENV_PACKET_TYPE_DHCP_ACK;
451
grub_pxe_call (GRUB_PXENV_GET_CACHED_INFO, &ci);
455
bp = LINEAR (ci.buffer);
457
grub_pxe_your_ip = bp->your_ip;
458
grub_pxe_default_server_ip = bp->server_ip;
459
grub_pxe_default_gateway_ip = bp->gateway_ip;
460
set_mac_env (bp->mac_addr, bp->hw_len < sizeof (bp->mac_addr) ? bp->hw_len
461
: sizeof (bp->mac_addr));
462
set_env_limn_ro ("net_pxe_boot_file", (char *) bp->boot_file,
463
sizeof (bp->boot_file));
464
set_env_limn_ro ("net_pxe_dhcp_server_name", (char *) bp->server_name,
465
sizeof (bp->server_name));
466
parse_dhcp_vendor (&bp->vendor, sizeof (bp->vendor));
467
grub_pxe_pxenv = pxenv;
471
grub_pxe_unload (void)
475
grub_fs_unregister (&grub_pxefs_fs);
476
grub_disk_dev_unregister (&grub_pxe_dev);
483
set_ip_env (char *varname, grub_uint32_t ip)
485
char buf[sizeof ("XXX.XXX.XXX.XXX")];
487
grub_snprintf (buf, sizeof (buf), "%d.%d.%d.%d", (ip & 0xff),
488
(ip >> 8) & 0xff, (ip >> 16) & 0xff, (ip >> 24) & 0xff);
489
grub_env_set (varname, buf);
493
write_ip_env (grub_uint32_t *ip, const char *val)
499
err = parse_ip (val, &newip, 0);
503
/* Normalize the IP. */
504
buf = grub_xasprintf ("%d.%d.%d.%d", (newip & 0xff), (newip >> 8) & 0xff,
505
(newip >> 16) & 0xff, (newip >> 24) & 0xff);
515
grub_env_write_pxe_default_server (struct grub_env_var *var
516
__attribute__ ((unused)),
519
return write_ip_env (&grub_pxe_default_server_ip, val);
523
grub_env_write_pxe_default_gateway (struct grub_env_var *var
524
__attribute__ ((unused)),
527
return write_ip_env (&grub_pxe_default_gateway_ip, val);
531
grub_env_write_pxe_blocksize (struct grub_env_var *var __attribute__ ((unused)),
537
size = grub_strtoul (val, 0, 0);
541
if (size < GRUB_PXE_MIN_BLKSIZE)
542
size = GRUB_PXE_MIN_BLKSIZE;
543
else if (size > GRUB_PXE_MAX_BLKSIZE)
544
size = GRUB_PXE_MAX_BLKSIZE;
546
buf = grub_xasprintf ("%d", size);
550
grub_pxe_blksize = size;
563
buf = grub_xasprintf ("%d", grub_pxe_blksize);
565
grub_env_set ("net_pxe_blksize", buf);
568
set_ip_env ("pxe_default_server", grub_pxe_default_server_ip);
569
set_ip_env ("pxe_default_gateway", grub_pxe_default_gateway_ip);
570
set_ip_env ("net_pxe_ip", grub_pxe_your_ip);
571
grub_register_variable_hook ("net_pxe_default_server", 0,
572
grub_env_write_pxe_default_server);
573
grub_register_variable_hook ("net_pxe_default_gateway", 0,
574
grub_env_write_pxe_default_gateway);
576
/* XXX: Is it possible to change IP in PXE? */
577
grub_register_variable_hook ("net_pxe_ip", 0,
578
grub_env_write_readonly);
579
grub_register_variable_hook ("net_pxe_blksize", 0,
580
grub_env_write_pxe_blocksize);
581
grub_disk_dev_register (&grub_pxe_dev);
582
grub_fs_register (&grub_pxefs_fs);