openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.openflowplugin.api.openflow.device;
  10
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import io.netty.util.Timeout;
  13 import java.math.BigInteger;
  14 import java.util.List;
  15 import javax.annotation.CheckForNull;
  16 import javax.annotation.Nullable;
  17 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  18 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  19 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
  20 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  21 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
  22 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  23 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
  24 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
  25 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
  26 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
  27 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
  30
  31 /**
  32  * <p>
  33  * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
  34  * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
  35  * These attach to a particular Device Context in such a way, that there is at most one primary
  36  * session associated with a Device Context. Whenever the controller needs to interact with a
  37  * particular switch, it will do so in the context of the calling thread, obtaining a lock on
  38  * the corresponding Device Context – thus the Device Context becomes the fine-grained point
  39  * of synchronization. The only two entities allowed to send requests towards the switch are
  40  * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
  41  * with a particular Device Context. The Request Contexts are the basic units of fairness,
  42  * which is enforced by keeping a cap on the number of outstanding requests a particular Request
  43  * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
  44  * a request to the switch will fail immediately, with proper error indication.
  45  * </p>
  46  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 25.2.2015.
  47  */
  48 public interface DeviceContext extends AutoCloseable,
  49         DeviceReplyProcessor,
  50         PortNumberCache,
  51         TxFacade,
  52         XidSequencer {
  53
  54     void setStatisticsRpcEnabled(boolean isStatisticsRpcEnabled);
  55
  56     /**
  57      * distinguished device context states
  58      */
  59     enum DEVICE_CONTEXT_STATE {
  60         /**
  61          * initial phase of talking to switch
  62          */
  63         INITIALIZATION,
  64         /**
  65          * standard phase - interacting with switch
  66          */
  67         WORKING,
  68         /**
  69          * termination phase of talking to switch
  70          */
  71         TERMINATION
  72     }
  73
  74     /**
  75      * Method returns current device context state.
  76      *
  77      * @return {@link DeviceContext.DEVICE_CONTEXT_STATE}
  78      */
  79     DEVICE_CONTEXT_STATE getDeviceContextState();
  80
  81     /**
  82      * Method close all auxiliary connections and primary connection.
  83      */
  84     void shutdownConnection();
  85
  86     /**
  87      * Method add auxiliary connection contexts to this context representing single device connection.
  88      *
  89      * @param connectionContext
  90      */
  91     void addAuxiliaryConnectionContext(ConnectionContext connectionContext);
  92
  93     /**
  94      * Method removes auxiliary connection context from this context representing single device connection.
  95      *
  96      * @param connectionContext
  97      */
  98     void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
  99
 100     /**
 101      * Method provides state of device represented by this device context.
 102      *
 103      * @return {@link DeviceState}
 104      */
 105     DeviceState getDeviceState();
 106
 107     /**
 108      * Method has to activate (MASTER) or deactivate (SLAVE) TransactionChainManager.
 109      * TransactionChainManager represents possibility to write or delete Node subtree data
 110      * for actual Controller Cluster Node. We are able to have an active TxManager only if
 111      * newRole is {@link OfpRole#BECOMESLAVE}.
 112      * Parameters are used as marker to be sure it is change to SLAVE from MASTER or from
 113      * MASTER to SLAVE and the last parameter "cleanDataStore" is used for validation only.
 114      * @param oldRole - old role for quick validation for needed processing
 115      * @param role - NewRole expect to be {@link OfpRole#BECOMESLAVE} or {@link OfpRole#BECOMEMASTER}
 116      * @return RoleChangeTxChainManager future for activation/deactivation
 117      * @deprecated replaced by method onDeviceTakeClusterLeadership and onDevicLostClusterLeadership
 118      */
 119     @Deprecated
 120     ListenableFuture<Void> onClusterRoleChange(@Nullable OfpRole oldRole, @CheckForNull OfpRole role);
 121
 122     /**
 123      * Method has to activate TransactionChainManager and prepare all Contexts from Device Contects suite
 124      * to Taking ClusterLeadership role {@link OfpRole#BECOMEMASTER} (e.g. Routed RPC registration, StatPolling ...)
 125      * @return DeviceInitialization furure
 126      */
 127     ListenableFuture<Void> onDeviceTakeClusterLeadership();
 128
 129     /**
 130      * Method has to deactivate TransactionChainManager and prepare all Contexts from Device Contects suite
 131      * to Lost ClusterLeadership role {@link OfpRole#BECOMESLAVE} (e.g. Stop RPC rounting, stop StatPolling ...)
 132      * @return RoleChangeTxChainManager future for deactivation
 133      */
 134     ListenableFuture<Void> onDeviceLostClusterLeadership();
 135
 136     /**
 137      * Method has to close TxManager ASAP we are notified about Closed Connection
 138      * @return sync. future for Slave and MD-SAL completition for Master
 139      */
 140     ListenableFuture<Void> shuttingDownDataStoreTransactions();
 141
 142     /**
 143      * Method provides current devices connection context.
 144      *
 145      * @return
 146      */
 147     ConnectionContext getPrimaryConnectionContext();
 148
 149     /**
 150      * Method provides current devices auxiliary connection contexts.
 151      *
 152      * @return
 153      */
 154     ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
 155
 156     /**
 157      * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
 158      *
 159      * @return
 160      */
 161     DeviceFlowRegistry getDeviceFlowRegistry();
 162
 163     /**
 164      * Method exposes device group registry used for storing group ids.
 165      *
 166      * @return
 167      */
 168     DeviceGroupRegistry getDeviceGroupRegistry();
 169
 170     /**
 171      * Method exposes device meter registry used for storing meter ids.
 172      *
 173      * @return
 174      */
 175     DeviceMeterRegistry getDeviceMeterRegistry();
 176
 177
 178     /**
 179      * @return translator library
 180      */
 181     TranslatorLibrary oook();
 182
 183     /**
 184      * store cancellable timeout handler of currently running barrier task
 185      */
 186     void setCurrentBarrierTimeout(Timeout timeout);
 187
 188     /**
 189      * @return cancellable timeout handle of currently running barrier task
 190      */
 191     Timeout getBarrierTaskTimeout();
 192
 193     void setNotificationPublishService(NotificationPublishService notificationPublishService);
 194
 195     MessageSpy getMessageSpy();
 196
 197     MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
 198
 199     /**
 200      * indicates that device context is fully published (e.g.: packetIn messages should be passed)
 201      */
 202     void onPublished();
 203
 204     /**
 205      * change packetIn rate limiter borders
 206      *
 207      * @param upperBound max amount of outstanding packetIns
 208      */
 209     void updatePacketInRateLimit(long upperBound);
 210
 211     /**
 212      * @return registry point for item life cycle sources of device
 213      */
 214     ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
 215
 216     void setRpcContext(RpcContext rpcContext);
 217
 218     RpcContext getRpcContext();
 219
 220     void setStatisticsContext(StatisticsContext statisticsContext);
 221
 222     StatisticsContext getStatisticsContext();
 223
 224     @Override
 225     void close();
 226 }
 227