org.opendaylight.vtn.manager.internal.vnode

Class VTNMacMap

java.lang.Object

org.opendaylight.vtn.manager.internal.vnode.VirtualElement<MacMap,MacMapIdentifier>

org.opendaylight.vtn.manager.internal.vnode.VTNMacMap

All Implemented Interfaces:

VirtualMapNode

public final class VTNMacMap
extends VirtualElement<MacMap,MacMapIdentifier>
implements VirtualMapNode

VTNMacMap describes a configuration and runtime status for a MAC mapping.

Constructor Summary

Constructors

Constructor and Description
VTNMacMap(BridgeIdentifier<Vbridge> vbrId, MacMap mmp) Construct a new instance.
VTNMacMap(BridgeIdentifier<Vbridge> vbrId, VTNMacMapConfig mmc) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	activate(TxContext ctx, VBridge vbr, EtherAddress eaddr, SalPort sport, int vid) Activate the specified host in the MAC mapping.
void	destroy(TxContext ctx, boolean retain) Destroy the MAC mapping.
void	disableInput(PacketContext pctx) This method does nothing.
void	filterPacket(PacketContext pctx, int vid) This method does nothing.
PacketContext	filterPacket(PacketContext pctx, int vid, VirtualBridge<?> bridge) Evaluate flow filters for outgoing packet to be transmitted by this MAC mapping.
VBridgeMapIdentifier<?>	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 MAC mapping.
protected org.slf4j.Logger	getLogger() Return a logger instance.
VnodeState	getState(TxContext ctx) Return the state of this MAC mapping.
boolean	isActive(TxContext ctx, EtherAddress eaddr, SalPort sport, int vid) Determine whether the given host is currently mapped by the MAC mapping or not.
boolean	isEnabled() Determine whether this MAC mapping is administravely enabled 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.
MacMap	resume(TxContext ctx) Resume the MAC mapping.
void	transmit(PacketContext pctx, VBridge vbr, Set<PortVlan> sent) Transmit the given packet to the physical network mapped by this VLAN mapping.

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

getIdentifier, getInitialValue

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

VTNMacMap

public VTNMacMap(BridgeIdentifier<Vbridge> vbrId,
                 VTNMacMapConfig mmc)

Construct a new instance.

This constructor is used to resume runtime status of the MAC mapping on bootstrap.

Parameters:

vbrId - The identifier for a vBridge that contains this MAC mapping.

mmc - MAC mapping configuration.

VTNMacMap

public VTNMacMap(BridgeIdentifier<Vbridge> vbrId,
                 MacMap mmp)
          throws RpcException

Construct a new instance.

Parameters:

vbrId - The identifier for a vBridge that contains this MAC mapping.

mmp - A MacMap instance read from the MD-SAL datastore.

Throws:

RpcException - mmp contains invalid configuration.

Method Detail

getState

public VnodeState getState(TxContext ctx)

Return the state of this MAC mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

Returns:

VnodeState.UP if this MAC mapping is active. VnodeState.DOWN otherwise.

resume

public MacMap resume(TxContext ctx)

Resume the MAC mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

Returns:

A MacMap instance on success. null on failure.

destroy

public void destroy(TxContext ctx,
                    boolean retain)

Destroy the MAC mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

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

notifyNode

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

activate

public boolean activate(TxContext ctx,
                        VBridge vbr,
                        EtherAddress eaddr,
                        SalPort sport,
                        int vid)
                 throws VTNException

Activate the specified host in the MAC mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

vbr - The parent vBridge.

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:

true on success. false on failure.

Throws:

VTNException - An error occurred.

isActive

public boolean isActive(TxContext ctx,
                        EtherAddress eaddr,
                        SalPort sport,
                        int vid)
                 throws VTNException

Determine whether the given host is currently mapped by the MAC mapping or not.

Parameters:

ctx - MD-SAL datastore transaction context.

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:

true if the given host is mapped by the MAC mapping. false if not mapped.

Throws:

VTNException - An error occurred.

transmit

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

Transmit the given packet to the physical network mapped by this VLAN mapping.

Parameters:

pctx - A runtime context for a received packet.

vbr - A VBridge instance that contains this VLAN mapping.

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.

getLogger

protected org.slf4j.Logger getLogger()

Return a logger instance.

Specified by:

getLogger in class VirtualElement<MacMap,MacMapIdentifier>

Returns:

A Logger instance.

getIdentifier

public VBridgeMapIdentifier<?> getIdentifier(EtherAddress eaddr,
                                             int vid)

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

Specified by:

getIdentifier in interface VirtualMapNode

Parameters:

eaddr - An EtherAddress instance that specifies the MAC address of the mapped host. null should be treated as if the mapped host is not specified.

vid - The VLAN ID of the mapped host.

Returns:

The identifier for the virtual network mapping.

isEnabled

public boolean isEnabled()

Determine whether this MAC mapping is administravely enabled or not.

Specified by:

isEnabled in interface VirtualMapNode

Returns:

Always true because the MAC mapping cannot be disabled administratively.

getIngressHop

public VNodeHop getIngressHop(EtherAddress eaddr,
                              int vid)

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

Specified by:

getIngressHop in interface VirtualMapNode

Parameters:

eaddr - An EtherAddress instance that specifies the MAC address of the mapped host. null should be treated as if the mapped host is not specified.

vid - The VLAN ID of the mapped host.

Returns:

A VNodeHop instance.

disableInput

public void disableInput(PacketContext pctx)

This method does nothing.

Specified by:

disableInput in interface VirtualMapNode

Parameters:

pctx - Unused.

filterPacket

public void filterPacket(PacketContext pctx,
                         int vid)

This method does nothing.

The input filters configured in the vBridge should be evaluated by VBridge.

Specified by:

filterPacket in interface VirtualMapNode

Parameters:

pctx - Unused.

vid - Unused.

filterPacket

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

Evaluate flow filters for outgoing packet to be transmitted by this MAC mapping.

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.