xrl_target.hh

// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// vim:set sts=4 ts=8:

// Copyright (c) 2001-2011 XORP, Inc and Others
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, Version 2, June
// 1991 as published by the Free Software Foundation. Redistribution
// and/or modification of this program under the terms of any other
// version of the GNU General Public License is not permitted.
// 
// 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. For more details,
// see the GNU General Public License, Version 2, a copy of which can be
// found in the XORP LICENSE.gpl file.
// 
// XORP Inc, 2953 Bunker Hill Lane, Suite 204, Santa Clara, CA 95054, USA;
// http://xorp.net

// $XORP: xorp/rib/xrl_target.hh,v 1.38 2008/10/02 21:58:14 bms Exp $

#ifndef __RIB_XRL_TARGET_HH__
#define __RIB_XRL_TARGET_HH__

#include "libxipc/xrl_router.hh"

#include "xrl/targets/rib_base.hh"

#include "rib.hh"
#include "vifmanager.hh"


class XrlRibTarget : public XrlRibTargetBase {
public:
    XrlRibTarget(XrlRouter* xrl_router,
         RIB<IPv4>& urib4, RIB<IPv4>& mrib4,
#ifdef HAVE_IPV6
         RIB<IPv6>& urib6, RIB<IPv6>& mrib6,
#endif
         VifManager& vif_manager, RibManager* rib_manager)
    : XrlRibTargetBase(xrl_router),
      _urib4(urib4), _mrib4(mrib4),
#ifdef HAVE_IPV6
      _urib6(urib6), _mrib6(mrib6),
#endif
      _vif_manager(vif_manager), _rib_manager(rib_manager) {}
    ~XrlRibTarget() {}

protected:
    RIB<IPv4>&  _urib4;
    RIB<IPv4>&  _mrib4;
#ifdef HAVE_IPV6
    RIB<IPv6>&  _urib6;
    RIB<IPv6>&  _mrib6;
#endif
    VifManager& _vif_manager;
    RibManager* _rib_manager;

protected:

    XrlCmdError common_0_1_get_target_name(
    // Output values,
    string& name);

    XrlCmdError common_0_1_get_version(
    // Output values,
    string& version);

    XrlCmdError common_0_1_get_status(
    // Output values,
        uint32_t& status,
    string& reason);

    XrlCmdError common_0_1_shutdown();

    XrlCmdError common_0_1_startup() { return rib_0_1_start_rib(); }

    XrlCmdError rib_0_1_enable_rib();

    XrlCmdError rib_0_1_disable_rib();

    XrlCmdError rib_0_1_start_rib();

    XrlCmdError rib_0_1_stop_rib();

    XrlCmdError rib_0_1_make_errors_fatal();

    XrlCmdError rib_0_1_get_registered_protocols(
    // Input values,
    const bool& ipv4,
    const bool& ipv6,
    const bool& unicast,
    const bool& multicast,
    // Output values,
    XrlAtomList&    ipv4_unicast_protocols,
    XrlAtomList&    ipv6_unicast_protocols,
    XrlAtomList&    ipv4_multicast_protocols,
    XrlAtomList&    ipv6_multicast_protocols);

    XrlCmdError rib_0_1_add_igp_table4(
    // Input values,
    const string&   protocol,
    const string&   target_class,
    const string&   target_instance,
    const bool& unicast,
    const bool& multicast);

    XrlCmdError rib_0_1_delete_igp_table4(
    // Input values,
    const string&   protocol,
    const string&   target_class,
    const string&   target_instance,
    const bool& unicast,
    const bool& multicast);

    XrlCmdError rib_0_1_add_egp_table4(
    // Input values,
    const string&   protocol,
    const string&   target_class,
    const string&   target_instance,
    const bool& unicast,
    const bool& multicast);

    XrlCmdError rib_0_1_delete_egp_table4(
    // Input values,
    const string&   protocol,
    const string&   target_class,
    const string&   target_instance,
    const bool& unicast,
    const bool& multicast);

    XrlCmdError rib_0_1_add_route4(
    // Input values,
    const string&   protocol,
    const bool& unicast,
    const bool& multicast,
    const IPv4Net&  network,
    const IPv4&     nexthop,
    const uint32_t& metric,
    const XrlAtomList&  policytags);

    XrlCmdError rib_0_1_replace_route4(
    // Input values,
    const string&   protocol,
    const bool& unicast,
    const bool& multicast,
    const IPv4Net&  network,
    const IPv4&     nexthop,
    const uint32_t& metric,
    const XrlAtomList&  policytags);

