org.opendaylight.vtn.manager.internal.vnode

Class VirtualBridge<T extends VtnPortMappableBridge>

java.lang.Object

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

org.opendaylight.vtn.manager.internal.vnode.VirtualNode<T,BridgeIdentifier<T>>

org.opendaylight.vtn.manager.internal.vnode.VirtualBridge<T>

Type Parameters:

T - The type of the target data model.

Direct Known Subclasses:

VBridge, VTerminal

public abstract class VirtualBridge<T extends VtnPortMappableBridge>
extends VirtualNode<T,BridgeIdentifier<T>>

VInterface describes a configuration and runtime status for a virtual bridge inside VTN.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VirtualBridge(BridgeIdentifier<T> brId) Construct a new instance.
protected	VirtualBridge(BridgeIdentifier<T> brId, T value) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	broadcastInterfaces(PacketContext pctx, Set<PortVlan> sent) Broadcast the given packet to all the virtual interfaces configured in this virtual bridge.
static <B extends VtnPortMappableBridge> VirtualBridge<B>	create(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx, BridgeIdentifier<B> ident) Construct a new virtual bridge instance.
abstract void	destroy(TxContext ctx, boolean retain) Destroy the virtual bridge.
protected void	destroyInterfaces(TxContext ctx) Destroy all the virtual interfaces in this virtual bridge.
protected abstract PacketContext	evaluateOutputFilter(PacketContext pctx, int vid) Evaluate flow filters configured in this bridge against the given outgoing packet.
protected abstract VnodeState	eventReceived(TxContext ctx, VtnNodeEvent ev) Notify virtual mappings in this bridge of node event.
protected abstract VnodeState	eventReceived(TxContext ctx, VtnPortEvent ev) Notify virtual mappings in this bridge of port event.
protected void	forward(PacketContext pctx, SalPort egress, int outVid) Forward the given unicast packet to the specified physical network, and establish the data flow for the given packet.
protected abstract void	forward(PacketContext pctx, VirtualMapNode vnode) Forward the specified packet to the virtual mapping configured in this virtual bridge.
BridgeStatus	getBridgeStatus() Return the runtime status information of the virtual bridge.
protected abstract VnodeState	getMapState(TxContext ctx) Return the state of the virtual mapping configured to this bridge.
VnodeState	getState() Return the current state of this virtual bridge.
boolean	hasPathFault() Determine whether at least one path fault is detected in this vBridge or not.
boolean	isFilterEmpty() Determine whether this virtual bridge contains no flow filter or not.
protected VirtualMapNode	match(PacketContext pctx, EtherAddress eaddr, SalPort sport, int vid) Return the virtual network node in this virtual bridge that maps the specified host.
protected VirtualMapNode	match(PacketContext pctx, TenantNodeIdentifier<?,?> ref, EtherAddress eaddr, SalPort sport, int vid, boolean pktin) Return the virtual network node in this bridge which maps the specified host.
static BridgeStatus	newBridgeStatus() Create a default virtual bridge status.
static BridgeStatus	newBridgeStatus(VnodeState st, List<FaultedPaths> faults) Create a new virtual bridge status.
abstract VInterface<T>	newInterface(VInterfaceIdentifier<T> ifId, Vinterface vif) Construct a new virtual interface instance associated with the interface inside this virtual bridge.
abstract VInterface<T>	newInterface(VInterfaceIdentifier<T> ifId, VtnVinterfaceConfig vifc, VTNPortMapConfig pmap) Construct a new virtual interface instance associated with the interface inside this virtual bridge.
void	notifyNode(TxContext ctx, VtnNodeEvent ev) Invoked when a physical switch is added, removed, or changed.
void	notifyPort(TxContext ctx, VtnPortEvent ev) Invoked when a physical switch port is added, removed, or changed.
void	putState(TxContext ctx) Scan virtual mappings configured in this virtual bridge, and update the bridge status in the MD-SAL datastore.
void	putState(TxContext ctx, VInterface vif) Scan virtual mappings configured in this virtual bridge, and update the bridge status in the MD-SAL datastore.
void	putState(TxContext ctx, VnodeState cstate) Scan virtual mappings configured in this virtual bridge, and update the bridge status in the MD-SAL datastore.
void	receive(PacketContext pctx, TenantNodeIdentifier<?,?> ref) Receive a packet mapped to the virtual bridge.
void	redirect(PacketContext pctx, RedirectFlowException rex) Redirect the given packet to the specified virtual interface.
List<Vinterface>	resume(TxContext ctx, XmlLogger xlogger, List<XmlVInterface> xiflist) Resume the runtime status information about virtual interfaces inside this virtual bridge.
void	routingUpdated(TxContext ctx) Invoked when the packet routing table has been updated.
void	setInterfaceEnabled(TxContext ctx, VInterfaceIdentifier<T> ifId, boolean value) Set the enabled state to the specified virtual interface.
void	submit(TxContext ctx) Update the runtime status information in the MD-SAL datastore.
protected void	traceState(VirtualElement<?,?> child, VnodeState cst, VnodeState st) Record a trace log for transition of the virtual bridge status.
void	updateState(TxContext ctx) Scan virtual mappings configured in this virtual bridge, and update the bridge status in this instance.
void	updateState(VirtualElement<?,?> child, VnodeState cstate) Update the state of this virtual bridge using the child node state.
static VnodeState	updateState(VnodeState bstate, VnodeState cstate) Update the state of this virtual bridge using the child node state.

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

