xrl_port_manager.hh

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

// 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/rip/xrl_port_manager.hh,v 1.22 2008/10/30 00:30:54 pavlin Exp $

#ifndef __RIP_XRL_PORT_MANAGER_HH__
#define __RIP_XRL_PORT_MANAGER_HH__



#include "libxorp/service.hh"
#include "libfeaclient/ifmgr_xrl_mirror.hh"
#include "port_manager.hh"

#include "port.hh"
#include "trace.hh"

class XrlRouter;

template <typename A>
class XrlPortManager :
    public NONCOPYABLE,
    public PortManagerBase<A>,
    public IfMgrHintObserver,
    public ServiceBase,
    public ServiceChangeObserverBase
{
public:
    XrlPortManager(System<A>&       system,
           XrlRouter&       xr,
           IfMgrXrlMirror&  ifm)
    : PortManagerBase<A>(system, ifm.iftree()),
      ServiceBase("RIP Port Manager"),
      _xr(xr), _ifm(ifm)
    {
    _ifm.attach_hint_observer(this);
    }

    ~XrlPortManager();

    int startup();

    int shutdown();

    bool add_rip_address(const string&  ifname,
             const string&  vifname,
             const A&   addr);

    bool remove_rip_address(const string&   ifname,
                const string&   vifname,
                const A&        addr);

    bool deliver_packet(const string&       sockid,
            const string&       ifname,
            const string&       vifname,
            const A&        src_addr,
            uint16_t        src_port,
            const vector<uint8_t>&  pdata);

    Port<A>* find_port(const string&    ifname,
               const string&    vifname,
               const A&     addr);
    const Port<A>* find_port(const string&  ifname,
                 const string&  vifname,
                 const A&       addr) const;

    bool underlying_rip_address_up(const string&    ifname,
                   const string&    vifname,
                   const A&     addr) const;

    bool underlying_rip_address_exists(const string&    ifname,
                       const string&    vifname,
                       const A&     addr) const;

    Trace& packet_trace() { return _trace; }
protected:
    //
    // IfMgrHintObserver methods
    //
    void tree_complete();
    void updates_made();

    //
    // ServiceChangeObserverBase methods
    // - used for observing status changes of XrlPortIO objects instantiated
    //   by XrlPortManager instance.
    //
    void status_change(ServiceBase* service,
               ServiceStatus    old_status,
               ServiceStatus    new_status);

    //
    // Attempt to start next io handler.  Walk list of ports, check
    // none are in state SERVICE_STARTING and call start on first found to be
    // in state SERVICE_READY.
    //
    // We start 1 at a time to avoid races trying to create
    // sockets with the fea.
    //
    void try_start_next_io_handler();

protected:
    XrlRouter&              _xr;    // XrlRouter
    IfMgrXrlMirror&             _ifm;   // Interface Mirror
    map<ServiceBase*, Port<A>*> _dead_ports; // Ports awaiting io shutdown

private:
    Trace _trace;
};

#endif // __RIP_XRL_PORT_MANAGER_HH__