net.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. /* Minimal network stack: ARP + ICMP echo (ping) over a netdev NIC.
  2. Parsing, decoding, reply generation, and the card's IPv4 address. */
  3. #ifndef NET_H
  4. #define NET_H
  5. /* Ethernet ethertypes. */
  6. #define ET_IPV4 0x0800
  7. #define ET_ARP 0x0806
  8. #define ET_IPV6 0x86DD
  9. /* IPv4 protocol numbers. */
  10. #define IPPROTO_ICMP 1
  11. #define IPPROTO_UDP 17
  12. #define IPPROTO_TCP 6
  13. /* ICMP message types. */
  14. #define ICMP_ECHO_REPLY 0
  15. #define ICMP_ECHO_REQUEST 8
  16. void net_set_ip(const unsigned char ip[4]);
  17. void net_get_ip(unsigned char ip[4]);
  18. int net_parse_ip(const char *s, unsigned char ip[4]); /* 0 on success, -1 on error */
  19. void net_print_ip(void);
  20. /* Full configuration (mask/gateway stay zero when unknown). net_set_ip()
  21. * keeps the manual override semantics and clears mask/gateway; DHCP uses
  22. * net_configure(). */
  23. void net_configure(const unsigned char ip[4], const unsigned char mask[4],
  24. const unsigned char gw[4]);
  25. void net_get_mask(unsigned char mask[4]);
  26. void net_get_gateway(unsigned char gw[4]);
  27. int net_is_configured(void); /* ip != 0.0.0.0 */
  28. /* DNS resolver address (DHCP option 6 or the `netdns` command); zero when
  29. * unknown. Kept across net_set_ip()/net_configure() so a manual setting
  30. * survives a dhcp run without option 6. */
  31. void net_get_dns(unsigned char dns[4]);
  32. void net_set_dns(const unsigned char dns[4]);
  33. /* Next hop towards dst: the gateway when dst is off-subnet and a gateway is
  34. * known, else dst itself. */
  35. void net_next_hop(const unsigned char dst[4], unsigned char hop[4]);
  36. /* Resolve dst_ip's MAC by ARP (3 tries, 1 s apart), polling the active NIC.
  37. * Returns 0 on success, -1 when no reply arrived, -2 on transmit error.
  38. * The caller must own the NIC (netdev_acquire). */
  39. int net_arp_resolve(const unsigned char *dst_ip, unsigned char mac[6]);
  40. const char *net_ethertype_name(unsigned short et);
  41. /* Internet checksum (16-bit one's complement, network byte order). */
  42. unsigned short net_checksum(const void *data, unsigned int len);
  43. /* TCP checksum over the IPv4 pseudo-header (src/dst/proto/length) plus the
  44. * TCP header and payload; result is in network byte order. */
  45. unsigned short net_checksum_tcp(const unsigned char *src_ip,
  46. const unsigned char *dst_ip,
  47. const unsigned char *tcp, unsigned int len);
  48. /* Largest UDP payload net_udp_send() accepts. */
  49. #define NET_UDP_MAX 1400
  50. /* Send one UDP datagram (IPv4, checksum disabled) in a single Ethernet frame
  51. * to dst_mac/dst_ip, with the configured source address. Returns 0 on
  52. * success, -1 on error. */
  53. int net_udp_send(const unsigned char *dst_mac, const unsigned char *dst_ip,
  54. unsigned int src_port, unsigned int dst_port,
  55. const void *payload, unsigned int len);
  56. /* Same, but with an explicit source address (DHCP uses 0.0.0.0). */
  57. int net_udp_send_from(const unsigned char *src_ip,
  58. const unsigned char *dst_mac, const unsigned char *dst_ip,
  59. unsigned int src_port, unsigned int dst_port,
  60. const void *payload, unsigned int len);
  61. /* Same, but forced onto a specific NIC (netlog/netkexec management link). */
  62. struct netdev;
  63. int net_udp_send_from_dev(const struct netdev *nd,
  64. const unsigned char *src_ip,
  65. const unsigned char *dst_mac, const unsigned char *dst_ip,
  66. unsigned int src_port, unsigned int dst_port,
  67. const void *payload, unsigned int len);
  68. /* Parse one Ethernet frame as a UDP datagram addressed to us or to the
  69. * broadcast address. Fills the addresses/ports and the payload location.
  70. * Returns 1 on match. */
  71. int net_udp_parse(const unsigned char *frame, unsigned int len,
  72. unsigned char src_ip[4], unsigned char dst_ip[4],
  73. unsigned int *src_port, unsigned int *dst_port,
  74. const unsigned char **payload, unsigned int *plen);
  75. /* Same, but without the destination-IP filter. DHCP uses this because a
  76. * server may send its OFFER unicast to the address it is offering, which is
  77. * not our current (static) IP. The protocol layer still validates the DHCP
  78. * transaction ID and chaddr. */
  79. int net_udp_parse_any(const unsigned char *frame, unsigned int len,
  80. unsigned char src_ip[4], unsigned char dst_ip[4],
  81. unsigned int *src_port, unsigned int *dst_port,
  82. const unsigned char **payload, unsigned int *plen);
  83. /* Print one decoded frame summary line (dst/src/ethertype + ARP/IP/ICMP). */
  84. void net_decode_frame(const unsigned char *frame, unsigned int len);
  85. /* Build a reply to an ARP request or ICMP echo request addressed to us.
  86. Returns reply length (> 0) or 0 if the frame needs no reply. */
  87. int net_build_reply(const unsigned char *frame, unsigned int len,
  88. unsigned char *out, unsigned int maxout);
  89. #endif