Constructor Detail

VirtualBridge

protected VirtualBridge(BridgeIdentifier<T> brId)

Construct a new instance.

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

Parameters:

brId - The identifier for the virtual bridge.

VirtualBridge

protected VirtualBridge(BridgeIdentifier<T> brId,
                        T value)

Construct a new instance.

Parameters:

brId - The identifier for the virtual bridge.

value - A data object read from the MD-SAL datastore.

Method Detail

updateState

public static final VnodeState updateState(VnodeState bstate,
                                           VnodeState cstate)

Update the state of this virtual bridge using the child node state.

Parameters:

bstate - The current state of the virtual bridge.

cstate - The state of the child node inside this virtual bridge.

Returns:

A new state for the virtual bridge.

newBridgeStatus

public static final BridgeStatus newBridgeStatus()

Create a default virtual bridge status.

Returns:

A BridgeStatus instance.

newBridgeStatus

public static final BridgeStatus newBridgeStatus(VnodeState st,
                                                 List<FaultedPaths> faults)

Create a new virtual bridge status.

Parameters:

st - The state of the virtual bridge.

faults - A list of faulted paths.

Returns:

A BridgeStatus instance.

create

public static final <B extends VtnPortMappableBridge> VirtualBridge<B> create(org.opendaylight.controller.md.sal.binding.api.ReadTransaction rtx,
                                                                              BridgeIdentifier<B> ident)
                                                                       throws VTNException

Construct a new virtual bridge instance.

Type Parameters:

B - The type of the virtual bridge.

Parameters:

rtx - A read transaction for the MD-SAL datastore.

ident - The virtual bridge identifier.

Returns:

A VirtualBridge instance.

Throws:

VTNException - An error occurred.

getState

public final VnodeState getState()

Return the current state of this virtual bridge.

Returns:

The current state of this virtual bridge.

hasPathFault

public final boolean hasPathFault()

Determine whether at least one path fault is detected in this vBridge or not.

Returns:

true only if at least one path fault is detected.

getBridgeStatus

public final BridgeStatus getBridgeStatus()

Return the runtime status information of the virtual bridge.

Returns:

A BridgeStatus instance.

updateState

public final void updateState(TxContext ctx)

Scan virtual mappings configured in this virtual bridge, and update the bridge status in this instance.

Parameters:

ctx - MD-SAL datastore transaction context.

updateState

public final void updateState(VirtualElement<?,?> child,
                              VnodeState cstate)

Update the state of this virtual bridge using the child node state.

Parameters:

child - The child node in this virtual bridge.

cstate - The state of the child node inside this virtual bridge.

putState

public final void putState(TxContext ctx)

Scan virtual mappings configured in this virtual bridge, and update the bridge status in the MD-SAL datastore.

Parameters:

ctx - MD-SAL datastore transaction context.

