org.opendaylight.vtn.manager.internal.vnode

Class VInterface<B extends VtnPortMappableBridge>

java.lang.Object

org.opendaylight.vtn.manager.internal.vnode.VirtualElement<T,I>

org.opendaylight.vtn.manager.internal.vnode.VirtualNode<Vinterface,VInterfaceIdentifier<B>>

org.opendaylight.vtn.manager.internal.vnode.VInterface<B>

Type Parameters:

B - The type of the virtual bridge that contains the virtual interrace.

All Implemented Interfaces:

VirtualMapNode

Direct Known Subclasses:

VBridgeInterface, VTerminalInterface

public abstract class VInterface<B extends VtnPortMappableBridge>
extends VirtualNode<Vinterface,VInterfaceIdentifier<B>>
implements VirtualMapNode

VInterface describes a configuration and runtime status for a virtual interface.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VInterface(VInterfaceIdentifier<B> ifId, Vinterface vif) Construct a new instance.
protected	VInterface(VInterfaceIdentifier<B> ifId, VtnVinterfaceConfig vifc, VTNPortMapConfig pmap) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
static <T extends VtnPortMappableBridge> VInterface<T>	create(VInterfaceIdentifier<T> ident, Vinterface vintf) Construct a new virtual interface instance.
void	destroy(TxContext ctx, boolean retain) Destroy the virtual interface.
void	disableInput(PacketContext pctx) Install a flow entry that drops every incoming packet.
void	filterPacket(PacketContext pctx, int vid) Evaluate flow filters for incoming packet received from this virtual interface.
PacketContext	filterPacket(PacketContext pctx, int vid, VirtualBridge<?> bridge) Evaluate flow filters for outgoing packet to be transmitted by this virtual interface.
VInterfaceIdentifier<B>	getIdentifier(EtherAddress eaddr, int vid) Return the identifier for the virtual mapping which maps the given host.
VNodeHop	getIngressHop(EtherAddress eaddr, int vid) Return a VNodeHop instance that indicates the packet was mapped by the port mapping.
VnodeState	getPortState() Return the state of the physical switch port mapped to this virtual interface.
VnodeState	getState() Return the current state of this virtual interface.
Vinterface	getVinterface() Return the vinterface container associated with this instance.
VinterfaceStatus	getVinterfaceStatus() Return the runtime status information of the virtual interface.
int	getVlanId() Return the VLAN ID mapped to this virtual interface.
boolean	isEnabled() Determine whether this virtual interface is enabled or not.
boolean	isFilterEmpty() Determine whether flow filter list in this virtual interface is empty or not.
boolean	match(SalPort sport, int vid) Determine whether the specified VLAN is mapped to this virtual interface or not.
VnodeState	notifyNode(TxContext ctx, VtnNodeEvent ev) Invoked when a physical switch is added, removed, or changed.
VnodeState	notifyPort(TxContext ctx, VtnPortEvent ev) Invoked when a physical switch port is added, removed, or changed.
protected void	purgeCache(TxContext ctx, SalPort sport, int vid) Purge all the network caches associated with the VLAN specified by a pair of physical switch port and VLAN ID.
protected abstract void	purgePortCache(TxContext ctx, SalPort sport, int vid) Purge all the network caches associated with the VLAN specified by a pair of physical switch port and VLAN ID.
void	redirect(PacketContext pctx, RedirectFlowException rex, VirtualBridge<B> bridge) Redirect the given packet to this virtual interface as outgoing packet.
VtnUpdateType	removePortMap(TxContext ctx) Remove the port mapping from this interface.
void	resume(TxContext ctx) Resume the port mapping.
void	setEnabled(TxContext ctx, boolean value) Set the enabled state to this virtual interface, and update the vinterface-status container in the MD-SAL datastore.
VtnUpdateType	setPortMap(TxContext ctx, VTNPortMapConfig pmap) Change the configuration for the port mapping.
void	transmit(PacketContext pctx, Set<PortVlan> sent) Transmit the given packet to the physical network mapped to this virtual interface.

Methods inherited from class org.opendaylight.vtn.manager.internal.vnode.VirtualNode

getFlowFilterList

Methods inherited from class org.opendaylight.vtn.manager.internal.vnode.VirtualElement

getIdentifier, getInitialValue, getLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opendaylight.vtn.manager.internal.vnode.VirtualMapNode

getIdentifier

Constructor Detail

VInterface

protected VInterface(VInterfaceIdentifier<B> ifId,
                     VtnVinterfaceConfig vifc,
                     VTNPortMapConfig pmap)

Construct a new instance.

This constructor is used to resume runtime status of the virtual interface on bootstrap.

Parameters:

ifId - The location of the virtual interface.

vifc - Configuration of the virtual interface.

pmap - Port mapping configuration.

VInterface

protected VInterface(VInterfaceIdentifier<B> ifId,
                     Vinterface vif)

Construct a new instance.

Parameters:

ifId - The location of the virtual interface.

vif - A Vinterface instance read from the MD-SAL datastore.

Method Detail

create

public static final <T extends VtnPortMappableBridge> VInterface<T> create(VInterfaceIdentifier<T> ident,
                                                                           Vinterface vintf)

Construct a new virtual interface instance.

Type Parameters:

T - The type of the parent virtual bridge.

Parameters:

ident - The virtual interface identifier.

vintf - The virtual interface.

Returns:

A VInterface instance.

getState

public final VnodeState getState()

Return the current state of this virtual interface.

Returns:

The current state of this virtual interface.

getPortState

public final VnodeState getPortState()

Return the state of the physical switch port mapped to this virtual interface.

Returns:

The state of the switch port mapped to this virtual interface.

getVinterface

public final Vinterface getVinterface()

Return the vinterface container associated with this instance.

Returns:

A Vinterface instance.

getVinterfaceStatus

public final VinterfaceStatus getVinterfaceStatus()

Return the runtime status information of the virtual interface.

Returns:

A VinterfaceStatus instance.

setPortMap

public final VtnUpdateType setPortMap(TxContext ctx,
                                      VTNPortMapConfig pmap)
                               throws VTNException

Change the configuration for the port mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

pmap - A VTNPortMapConfig that contains the port mapping configuration to be applied. Specifying null results in undefined behavior.

Returns:

A VtnUpdateType instance if the port mapping configuration has been changed. null if not changed.

Throws:

VTNException - An error occurred.

removePortMap

public final VtnUpdateType removePortMap(TxContext ctx)
                                  throws VTNException

Remove the port mapping from this interface.

Parameters:

ctx - MD-SAL datastore transaction context.

Returns:

VtnUpdateType.REMOVED if the port mapping configuration has been removed. null if not changed.

Throws:

VTNException - An error occurred.

setEnabled

public final void setEnabled(TxContext ctx,
                             boolean value)
                      throws VTNException

Set the enabled state to this virtual interface, and update the vinterface-status container in the MD-SAL datastore.

Parameters:

ctx - MD-SAL datastore transaction context.

value - A new value of the enabled state.

Throws:

VTNException - An error occurred.

destroy

public final void destroy(TxContext ctx,
                          boolean retain)

Destroy the virtual interface.

Parameters:

ctx - MD-SAL datastore transaction context.

retain - true means that the parent virtual node will be retained. false means that the parent virtual node is being destroyed.

isFilterEmpty

public final boolean isFilterEmpty()

Determine whether flow filter list in this virtual interface is empty or not.

Returns:

true if this virtual interface contains no flow filter. false otherwise.

resume

public final void resume(TxContext ctx)
                  throws VTNException

Resume the port mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

Throws:

VTNException - An error occurred.

notifyNode

public final VnodeState notifyNode(TxContext ctx,
                                   VtnNodeEvent ev)

Invoked when a physical switch is added, removed, or changed.

Parameters:

ctx - MD-SAL datastore transaction context.

ev - A VtnNodeEvent instance.

Returns:

New state of this virtual interface.

notifyPort

public final VnodeState notifyPort(TxContext ctx,
                                   VtnPortEvent ev)

Invoked when a physical switch port is added, removed, or changed.

Parameters:

ctx - MD-SAL datastore transaction context.

ev - A VtnPortEvent instance.

Returns:

New state of this virtual interface.

match

public final boolean match(SalPort sport,
                           int vid)

Determine whether the specified VLAN is mapped to this virtual interface or not.

Note that this method does not see the state of this node. This method returns true if the specified VLAN is mapped to this virtual interface by port mapping.

Parameters:

sport - A SalPort instance that specifies the physical

vid - The VLAN ID.

Returns:

true only if the specified VLAN is mapped to this virtual interface. treated as input of this node.

transmit

public final void transmit(PacketContext pctx,
                           Set<PortVlan> sent)
                    throws RedirectFlowException,
                           VTNException

Transmit the given packet to the physical network mapped to this virtual interface.

Parameters:

pctx - A runtime context for a received packet.

