Versions Compared

Old Version 22

changes.mady.by.user Srikanth Vavilapalli

Saved on

compared with

New Version Current

changes.mady.by.user Srikanth Vavilapalli

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Provides the following API to applications

    • Code Block
      languagejava
      titleGroup Service APIs
      /**
 * Service for create/update/delete "group" in the devices.
 * Flow entries can point to a "group" defined in the devices that enables
 * to represent additional methods of forwarding like load-balancing or
 * failover among different group of ports or multicast to all ports
 * specified in a group.
 * "group" can also be used for grouping common actions of different flows,
 * so that in some scenarios only one group entry required to be modified
 * for all the referencing flow entries instead of modifying all of them
 *
 * This implements semantics of a distributed authoritative group store
 * where the master copy of the groups lies with the controller and
 * the devices hold only the 'cached' copy.
 */
public interface GroupService {
    /**
     * Create a group in the specified device with the provided buckets.
     * This API provides an option for application to associate a cookie
     * while creating a group, so that applications can look-up the
     * groups based on the cookies. These Groups will be retained by
     * the core system and re-applied if any groups found missing in the
     * device when it reconnects. This API would immediately return after
     * submitting the request locally or to a remote Master controller
     * instance. As a response to this API invocation, GROUP_ADDED or
     * GROUP_ADD_FAILED notifications would be provided along with cookie
     * depending on the result of the operation on the device in the
     * data plane. The caller may also use "getGroup" API to get the
     * Group object created as part of this request.
     *
     * @param groupDesc group creation parameters
     *
     */
    void addGroup(GroupDescription groupDesc);
    /**
     * Return a group object associated to an application cookie.
     *
     * NOTE1: The presence of group object in the system does not
     * guarantee that the "group" is actually created in device.
     * GROUP_ADDED notification would confirm the creation of
     * this group in data plane
     *
     * @param deviceId device identifier
     * @param appCookie application cookie to be used for lookup
     *
     * @return group associated with the application cookie or
     *               NULL if Group is not found for the provided cookie
     */
    Group getGroup(DeviceId deviceId, GroupKey appCookie);
    /**
     * Append buckets to existing group. The caller can optionally
     * associate a new cookie during this updation. GROUP_UPDATED or
     * GROUP_UPDATE_FAILED notifications would be provided along with
     * cookie depending on the result of the operation on the device
     *
     * @param deviceId device identifier
     * @param oldCookie cookie to be used to retrieve the existing group
     * @param buckets immutable list of group bucket to be added
     * @param newCookie immutable cookie to be used post update operation
     * @param appId Application Id
     */
    void addBucketsToGroup(DeviceId deviceId,
                           GroupKey oldCookie,
                           GroupBuckets buckets,
                           GroupKey newCookie,
                           ApplicationId appId);
    /**
     * Remove buckets from existing group. The caller can optionally
     * associate a new cookie during this updation. GROUP_UPDATED or
     * GROUP_UPDATE_FAILED notifications would be provided along with
     * cookie depending on the result of the operation on the device
     *
     * @param deviceId device identifier
     * @param oldCookie cookie to be used to retrieve the existing group
     * @param buckets immutable list of group bucket to be removed
     * @param newCookie immutable cookie to be used post update operation
     * @param appId Application Id
     */
    void removeBucketsFromGroup(Device deviceId,
                                GroupKey oldCookie,
                                GroupBuckets buckets,
                                GroupKey newCookie,
                                ApplicationId appId);
    /**
     * Delete a group associated to an application cookie.
     * GROUP_DELETED or GROUP_DELETE_FAILED notifications would be
     * provided along with cookie depending on the result of the
     * operation on the device
     *
     * @param deviceId device identifier
     * @param appCookie application cookie to be used for lookup
     * @param appId Application Id
     */
    void removeGroup(Device deviceId, GroupKey appCookie, ApplicationId appId);
    /**
     * Retrieve all groups created by an application in the specified device
     * as seen by current controller instance.
     *
     * @param deviceId device identifier
     * @param appId application id
     *
     * @return collection of immutable group objects created by the application
     */
    Iterable<Group> getGroups(Device deviceId, ApplicationId appId);
    /**
     * Adds the specified group listener.
     *
     * @param listener group listener
     */
    void addListener(GroupListener listener);
    /**
     * Removes the specified group listener.
     *
     * @param listener group listener
     */
    void removeListener(GroupListener listener);
}

    • void CreateGroup(GroupDescription)

    • Group GetGroup(Device, GroupKey)

    • void AddBucketsToGroup(Device, OldGroupKey, GroupBuckets, NewGroupKey, appid)

    • void RemoveBucketsFromGroup(Device, OldGroupKey, GroupBuckets, NewGroupKey, appid)

    • void RemoveGroup(Device, GroupKey, appid)
    • Iterable<Group> GetGroups(Device, appid)
      • GetAllGroupStatistics(Device, appid)

    •  

       

  • DataModel

    Image Added

    • Group Types to be supported

      • Select

      • Indirect

      • All

      • Failover

    DataModel

    Image Removed

    • Group Types to be supported

      • Select

      • Indirect

      • All

      • Failover

    • Key

      • An application specific cookie that supports Hash and Equals method

    • Id

      • Integer

    • Bucket

      • One or more collection of Traffic Instructions

