name.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
 * 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 HICN_NAME_H
#define HICN_NAME_H
 
#include <stdbool.h>
#ifndef _WIN32
#include <netinet/in.h>        // struct sockadd
#endif
#include <hicn/util/ip_address.h>
#include "common.h"
 
/******************************************************************************
 * hICN names
 ******************************************************************************/
 
#define TCP_SEQNO_LEN 4        /* bytes */
#define HICN_V4_PREFIX_LEN IPV4_ADDR_LEN
#define HICN_V6_PREFIX_LEN IPV6_ADDR_LEN
#define HICN_SEGMENT_LEN TCP_SEQNO_LEN
#define HICN_V6_NAME_LEN (HICN_V6_PREFIX_LEN + HICN_SEGMENT_LEN)    /* 20 bytes */
#define HICN_V4_NAME_LEN (HICN_V4_PREFIX_LEN + HICN_SEGMENT_LEN)    /*  8 bytes */
 
/* Prefix */
 
typedef u32 hicn_name_suffix_t;
 
typedef struct
{
  ip46_address_t name;
  u8 len;
} hicn_prefix_t;
 
/*
 * Name
 *
 * A name is a prefix + a segment name (suffix)
 */
 
typedef union
{
  struct
  {
    union
    {
      u32 prefix;
      u8 prefix_as_u8[4];
      ip4_address_t prefix_as_ip4;
    };
    hicn_name_suffix_t suffix;
  };
  u8 buffer[HICN_V4_NAME_LEN];
} hicn_v4_name_t;
 
typedef union
{
  struct
  {
    union
    {
      u64 prefix[2];
      u8 prefix_as_u8[16];
      ip6_address_t prefix_as_ip6;
    };
    hicn_name_suffix_t suffix;
  };
  u8 buffer[HICN_V6_NAME_LEN];
} hicn_v6_name_t;
 
#ifndef HICN_VPP_PLUGIN
#define HICN_NAME_COMPONENT_SIZE 2
 
typedef struct
{
  struct iovec buffers[HICN_NAME_COMPONENT_SIZE];
} hicn_iov_name_t;
 
#define UNSPEC            1 << 0
#define HNT_CONTIGUOUS    1 << 1
#define HNT_IOV           1 << 2
#define HNT_INET          1 << 3
#define HNT_INET6         1 << 4
 
typedef enum
{
  HNT_UNSPEC = UNSPEC,
  HNT_CONTIGUOUS_V4 = HNT_CONTIGUOUS | HNT_INET,
  HNT_CONTIGUOUS_V6 = HNT_CONTIGUOUS | HNT_INET6,
  HNT_IOV_V4 = HNT_IOV | HNT_INET,
  HNT_IOV_V6 = HNT_IOV | HNT_INET6,
} hicn_name_type_t;
#endif /* HICN_VPP_PLUGIN */
 
typedef struct
{
#ifndef HICN_VPP_PLUGIN
  hicn_name_type_t type;
  u8 len;
#endif                /* HICN_VPP_PLUGIN */
  union
  {
    hicn_v4_name_t ip4;
    hicn_v6_name_t ip6;
    ip46_address_t ip46;
#ifndef HICN_VPP_PLUGIN
    hicn_iov_name_t iov;
    u8 buffer[HICN_V6_NAME_LEN];
#endif                /* HICN_VPP_PLUGIN */
  };
} hicn_name_t;
 
#ifndef HICN_VPP_PLUGIN
#define _is_unspec(name)     ((name->type & UNSPEC))
#define _is_contiguous(name) ((name->type & HNT_CONTIGUOUS) >> 1)
#define _is_iov(name)        ((name->type & HNT_IOV) >> 2)
#define _is_inet4(name)      ((name->type & HNT_INET) >> 3)
#define _is_inet6(name)      ((name->type & HNT_INET6) >> 4)
#endif /* HICN_VPP_PLUGIN */
 
int hicn_name_create (const char *ip_address, u32 id, hicn_name_t * name);
 
int hicn_name_create_from_ip_prefix (const ip_prefix_t * prefix, u32 id,
                      hicn_name_t * name);
 
u8 hicn_name_get_length (const hicn_name_t * name);
 
int hicn_name_compare (const hicn_name_t * name_1, const hicn_name_t * name_2,
               bool consider_segment);
 
int hicn_name_hash (const hicn_name_t * name, u32 * hash, bool consider_suffix);
 
int hicn_name_empty (hicn_name_t * name);
 
int hicn_name_copy (hicn_name_t * dst, const hicn_name_t * src);
 
int hicn_name_copy_to_destination (u8 * dst, const hicn_name_t * src,
                   bool copy_suffix);
 
int hicn_name_set_seq_number (hicn_name_t * name, u32 seq_number);
 
int hicn_name_get_seq_number (const hicn_name_t * name, u32 * seq_number);
 
int hicn_name_to_sockaddr_address (const hicn_name_t * name,
                   struct sockaddr *ip_address);
 
int hicn_name_to_ip_prefix (const hicn_name_t * name,
                 ip_prefix_t * ip_prefix);
 
int hicn_name_ntop (const hicn_name_t * src, char *dst, size_t len);
 
int hicn_name_pton (const char *src, hicn_name_t * dst);
 
int hicn_name_get_family (const hicn_name_t * name, int *family);
 
int hicn_prefix_create_from_ip_prefix (const ip_prefix_t * ip_prefix,
                    hicn_prefix_t * prefix);
 
#endif /* HICN_NAME_H */
 
/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */