[PATCH 01/17] net: ipv6: Add IPv6 basic primitives

Vyacheslav Mitrofanov V v.v.mitrofanov at yadro.com
Mon Sep 12 12:11:06 CEST 2022


On Mon, 2022-09-12 at 10:23 +0300, Ramon Fried wrote:
> «Внимание! Данное письмо от внешнего адресата!»
> 
> On Tue, Sep 6, 2022 at 6:10 PM Viacheslav Mitrofanov
> <v.v.mitrofanov at yadro.com> wrote:
> > This patch is a collection of basic primitives that are
> > prerequisite for
> > further IPv6 implementation.
> > 
> > There are structures definition such as IPv6 header, UDP header
> > (for TFTP), ICMPv6 header. There are auxiliary defines such as
> > protocol
> > codes, padding, struct size and etc. Also here are functions
> > prototypes
> > and its empty implementation that will be used as API for further
> > patches.
> > Here are variables declaration such as IPv6 address of our host,
> > gateway, ipv6 server.
> > 
> > Signed-off-by: Viacheslav Mitrofanov <v.v.mitrofanov at yadro.com>
> > ---
> >  include/net6.h | 369
> > +++++++++++++++++++++++++++++++++++++++++++++++++
> >  net/net6.c     |  31 +++++
> >  2 files changed, 400 insertions(+)
> >  create mode 100644 include/net6.h
> >  create mode 100644 net/net6.c
> > 
> > diff --git a/include/net6.h b/include/net6.h
> > new file mode 100644
> > index 0000000000..80236bd5ac
> > --- /dev/null
> > +++ b/include/net6.h
> > @@ -0,0 +1,369 @@
> > +/* SPDX-License-Identifier: GPL-2.0+ */
> > +/*
> > + * Copyright (C) 2013 Allied Telesis Labs NZ
> > + * Chris Packham, <judge.packham at gmail.com>
> > + *
> > + * Copyright (C) 2022 YADRO
> > + * Viacheslav Mitrofanov <v.v.mitrofanov at yadro.com>
> > + */
> > +
> > +#ifndef __NET6_H__
> > +#define __NET6_H__
> > +
> > +#include <net.h>
> > +#include <linux/ctype.h>
> > +
> > +/* struct in6_addr - 128 bits long IPv6 address */
> > +struct in6_addr {
> > +       union {
> > +               u8      u6_addr8[16];
> > +               __be16  u6_addr16[8];
> > +               __be32  u6_addr32[4];
> > +       } in6_u;
> > +
> > +#define s6_addr                in6_u.u6_addr8
> > +#define s6_addr16      in6_u.u6_addr16
> > +#define s6_addr32      in6_u.u6_addr32
> > +};
> > +
> > +#define IN6ADDRSZ      sizeof(struct in6_addr)
> > +#define INETHADDRSZ    sizeof(net_ethaddr)
> > +
> > +#define PROT_IP6       0x86DD  /* IPv6 protocol */
> > +#define PROT_ICMPV6    58      /* ICMPv6 protocol*/
> > +
> > +#define IPV6_ADDRSCOPE_INTF    0x01
> > +#define IPV6_ADDRSCOPE_LINK    0x02
> > +#define IPV6_ADDRSCOPE_AMDIN   0x04
> > +#define IPV6_ADDRSCOPE_SITE    0x05
> > +#define IPV6_ADDRSCOPE_ORG     0x08
> > +#define IPV6_ADDRSCOPE_GLOBAL  0x0E
> > +
> > +#define USE_IP6_CMD_PARAM      "-ipv6"
> > +
> > +/**
> > + * struct ipv6hdr - Internet Protocol V6 (IPv6) header.
> > + *
> > + * IPv6 packet header as defined in RFC 2460.
> > + */
> > +struct ip6_hdr {
> > +#if defined(__LITTLE_ENDIAN_BITFIELD)
> > +       u8      priority:4,
> > +               version:4;
> > +#elif defined(__BIG_ENDIAN_BITFIELD)
> > +       u8      version:4,
> > +               priority:4;
> > +#else
> > +#error  "Please fix <asm/byteorder.h>"
> > +#endif
> > +       u8              flow_lbl[3];
> > +       __be16          payload_len;
> > +       u8              nexthdr;
> > +       u8              hop_limit;
> > +       struct in6_addr saddr;
> > +       struct in6_addr daddr;
> > +};
> > +#define IP6_HDR_SIZE (sizeof(struct ip6_hdr))
> > +
> > +/* struct udp_hdr - User Datagram Protocol header */
> > +struct udp_hdr {
> > +       u16             udp_src;        /* UDP source
> > port              */
> > +       u16             udp_dst;        /* UDP destination
> > port         */
> > +       u16             udp_len;        /* Length of UDP
> > packet         */
> > +       u16             udp_xsum;       /*
> > Checksum                     */
> > +} __packed;
> > +
> > +/*
> > + * Handy for static initialisations of struct in6_addr, atlhough
> > the
> > + * c99 '= { 0 }' idiom might work depending on you compiler.
> > + */
> > +#define ZERO_IPV6_ADDR { { { 0x00, 0x00, 0x00, 0x00, \
> > +                         0x00, 0x00, 0x00, 0x00, \
> > +                         0x00, 0x00, 0x00, 0x00, \
> > +                         0x00, 0x00, 0x00, 0x00 } } }
> > +
> > +#define IPV6_LINK_LOCAL_PREFIX 0xfe80
> > +
> > +/* hop limit for neighbour discovery packets */
> > +#define IPV6_NDISC_HOPLIMIT             255
> > +#define NDISC_TIMEOUT                  5000UL
> > +#define NDISC_TIMEOUT_COUNT             3
> > +
> > +/* struct icmp6hdr - Internet Control Message Protocol header for
> > IPV6 */
> > +struct icmp6hdr {
> > +       u8      icmp6_type;
> > +#define IPV6_ICMP_ECHO_REQUEST                 128
> > +#define IPV6_ICMP_ECHO_REPLY                   129
> > +#define IPV6_NDISC_ROUTER_SOLICITATION         133
> > +#define IPV6_NDISC_ROUTER_ADVERTISEMENT                134
> > +#define IPV6_NDISC_NEIGHBOUR_SOLICITATION      135
> > +#define IPV6_NDISC_NEIGHBOUR_ADVERTISEMENT     136
> > +#define IPV6_NDISC_REDIRECT                    137
> > +       u8      icmp6_code;
> > +       __be16  icmp6_cksum;
> > +
> > +       /* ICMPv6 data */
> > +       union {
> > +               __be32  un_data32[1];
> > +               __be16  un_data16[2];
> > +               u8      un_data8[4];
> > +
> > +               /* struct icmpv6_echo - echo request/reply message
> > format */
> > +               struct icmpv6_echo {
> > +                       __be16          identifier;
> > +                       __be16          sequence;
> > +               } u_echo;
> > +
> > +               /* struct icmpv6_nd_advt - Neighbor Advertisement
> > format */
> > +               struct icmpv6_nd_advt {
> > +#if defined(__LITTLE_ENDIAN_BITFIELD)
> > +                       __be32          reserved:5,
> > +                                       override:1,
> > +                                       solicited:1,
> > +                                       router:1,
> > +                                       reserved2:24;
> > +#elif defined(__BIG_ENDIAN_BITFIELD)
> > +                       __be32          router:1,
> > +                                       solicited:1,
> > +                                       override:1,
> > +                                       reserved:29;
> > +#else
> > +#error "Please fix <asm/byteorder.h>"
> > +#endif
> > +               } u_nd_advt;
> > +
> > +               /* struct icmpv6_nd_ra - Router Advertisement
> > format */
> > +               struct icmpv6_nd_ra {
> > +                       u8              hop_limit;
> > +#if defined(__LITTLE_ENDIAN_BITFIELD)
> > +                       u8              reserved:6,
> > +                                       other:1,
> > +                                       managed:1;
> > +
> > +#elif defined(__BIG_ENDIAN_BITFIELD)
> > +                       u8              managed:1,
> > +                                       other:1,
> > +                                       reserved:6;
> > +#else
> > +#error "Please fix <asm/byteorder.h>"
> > +#endif
> > +                       __be16          rt_lifetime;
> > +               } u_nd_ra;
> > +       } icmp6_dataun;
> > +#define icmp6_identifier       icmp6_dataun.u_echo.identifier
> > +#define icmp6_sequence         icmp6_dataun.u_echo.sequence
> > +#define icmp6_pointer          icmp6_dataun.un_data32[0]
> > +#define icmp6_mtu              icmp6_dataun.un_data32[0]
> > +#define icmp6_unused           icmp6_dataun.un_data32[0]
> > +#define icmp6_maxdelay         icmp6_dataun.un_data16[0]
> > +#define icmp6_router           icmp6_dataun.u_nd_advt.router
> > +#define
> > icmp6_solicited                icmp6_dataun.u_nd_advt.solicited
> > +#define icmp6_override         icmp6_dataun.u_nd_advt.override
> > +#define icmp6_ndiscreserved    icmp6_dataun.u_nd_advt.reserved
> > +#define
> > icmp6_hop_limit                icmp6_dataun.u_nd_ra.hop_limit
> > +#define icmp6_addrconf_managed icmp6_dataun.u_nd_ra.managed
> > +#define icmp6_addrconf_other   icmp6_dataun.u_nd_ra.other
> > +#define icmp6_rt_lifetime      icmp6_dataun.u_nd_ra.rt_lifetime
> > +};
> > +
> > +extern struct in6_addr const net_null_addr_ip6;        /* NULL
> > IPv6 address */
> > +extern struct in6_addr net_gateway6;   /* Our gateways IPv6
> > address */
> > +extern struct in6_addr net_ip6;        /* Our IPv6 addr (0 =
> > unknown) */
> > +extern struct in6_addr net_link_local_ip6;     /* Our link local
> > IPv6 addr */
> > +extern u32 net_prefix_length;  /* Our prefixlength (0 = unknown)
> > */
> > +extern struct in6_addr net_server_ip6; /* Server IPv6 addr (0 =
> > unknown) */
> > +extern bool use_ip6;
> > +
> > +/**
> > + * Convert IPv6 string addr to inner IPV6 addr format
> > + *
> > + * Examples of valid strings:
> > + *     2001:db8::0:1234:1
> > + *     2001:0db8:0000:0000:0000:0000:1234:0001
> > + *     ::1
> > + *     ::ffff:192.168.1.1
> > + *
> > + * Examples of invalid strings
> > + *     2001:db8::0::0          (:: can only appear once)
> > + *     2001:db8:192.168.1.1::1 (v4 part can only appear at the
> > end)
> > + *     192.168.1.1             (we don't implicity map v4)
> > + *
> > + * @param s IPv6 string addr format
> > + * @param len IPv6 string addr length
> > + * @param addr converted IPv6 addr
> > + * @return 0 if conversion successful, -EINVAL if fail
> > + */
> > +static inline int
> > +string_to_ip6(const char *s, size_t len, struct in6_addr *addr)
> > +{
> > +       return -EINVAL;
> > +}
> > +
> > +/**
> > + * Check if IPv6 addr is not set i.e. is zero
> > + *
> > + * @param addr IPv6 addr
> > + * @return 0 if addr is not set, -1 if is set
> > + */
> > +static inline int ip6_is_unspecified_addr(struct in6_addr *addr)
> > +{
> > +       return -1;
> > +}
> > +
> > +/**
> > + * Check if IPv6 addr belongs to our host addr
> > + *
> > + * We have 2 addresses that we should respond to. A link local
> > address and a
> > + * global address. This returns true if the specified address
> > matches either
> > + * of these.
> > + *
> > + * @param addr addr to check
> > + * @return 0 if addr is our, -1 otherwise
> > + */
> > +static inline int ip6_is_our_addr(struct in6_addr *addr)
> > +{
> > +       return -1;
> > +}
> > +
> > +/**
> > + * Check if two IPv6 addresses are in the same subnet
> > + *
> > + * @param our_addr first IPv6 addr
> > + * @param neigh_addr second IPv6 addr
> > + * @param prefix_length network mask length
> > + * @return 0 if two addresses in the same subnet, -1 otherwise
> > + */
> > +static inline int
> > +ip6_addr_in_subnet(struct in6_addr *our_addr, struct in6_addr
> > *neigh_addr,
> > +                  u32 prefix_length)
> > +{
> > +       return -1;
> > +}
> > +
> > +/**
> > + * Make up IPv6 Link Local address
> > + *
> > + * @param lladdr formed IPv6 Link Local address
> > + * @param enetaddr MAC addr of a device
> > + */
> > +static inline void
> > +ip6_make_lladdr(struct in6_addr *lladdr, unsigned char const
> > enetaddr[6])
> > +{
> > +}
> > +
> > +/**
> > + * Make up Solicited Node Multicast Address from IPv6 addr
> > + *
> > + * @param mcast_addr formed SNMA addr
> > + * @param ip6_addr base IPv6 addr
> > + */
> > +static inline void
> > +ip6_make_snma(struct in6_addr *mcast_addr, struct in6_addr
> > *ip6_addr)
> > +{
> > +}
> > +
> > +/**
> > + * Make up IPv6 multicast addr
> > + *
> > + * @param enetaddr MAC addr of a device
> > + * @param mcast_addr formed IPv6 multicast addr
> > + */
> > +static inline void
> > +ip6_make_mult_ethdstaddr(unsigned char enetaddr[6],
> > +                        struct in6_addr *mcast_addr)
> > +{
> > +}
> > +
> > +/**
> > + * Compute an internet checksum
> > + *
> > + * @param buff buffer to be checksummed
> > + * @param len length of buffer
> > + * @param sum initial sum to be added in
> > + * @return internet checksum of the buffer
> > + */
> > +static inline unsigned int
> > +csum_partial(const unsigned char *buff, int len, unsigned int sum)
> > +{
> > +       return 0;
> > +}
> > +
> > +/**
> > + * Compute checksum of IPv6 "psuedo-header" per RFC2460 section
> > 8.1
> > + *
> > + * @param saddr source IPv6 addr
> > + * @param daddr destination IPv6 add
> > + * @param len data length to be checksumed
> > + * @param proto IPv6 above protocol code
> > + * @param csum upper layer checksum
> > + * @return computed checksum
> > + */
> > +static inline unsigned short
> > +csum_ipv6_magic(struct in6_addr *saddr,
> > +               struct in6_addr *daddr, u16 len,
> > +               unsigned short proto, unsigned int csum)
> > +{
> > +       return 0;
> > +}
> > +
> > +/**
> > + * Make up IPv6 header
> > + *
> > + * @param xip pointer to IPv6 header to be formed
> > + * @param src source IPv6 addr
> > + * @param dest destination IPv6 addr
> > + * @param nextheader next header type
> > + * @param hoplimit hop limit
> > + * @param payload_len payload length
> > + * @return IPv6 header length
> > + */
> > +static inline unsigned int
> > +ip6_add_hdr(uchar *xip, struct in6_addr *src, struct in6_addr
> > *dest,
> > +           int nextheader, int hoplimit, int payload_len)
> > +{
> > +       return 0;
> > +}
> > +
> > +/**
> > + * Make up UDP packet and send it
> > + *
> > + * @param ether destination MAC addr
> > + * @param dest destination IPv6 addr
> > + * @param dport destination port
> > + * @param sport source port
> > + * @param len UDP packet length
> > + * @return 0 if send successfully, -1 otherwise
> > + */
> > +static inline int
> > +net_send_udp_packet6(uchar *ether, struct in6_addr *dest,
> > +                    int dport, int sport, int len)
> > +{
> > +       return -1;
> > +}
> > +
> > +/**
> > + * Handle IPv6 packet
> > + *
> > + * @param et pointer to the begining of the packet
> > + * @param ip6 pointer to the begining of IPv6 protocol
> > + * @param len incoming packet len
> > + * @return 0 if handle packet successfully, -EINVAL in case of
> > invalid protocol
> > + */
> > +static inline int
> > +net_ip6_handler(struct ethernet_hdr *et, struct ip6_hdr *ip6,
> > +               int len)
> > +{
> > +       return -EINVAL;
> > +}
> > +
> > +/**
> > + * Copy IPv6 addr
> > + *
> > + * @param to destination IPv6 addr
> > + * @param from source IPv6 addr
> > + */
> > +static inline void net_copy_ip6(void *to, const void *from)
> > +{
> > +}
> > +
> > +#endif /* __NET6_H__ */
> > diff --git a/net/net6.c b/net/net6.c
> > new file mode 100644
> > index 0000000000..7cd442e6e2
> > --- /dev/null
> > +++ b/net/net6.c
> > @@ -0,0 +1,31 @@
> > +// SPDX-License-Identifier: GPL-2.0+
> > +/*
> > + * Copyright (C) 2013 Allied Telesis Labs NZ
> > + * Chris Packham, <judge.packham at gmail.com>
> > + *
> > + * Copyright (C) 2022 YADRO
> > + * Viacheslav Mitrofanov <v.v.mitrofanov at yadro.com>
> > + */
> > +
> > +/* Simple IPv6 network layer implementation */
> > +
> > +#include <common.h>
> > +#include <env_internal.h>
> > +#include <malloc.h>
> > +#include <net.h>
> > +#include <net6.h>
> > +
> > +/* NULL IPv6 address */
> > +struct in6_addr const net_null_addr_ip6 = ZERO_IPV6_ADDR;
> > +/* Our gateway's IPv6 address */
> > +struct in6_addr net_gateway6 = ZERO_IPV6_ADDR;
> > +/* Our IPv6 addr (0 = unknown) */
> > +struct in6_addr net_ip6 = ZERO_IPV6_ADDR;
> > +/* Our link local IPv6 addr (0 = unknown) */
> > +struct in6_addr net_link_local_ip6 = ZERO_IPV6_ADDR;
> > +/* set server IPv6 addr (0 = unknown) */
> > +struct in6_addr net_server_ip6 = ZERO_IPV6_ADDR;
> > +/* The prefix length of our network */
> > +u32 net_prefix_length;
> > +
> > +bool use_ip6;
> > --
> > 2.25.1
> > 
> Reviewed-by: Ramon Fried <rfried.dev at gmail.com>

Hello, Ramon!

Many thanks for your review!
I'm sorry but some code that you have reviewed is version 3. I made
version 4. It has small cosmetic changes.

in cover letter...
Changes in v3:
 - Added functions and structures description in whole patch-series
 - Removed memory allocation in on_ip6addr()
 - Some functions got return code from errno.h
 - Add to string_to_ip6() length parameter to avoid obligatory null
termination
 - Add a lot of small decorative cnages

Changes in v4:
 - Fixed funcs and structures style description
 - Added omitted tags 

I think this has happened because of my mistake that I didn't add
version tags to each patch i.e. [01/17] instead of [v4,01/17] 
I can resend the whole series with these tags if it will be suitable
for you!


More information about the U-Boot mailing list