sent - A set of PortVlan which indicates the network already processed.

Throws:

RedirectFlowException - The given packet was redirected by a flow filter.

VTNException - An error occurred.

getVlanId

public int getVlanId()

Return the VLAN ID mapped to this virtual interface.

Returns:

A VLAN ID mapped to this interface. A negative value is returned if port mapping is not configured.

redirect

public final void redirect(PacketContext pctx,
                           RedirectFlowException rex,
                           VirtualBridge<B> bridge)
                    throws DropFlowException,
                           RedirectFlowException,
                           VTNException

Redirect the given packet to this virtual interface as outgoing packet.

Parameters:

pctx - A runtime context for a received packet.

rex - An exception that keeps information about the packet redirection.

bridge - A VirtualBridge instance associated with this virtual interface.

Throws:

DropFlowException - The given packet was discarded by a DROP flow filter.

RedirectFlowException - The given packet was redirected by a REDIRECT flow filter.

VTNException - An error occurred.

purgeCache

protected final void purgeCache(TxContext ctx,
                                SalPort sport,
                                int vid)
                         throws VTNException

Purge all the network caches associated with the VLAN specified by a pair of physical switch port and VLAN ID.

This method is used to purge network data cached by obsolete port mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

sport - A SalPort instance that specifies the physical switch port mapped by the port mapping. Node that null is specified if no switch port is mapped by the port mapping.

vid - The VLAN ID specified by the port mapping configuration.

Throws:

VTNException - An error occurred.

purgePortCache

protected abstract void purgePortCache(TxContext ctx,
                                       SalPort sport,
                                       int vid)
                                throws VTNException

Purge all the network caches associated with the VLAN specified by a pair of physical switch port and VLAN ID.

This method in this class does nothing. Subclass can override this method to purge network data cached by obsolete port mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

sport - A SalPort instance that specifies the physical switch port mapped by the port mapping. Specifying null results in undefined behavior.

vid - The VLAN ID specified by the port mapping configuration.

Throws:

VTNException - An error occurred.

getIdentifier

public final VInterfaceIdentifier<B> getIdentifier(EtherAddress eaddr,
                                                   int vid)

Return the identifier for the virtual mapping which maps the given host.

This method always returns the identifier for this virtual interface because port mapping does not specifies the host to be mapped.

Specified by:

getIdentifier in interface VirtualMapNode

Parameters:

eaddr - Unused.

vid - Unused.

Returns:

The identifier for the virtual interface.

isEnabled

public final boolean isEnabled()

Determine whether this virtual interface is enabled or not.

Specified by:

isEnabled in interface VirtualMapNode

Returns:

true only if this virtual interface is enabled.

getIngressHop

public VNodeHop getIngressHop(EtherAddress eaddr,
                              int vid)

Return a VNodeHop instance that indicates the packet was mapped by the port mapping.

Specified by:

getIngressHop in interface VirtualMapNode

Parameters:

eaddr - Unused.

vid - Unused.

Returns:

A VNodeHop instance.

disableInput

public void disableInput(PacketContext pctx)

Install a flow entry that drops every incoming packet.

Specified by:

disableInput in interface VirtualMapNode

Parameters:

pctx - A runtime context for a received packet.

filterPacket

public void filterPacket(PacketContext pctx,
                         int vid)
                  throws DropFlowException,
                         RedirectFlowException

Evaluate flow filters for incoming packet received from this virtual interface.

Specified by:

filterPacket in interface VirtualMapNode

Parameters:

pctx - A runtime context for a received packet.

vid - A VLAN ID to be used for packet matching. A VLAN ID configured in the given packet is used if a negative value is specified.

Throws:

DropFlowException - The given packet was discarded by a flow filter.

RedirectFlowException - The given packet was redirected by a flow filter.

filterPacket

public PacketContext filterPacket(PacketContext pctx,
                                  int vid,
                                  VirtualBridge<?> bridge)
                           throws DropFlowException,
                                  RedirectFlowException

Evaluate flow filters for outgoing packet to be transmitted by this virtual interface.

Specified by:

filterPacket in interface VirtualMapNode

Parameters:

pctx - A runtime context for a received packet.

vid - A VLAN ID to be used for packet matching. A VLAN ID configured in the given packet is used if a negative value is specified.

bridge - A VirtualBridge instance associated with this virtual mapping.

Returns:

A PacketContext to be used for transmitting packet.

Throws:

DropFlowException - The given packet was discarded by a flow filter.

RedirectFlowException - The given packet was redirected by a flow filter.