api.h

/*
 * 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_SOCKET_API_H
#define HICN_SOCKET_API_H
 
#include <stdint.h>  // uint*_t
#include <stdlib.h>
 
#include <hicn/hicn.h>
#include "error.h"
 
#define BUFSIZE 4096
#define MAX_CONNECTIONS \
  255  // We currently limit the number of connections we can establish
#ifndef IF_NAMESIZE
#define IF_NAMESIZE 16
#endif
/* hICN socket helper */
 
typedef struct {
  // uint32_t interval;
 
  /* Identifier used to name hICN TUN interfaces (should be unique) */
  char *identifier;
  // hicn_format_t format;
 
} hicn_conf_t;
 
typedef struct {
  char *local_ip_address;
  char *gateway_ip_address;
} hicn_adjacency_t;
 
#define EMPTY_HICN_ADJACENCY \
  (hicn_adjacency_t) { 0, 0 }
 
/* hICN socket operations */
 
typedef struct {
  uint8_t pkbuf[BUFSIZE];
  uint32_t rb_pkbuf_r;
  uint32_t rb_pkbuf_w;
} hicn_buffer_t;
 
typedef enum { HS_UNSPEC, HS_LISTENER, HS_CONNECTION } hicn_socket_type_t;
 
typedef struct hicn_socket_s {
  hicn_socket_type_t type;
  int fd;
 
  /* Implementation specific state follows */
  char tun_name[IF_NAMESIZE];
  uint32_t tun_id;
 
  hicn_buffer_t buffer;
  void (*cb)(struct hicn_socket_s *, void *, uint8_t *, size_t);
  void *cb_data;
 
  union {
    struct {
      ip_prefix_t tun_ip_address;
      uint32_t interface_id;
 
      /* ID of the corresponding table : avoid default values of 0, 32766 and
       * 32767 */
      uint8_t table_id;
    } connection;
  };
} hicn_socket_t;
 
typedef struct {
  /* Configuration data */
  hicn_conf_t *conf;
 
  // We need state associate to each FD, to know what type of socket it is and
  // its state.
  void *socket_root; 
} hicn_socket_helper_t;
 
hicn_socket_helper_t *hicn_create();
 
void hicn_destroy();
 
hicn_conf_t *hicn_get_conf(hicn_socket_helper_t *hicn);
 
int hicn_set_conf(hicn_socket_helper_t *hicn, hicn_conf_t *hicn_conf);
 
void hicn_free(hicn_socket_helper_t *hicn);
 
int hicn_get_local_address(const ip_prefix_t *remote_address,
                           ip_prefix_t *local_address);
 
/* hICN socket */
 
int hicn_socket(hicn_socket_helper_t *hicn, const char *identifier,
                const char *local_ip_address);
 
int hicn_listen(hicn_socket_helper_t *hicn, int fd, const char *prefix);
 
int hicn_bind(hicn_socket_helper_t *hicn, int fd,
              const char *remote_ip_address);
 
#endif /* HICN_SOCKET_API_H */