eth_common.h

Go to the documentation of this file.

//  Copyright 2018, Carnegie Mellon University
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
 
#ifndef ETH_COMMON_H_
#define ETH_COMMON_H_
 
#include <arpa/inet.h>
#include <ifaddrs.h>
#include <linux/if_packet.h>
#include <net/if.h>
#include <sys/ioctl.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <unistd.h>
 
#include <cassert>
#include <sstream>
#include <string>
 
#include "utils.h"
 
static constexpr uint16_t kIPEtherType = 0x800;
static constexpr uint16_t kIPHdrProtocol = 0x11;
 
static inline std::string mac_to_string(const uint8_t* mac) {
  std::ostringstream ret;
  for (size_t i = 0; i < 6; i++) {
    ret << std::hex << static_cast<uint32_t>(mac[i]);
    if (i != 5) ret << ":";
  }
  return ret.str();
}
 
static inline uint32_t ipv4_from_str(const char* ip) {
  uint32_t addr;
  int ret = inet_pton(AF_INET, ip, &addr);
  RtAssert(ret == 1, "inet_pton() failed for " + std::string(ip));
  return addr;
}
 
static inline std::string ipv4_to_string(uint32_t ipv4_addr) {
  char str[INET_ADDRSTRLEN];
  const char* ret = inet_ntop(AF_INET, &ipv4_addr, str, sizeof(str));
  RtAssert(ret == str, "inet_ntop failed");
  str[INET_ADDRSTRLEN - 1] = 0;  // Null-terminate
  return str;
}
 
struct eth_routing_info_t {
  uint8_t mac[6];
  uint32_t ipv4_addr;
  uint16_t udp_port;
 
  std::string to_string() {
    std::ostringstream ret;
    ret << "[MAC " << mac_to_string(mac) << ", IP " << ipv4_to_string(ipv4_addr)
        << ", UDP port " << std::to_string(udp_port) << "]";
 
    return std::string(ret.str());
  }
  // This must be smaller than Transport::kMaxRoutingInfoSize, but a static
  // assert here causes a circular dependency.
};
 
struct eth_hdr_t {
  uint8_t dst_mac[6];
  uint8_t src_mac[6];
  uint16_t eth_type;
 
  std::string to_string() const {
    std::ostringstream ret;
    ret << "[ETH: dst " << mac_to_string(dst_mac) << ", src "
        << mac_to_string(src_mac) << ", eth_type "
        << std::to_string(ntohs(eth_type)) << "]";
    return ret.str();
  }
} __attribute__((packed));
 
struct ipv4_hdr_t {
  uint8_t ihl : 4;
  uint8_t version : 4;
  uint8_t ecn : 2;
  uint8_t dscp : 6;
  uint16_t tot_len;
  uint16_t id;
  uint16_t frag_off;
  uint8_t ttl;
  uint8_t protocol;
  uint16_t check;
  uint32_t src_ip;
  uint32_t dst_ip;
 
  std::string to_string() const {
    std::ostringstream ret;
    ret << "[IPv4: ihl " << std::to_string(ihl) << ", version "
        << std::to_string(version) << ", ecn " << std::to_string(ecn)
        << ", tot_len " << std::to_string(ntohs(tot_len)) << ", id "
        << std::to_string(ntohs(id)) << ", frag_off "
        << std::to_string(ntohs(frag_off)) << ", ttl " << std::to_string(ttl)
        << ", protocol " << std::to_string(protocol) << ", check "
        << std::to_string(check) << ", src IP " << ipv4_to_string(src_ip)
        << ", dst IP " << ipv4_to_string(dst_ip) << "]";
    return ret.str();
  }
} __attribute__((packed));
 
struct udp_hdr_t {
  uint16_t src_port;
  uint16_t dst_port;
  uint16_t len;
  uint16_t check;
 
  std::string to_string() const {
    std::ostringstream ret;
    ret << "[UDP: src_port " << std::to_string(ntohs(src_port)) << ", dst_port "
        << std::to_string(ntohs(dst_port)) << ", len "
        << std::to_string(ntohs(len)) << ", check " << std::to_string(check)
        << "]";
    return ret.str();
  }
} __attribute__((packed));
 