putState

public final void putState(TxContext ctx,
                           VInterface vif)

Scan virtual mappings configured in this virtual bridge, and update the bridge status in the MD-SAL datastore.

Parameters:

ctx - MD-SAL datastore transaction context.

vif - A VInterface instance that was changed its status. This is used as a hint for determining the virtual bridge status.

putState

public final void putState(TxContext ctx,
                           VnodeState cstate)

Scan virtual mappings configured in this virtual bridge, and update the bridge status in the MD-SAL datastore.

Parameters:

ctx - MD-SAL datastore transaction context.

cstate - The state of the child node inside this virtual bridge. This is used as a hint for determining the virtual bridge status.

submit

public final void submit(TxContext ctx)

Update the runtime status information in the MD-SAL datastore.

Parameters:

ctx - MD-SAL datastore transaction context.

setInterfaceEnabled

public final void setInterfaceEnabled(TxContext ctx,
                                      VInterfaceIdentifier<T> ifId,
                                      boolean value)
                               throws VTNException

Set the enabled state to the specified virtual interface.

Parameters:

ctx - MD-SAL datastore transaction context.

ifId - The identifier for the target virtual interface. The specified interface must be present in this virtual bridge.

value - A new value of the enabled state.

Throws:

VTNException - An error occurred.

resume

public final List<Vinterface> resume(TxContext ctx,
                                     XmlLogger xlogger,
                                     List<XmlVInterface> xiflist)
                              throws VTNException

Resume the runtime status information about virtual interfaces inside this virtual bridge.

Parameters:

ctx - MD-SAL datastore transaction context.

xlogger - A XmlLogger instance.

xiflist - A list of XmlVInterface which represents the configuration of virtual interfaces inside this virtual bridge.

Returns:

A list of Vinterface instances or null.

Throws:

VTNException - Failed to resume the vBridge.

isFilterEmpty

public boolean isFilterEmpty()

Determine whether this virtual bridge contains no flow filter or not.

Returns:

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

receive

public final void receive(PacketContext pctx,
                          TenantNodeIdentifier<?,?> ref)
                   throws VTNException,
                          DropFlowException,
                          RedirectFlowException

Receive a packet mapped to the virtual bridge.

Parameters:

pctx - A runtime context for a received packet.

ref - A TenantNodeIdentifier instance that specifies the virtual mapping that maps the packet. Note that the specified virtual mapping must be present in this virtual bridge.

Throws:

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

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

VTNException - An error occurred.

redirect

public final void redirect(PacketContext pctx,
                           RedirectFlowException rex)
                    throws DropFlowException,
                           RedirectFlowException,
                           VTNException

Redirect the given packet to the specified virtual interface.

Parameters:

pctx - A runtime context for a received packet.

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

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.

notifyNode

public final void 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.

notifyPort

public final void 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.

routingUpdated

public final void routingUpdated(TxContext ctx)

Invoked when the packet routing table has been updated.

Note that the caller must guarantee that a set of faulted paths in this instance is not yet modified.

Parameters:

ctx - MD-SAL datastore transaction context.

destroyInterfaces

protected final void destroyInterfaces(TxContext ctx)
                                throws VTNException

Destroy all the virtual interfaces in this virtual bridge.

This method is called only when this virtual bridge is being destroyed.

Parameters:

ctx - MD-SAL datastore transaction context.

Throws:

VTNException - An error occurred.

traceState

protected final void traceState(VirtualElement<?,?> child,
                                VnodeState cst,
                                VnodeState st)

Record a trace log for transition of the virtual bridge status.

Parameters:

child - The child node in this virtual bridge.

cst - The state of the child node.

st - The current state of this virtual bridge.

match

protected final VirtualMapNode match(PacketContext pctx,
                                     EtherAddress eaddr,
                                     SalPort sport,
                                     int vid)
                              throws VTNException

Return the virtual network node in this virtual bridge that maps the specified host.

Parameters:

pctx - A runtime context for a received packet.

eaddr - The MAC address of the host.

sport - A SalPort instance that specifies the switch port where the host was detected.

vid - The VLAN ID associated with the specified host.

Returns:

A VirtualMapNode if the specified VLAN is mapped to this virtual bridge. null otherwise.

Throws:

VTNException - An error occurred.

match

protected VirtualMapNode match(PacketContext pctx,
                               TenantNodeIdentifier<?,?> ref,
                               EtherAddress eaddr,
                               SalPort sport,
                               int vid,
                               boolean pktin)
                        throws VTNException

Return the virtual network node in this bridge which maps the specified host.

Parameters:

pctx - A runtime context for a received packet.

ref - Reference to the virtual network mapping that maps the host. Note that the specified virtual mapping must be present in this virtual bridge.

eaddr - The MAC address of the host.

sport - A SalPort instance that specifies the switch port where the host was detected.

vid - The VLAN ID associated with the specified host.

pktin - true indicates the caller is the PACKET_IN handler.

Returns:

A VirtualMapNode if the specified host is mapped to this virtual bridge. null otherwise.

Throws:

VTNException - An error occurred.

forward

protected final void forward(PacketContext pctx,
                             SalPort egress,
                             int outVid)
                      throws VTNException

Forward the given unicast packet to the specified physical network, and establish the data flow for the given packet.

Parameters:

pctx - A runtime context for a received packet.

egress - A SalPort corresponding to the outgoing physical switch port.

outVid - A VLAN ID for the outgoing packet.

Throws:

VTNException - An error occurred.

broadcastInterfaces

protected final void broadcastInterfaces(PacketContext pctx,
                                         Set<PortVlan> sent)
                                  throws RedirectFlowException,
                                         VTNException

Broadcast the given packet to all the virtual interfaces configured in this virtual bridge.

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.

destroy

public abstract void destroy(TxContext ctx,
                             boolean retain)
                      throws VTNException

Destroy the virtual bridge.

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.

Throws:

VTNException - An error occurred.

newInterface

public abstract VInterface<T> newInterface(VInterfaceIdentifier<T> ifId,
                                           Vinterface vif)

Construct a new virtual interface instance associated with the interface inside this virtual bridge.

Parameters:

ifId - The identifier for a new virtual interface.

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

Returns:

A VInterface instance.

newInterface

public abstract VInterface<T> newInterface(VInterfaceIdentifier<T> ifId,
                                           VtnVinterfaceConfig vifc,
                                           VTNPortMapConfig pmap)

Construct a new virtual interface instance associated with the interface inside this virtual bridge.

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

Parameters:

ifId - The identifier for a new virtual interface.

vifc - Configuration of the virtual interface.

pmap - Port mapping configuration.

Returns:

A VInterface instance.

getMapState

protected abstract VnodeState getMapState(TxContext ctx)

Return the state of the virtual mapping configured to this bridge.

Parameters:

ctx - MD-SAL datastore transaction context.

Returns:

The state of the virtual mapping configured to this bridge.

eventReceived

protected abstract VnodeState eventReceived(TxContext ctx,
                                            VtnNodeEvent ev)

Notify virtual mappings in this bridge of node event.

Parameters:

ctx - MD-SAL datastore transaction context.

ev - A VtnNodeEvent instance.

Returns:

The state of the virtual mapping configured to this bridge.

eventReceived

protected abstract VnodeState eventReceived(TxContext ctx,
                                            VtnPortEvent ev)

Notify virtual mappings in this bridge of port event.

Parameters:

ctx - MD-SAL datastore transaction context.

ev - A VtnPortEvent instance.

Returns:

The state of the virtual mapping configured to this bridge.

evaluateOutputFilter

protected abstract PacketContext evaluateOutputFilter(PacketContext pctx,
                                                      int vid)
                                               throws DropFlowException,
                                                      RedirectFlowException

Evaluate flow filters configured in this bridge against the given outgoing packet.

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.

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.

forward

protected abstract void forward(PacketContext pctx,
                                VirtualMapNode vnode)
                         throws DropFlowException,
                                RedirectFlowException,
                                VTNException

Forward the specified packet to the virtual mapping configured in this virtual bridge.

Parameters:

pctx - A runtime context for a received packet.

vnode - A VirtualMapNode instance that maps the given packet.

Throws:

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

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

VTNException - An error occurred.