OpenFlowJ-Loxigen简介

Posted 2022-11-22 悟空很开心

OpenFlowJ-Loxigen简介
Floodlight v1.0及以上版本的依靠新的OpenFlowJ-Loxigen库。OpenFlowJ-Loxigen支持的OpenFlow版本由1.0到1.4。所有OpenFlow的概念和类型都可以通过OpenFlowJ-Loxigen来获得。OpenFlowJ-Loxigen支持更新，更优化地方式去创建OpenFlow消息，匹配域（Matches），动作集（Actions），流表更改（FlowMods）等等。本文主要分析OpenFlowJ-Loxigen库当中一些常用的类和构造方法。

OFFactory

几乎所有OpenFlow概念（OFObject，例如：Match, OFAction, OFMessage, etc.）可以被构造器构造，所有的构造器都通过OFFactory暴露。由于不同版本的OpenFlow协议存在差异性，所以每个OpenFlow协议版本对应一个特地的工厂类：

OFFactoryVer10
OFFactoryVer11
OFFactoryVer12
OFFactoryVer13
OFFactoryVer14（在floodlight中不被官方支持）
这些都实现了OFFactory接口，所以你可以简单地使用OFFactory接口，忽略存在不同版本的工厂类。
有很多种方法可以得到你想要的OFFactory实例。你可以从OpenFlowJ-Loxigen，通过指定OFVersion的枚举值来请求一个特定版本的OFFactory。

OFFactory my13Factory = OFFactories.getOFFactory(OFVersion.OF_13);    //取得一个OpenFlow 1.3的工厂类

更加实用的是，你可以从IOFSwitch中取得工厂类。

IOFSwitch mySwitch = switchService.getSwitch(DatapathId.of("00:00:00:00:00:00:00:01"));
OFFactory myFactory = mySwitch.getOFFactory();    //取得与请求交换机版本相符的工厂类版本

也可以从由OFFactory生成的已存在对象中取得一个特定的OFFactory，所有从OFFactory构造的对象中得到的OFVersion和用OFFactory构造出来的相同。

OFVersion flowModVersion = myFlowMod.getVersion();    //假设myFlowMod已经被构造好
OFFactory myFactory = OFFactories.getFactory(flowModVersion);

Match

匹配域（Match）通常用在OpenFlow当中用于表示和定义包的头部域的特征。如上所说，大部分OpenFlow的概念都可以使用工厂类去构造。所以创建一个工厂类的引用是构造一个匹配域的准备工作。

Match myMatch = myFactory.buildMatch()
    .setExact(MatchField.IN_PORT, OFPort.of(1))
    .setExact(MatchField.ETH_TYPE, EthType.IPv4)
    .setMasked(MatchField.IPV4_SRC, IPv4AddressWithMask.of("192.168.0.1/24"))
    .setExact(MatchField.IP_PROTO, IpProtocol.TCP)
    .setExact(MatchField.TCP_DST, TransportPort.of(80))
    .build();

可以看到，OFFactory的实例myFactory包含一个构造器（Match.builder），这个构造器可以使用buildMatch方法返回。通过调用构造器的setExact和setMasked方法可以分别指定精确匹配和掩码匹配。

Actions

OFAction’s，像匹配域一样，通过OFFactory构造。注意：有一个类叫做OFAction以及另一个类叫做OFActions。为了表示OFAction的复数形式，此处采用OFAction’s。虽然语法上存在问题，但不会和OFActions混淆。

OFActions allActions = myFactory.actions();

actions的调用可以返回一个已实现的OFActions接口。这个返回的实现完全取决与OFFactoy的版本。（本文仅介绍OpenFlow v1.3的Actions构造）
OpenFlow 1.2引入了OXM（OpenFlow Extensible Match）。通过OXM，所有导致已存在头部域修改的Actions都会被用一个新的set-field动作说明，set-field动作包含了OXM指定了头部域和新的写入该头部域的值。注意此处Oxm’s和Oxms的区别，和OFAction’s和OFActions的区别一样，Oxms是一个接口包含了所有独立的Oxm’s。

ArrayList<OFAction> actionList = new ArrayList<OFAction>();    //actionList用来存储不同的动作
OFActions actions = myOF13Factory.actions();    //actions为实例化的接口，此接口当中包含了所有独立的OFAction
OFOxms oxms = myOF13Factory.oxms();    //oxms为实例化的接口，此接口当中包含了所有独立的Oxm

/* 使用OXM去修改数据链路层的目地地址 */
OFActionSetField setDlDst = actions.buildSetField()
    .setField(
        oxms.buildEthDst()
        .setValue(MacAddress.of("ff:ff:ff:ff:ff:ff"))
        .build()
    )
    .build();
actionList.add(setDlDst);

/* 使用OXM去修改网络层的目地地址 */
OFActionSetField setNwDst = actions.buildSetField()
    .setField(
        oxms.buildIpv4Dst()
        .setValue(IPv4Address.of("255.255.255.255"))
        .build()
    )
    .build();
actionList.add(setNwDst);

/* 去VLAN加标不是OXM而是一个OFAction */
OFActionPopVlan popVlan = actions.popVlan();
actionList.add(popVlan);

/* 向一个端口发送不是OXM而是一个OFAction */
OFActionOutput output = actions.buildOutput()
    .setMaxLen(0xFFffFFff)
    .setPort(OFPort.of(1))
    .build();
actionList.add(output);

FlowMods

OpenFlowJ-Loxigen库提供了一个版本无关的OFFlowMod接口，它由很多子接口允许你写入一个与特定OFFlowModCommand相关的特定类型的OFFlowMod：

OFFlowAdd
OFFlowModify
OFFlowModifyStrict
OFFlowDelete
OFFlowDeleteStrict
关于OFFlowMods需要注意：OpenFlow 1.3移除了默认的table-miss操作（packet-in到控制器），OpenFlow 1.3指定了控制器必须插入一条特定的优先级为0的table-miss流表，通配所有匹配域，由OFAction’s定义的action列表

OFFlowAdd flowAdd = myFactory.buildFlowAdd()

与其他OpenFlow概念类似，OFFactory可以用于产生一种特定类型的OFFlowMod。
OFFactory可以返回你指定的OFFlowMod类型的构造器。但一般情况下，我们会发现将OFFlowMod从一种OFFlowModCommand转换成另一种会更实用。这个特性目前OpenFlowJ-Loxigen还不支持，但是可以通过net.floodlightcontroller.util.FlowModUtils.java来实现

OFFlowAdd flowAdd = myFactory.buildFlowAdd().build();

/* 将FlowAdd转换为FloodModify. */
OFFlowModify flowModify = FlowModUtils.toFlowModify(flowAdd);
OFFlowModifyStrict flowModifyStrict = FlowModUtils.toFlowModifyStrict(flowAdd);
OFFlowDelete flowDelete = FlowModUtils.toFlowDelete(flowAdd);
OFFlowDeleteStrict flowDelStrict = FlowModUtils.toFlowDeleteStrict(flowAdd);
OFFlowAdd flowAdd2 = FlowModUtils.toFlowAdd(flowModify);

下面讨论如何组成一个OFFlowMod

OFFlowAdd flowAdd = my13Factory.buildFlowAdd()
    .setBufferId(OFBufferId.NO_BUFFER)
    .setHardTimeout(3600)
    .setIdleTimeout(10)
    .setPriority(32768)
    .setMatch(myMatch)
    .setActions(actionList)
    .setOutPort(OFPort.FLOOD)
    .setTableId(TableId.of(1))
    .build();