static constexpr size_t kInetHdrsTotSize =
    sizeof(eth_hdr_t) + sizeof(ipv4_hdr_t) + sizeof(udp_hdr_t);
static_assert(kInetHdrsTotSize == 42);
 
static inline std::string frame_header_to_string(const uint8_t* buf) {
  auto* eth_hdr = reinterpret_cast<const eth_hdr_t*>(buf);
  auto* ipv4_hdr = reinterpret_cast<const ipv4_hdr_t*>(&eth_hdr[1]);
  auto* udp_hdr = reinterpret_cast<const udp_hdr_t*>(&ipv4_hdr[1]);
 
  return eth_hdr->to_string() + ", " + ipv4_hdr->to_string() + ", " +
         udp_hdr->to_string();
}
 
static void inline gen_eth_header(eth_hdr_t* eth_header, const uint8_t* src_mac,
                                  const uint8_t* dst_mac) {
  std::memcpy(eth_header->src_mac, src_mac, 6);
  std::memcpy(eth_header->dst_mac, dst_mac, 6);
  eth_header->eth_type = htons(kIPEtherType);
}
 
static inline void gen_ipv4_header(ipv4_hdr_t* ipv4_hdr, uint32_t src_ip,
                                   uint32_t dst_ip, uint16_t data_size) {
  ipv4_hdr->version = 4;
  ipv4_hdr->ihl = 5;
  ipv4_hdr->ecn = 1;  // ECT => ECN-capable transport
  ipv4_hdr->dscp = 0;
  ipv4_hdr->tot_len = htons(sizeof(ipv4_hdr_t) + sizeof(udp_hdr_t) + data_size);
  ipv4_hdr->id = htons(0);
  ipv4_hdr->frag_off = htons(0);
  ipv4_hdr->ttl = 128;
  ipv4_hdr->protocol = kIPHdrProtocol;
  ipv4_hdr->src_ip = htonl(src_ip);
  ipv4_hdr->dst_ip = htonl(dst_ip);
  ipv4_hdr->check = 0;
}
 
static inline void gen_udp_header(udp_hdr_t* udp_hdr, uint16_t src_port,
                                  uint16_t dst_port, uint16_t data_size) {
  udp_hdr->src_port = htons(src_port);
  udp_hdr->dst_port = htons(dst_port);
  udp_hdr->len = htons(sizeof(udp_hdr_t) + data_size);
  udp_hdr->check = 0;
}
 
static inline uint32_t get_interface_ipv4_addr(const std::string& interface) {
  struct ifaddrs *ifaddr, *ifa;
  RtAssert(getifaddrs(&ifaddr) == 0);
  uint32_t ipv4_addr = 0;
 
  for (ifa = ifaddr; ifa != nullptr; ifa = ifa->ifa_next) {
    if (strcmp(ifa->ifa_name, interface.c_str()) != 0) continue;
 
    // We might get the same interface multiple times with different sa_family
    if (ifa->ifa_addr == nullptr || ifa->ifa_addr->sa_family != AF_INET) {
      continue;
    }
 
    auto sin_addr = reinterpret_cast<sockaddr_in*>(ifa->ifa_addr);
    ipv4_addr = ntohl(*reinterpret_cast<uint32_t*>(&sin_addr->sin_addr));
  }
 
  RtAssert(ipv4_addr != 0,
           std::string("Failed to find interface ") + interface);
 
  freeifaddrs(ifaddr);
  return ipv4_addr;
}
 
static inline void fill_interface_mac(const std::string& interface,
                                      uint8_t* mac) {
  struct ifreq ifr;
  ifr.ifr_addr.sa_family = AF_INET;
  strncpy(ifr.ifr_name, interface.c_str(), IFNAMSIZ - 1);
 
  int fd = socket(AF_INET, SOCK_DGRAM, 0);
  assert(fd >= 0);
 
  int ret = ioctl(fd, SIOCGIFHWADDR, &ifr);
  RtAssert(ret == 0, "MAC address IOCTL failed");
  close(fd);
 
  for (size_t i = 0; i < 6; i++) {
    mac[i] = static_cast<uint8_t>(ifr.ifr_hwaddr.sa_data[i]);
  }
}
 
#endif  // ETH_COMMON_H_