Code Block
languagejava
titleHow to create and use Group
firstline1
linenumberstrue
collapsetrue
{
    Collection<TrafficTreatment>List<GroupBucket> groupBucketsbuckets = new ArrayList<TrafficTreatment>ArrayList<GroupBucket>();
	List<PortNumber> outPorts = getPortsToDevice(srcDevice, neighborDevice);

    for (PortNumber portNumber: outPorts) {
        TrafficTreatment.Builder tBuilder = DefaultTrafficTreatment.builder();
        tBuilder.setOutput(portNumber)
                .setEthDst(getRouterMacAddress(neighborDevice))
                .setEthSrc(getRouterMacAddress(srcDevice))
                .pushMpls()
                .setMpls(getMplsId(finalDstDevice));
        groupBucketsbuckets.add(GroupBucket.createSelectGroupBucket(tBuilder.build()));
    }

	GroupKey gorupKey    GroupBuckets groupBuckets = SegmentRoutingGroupKey.build(srcDevice, Collection<NeighborDevice>, dstDevicenew GroupBuckets(buckets);
	GroupKey groupKey = SegmentRoutingGroupKey.build(srcDevice,  Future<Group> future = groupService.createGroupCollection<NeighborDevice>, dstDevice);
 
	GroupDescription groupDesc = new DefaultGroupDescription(srcDevice, Group.Type.SELECT,
            groupBuckets, groupKey, getAppId());
    Group group = future.get(groupService.addGroup(groupDesc);
}
 
public void SetIpRule() {
....
	GroupKey gorupKey = SegmentRoutingGroupKey.build(srcDevice, Collection<NeighborDevice>, dstDevice);
	Group group = groupService.getGroup(srcDevice, groupKey);
	tbuilder.setGroup(group.id().id());
....
 
}

Group Manager

This component implements the Group Service interface by defining Group create/modify/remove/query operations on devices.

...

High level flow of events in the Group subsystem is depicted below when an operation like CreateGroup is submitted by the application to non-Master controller instance in a multi-instance environment.

Multi-instance Support

TODO

Group Provider

  • Provides SB APIs towards core

    • CreateGroup(GroupId, Buckets)

    • ModifyGroup(GroupId, Buckets)

    • RemoveGroup(GroupId)

    • GetGroups()

OF Group Provider

...

Implements Group Providers interface

...

    • Code Block
      languagejava
      titleGroup Provider SB API
      /**
 * Abstraction of group provider.
 */
public interface GroupProvider extends Provider {
    /**
     * Perform a group operation in the specified device with the
     * specified parameters.
     *
     * @param deviceId device identifier on which the batch of group
     * operations to be executed
     * @param groupOps immutable list of group operation
     */
    void performGroupOperation(DeviceId deviceId,
                               GroupOperations groupOps);
}
    • Code Block
      languagejava
      titleGroup Provider Notifications to Northbound
      /**
 * Service through which Group providers can inject information into
 * the core.
 */
public interface GroupProviderService extends ProviderService<GroupProvider> {
    /**
     * Notifies core if any failure from data plane during group operations.
     *
     * @param operation offended group operation
     */
    void groupOperationFailed(GroupOperation operation);


    /**
     * Pushes the collection of group detected in the data plane along
     * with statistics.
     *
     * @param deviceId device identifier
     * @param groupEntries collection of group entries as seen in data plane
     */
    void pushGroupMetrics(DeviceId deviceId,
                       Collection<Group> groupEntries);
}

OF Group Provider

  • Implements Group Providers interface

  • Add listeners to OpenFlowController for any events
  • On DeviceConnected event, spawn a Group statistics collector per device that retrieves the Group descriptions and Group statistics
  • On receiving GROUP_DESC or STATS_REPLY for GROUPS, pass them to GroupStatsCollector module to combine them into a single notification event to be notified to core

  • Builds Open Flow GROUP_MOD (ADD/MOD/DELETE) Message depending on the group operation invocation and writes the message to switch driver

  • On GROUP_MOD failures, notifies the core with the correction Group operation information. To achieve this, OF Group Provider maintain a map of Open flow transaction Id and associated GroupOperation that was submitted from core. On receiving GROUP_DESC with the corresponding GroupId or receiving GROUP_MOD failed with the transaction Id, OF Group Provider should clear the map and notifies the core accordingly.

 

Class Diagram

Image Added

OF Switch Driver

  • No changes

...