ipv4_routing.h

Go to the documentation of this file.

/**
 * @file ipv4_routing.h
 * @brief IPv4 routing
 *
 * @section License
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * Copyright (C) 2010-2026 Oryx Embedded SARL. All rights reserved.
 *
 * This file is part of CycloneTCP Open.
 *
 * 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.
 *
 * @author Oryx Embedded SARL (www.oryx-embedded.com)
 * @version 2.6.0
 **/
 
#ifndef _IPV4_ROUTING_H
#define _IPV4_ROUTING_H
 
//Dependencies
#include "core/net.h"
#include "ipv4/ipv4.h"
 
//IPv4 routing support
#ifndef IPV4_ROUTING_SUPPORT
   #define IPV4_ROUTING_SUPPORT DISABLED
#elif (IPV4_ROUTING_SUPPORT != ENABLED && IPV4_ROUTING_SUPPORT != DISABLED)
   #error IPV4_ROUTING_SUPPORT parameter is not valid
#endif
 
//Size of the IPv4 routing table
#ifndef IPV4_ROUTING_TABLE_SIZE
   #define IPV4_ROUTING_TABLE_SIZE 8
#elif (IPV4_ROUTING_TABLE_SIZE < 1)
   #error IPV4_ROUTING_TABLE_SIZE parameter is not valid
#endif
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
/**
 * @brief Routing table entry
 **/
 
typedef struct
{
   bool_t valid;            ///<Valid entry
   Ipv4Addr networkDest;    ///<Network destination
   Ipv4Addr networkMask;    ///<Subnet mask for this route
   NetInterface *interface; ///<Outgoing network interface
   Ipv4Addr nextHop;        ///<Next hop
   uint_t metric;           ///<Metric value
} Ipv4RoutingTableEntry;
 
 
//IPv4 routing related functions
error_t ipv4InitRouting(NetContext *context);
error_t ipv4EnableRouting(NetInterface *interface, bool_t enable);
 
error_t ipv4AddRoute(NetContext *context, Ipv4Addr networkDest,
   Ipv4Addr networkMask, NetInterface *interface, Ipv4Addr nextHop,
   uint_t metric);
 
error_t ipv4DeleteRoute(NetContext *context, Ipv4Addr networkDest,
   Ipv4Addr networkMask);
 
error_t ipv4DeleteAllRoutes(NetContext *context);
 
error_t ipv4ForwardPacket(NetInterface *srcInterface, const NetBuffer *ipPacket,
   size_t ipPacketOffset);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif