opendaylight（Li） l2switch 源代码分析（3）--packethandler

本文介绍packethander工程，该工程用于对进入到controller的packet进行解析并分发到不同的
模块进行处理。
工程分为四个部分：
config文件夹：packethander的配置信息，如plugin的部署顺序，初始化时的配置。
implementation文件夹：service的具体实现，包含了java和yang。
model文件夹：定义了packet相关的yang。
pom.xml


一、pom.xml
packethander的pom.xml文件很简单，主要包含一下两部分：
 
    org.opendaylight.l2switch
    l2switch-parent
    0.4.0-SNAPSHOT
    ../parent
 
该配置指向了之前讲的parent工程，说明packethander继承了parent，所以很多配置都可以省略。

 
    model
    implementation
    config
 
该配置指向了config，implementation和model三个文件夹，maven会去这三个文件夹下面去找
pom.xml文件。


二、model
该目录包含了五个yang文件和一个pom.xml.

1.arp-packet.yang
该文件主要定义了一个grouping和一个notification。
grouping arp-packet-fields {
leaf xxx {
}

leaf xxx {
}
......
uses bpacket:packet-fields;
}
上面的语句定义了arp pakcet的结构。
最后的uses语句会引用packet.yang中grouping packet-fields。

notification arp-packet-received {
  uses bpacket:packet-chain-grp {
    augment "packet-chain/packet" {
       case arp-packet {
        uses arp-packet-fields;
      }
    }
  }
  uses bpacket:packet-payload;
}
上面的语句定义了一个notification，notification的内容是一个arp packet，当Provider
提交一个notification时,所有的订阅该服务的Consumer都会收到这个arp packet.

上述语句的意思是引入了bpacket的grouping packet-chain-grp（bpacket为packet.yang
的prefix），在list packet-chain的choice packet中增加一个case arp-packet，该case
引用了arp-packet-fields。最后引用bpacket的grouping packet-payload，最终的结果
为:
notification arp-packet-received {
    list packet-chain {
      choice packet {
        case arp-packet {
          uses arp-packet-fields;
        }
        case raw-packet {
          uses raw-packet-fields;
        }
      }
    }
    grouping packet-payload {
      leaf payload {
        type binary;
      }
    }
}

2.ethernet-packet.yang
3.ipv4-packet.yang
4.ipv6-packet.yang
上面三个YANG文件的分析参考1。

5.packet.yang
该YANG文件作为一个基础文件被上面4个文件引用。

6.pom.xml
这个pom文件主要作用是编译yang文件生成java代码。主要的几部分语句如下：

    org.opendaylight.l2switch
    l2switch-parent
    0.4.0-SNAPSHOT
    ../../parent

继承了parent工程。

 
   
      org.opendaylight.openflowplugin.model
      model-flow-service
   
   
      org.opendaylight.mdsal.model
      ietf-yang-types
   
 
虽然继承了parent中的依赖关系，这边还需要一些编译yang文件所需的特别的依赖。


   
     
    ......
          
     
    ......
          
    ......
    

同样，虽然继承了parent中的插件，这边还需要一些编译yang文件所需要的特别的插件。


三、implementation
该目录实现了具体的service，包含了java文件，yang文件和pom.xml文件。

1.pom.xml文件
该文件的的结构和之前分析的差不多，这边就不再说明了。


2.packet-handler-impl.yang
该文件的主要部分：
  augment "/config:modules/config:module/config:configuration" {
    case packet-handler-impl {
      when "/config:modules/config:module/config:type = 'packet-handler-impl'";

      container notification-service {
        uses config:service-ref {
          refine type {
            mandatory true;
            config:required-identity mdsal:binding-notification-service;
          }
        }
      }
    }
  }
注册一个notification service到mdsal中。


3.java文件
AbstractPacketDecoder.java：定义了一个抽象类，下面的类都会继承它，主要抽象方法
是decode，用于解析各类packet。
ArpDecoder.java：继承AbstractPacketDecoder，其中的decode方法用于解析arp包。
EthernetDecoder.java：继承AbstractPacketDecoder，其中的decode方法用于解析以太网帧。
Ipv4Decoder.java：继承AbstractPacketDecoder，其中的decode方法用于解析Ipv4数据包。
Ipv6Decoder.java：继承AbstractPacketDecoder，其中的decode方法用于解析Ipv6数据包。


四、config
主要包含一个xml配置文件：50-packethandler.xml
 
   
     
       
         
            prefix:packet-handler-impl
         
          packet-handler-impl

         
           
              binding:binding-notification-service
           
            binding-notification-broker
         
       
     
   
 
它为packethandler创建了初始配置，主要是在mdsal中注册notification service，在运行时，
实际的模块实例会被插入到modules/module/下面。

最后要是说明下文件名中的50，该数字代表了启动等级，数字越高，启动的优先级越低，比如mdsal的为1，
则最先启动。