fea_data_plane_manager_click.hh

// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-

// Copyright (c) 2007-2012 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


#ifndef __FEA_DATA_PLANE_MANAGERS_FEA_DATA_PLANE_MANAGER_CLICK_HH__
#define __FEA_DATA_PLANE_MANAGERS_FEA_DATA_PLANE_MANAGER_CLICK_HH__

#include <xorp_config.h>
#ifdef XORP_USE_CLICK

#include "fea/fea_data_plane_manager.hh"

class FibConfigEntryGetClick;
class FibConfigEntrySetClick;
class FibConfigForwardingDummy;
class FibConfigTableGetClick;
class FibConfigTableSetClick;
class FirewallGetDummy;
class FirewallSetDummy;
class IfConfigGetClick;
class IfConfigPropertyDummy;
class IfConfigSetClick;
class IPv4;


class FeaDataPlaneManagerClick : public FeaDataPlaneManager {
public:
    FeaDataPlaneManagerClick(FeaNode& fea_node);

    virtual ~FeaDataPlaneManagerClick();

    int load_plugins(string& error_msg);

    int unload_plugins(string& error_msg);

    int register_plugins(string& error_msg);

    IoLink* allocate_io_link(const IfTree& iftree,
                 const string& if_name,
                 const string& vif_name,
                 uint16_t ether_type,
                 const string& filter_program);

    IoIp* allocate_io_ip(const IfTree& iftree, int family,
             uint8_t ip_protocol);

    IoTcpUdp* allocate_io_tcpudp(const IfTree& iftree, int family,
                 bool is_tcp);

    //
    // Click-specific methods
    //

    int enable_click(bool enable, string& error_msg);

    int enable_kernel_click(bool enable, string& error_msg);

    int set_kernel_click_config_generator_file(const string& v,
                           string& error_msg);

    int enable_duplicate_routes_to_kernel(bool enable, string& error_msg);

    int enable_kernel_click_install_on_startup(bool enable, string& error_msg);

    int set_kernel_click_modules(const list<string>& modules,
                 string& error_msg);

    int set_kernel_click_mount_directory(const string& directory,
                     string& error_msg);

    int enable_user_click(bool enable, string& error_msg);

    int set_user_click_command_file(const string& v, string& error_msg);

    int set_user_click_command_extra_arguments(const string& v,
                           string& error_msg);

    int set_user_click_command_execute_on_startup(bool v, string& error_msg);

    int set_user_click_control_address(const IPv4& v, string& error_msg);

    int set_user_click_control_socket_port(uint32_t v, string& error_msg);

    int set_user_click_startup_config_file(const string& v, string& error_msg);

    int set_user_click_config_generator_file(const string& v,
                         string& error_msg);

private:
    //
    // The plugins
    //
    //
    // TODO: XXX: For the time being some of the plugins
    // used by Click are dummy.
    //
    IfConfigPropertyDummy*  _ifconfig_property_dummy;
    IfConfigGetClick*       _ifconfig_get_click;
    IfConfigSetClick*       _ifconfig_set_click;
    FirewallGetDummy*       _firewall_get_dummy;
    FirewallSetDummy*       _firewall_set_dummy;
    FibConfigForwardingDummy*   _fibconfig_forwarding_dummy;
    FibConfigEntryGetClick* _fibconfig_entry_get_click;
    FibConfigEntrySetClick* _fibconfig_entry_set_click;
    FibConfigTableGetClick* _fibconfig_table_get_click;
    FibConfigTableSetClick* _fibconfig_table_set_click;
};

#endif // click
#endif // _FEA_DATA_PLANE_MANAGERS_FEA_DATA_PLANE_MANAGER_CLICK_HH__