Floodlight 源码解读 ：Main

Floodlight 的 Main 解析图

---

需要理解的概念

模块（Module）

Module 是指继承了 IFloodlightModule 接口的类

IFloodlightModule的相关注释

 
 Defines an interface for loadable Floodlight modules.
 At a high level, these functions are called in the following order:
 
  getModuleServices() : 获得模块实现的服务列表
  getServiceImpls(); 实例化并返回：服务实现类-实现此服务的对象 映射
  getModuleDependencies() : 获得模块依赖的列表
  init() : internal initializations (<em>don't</em> touch other modules)
  startUp() : external initializations (<em>do</em> touch other modules)

所有可加载的模块都有这几种方法，在接下来的加载模块时需要使用到。
每个具体的模块都会重写这几个函数，下面举个 FloodlightProvider 的例子。

getModuleServices()

@Override
public Collection<Class<? extends IFloodlightService>> getModuleServices() {
    Collection<Class<? extends IFloodlightService>> services =
            new ArrayList<Class<? extends IFloodlightService>>(1);
    services.add(IFloodlightProviderService.class);
    return services;
}

获得 FloodlightProvider 的服务 IFloodlightProviderService

getServiceImple()

@Override
public Map<Class<? extends IFloodlightService>,
           IFloodlightService> getServiceImpls() {
    controller = new Controller();

    Map<Class<? extends IFloodlightService>,
        IFloodlightService> m =
            new HashMap<Class<? extends IFloodlightService>,
                        IFloodlightService>();
    m.put(IFloodlightProviderService.class, controller);
    return m;
}

返回服务实现类和实现用的对象的Map。

getModuleDependencies()

@Override
public Collection<Class<? extends IFloodlightService>> getModuleDependencies() {
    Collection<Class<? extends IFloodlightService>> dependencies =
        new ArrayList<Class<? extends IFloodlightService>>(4);
    dependencies.add(IStorageSourceService.class);
    dependencies.add(IPktInProcessingTimeService.class);
    dependencies.add(IRestApiService.class);
    dependencies.add(IDebugCounterService.class);
    dependencies.add(IOFSwitchService.class);
    dependencies.add(IThreadPoolService.class);
    dependencies.add(ISyncService.class);
    return dependencies;
}

返回依赖的列表

其他

init(),startup()，到对应的模块去看就可以了。
有的模块是没有服务依赖的，比如 ThreadPool模块。

服务（Service）

Service 是指继承了 IFloodlightService 接口的类。

public abstract interface IFloodlightService {
   // This space is intentionally left blank....don't touch it
}

模块使用getModuleServices()方法可以获得对应的服务列表，可以到源码去看对应的服务功能。

Main函数

1. 解析命令行参数
2. 加载模块
3. 启动 REST 服务器
4. 启动 Controller

命令行参数解析

CmdLineSetting 定义了命令行参数的格式

public static final String DEFAULT_CONFIG_FILE = "src/main/resources/floodlightdefault.properties";

@Option(name="-cf", aliases="--configFile", metaVar="FILE", usage="Floodlight configuration file")
private String configFile = DEFAULT_CONFIG_FILE;

如果没有使用-cf指定配置文件路径，则使用默认路径“src/main/resources/floodlightdefault.properties”

CmdLineParser 解析命令参数

CmdLineParser parser = new CmdLineParser(settings)
parser.parserArgument(args)

加载模块

moduleContext=fml.loadModulesFromConfig(settings.getModuleFile())
settings.getModuleFile()提供配置文件的路径

mergeProperties()

• 目的是获得配置文件里的模块的集合configMods和prop是除去配置文件里的模块键值对后剩余的配置信息(模块的配置参数)

loadModulesFromList(configsMods,prop)

findAllModule(configMods)

• 填充moduleNameMap,moduleServiceMap,ServiceMap

这个方法比较重要的是这个 ServiceLoader，返回服务加载器

ServiceLoader<IFloodlightModule> moduleLoader =
            ServiceLoader.load(IFloodlightModule.class, cl);

ServiceLoader 为了注册服务，需要在类路径 src/main/resources/META_INF/services文件夹内列好注册服务的模块，可以得到继承了 IFloodlightModule 接口的实现类
使用moduleLoader.iterator()迭代器去填充moduleNameMap,moduleServiceMap,ServiceMap
moduleNameMap 模块名称-模块对象 Map
moduleServiceMAP 模块名称-模块服务 Map
ServiceMap 模块服务-模块名称 Map

traverseDeps(moduleName,modsToLoad,moduleList,moduleMap,modsVisited)

addModule()

• 添加模块到模块的哈希集moduleMap，同时注册它们的服务（即得到已加载模块序列 moduleList）

parseConfigParameters(prop)

• 解析每个模块的配置参数

取配置文件的一条参数配置net.floodlightcontroller.forwarding.Forwarding.match=in-port, vlan, mac, ip, transport举例

key：net.floodlightcontroller.forwarding.Forwarding.match

String configKey=key.substring(LastPeriod+1)

获到的就是 match,即 configKey=match

String systemKey = System.getProperty(key);
if (systemKey != null) {
            configValue = systemKey;
        } else {
            configValue = prop.getProperty(key);
        }

如果系统属性已经存在，则使用系统属性的值，如果不存在，则configValue = prop.getProperty(key);【即 configValue 在此处为in-port, vlan, mac, ip, transport】

floodlightModuleContext.addConfigParam(mod,configKey,configValue)

• 添加模块的配置参数

FloodlightModuleLoader 类下的方法

public void addConfigParam(IFloodlightModule mod, String key, String value) {
    Map<String, String> moduleParams = configParams.get(mod.getClass());
    if (moduleParams == null) {
        moduleParams = new HashMap<String, String>();
        configParams.put(mod.getClass(), moduleParams);
    }
    moduleParams.put(key, value);
}

initModules(moduleList)

• 初始化已加载模块列表下的模块

获得模块的服务实例

Map<Class<? extends IFloodlightService>,
            IFloodlightService> simpls = module.getServiceImpls();

添加服务到 floodlightModuleContext

if (floodlightModuleContext.getServiceImpl(s.getKey()) == null) {
                    floodlightModuleContext.addService(s.getKey(),
                                                       s.getValue());

遍历已加载模块集，开始初始化模块，调用模块的方法：init

for (IFloodlightModule module : moduleSet) {
        // init the module
        if (logger.isDebugEnabled()) {
            logger.debug("Initializing " +
                         module.getClass().getCanonicalName());
        }
        module.init(floodlightModuleContext);
    }

startupModules(moduleList)

• 调用已加载模块的启动方法

遍历已加载模块集，调用每个模块的启动方法

for (IFloodlightModule m : moduleSet) {
        if (logger.isDebugEnabled()) {
            logger.debug("Starting " + m.getClass().getCanonicalName());
        }
        m.startUp(floodlightModuleContext);
    }

return floodlightModuleContext

返回公共环境变量

fml.runModules()

• 运动控制器模块和所有模块

getModuleList()

• 获得一个按初始化顺序的模块列表

返回一个不可修改的已加载模块序列，如果没被初始化则返回 null

public List<IFloodlightModule> getModuleList() {
    if (loadedModuleList == null)
        return Collections.emptyList();
    else
        return Collections.unmodifiableList(loadedModuleList);
}

runModules()

for (IFloodlightModule m : getModuleList()) {
        for (Method method : m.getClass().getDeclaredMethods()) {
            Run runAnnotation = method.getAnnotation(Run.class);
            if (runAnnotation != null) {
                RunMethod runMethod = new RunMethod(m, method);
                if(runAnnotation.mainLoop()) {
                    mainLoopMethods.add(runMethod);
                } else {
                    runMethod.run();
                }
            }
        }
    }

for 循环遍历模块中的方法，找到@run注解的方法为主方法，以下的就是 FloodlightProvider 提供的 run 方法

@Run(mainLoop=true)
public void run() throws FloodlightModuleException {
    controller.run();
}

运行控制器的模块

 mainLoopMethods.get(0).run();