/src/frr/lib/srv6.h

Source (jump to first uncovered line)
// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * SRv6 definitions
 * Copyright (C) 2020  Hiroki Shirokura, LINE Corporation
 */

#ifndef _FRR_SRV6_H
#define _FRR_SRV6_H

#include <zebra.h>
#include "prefix.h"
#include "json.h"

#include <arpa/inet.h>
#include <netinet/in.h>

#define SRV6_MAX_SIDS 16
#define SRV6_LOCNAME_SIZE 256

#ifdef __cplusplus
extern "C" {
#endif

#define sid2str(sid, str, size) \
  inet_ntop(AF_INET6, sid, str, size)

enum seg6_mode_t {
  INLINE,
  ENCAP,
  L2ENCAP,
};

enum seg6local_action_t {
  ZEBRA_SEG6_LOCAL_ACTION_UNSPEC       = 0,
  ZEBRA_SEG6_LOCAL_ACTION_END          = 1,
  ZEBRA_SEG6_LOCAL_ACTION_END_X        = 2,
  ZEBRA_SEG6_LOCAL_ACTION_END_T        = 3,
  ZEBRA_SEG6_LOCAL_ACTION_END_DX2      = 4,
  ZEBRA_SEG6_LOCAL_ACTION_END_DX6      = 5,
  ZEBRA_SEG6_LOCAL_ACTION_END_DX4      = 6,
  ZEBRA_SEG6_LOCAL_ACTION_END_DT6      = 7,
  ZEBRA_SEG6_LOCAL_ACTION_END_DT4      = 8,
  ZEBRA_SEG6_LOCAL_ACTION_END_B6       = 9,
  ZEBRA_SEG6_LOCAL_ACTION_END_B6_ENCAP = 10,
  ZEBRA_SEG6_LOCAL_ACTION_END_BM       = 11,
  ZEBRA_SEG6_LOCAL_ACTION_END_S        = 12,
  ZEBRA_SEG6_LOCAL_ACTION_END_AS       = 13,
  ZEBRA_SEG6_LOCAL_ACTION_END_AM       = 14,
  ZEBRA_SEG6_LOCAL_ACTION_END_BPF      = 15,
  ZEBRA_SEG6_LOCAL_ACTION_END_DT46     = 16,
};

struct seg6_segs {
  size_t num_segs;
  struct in6_addr segs[256];
};

struct seg6local_context {
  struct in_addr nh4;
  struct in6_addr nh6;
  uint32_t table;
};

struct srv6_locator {
  char name[SRV6_LOCNAME_SIZE];
  struct prefix_ipv6 prefix;

  /*
   * Bit length of SRv6 locator described in
   * draft-ietf-bess-srv6-services-05#section-3.2.1
   */
  uint8_t block_bits_length;
  uint8_t node_bits_length;
  uint8_t function_bits_length;
  uint8_t argument_bits_length;

  int algonum;
  uint64_t current;
  bool status_up;
  struct list *chunks;

  uint8_t flags;
#define SRV6_LOCATOR_USID (1 << 0) /* The SRv6 Locator is a uSID Locator */

  QOBJ_FIELDS;
};
DECLARE_QOBJ_TYPE(srv6_locator);

struct srv6_locator_chunk {
  char locator_name[SRV6_LOCNAME_SIZE];
  struct prefix_ipv6 prefix;

  /*
   * Bit length of SRv6 locator described in
   * draft-ietf-bess-srv6-services-05#section-3.2.1
   */
  uint8_t block_bits_length;
  uint8_t node_bits_length;
  uint8_t function_bits_length;
  uint8_t argument_bits_length;

  /*
   * For Zclient communication values
   */
  uint8_t keep;
  uint8_t proto;
  uint16_t instance;
  uint32_t session_id;

  uint8_t flags;
};

/*
 * SRv6 Endpoint Behavior codepoints, as defined by IANA in
 * https://www.iana.org/assignments/segment-routing/segment-routing.xhtml
 */
enum srv6_endpoint_behavior_codepoint {
  SRV6_ENDPOINT_BEHAVIOR_RESERVED       = 0x0000,
  SRV6_ENDPOINT_BEHAVIOR_END_DT6        = 0x0012,
  SRV6_ENDPOINT_BEHAVIOR_END_DT4        = 0x0013,
  SRV6_ENDPOINT_BEHAVIOR_END_DT46       = 0x0014,
  SRV6_ENDPOINT_BEHAVIOR_END_DT6_USID   = 0x003E,
  SRV6_ENDPOINT_BEHAVIOR_END_DT4_USID   = 0x003F,
  SRV6_ENDPOINT_BEHAVIOR_END_DT46_USID  = 0x0040,
  SRV6_ENDPOINT_BEHAVIOR_OPAQUE         = 0xFFFF,
};

struct nexthop_srv6 {
  /* SRv6 localsid info for Endpoint-behaviour */
  enum seg6local_action_t seg6local_action;
  struct seg6local_context seg6local_ctx;

  /* SRv6 Headend-behaviour */
  struct in6_addr seg6_segs;
};

static inline const char *seg6_mode2str(enum seg6_mode_t mode)
{
  switch (mode) {
  case INLINE:
    return "INLINE";
  case ENCAP:
    return "ENCAP";
  case L2ENCAP:
    return "L2ENCAP";
  default:
    return "unknown";
  }
}

static inline bool sid_same(
    const struct in6_addr *a,
    const struct in6_addr *b)
{
  if (!a && !b)
    return true;
  else if (!(a && b))
    return false;
  else
    return memcmp(a, b, sizeof(struct in6_addr)) == 0;
}

static inline bool sid_diff(
    const struct in6_addr *a,
    const struct in6_addr *b)
{
  return !sid_same(a, b);
}

static inline bool sid_zero(
    const struct in6_addr *a)
{
  struct in6_addr zero = {};

  return sid_same(a, &zero);
}

static inline void *sid_copy(struct in6_addr *dst,
    const struct in6_addr *src)
{
  return memcpy(dst, src, sizeof(struct in6_addr));
}

const char *
seg6local_action2str(uint32_t action);

const char *seg6local_context2str(char *str, size_t size,
          const struct seg6local_context *ctx,
          uint32_t action);

int snprintf_seg6_segs(char *str,
    size_t size, const struct seg6_segs *segs);

extern struct srv6_locator *srv6_locator_alloc(const char *name);
extern struct srv6_locator_chunk *srv6_locator_chunk_alloc(void);
extern void srv6_locator_free(struct srv6_locator *locator);
extern void srv6_locator_chunk_free(struct srv6_locator_chunk **chunk);
json_object *srv6_locator_chunk_json(const struct srv6_locator_chunk *chunk);
json_object *srv6_locator_json(const struct srv6_locator *loc);
json_object *srv6_locator_detailed_json(const struct srv6_locator *loc);
json_object *
srv6_locator_chunk_detailed_json(const struct srv6_locator_chunk *chunk);

#ifdef __cplusplus
}
#endif

#endif

Coverage Report

Created: 2025-07-14 06:48