2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.openflowplugin.api.openflow.device;
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;
17 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
18 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
19 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
20 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
21 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
22 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
23 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
24 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
25 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
26 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
27 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
28 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
34 * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
35 * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
36 * These attach to a particular Device Context in such a way, that there is at most one primary
37 * session associated with a Device Context. Whenever the controller needs to interact with a
38 * particular switch, it will do so in the context of the calling thread, obtaining a lock on
39 * the corresponding Device Context – thus the Device Context becomes the fine-grained point
40 * of synchronization. The only two entities allowed to send requests towards the switch are
41 * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
42 * with a particular Device Context. The Request Contexts are the basic units of fairness,
43 * which is enforced by keeping a cap on the number of outstanding requests a particular Request
44 * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
45 * a request to the switch will fail immediately, with proper error indication.
48 public interface DeviceContext extends AutoCloseable,
56 * distinguished device context states
58 enum DEVICE_CONTEXT_STATE {
60 * initial phase of talking to switch
64 * standard phase - interacting with switch
68 * termination phase of talking to switch
74 * Method returns current device context state.
76 * @return {@link DeviceContext.DEVICE_CONTEXT_STATE}
78 DEVICE_CONTEXT_STATE getDeviceContextState();
81 * Method close all auxiliary connections and primary connection.
83 void shutdownConnection();
86 * Method add auxiliary connection contexts to this context representing single device connection.
88 * @param connectionContext
90 void addAuxiliaryConnectionContext(ConnectionContext connectionContext);
93 * Method removes auxiliary connection context from this context representing single device connection.
95 * @param connectionContext
97 void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
100 * Method provides state of device represented by this device context.
102 * @return {@link DeviceState}
104 DeviceState getDeviceState();
106 DeviceInfo getDeviceInfo();
109 * Method has to activate (MASTER) or deactivate (SLAVE) TransactionChainManager.
110 * TransactionChainManager represents possibility to write or delete Node subtree data
111 * for actual Controller Cluster Node. We are able to have an active TxManager only if
112 * newRole is {@link OfpRole#BECOMESLAVE}.
113 * Parameters are used as marker to be sure it is change to SLAVE from MASTER or from
114 * MASTER to SLAVE and the last parameter "cleanDataStore" is used for validation only.
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
120 ListenableFuture<Void> onClusterRoleChange(@CheckForNull OfpRole role);
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
127 ListenableFuture<Void> onDeviceTakeClusterLeadership();
130 * Method has to close TxManager ASAP we are notified about Closed Connection
131 * @return sync. future for Slave and MD-SAL completition for Master
133 ListenableFuture<Void> shuttingDownDataStoreTransactions();
136 * Method provides current devices connection context.
140 ConnectionContext getPrimaryConnectionContext();
143 * Method provides current devices auxiliary connection contexts.
147 ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
150 * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
154 DeviceFlowRegistry getDeviceFlowRegistry();
157 * Method exposes device group registry used for storing group ids.
161 DeviceGroupRegistry getDeviceGroupRegistry();
164 * Method exposes device meter registry used for storing meter ids.
168 DeviceMeterRegistry getDeviceMeterRegistry();
172 * @return translator library
174 TranslatorLibrary oook();
177 * store cancellable timeout handler of currently running barrier task
179 void setCurrentBarrierTimeout(Timeout timeout);
182 * @return cancellable timeout handle of currently running barrier task
184 Timeout getBarrierTaskTimeout();
186 void setNotificationPublishService(NotificationPublishService notificationPublishService);
188 MessageSpy getMessageSpy();
190 MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
193 * indicates that device context is fully published (e.g.: packetIn messages should be passed)
198 * change packetIn rate limiter borders
200 * @param upperBound max amount of outstanding packetIns
202 void updatePacketInRateLimit(long upperBound);
205 * @return registry point for item life cycle sources of device
207 ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
209 void setStatisticsContext(StatisticsContext statisticsContext);
211 StatisticsContext getStatisticsContext();