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/int.h>
31
#include <grub/machine/memory.h>
33
#define SEGMENT(x) ((x) >> 4)
34
#define OFFSET(x) ((x) & 0xF)
35
#define SEGOFS(x) ((SEGMENT(x) << 16) + OFFSET(x))
36
#define LINEAR(x) (void *) (((x >> 16) <<4) + (x & 0xFFFF))
38
struct grub_pxe_disk_data
40
grub_uint32_t server_ip;
41
grub_uint32_t gateway_ip;
44
struct grub_pxe_bangpxe *grub_pxe_pxenv;
45
static grub_uint32_t grub_pxe_your_ip;
46
static grub_uint32_t grub_pxe_default_server_ip;
47
static grub_uint32_t grub_pxe_default_gateway_ip;
48
static unsigned grub_pxe_blksize = GRUB_PXE_MIN_BLKSIZE;
50
static grub_file_t curr_file = 0;
54
grub_uint32_t packet_number;
55
grub_uint32_t block_size;
59
static grub_uint32_t pxe_rm_entry = 0;
61
static struct grub_pxe_bangpxe *
64
struct grub_bios_int_registers regs;
65
struct grub_pxenv *pxenv;
66
struct grub_pxe_bangpxe *bangpxe;
68
regs.flags = GRUB_CPU_INT_FLAGS_DEFAULT;
75
grub_bios_interrupt (0x1a, ®s);
77
if ((regs.eax & 0xffff) != 0x564e)
80
pxenv = (struct grub_pxenv *) ((regs.es << 4) + (regs.ebx & 0xffff));
81
if (grub_memcmp (pxenv->signature, GRUB_PXE_SIGNATURE,
82
sizeof (pxenv->signature))
86
if (pxenv->version < 0x201)
89
bangpxe = (void *) ((((pxenv->pxe_ptr & 0xffff0000) >> 16) << 4)
90
+ (pxenv->pxe_ptr & 0xffff));
95
if (grub_memcmp (bangpxe->signature, GRUB_PXE_BANGPXE_SIGNATURE,
96
sizeof (bangpxe->signature)) != 0)
99
pxe_rm_entry = bangpxe->rm_entry;
105
grub_pxe_iterate (int (*hook) (const char *name))
113
parse_ip (const char *val, grub_uint32_t *ip, const char **rest)
115
grub_uint32_t newip = 0;
118
const char *ptr = val;
120
for (i = 0; i < 4; i++)
122
t = grub_strtoul (ptr, (char **) &ptr, 0);
126
return grub_error (GRUB_ERR_OUT_OF_RANGE, "Invalid IP.");
129
if (i != 3 && *ptr != '.')
130
return grub_error (GRUB_ERR_OUT_OF_RANGE, "Invalid IP.");
140
grub_pxe_open (const char *name, grub_disk_t disk)
142
struct grub_pxe_disk_data *data;
144
if (grub_strcmp (name, "pxe") != 0
145
&& grub_strncmp (name, "pxe:", sizeof ("pxe:") - 1) != 0)
146
return grub_error (GRUB_ERR_UNKNOWN_DEVICE, "not a pxe disk");
148
data = grub_malloc (sizeof (*data));
152
if (grub_strncmp (name, "pxe:", sizeof ("pxe:") - 1) == 0)
157
ptr = name + sizeof ("pxe:") - 1;
158
err = parse_ip (ptr, &(data->server_ip), &ptr);
163
err = parse_ip (ptr + 1, &(data->gateway_ip), 0);
168
data->gateway_ip = grub_pxe_default_gateway_ip;
172
data->server_ip = grub_pxe_default_server_ip;
173
data->gateway_ip = grub_pxe_default_gateway_ip;
176
disk->total_sectors = 0;
177
disk->id = (unsigned long) data;
181
return GRUB_ERR_NONE;
185
grub_pxe_close (grub_disk_t disk)
187
grub_free (disk->data);
191
grub_pxe_read (grub_disk_t disk __attribute((unused)),
192
grub_disk_addr_t sector __attribute((unused)),
193
grub_size_t size __attribute((unused)),
194
char *buf __attribute((unused)))
196
return GRUB_ERR_OUT_OF_RANGE;
200
grub_pxe_write (grub_disk_t disk __attribute((unused)),
201
grub_disk_addr_t sector __attribute((unused)),
202
grub_size_t size __attribute((unused)),
203
const char *buf __attribute((unused)))
205
return GRUB_ERR_OUT_OF_RANGE;
208
static struct grub_disk_dev grub_pxe_dev =
211
.id = GRUB_DISK_DEVICE_PXE_ID,
212
.iterate = grub_pxe_iterate,
213
.open = grub_pxe_open,
214
.close = grub_pxe_close,
215
.read = grub_pxe_read,
216
.write = grub_pxe_write,
221
grub_pxefs_dir (grub_device_t device,
222
const char *path __attribute__ ((unused)),
223
int (*hook) (const char *filename,
224
const struct grub_dirhook_info *info)
225
__attribute__ ((unused)))
227
if (device->disk->dev->id != GRUB_DISK_DEVICE_PXE_ID)
228
return grub_error (GRUB_ERR_IO, "not a pxe disk");
230
return GRUB_ERR_NONE;
234
grub_pxefs_open (struct grub_file *file, const char *name)
238
struct grub_pxenv_tftp_get_fsize c1;
239
struct grub_pxenv_tftp_open c2;
241
struct grub_pxe_data *data;
242
struct grub_pxe_disk_data *disk_data = file->device->disk->data;
243
grub_file_t file_int, bufio;
245
if (file->device->disk->dev->id != GRUB_DISK_DEVICE_PXE_ID)
246
return grub_error (GRUB_ERR_IO, "not a pxe disk");
250
grub_pxe_call (GRUB_PXENV_TFTP_CLOSE, &c.c2, pxe_rm_entry);
254
c.c1.server_ip = disk_data->server_ip;
255
c.c1.gateway_ip = disk_data->gateway_ip;
256
grub_strcpy ((char *)&c.c1.filename[0], name);
257
grub_pxe_call (GRUB_PXENV_TFTP_GET_FSIZE, &c.c1, pxe_rm_entry);
259
return grub_error (GRUB_ERR_FILE_NOT_FOUND, "file not found");
261
file->size = c.c1.file_size;
263
c.c2.tftp_port = grub_cpu_to_be16 (GRUB_PXE_TFTP_PORT);
264
c.c2.packet_size = grub_pxe_blksize;
265
grub_pxe_call (GRUB_PXENV_TFTP_OPEN, &c.c2, pxe_rm_entry);
267
return grub_error (GRUB_ERR_BAD_FS, "open fails");
269
data = grub_zalloc (sizeof (struct grub_pxe_data) + grub_strlen (name) + 1);
273
data->block_size = c.c2.packet_size;
274
grub_strcpy (data->filename, name);
276
file_int = grub_malloc (sizeof (*file_int));
284
file->not_easly_seekable = 1;
285
grub_memcpy (file_int, file, sizeof (struct grub_file));
286
curr_file = file_int;
288
bufio = grub_bufio_open (file_int, data->block_size);
291
grub_free (file_int);
296
grub_memcpy (file, bufio, sizeof (struct grub_file));
298
return GRUB_ERR_NONE;
302
grub_pxefs_read (grub_file_t file, char *buf, grub_size_t len)
304
struct grub_pxenv_tftp_read c;
305
struct grub_pxe_data *data;
306
struct grub_pxe_disk_data *disk_data = file->device->disk->data;
311
pn = grub_divmod64 (file->offset, data->block_size, &r);
314
grub_error (GRUB_ERR_BAD_FS,
315
"read access must be aligned to packet size");
319
if ((curr_file != file) || (data->packet_number > pn))
321
struct grub_pxenv_tftp_open o;
324
grub_pxe_call (GRUB_PXENV_TFTP_CLOSE, &o, pxe_rm_entry);
326
o.server_ip = disk_data->server_ip;
327
o.gateway_ip = disk_data->gateway_ip;
328
grub_strcpy ((char *)&o.filename[0], data->filename);
329
o.tftp_port = grub_cpu_to_be16 (GRUB_PXE_TFTP_PORT);
330
o.packet_size = data->block_size;
331
grub_pxe_call (GRUB_PXENV_TFTP_OPEN, &o, pxe_rm_entry);
334
grub_error (GRUB_ERR_BAD_FS, "open fails");
337
data->block_size = o.packet_size;
338
data->packet_number = 0;
342
c.buffer = SEGOFS (GRUB_MEMORY_MACHINE_SCRATCH_ADDR);
343
while (pn >= data->packet_number)
345
c.buffer_size = data->block_size;
346
grub_pxe_call (GRUB_PXENV_TFTP_READ, &c, pxe_rm_entry);
349
grub_error (GRUB_ERR_BAD_FS, "read fails");
352
data->packet_number++;
355
grub_memcpy (buf, (char *) GRUB_MEMORY_MACHINE_SCRATCH_ADDR, len);
361
grub_pxefs_close (grub_file_t file)
363
struct grub_pxenv_tftp_close c;
365
if (curr_file == file)
367
grub_pxe_call (GRUB_PXENV_TFTP_CLOSE, &c, pxe_rm_entry);
371
grub_free (file->data);
373
return GRUB_ERR_NONE;
377
grub_pxefs_label (grub_device_t device __attribute ((unused)),
378
char **label __attribute ((unused)))
381
return GRUB_ERR_NONE;
384
static struct grub_fs grub_pxefs_fs =
387
.dir = grub_pxefs_dir,
388
.open = grub_pxefs_open,
389
.read = grub_pxefs_read,
390
.close = grub_pxefs_close,
391
.label = grub_pxefs_label,
396
grub_env_write_readonly (struct grub_env_var *var __attribute__ ((unused)),
397
const char *val __attribute__ ((unused)))
403
set_mac_env (grub_uint8_t *mac_addr, grub_size_t mac_len)
405
char buf[(sizeof ("XX:") - 1) * mac_len + 1];
409
for (i = 0; i < mac_len; i++)
411
grub_snprintf (ptr, sizeof (buf) - (ptr - buf),
412
"%02x:", mac_addr[i] & 0xff);
413
ptr += (sizeof ("XX:") - 1);
420
grub_env_set ("net_pxe_mac", buf);
421
/* XXX: Is it possible to change MAC in PXE? */
422
grub_register_variable_hook ("net_pxe_mac", 0, grub_env_write_readonly);
426
set_env_limn_ro (const char *varname, char *value, grub_size_t len)
431
grub_env_set (varname, value);
433
grub_register_variable_hook (varname, 0, grub_env_write_readonly);
437
parse_dhcp_vendor (void *vend, int limit)
439
grub_uint8_t *ptr, *ptr0;
443
if (grub_be_to_cpu32 (*(grub_uint32_t *) ptr) != 0x63825363)
445
ptr = ptr + sizeof (grub_uint32_t);
446
while (ptr - ptr0 < limit)
448
grub_uint8_t tagtype;
449
grub_uint8_t taglength;
466
set_env_limn_ro ("net_pxe_hostname", (char *) ptr, taglength);
470
set_env_limn_ro ("net_pxe_domain", (char *) ptr, taglength);
474
set_env_limn_ro ("net_pxe_rootpath", (char *) ptr, taglength);
478
set_env_limn_ro ("net_pxe_extensionspath", (char *) ptr, taglength);
481
/* If you need any other options please contact GRUB
482
developpement team. */
490
grub_pxe_detect (void)
492
struct grub_pxe_bangpxe *pxenv;
493
struct grub_pxenv_get_cached_info ci;
494
struct grub_pxenv_boot_player *bp;
496
pxenv = grub_pxe_scan ();
500
ci.packet_type = GRUB_PXENV_PACKET_TYPE_DHCP_ACK;
503
grub_pxe_call (GRUB_PXENV_GET_CACHED_INFO, &ci, pxe_rm_entry);
507
bp = LINEAR (ci.buffer);
509
grub_pxe_your_ip = bp->your_ip;
510
grub_pxe_default_server_ip = bp->server_ip;
511
grub_pxe_default_gateway_ip = bp->gateway_ip;
512
set_mac_env (bp->mac_addr, bp->hw_len < sizeof (bp->mac_addr) ? bp->hw_len
513
: sizeof (bp->mac_addr));
514
set_env_limn_ro ("net_pxe_boot_file", (char *) bp->boot_file,
515
sizeof (bp->boot_file));
516
set_env_limn_ro ("net_pxe_dhcp_server_name", (char *) bp->server_name,
517
sizeof (bp->server_name));
518
parse_dhcp_vendor (&bp->vendor, sizeof (bp->vendor));
519
grub_pxe_pxenv = pxenv;
523
grub_pxe_unload (void)
527
grub_fs_unregister (&grub_pxefs_fs);
528
grub_disk_dev_unregister (&grub_pxe_dev);
535
set_ip_env (char *varname, grub_uint32_t ip)
537
char buf[sizeof ("XXX.XXX.XXX.XXX")];
539
grub_snprintf (buf, sizeof (buf), "%d.%d.%d.%d", (ip & 0xff),
540
(ip >> 8) & 0xff, (ip >> 16) & 0xff, (ip >> 24) & 0xff);
541
grub_env_set (varname, buf);
545
write_ip_env (grub_uint32_t *ip, const char *val)
551
err = parse_ip (val, &newip, 0);
555
/* Normalize the IP. */
556
buf = grub_xasprintf ("%d.%d.%d.%d", (newip & 0xff), (newip >> 8) & 0xff,
557
(newip >> 16) & 0xff, (newip >> 24) & 0xff);
567
grub_env_write_pxe_default_server (struct grub_env_var *var
568
__attribute__ ((unused)),
571
return write_ip_env (&grub_pxe_default_server_ip, val);
575
grub_env_write_pxe_default_gateway (struct grub_env_var *var
576
__attribute__ ((unused)),
579
return write_ip_env (&grub_pxe_default_gateway_ip, val);
583
grub_env_write_pxe_blocksize (struct grub_env_var *var __attribute__ ((unused)),
589
size = grub_strtoul (val, 0, 0);
593
if (size < GRUB_PXE_MIN_BLKSIZE)
594
size = GRUB_PXE_MIN_BLKSIZE;
595
else if (size > GRUB_PXE_MAX_BLKSIZE)
596
size = GRUB_PXE_MAX_BLKSIZE;
598
buf = grub_xasprintf ("%d", size);
602
grub_pxe_blksize = size;
615
buf = grub_xasprintf ("%d", grub_pxe_blksize);
617
grub_env_set ("pxe_blksize", buf);
620
set_ip_env ("pxe_default_server", grub_pxe_default_server_ip);
621
set_ip_env ("pxe_default_gateway", grub_pxe_default_gateway_ip);
622
set_ip_env ("net_pxe_ip", grub_pxe_your_ip);
623
grub_register_variable_hook ("pxe_default_server", 0,
624
grub_env_write_pxe_default_server);
625
grub_register_variable_hook ("pxe_default_gateway", 0,
626
grub_env_write_pxe_default_gateway);
628
/* XXX: Is it possible to change IP in PXE? */
629
grub_register_variable_hook ("net_pxe_ip", 0,
630
grub_env_write_readonly);
631
grub_register_variable_hook ("pxe_blksize", 0,
632
grub_env_write_pxe_blocksize);
633
grub_disk_dev_register (&grub_pxe_dev);
634
grub_fs_register (&grub_pxefs_fs);