2N/A/*
2N/A * GRUB -- GRand Unified Bootloader
2N/A * Copyright (C) 2010,2011 Free Software Foundation, Inc.
2N/A * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
2N/A *
2N/A * GRUB is free software: you can redistribute it and/or modify
2N/A * it under the terms of the GNU General Public License as published by
2N/A * the Free Software Foundation, either version 3 of the License, or
2N/A * (at your option) any later version.
2N/A *
2N/A * GRUB is distributed in the hope that it will be useful,
2N/A * but WITHOUT ANY WARRANTY; without even the implied warranty of
2N/A * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2N/A * GNU General Public License for more details.
2N/A *
2N/A * You should have received a copy of the GNU General Public License
2N/A * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
2N/A */
2N/A
2N/A#ifndef GRUB_NET_HEADER
2N/A#define GRUB_NET_HEADER 1
2N/A
2N/A#include <grub/types.h>
2N/A#include <grub/err.h>
2N/A#include <grub/list.h>
2N/A#include <grub/fs.h>
2N/A#include <grub/file.h>
2N/A#include <grub/mm.h>
2N/A#include <grub/net/netbuff.h>
2N/A
2N/Aenum
2N/A {
2N/A GRUB_NET_MAX_LINK_HEADER_SIZE = 64,
2N/A GRUB_NET_UDP_HEADER_SIZE = 8,
2N/A GRUB_NET_TCP_HEADER_SIZE = 20,
2N/A GRUB_NET_OUR_IPV4_HEADER_SIZE = 20,
2N/A GRUB_NET_OUR_IPV6_HEADER_SIZE = 40,
2N/A GRUB_NET_OUR_MAX_IP_HEADER_SIZE = 40,
2N/A GRUB_NET_TCP_RESERVE_SIZE = GRUB_NET_TCP_HEADER_SIZE
2N/A + GRUB_NET_OUR_IPV4_HEADER_SIZE
2N/A + GRUB_NET_MAX_LINK_HEADER_SIZE
2N/A };
2N/A
2N/Atypedef enum grub_link_level_protocol_id
2N/A{
2N/A GRUB_NET_LINK_LEVEL_PROTOCOL_ETHERNET
2N/A} grub_link_level_protocol_id_t;
2N/A
2N/Atypedef struct grub_net_link_level_address
2N/A{
2N/A grub_link_level_protocol_id_t type;
2N/A union
2N/A {
2N/A grub_uint8_t mac[6];
2N/A };
2N/A} grub_net_link_level_address_t;
2N/A
2N/Atypedef enum grub_net_interface_flags
2N/A {
2N/A GRUB_NET_INTERFACE_HWADDRESS_IMMUTABLE = 1,
2N/A GRUB_NET_INTERFACE_ADDRESS_IMMUTABLE = 2,
2N/A GRUB_NET_INTERFACE_PERMANENT = 4
2N/A } grub_net_interface_flags_t;
2N/A
2N/Atypedef enum grub_net_card_flags
2N/A {
2N/A GRUB_NET_CARD_HWADDRESS_IMMUTABLE = 1,
2N/A GRUB_NET_CARD_NO_MANUAL_INTERFACES = 2
2N/A } grub_net_card_flags_t;
2N/A
2N/Astruct grub_net_card;
2N/A
2N/Astruct grub_net_card_driver
2N/A{
2N/A struct grub_net_card_driver *next;
2N/A const char *name;
2N/A grub_err_t (*open) (const struct grub_net_card *dev);
2N/A void (*close) (const struct grub_net_card *dev);
2N/A grub_err_t (*send) (const struct grub_net_card *dev,
2N/A struct grub_net_buff *buf);
2N/A struct grub_net_buff * (*recv) (const struct grub_net_card *dev);
2N/A};
2N/A
2N/Atypedef struct grub_net_packet
2N/A{
2N/A struct grub_net_packet *next;
2N/A struct grub_net_packet *prev;
2N/A struct grub_net_packets *up;
2N/A struct grub_net_buff *nb;
2N/A} grub_net_packet_t;
2N/A
2N/Atypedef struct grub_net_packets
2N/A{
2N/A grub_net_packet_t *first;
2N/A grub_net_packet_t *last;
2N/A} grub_net_packets_t;
2N/A
2N/A#ifdef GRUB_MACHINE_EFI
2N/A#include <grub/efi/api.h>
2N/A#endif
2N/A
2N/Astruct grub_net_slaac_mac_list
2N/A{
2N/A struct grub_net_slaac_mac_list *next;
2N/A grub_net_link_level_address_t address;
2N/A int slaac_counter;
2N/A char *name;
2N/A};
2N/A
2N/Astruct grub_net_link_layer_entry;
2N/A
2N/Astruct grub_net_card
2N/A{
2N/A struct grub_net_card *next;
2N/A const char *name;
2N/A struct grub_net_card_driver *driver;
2N/A grub_net_link_level_address_t default_address;
2N/A grub_net_card_flags_t flags;
2N/A int num_ifaces;
2N/A int opened;
2N/A unsigned idle_poll_delay_ms;
2N/A grub_uint64_t last_poll;
2N/A grub_size_t mtu;
2N/A struct grub_net_slaac_mac_list *slaac_list;
2N/A grub_ssize_t new_ll_entry;
2N/A struct grub_net_link_layer_entry *link_layer_table;
2N/A union
2N/A {
2N/A#ifdef GRUB_MACHINE_EFI
2N/A struct
2N/A {
2N/A struct grub_efi_simple_network *efi_net;
2N/A grub_efi_handle_t efi_handle;
2N/A };
2N/A#endif
2N/A void *data;
2N/A int data_num;
2N/A };
2N/A};
2N/A
2N/Astruct grub_net_network_level_interface;
2N/A
2N/Atypedef enum grub_network_level_protocol_id
2N/A{
2N/A GRUB_NET_NETWORK_LEVEL_PROTOCOL_DHCP_RECV,
2N/A GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV4,
2N/A GRUB_NET_NETWORK_LEVEL_PROTOCOL_IPV6
2N/A} grub_network_level_protocol_id_t;
2N/A
2N/Atypedef struct grub_net_network_level_address
2N/A{
2N/A grub_network_level_protocol_id_t type;
2N/A union
2N/A {
2N/A grub_uint32_t ipv4;
2N/A grub_uint64_t ipv6[2];
2N/A };
2N/A} grub_net_network_level_address_t;
2N/A
2N/Atypedef struct grub_net_network_level_netaddress
2N/A{
2N/A grub_net_network_level_address_t addr;
2N/A int masksize;
2N/A} grub_net_network_level_netaddress_t;
2N/A
2N/A#define FOR_PACKETS(cont,var) for (var = (cont).first; var; var = var->next)
2N/A
2N/Astatic inline grub_err_t
2N/Agrub_net_put_packet (grub_net_packets_t *pkts, struct grub_net_buff *nb)
2N/A{
2N/A struct grub_net_packet *n;
2N/A
2N/A n = grub_malloc (sizeof (*n));
2N/A if (!n)
2N/A return grub_errno;
2N/A
2N/A n->nb = nb;
2N/A n->next = NULL;
2N/A n->prev = NULL;
2N/A n->up = pkts;
2N/A if (pkts->first)
2N/A {
2N/A pkts->last->next = n;
2N/A pkts->last = n;
2N/A n->prev = pkts->last;
2N/A }
2N/A else
2N/A pkts->first = pkts->last = n;
2N/A
2N/A return GRUB_ERR_NONE;
2N/A}
2N/A
2N/Astatic inline void
2N/Agrub_net_remove_packet (grub_net_packet_t *pkt)
2N/A{
2N/A if (pkt->prev)
2N/A pkt->prev->next = pkt->next;
2N/A else
2N/A pkt->up->first = pkt->next;
2N/A if (pkt->next)
2N/A pkt->next->prev = pkt->prev;
2N/A else
2N/A pkt->up->last = pkt->prev;
2N/A grub_free (pkt);
2N/A}
2N/A
2N/Atypedef struct grub_net_app_protocol *grub_net_app_level_t;
2N/A
2N/Atypedef struct grub_net_socket *grub_net_socket_t;
2N/A
2N/Astruct grub_net_app_protocol
2N/A{
2N/A struct grub_net_app_protocol *next;
2N/A const char *name;
2N/A grub_err_t (*dir) (grub_device_t device, const char *path,
2N/A int (*hook) (const char *filename,
2N/A const struct grub_dirhook_info *info));
2N/A grub_err_t (*open) (struct grub_file *file, const char *filename);
2N/A grub_err_t (*seek) (struct grub_file *file, grub_off_t off);
2N/A grub_err_t (*close) (struct grub_file *file);
2N/A};
2N/A
2N/Atypedef struct grub_net
2N/A{
2N/A char *server;
2N/A char *name;
2N/A grub_net_app_level_t protocol;
2N/A grub_net_packets_t packs;
2N/A grub_off_t offset;
2N/A grub_fs_t fs;
2N/A int eof;
2N/A} *grub_net_t;
2N/A
2N/Aextern grub_net_t (*EXPORT_VAR (grub_net_open)) (const char *name);
2N/A
2N/Astruct grub_net_network_level_interface
2N/A{
2N/A struct grub_net_network_level_interface *next;
2N/A struct grub_net_network_level_interface **prev;
2N/A char *name;
2N/A struct grub_net_card *card;
2N/A grub_net_network_level_netaddress_t address;
2N/A grub_net_link_level_address_t hwaddress;
2N/A grub_net_interface_flags_t flags;
2N/A struct grub_net_bootp_packet *dhcp_ack;
2N/A grub_size_t dhcp_acklen;
2N/A void *data;
2N/A};
2N/A
2N/Astruct grub_net_session;
2N/A
2N/Astruct grub_net_session_level_protocol
2N/A{
2N/A void (*close) (struct grub_net_session *session);
2N/A grub_ssize_t (*recv) (struct grub_net_session *session, void *buf,
2N/A grub_size_t size);
2N/A grub_err_t (*send) (struct grub_net_session *session, void *buf,
2N/A grub_size_t size);
2N/A};
2N/A
2N/Astruct grub_net_session
2N/A{
2N/A struct grub_net_session_level_protocol *protocol;
2N/A void *data;
2N/A};
2N/A
2N/Astatic inline void
2N/Agrub_net_session_close (struct grub_net_session *session)
2N/A{
2N/A session->protocol->close (session);
2N/A}
2N/A
2N/Astatic inline grub_err_t
2N/Agrub_net_session_send (struct grub_net_session *session, void *buf,
2N/A grub_size_t size)
2N/A{
2N/A return session->protocol->send (session, buf, size);
2N/A}
2N/A
2N/Astatic inline grub_ssize_t
2N/Agrub_net_session_recv (struct grub_net_session *session, void *buf,
2N/A grub_size_t size)
2N/A{
2N/A return session->protocol->recv (session, buf, size);
2N/A}
2N/A
2N/Astruct grub_net_network_level_interface *
2N/Agrub_net_add_addr (const char *name,
2N/A struct grub_net_card *card,
2N/A const grub_net_network_level_netaddress_t *addr,
2N/A const grub_net_link_level_address_t *hwaddress,
2N/A grub_net_interface_flags_t flags);
2N/A
2N/Aextern struct grub_net_network_level_interface *grub_net_network_level_interfaces;
2N/A#define FOR_NET_NETWORK_LEVEL_INTERFACES(var) for (var = grub_net_network_level_interfaces; var; var = var->next)
2N/A
2N/Aextern grub_net_app_level_t grub_net_app_level_list;
2N/A
2N/A#ifndef GRUB_LST_GENERATOR
2N/Astatic inline void
2N/Agrub_net_app_level_register (grub_net_app_level_t proto)
2N/A{
2N/A grub_list_push (GRUB_AS_LIST_P (&grub_net_app_level_list),
2N/A GRUB_AS_LIST (proto));
2N/A}
2N/A#endif
2N/A
2N/Astatic inline void
2N/Agrub_net_app_level_unregister (grub_net_app_level_t proto)
2N/A{
2N/A grub_list_remove (GRUB_AS_LIST_P (&grub_net_app_level_list),
2N/A GRUB_AS_LIST (proto));
2N/A}
2N/A
2N/A#define FOR_NET_APP_LEVEL(var) FOR_LIST_ELEMENTS((var), \
2N/A (grub_net_app_level_list))
2N/A
2N/Aextern struct grub_net_card *grub_net_cards;
2N/A
2N/Astatic inline void
2N/Agrub_net_card_register (struct grub_net_card *card)
2N/A{
2N/A grub_list_push (GRUB_AS_LIST_P (&grub_net_cards),
2N/A GRUB_AS_LIST (card));
2N/A}
2N/A
2N/Avoid
2N/Agrub_net_card_unregister (struct grub_net_card *card);
2N/A
2N/A#define FOR_NET_CARDS(var) for (var = grub_net_cards; var; var = var->next)
2N/A#define FOR_NET_CARDS_SAFE(var, next) for (var = grub_net_cards, next = (var ? var->next : 0); var; var = next, next = (var ? var->next : 0))
2N/A
2N/A
2N/Astruct grub_net_session *
2N/Agrub_net_open_tcp (char *address, grub_uint16_t port);
2N/A
2N/Agrub_err_t
2N/Agrub_net_resolve_address (const char *name,
2N/A grub_net_network_level_address_t *addr);
2N/A
2N/Agrub_err_t
2N/Agrub_net_resolve_net_address (const char *name,
2N/A grub_net_network_level_netaddress_t *addr);
2N/A
2N/Agrub_err_t
2N/Agrub_net_route_address (grub_net_network_level_address_t addr,
2N/A grub_net_network_level_address_t *gateway,
2N/A struct grub_net_network_level_interface **interf);
2N/A
2N/A
2N/Agrub_err_t
2N/Agrub_net_add_route (const char *name,
2N/A grub_net_network_level_netaddress_t target,
2N/A struct grub_net_network_level_interface *inter);
2N/A
2N/Agrub_err_t
2N/Agrub_net_add_route_gw (const char *name,
2N/A grub_net_network_level_netaddress_t target,
2N/A grub_net_network_level_address_t gw);
2N/A
2N/A
2N/A#define GRUB_NET_BOOTP_MAC_ADDR_LEN 16
2N/A
2N/Atypedef grub_uint8_t grub_net_bootp_mac_addr_t[GRUB_NET_BOOTP_MAC_ADDR_LEN];
2N/A
2N/Astruct grub_net_bootp_packet
2N/A{
2N/A grub_uint8_t opcode;
2N/A grub_uint8_t hw_type; /* hardware type. */
2N/A grub_uint8_t hw_len; /* hardware addr len. */
2N/A grub_uint8_t gate_hops; /* zero it. */
2N/A grub_uint32_t ident; /* random number chosen by client. */
2N/A grub_uint16_t seconds; /* seconds since did initial bootstrap. */
2N/A grub_uint16_t flags;
2N/A grub_uint32_t client_ip;
2N/A grub_uint32_t your_ip;
2N/A grub_uint32_t server_ip;
2N/A grub_uint32_t gateway_ip;
2N/A grub_net_bootp_mac_addr_t mac_addr;
2N/A char server_name[64];
2N/A char boot_file[128];
2N/A grub_uint8_t vendor[0];
2N/A} __attribute__ ((packed));
2N/A
2N/A#define GRUB_NET_BOOTP_RFC1048_MAGIC_0 0x63
2N/A#define GRUB_NET_BOOTP_RFC1048_MAGIC_1 0x82
2N/A#define GRUB_NET_BOOTP_RFC1048_MAGIC_2 0x53
2N/A#define GRUB_NET_BOOTP_RFC1048_MAGIC_3 0x63
2N/A
2N/Aenum
2N/A {
2N/A GRUB_NET_BOOTP_PAD = 0x00,
2N/A GRUB_NET_BOOTP_NETMASK = 0x01,
2N/A GRUB_NET_BOOTP_ROUTER = 0x03,
2N/A GRUB_NET_BOOTP_DNS = 0x06,
2N/A GRUB_NET_BOOTP_HOSTNAME = 0x0c,
2N/A GRUB_NET_BOOTP_DOMAIN = 0x0f,
2N/A GRUB_NET_BOOTP_ROOT_PATH = 0x11,
2N/A GRUB_NET_BOOTP_EXTENSIONS_PATH = 0x12,
2N/A GRUB_NET_BOOTP_END = 0xff
2N/A };
2N/A
2N/Astruct grub_net_network_level_interface *
2N/Agrub_net_configure_by_dhcp_ack (const char *name,
2N/A struct grub_net_card *card,
2N/A grub_net_interface_flags_t flags,
2N/A const struct grub_net_bootp_packet *bp,
2N/A grub_size_t size,
2N/A int is_def, char **device, char **path);
2N/A
2N/Avoid
2N/Agrub_net_process_dhcp (struct grub_net_buff *nb,
2N/A struct grub_net_card *card);
2N/A
2N/Aint
2N/Agrub_net_hwaddr_cmp (const grub_net_link_level_address_t *a,
2N/A const grub_net_link_level_address_t *b);
2N/Aint
2N/Agrub_net_addr_cmp (const grub_net_network_level_address_t *a,
2N/A const grub_net_network_level_address_t *b);
2N/A
2N/A
2N/A/*
2N/A Currently supported adresses:
2N/A IPv4: XXX.XXX.XXX.XXX
2N/A IPv6: XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX
2N/A */
2N/A#define GRUB_NET_MAX_STR_ADDR_LEN sizeof ("XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX")
2N/A
2N/A/*
2N/A Currently suppoerted adresses:
2N/A ethernet: XX:XX:XX:XX:XX:XX
2N/A */
2N/A
2N/A#define GRUB_NET_MAX_STR_HWADDR_LEN (sizeof ("XX:XX:XX:XX:XX:XX"))
2N/A
2N/Avoid
2N/Agrub_net_addr_to_str (const grub_net_network_level_address_t *target,
2N/A char *buf);
2N/Avoid
2N/Agrub_net_hwaddr_to_str (const grub_net_link_level_address_t *addr, char *str);
2N/A
2N/Aextern struct grub_net_network_level_interface *grub_net_network_level_interfaces;
2N/A#define FOR_NET_NETWORK_LEVEL_INTERFACES(var) for (var = grub_net_network_level_interfaces; var; var = var->next)
2N/A
2N/A#define FOR_NET_NETWORK_LEVEL_INTERFACES_SAFE(var,next) for (var = grub_net_network_level_interfaces, next = (var ? var->next : 0); var; var = next, next = (var ? var->next : 0))
2N/A
2N/Avoid
2N/Agrub_net_poll_cards (unsigned time);
2N/A
2N/Avoid grub_bootp_init (void);
2N/Avoid grub_bootp_fini (void);
2N/A
2N/Avoid grub_dns_init (void);
2N/Avoid grub_dns_fini (void);
2N/A
2N/Astatic inline void
2N/Agrub_net_network_level_interface_unregister (struct grub_net_network_level_interface *inter)
2N/A{
2N/A inter->card->num_ifaces--;
2N/A *inter->prev = inter->next;
2N/A if (inter->next)
2N/A inter->next->prev = inter->prev;
2N/A inter->next = 0;
2N/A inter->prev = 0;
2N/A}
2N/A
2N/Avoid
2N/Agrub_net_tcp_retransmit (void);
2N/A
2N/Avoid
2N/Agrub_net_link_layer_add_address (struct grub_net_card *card,
2N/A const grub_net_network_level_address_t *nl,
2N/A const grub_net_link_level_address_t *ll,
2N/A int override);
2N/Aint
2N/Agrub_net_link_layer_resolve_check (struct grub_net_network_level_interface *inf,
2N/A const grub_net_network_level_address_t *proto_addr);
2N/Agrub_err_t
2N/Agrub_net_link_layer_resolve (struct grub_net_network_level_interface *inf,
2N/A const grub_net_network_level_address_t *proto_addr,
2N/A grub_net_link_level_address_t *hw_addr);
2N/Agrub_err_t
2N/Agrub_net_dns_lookup (const char *name,
2N/A const struct grub_net_network_level_address *servers,
2N/A grub_size_t n_servers,
2N/A grub_size_t *naddresses,
2N/A struct grub_net_network_level_address **addresses,
2N/A int cache);
2N/Agrub_err_t
2N/Agrub_net_add_dns_server (const struct grub_net_network_level_address *s);
2N/Avoid
2N/Agrub_net_remove_dns_server (const struct grub_net_network_level_address *s);
2N/A
2N/A
2N/Aextern char *grub_net_default_server;
2N/A
2N/A#define GRUB_NET_TRIES 40
2N/A#define GRUB_NET_INTERVAL 400
2N/A
2N/A#endif /* ! GRUB_NET_HEADER */