    XrlCmdError rib_0_1_delete_route4(
    // Input values,
    const string&   protocol,
    const bool& unicast,
    const bool& multicast,
    const IPv4Net&  network);

    XrlCmdError rib_0_1_add_interface_route4(
    // Input values,
    const string&       protocol,
    const bool&     unicast,
    const bool&     multicast,
    const IPv4Net&      network,
    const IPv4&     nexthop,
    const string&       ifname,
    const string&       vifname,
    const uint32_t&     metric,
    const XrlAtomList&  policytags);

    XrlCmdError rib_0_1_replace_interface_route4(
    // Input values,
    const string&       protocol,
    const bool&     unicast,
    const bool&     multicast,
    const IPv4Net&      network,
    const IPv4&     nexthop,
    const string&       ifname,
    const string&       vifname,
    const uint32_t&     metric,
    const XrlAtomList&  policytags);

    XrlCmdError rib_0_1_lookup_route_by_dest4(
    // Input values,
    const IPv4& addr,
    const bool& unicast,
    const bool& multicast,
    // Output values,
    IPv4&       nexthop);

    XrlCmdError rib_0_1_new_vif(
    // Input values,
    const string&   name);

    XrlCmdError rib_0_1_add_vif_addr4(
    // Input values,
    const string&   name,
    const IPv4& addr,
    const IPv4Net&  subnet);

    XrlCmdError rib_0_1_redist_enable4(
    // Input values,
    const string&   to_xrl_target,
    const string&   from_protocol,
    const bool& unicast,
    const bool& multicast,
    const IPv4Net&  network_prefix,
    const string&   cookie);

    XrlCmdError rib_0_1_redist_disable4(
    // Input values,
    const string&   to_xrl_target,
    const string&   from_protocol,
    const bool& unicast,
    const bool& multicast,
    const string&   cookie);

    XrlCmdError rib_0_1_redist_transaction_enable4(
    // Input values,
    const string&   to_xrl_target,
    const string&   from_protocol,
    const bool& unicast,
    const bool& multicast,
    const IPv4Net&  network_prefix,
    const string&   cookie);

    XrlCmdError rib_0_1_redist_transaction_disable4(
    // Input values,
    const string&   to_xrl_target,
    const string&   from_protocol,
    const bool& unicast,
    const bool& multicast,
    const string&   cookie);

    XrlCmdError rib_0_1_register_interest4(
    // Input values,
        const string&   target,
    const IPv4& addr,
    // Output values,
    bool&       resolves,
    IPv4&       base_addr,
    uint32_t&   prefix_len,
    uint32_t&   real_prefix_len,
    IPv4&       nexthop,
    uint32_t&   metric);

    XrlCmdError rib_0_1_deregister_interest4(
    // Input values,
        const string&   target,
    const IPv4& addr,
    const uint32_t& prefix_len);

    XrlCmdError rib_0_1_get_protocol_admin_distances(
    // Input values,
    const bool& ipv4,
    const bool& unicast,
    // Output values,
    XrlAtomList&    protocols,
    XrlAtomList&    admin_distances);

    XrlCmdError rib_0_1_get_protocol_admin_distance(
    // Input values,
    const string&   protocol,
    const bool& unicast,
    const bool& multicast,
    // Output values,
    uint32_t&   admin_distance);

    XrlCmdError rib_0_1_set_protocol_admin_distance(
    // Input values,
    const string&   protocol,
    const bool& ipv4,
    const bool& ipv6,
    const bool& unicast,
    const bool& multicast,
    const uint32_t& admin_distance);

    XrlCmdError finder_event_observer_0_1_xrl_target_birth(
    // Input values,
    const string&   target_class,
    const string&   target_instance);

    XrlCmdError finder_event_observer_0_1_xrl_target_death(
    // Input values,
    const string&   target_class,
    const string&   target_instance);


    XrlCmdError policy_backend_0_1_configure(
        // Input values,
        const uint32_t& filter,
        const string&   conf);
      
    XrlCmdError policy_backend_0_1_reset(
        // Input values,
        const uint32_t& filter);

    XrlCmdError policy_backend_0_1_push_routes();

    
    XrlCmdError rib_0_1_insert_policy_redist_tags(
        // Input values,
        const string&   protocol,
        const XrlAtomList&      policytags);

    XrlCmdError rib_0_1_reset_policy_redist_tags();

#ifdef HAVE_IPV6

    XrlCmdError rib_0_1_add_igp_table6(
    // Input values,
    const string&   protocol,
    const string&   target_class,
    const string&   target_instance,
    const bool& unicast,
    const bool& multicast);


