serval-dna/overlay_address.h

145 lines
4.5 KiB
C
Raw Normal View History

/*
Serval DNA MDP addressing
Copyright (C) 2012-2013 Serval Project Inc.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __SERVAL_DNA__OVERLAY_ADDRESS_H
#define __SERVAL_DNA__OVERLAY_ADDRESS_H
#include "constants.h"
Switch to feature-driven linking This introduces a new way of linking Serval executables and dynamic libraries from static libraries like libservald.a -- called "feature-driven" linking. The Makefile now links servald and serval-tests from libservald.a, rather than from an explicit list of object (.o) files. Thanks to the section-based method for registering functions such as HTTP handlers, CLI commands and MDP handlers, these object files had become "stand-alone" and hence were no longer included in the link because there was no unresolved reference that required them to be linked in. The new "feature.h" provides the DECLARE_FEATURE(name) macro that each stand-alone source file uses to declare the named feature(s) it provides. Each executable can call the USE_FEATURE(name) macro in any of its explicitly-linked source files to cause the corresponding object(s) to be included in the link, eg, servald_features.c. The DEFINE_BINDING() macro has been extended so that every individual MDP binding is given a feature name based on its port number macro, eg, "mdp_binding_MDP_PORT_ECHO". Some features have been factored into their own separate source files so they can be omitted or included in a build independently of each other: - the MDP bindings for MDP_PORT_DNALOOKUP, MDP_PORT_ECHO, MDP_PORT_TRACE, MDP_PORT_KEYMAPREQUEST, MDP_PORT_RHIZOME_xxx, MDP_PORT_PROBE, MDP_PORT_STUN, MDP_PORT_STUNREQ - the CLI "log" and "echo" commands - the CLI "rhizome direct" command The JNI source files are only compiled if the <jni.h> header is present, otherwise they are omitted from libservald.so.
2016-10-13 02:58:23 +00:00
#include "serval_types.h" // for sid_t
#include "os.h" // for time_ms_t
#include "socket.h"
#include "nibble_tree.h"
// not reachable
#define REACHABLE_NONE 0
// this subscriber is in our keystore
#define REACHABLE_SELF (1<<0)
2012-09-10 01:25:12 +00:00
// immediate neighbour broadcast packet
#define REACHABLE_BROADCAST (1<<1)
// reachable directly via unicast packet
#define REACHABLE_UNICAST (1<<2)
// packets must be routed via next_hop
#define REACHABLE_INDIRECT (1<<3)
#define REACHABLE_ASSUMED (1<<4)
#define REACHABLE_DIRECT (REACHABLE_BROADCAST|REACHABLE_UNICAST)
#define REACHABLE (REACHABLE_DIRECT|REACHABLE_INDIRECT)
#define BROADCAST_LEN 8
struct packet_rule;
struct overlay_buffer;
// This structure supports both our own routing protocol which can store calculation details in *node
// or IP4 addresses reachable via any other kind of normal layer3 routing protocol, eg olsr
struct subscriber{
// minimum abbreviation length, in bits.
// Note this must be here to match the memory layout of struct tree_record
unsigned tree_depth;
sid_t sid;
int max_packet_version;
2013-04-26 07:23:04 +00:00
// link state routing information
struct link_state *link_state;
2013-06-18 03:57:26 +00:00
// rhizome sync state
struct rhizome_sync *sync_state;
struct rhizome_sync_keys *sync_keys_state;
uint8_t sync_version;
2013-06-18 03:57:26 +00:00
// result of routing calculations;
int reachable;
2012-10-17 01:08:31 +00:00
// if indirect, who is the next hop?
struct subscriber *next_hop;
int hop_count;
struct subscriber *prior_hop;
2012-10-17 01:08:31 +00:00
// if direct, or unicast, where do we send packets?
struct network_destination *destination;
2012-10-17 01:08:31 +00:00
time_ms_t last_stun_request;
time_ms_t last_probe_response;
time_ms_t last_explained;
2012-10-17 01:08:31 +00:00
// public signing key details for remote peers
identity_t id_public;
time_ms_t id_last_request;
uint8_t id_valid:1;
uint8_t id_combined:1;
// should we send the full address once?
uint8_t send_full:1;
// private keys for local identities
struct keyring_identity *identity;
};
struct broadcast{
unsigned char id[BROADCAST_LEN];
};
#define DECODE_FLAG_ENCODING_HEADER (1<<0)
#define DECODE_FLAG_INVALID_ADDRESS (1<<1)
#define DECODE_FLAG_DONT_EXPLAIN (1<<2)
struct decode_context{
struct overlay_interface *interface;
int sender_interface;
int packet_version;
int encapsulation;
struct socket_address addr;
uint8_t flags;
struct overlay_frame *please_explain;
struct subscriber *sender;
struct subscriber *previous;
struct subscriber *point_to_point_device;
};
struct subscriber *get_my_subscriber(bool_t create);
void release_my_subscriber();
extern __thread struct subscriber *directory_service;
struct subscriber *find_subscriber(const uint8_t *sid, int len, int create);
void enum_subscribers(struct subscriber *start, walk_callback callback, void *context);
int set_reachable(struct subscriber *subscriber, struct network_destination *destination, struct subscriber *next_hop, int hop_count, struct subscriber *prior_hop);
struct network_destination *load_subscriber_address(struct subscriber *subscriber);
int process_explain(struct overlay_frame *frame);
int overlay_broadcast_drop_check(struct broadcast *addr);
int overlay_broadcast_generate_address(struct broadcast *addr);
void overlay_broadcast_append(struct overlay_buffer *b, struct broadcast *broadcast);
void overlay_address_append(struct decode_context *context, struct overlay_buffer *b, struct subscriber *subscriber);
int overlay_broadcast_parse(struct overlay_buffer *b, struct broadcast *broadcast);
int overlay_address_parse(struct decode_context *context, struct overlay_buffer *b, struct subscriber **subscriber);
int send_please_explain(struct decode_context *context, struct subscriber *source, struct subscriber *destination);
void free_subscribers();
#endif //__SERVAL_DNA__OVERLAY_ADDRESS_H