    XrlCmdError rib_0_1_delete_igp_table6(
    // Input values,
    const string&   protocol,
    const string&   target_class,
    const string&   target_instance,
    const bool& unicast,
    const bool& multicast);

    XrlCmdError rib_0_1_add_egp_table6(
    // Input values,
    const string&   protocol,
    const string&   target_class,
    const string&   target_instance,
    const bool& unicast,
    const bool& multicast);

    XrlCmdError rib_0_1_delete_egp_table6(
    // Input values,
    const string&   protocol,
    const string&   target_class,
    const string&   target_instance,
    const bool& unicast,
    const bool& multicast);

    XrlCmdError rib_0_1_add_route6(
    // Input values,
    const string&   protocol,
    const bool& unicast,
    const bool& multicast,
    const IPv6Net&  network,
    const IPv6& nexthop,
    const uint32_t& metric,
    const XrlAtomList&  policytags);

    XrlCmdError rib_0_1_replace_route6(
    // Input values,
    const string&   protocol,
    const bool& unicast,
    const bool& multicast,
    const IPv6Net&  network,
    const IPv6& nexthop,
    const uint32_t& metric,
    const XrlAtomList&  policytags);

    XrlCmdError rib_0_1_delete_route6(
    // Input values,
    const string&   protocol,
    const bool& unicast,
    const bool& multicast,
    const IPv6Net&  network);

    XrlCmdError rib_0_1_add_interface_route6(
    // Input values,
    const string&       protocol,
    const bool&     unicast,
    const bool&     multicast,
    const IPv6Net&      network,
    const IPv6&     nexthop,
    const string&       ifname,
    const string&       vifname,
    const uint32_t&     metric,
    const XrlAtomList&  policytags);

    XrlCmdError rib_0_1_replace_interface_route6(
    // Input values,
    const string&       protocol,
    const bool&     unicast,
    const bool&     multicast,
    const IPv6Net&      network,
    const IPv6&     nexthop,
    const string&       ifname,
    const string&       vifname,
    const uint32_t&     metric,
    const XrlAtomList&  policytags);

    XrlCmdError rib_0_1_lookup_route_by_dest6(
    // Input values,
    const IPv6& addr,
    const bool& unicast,
    const bool& multicast,
    // Output values,
    IPv6&       nexthop);

    XrlCmdError rib_0_1_add_vif_addr6(
    // Input values,
    const string&   name,
    const IPv6& addr,
    const IPv6Net&  subnet);

    XrlCmdError rib_0_1_redist_enable6(
    // Input values,
    const string&   to_xrl_target,
    const string&   from_protocol,
    const bool& unicast,
    const bool& multicast,
    const IPv6Net&  network_prefix,
    const string&   cookie);

    XrlCmdError rib_0_1_redist_disable6(
    // Input values,
    const string&   to_xrl_target,
    const string&   from_protocol,
    const bool& unicast,
    const bool& multicast,
    const string&   cookie);

    XrlCmdError rib_0_1_redist_transaction_enable6(
    // Input values,
    const string&   to_xrl_target,
    const string&   from_protocol,
    const bool& unicast,
    const bool& multicast,
    const IPv6Net&  network_prefix,
    const string&   cookie);

    XrlCmdError rib_0_1_redist_transaction_disable6(
    // Input values,
    const string&   to_xrl_target,
    const string&   from_protocol,
    const bool& unicast,
    const bool& multicast,
    const string&   cookie);

    XrlCmdError rib_0_1_register_interest6(
    // Input values,
        const string&   target,
    const IPv6& addr,
    // Output values,
    bool&       resolves,
    IPv6&       base_addr,
    uint32_t&   prefix_len,
    uint32_t&   real_prefix_len,
    IPv6&       nexthop,
    uint32_t&   metric);

    XrlCmdError rib_0_1_deregister_interest6(
    // Input values,
        const string&   target,
    const IPv6& addr,
    const uint32_t& prefix_len);

#endif //ipv6

#ifndef XORP_DISABLE_PROFILE

     XrlCmdError profile_0_1_enable(
    // Input values,
    const string&   pname);

    XrlCmdError profile_0_1_disable(
    // Input values,
    const string&   pname);

    XrlCmdError profile_0_1_get_entries(
    // Input values,
    const string&   pname,
    const string&   instance_name);

    XrlCmdError profile_0_1_clear(
    // Input values,
    const string&   pname);

    XrlCmdError profile_0_1_list(
    // Output values,
    string& info);
#endif
};

#endif // __RIB_XRL_TARGET_HH__