2 * Copyright (c) 2013 Pantheon Technologies s.r.o. 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
10 package org.opendaylight.openflowjava.protocol.impl.core;
12 import com.google.common.util.concurrent.ListenableFuture;
13 import com.google.common.util.concurrent.SettableFuture;
14 import io.netty.channel.EventLoopGroup;
15 import io.netty.channel.epoll.Epoll;
16 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionConfiguration;
17 import org.opendaylight.openflowjava.protocol.api.connection.SwitchConnectionHandler;
18 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
19 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
20 import org.opendaylight.openflowjava.protocol.api.extensibility.OFGeneralDeserializer;
21 import org.opendaylight.openflowjava.protocol.api.extensibility.OFGeneralSerializer;
22 import org.opendaylight.openflowjava.protocol.api.extensibility.OFSerializer;
23 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
24 import org.opendaylight.openflowjava.protocol.api.keys.ActionSerializerKey;
25 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterActionDeserializerKey;
26 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterDeserializerKey;
27 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdDeserializerKey;
28 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdMeterSubTypeSerializerKey;
29 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdSerializerKey;
30 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterInstructionDeserializerKey;
31 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterSerializerKey;
32 import org.opendaylight.openflowjava.protocol.api.keys.InstructionSerializerKey;
33 import org.opendaylight.openflowjava.protocol.api.keys.MatchEntryDeserializerKey;
34 import org.opendaylight.openflowjava.protocol.api.keys.MatchEntrySerializerKey;
35 import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey;
36 import org.opendaylight.openflowjava.protocol.api.keys.MessageTypeKey;
37 import org.opendaylight.openflowjava.protocol.impl.deserialization.DeserializationFactory;
38 import org.opendaylight.openflowjava.protocol.impl.deserialization.DeserializerRegistryImpl;
39 import org.opendaylight.openflowjava.protocol.impl.serialization.SerializationFactory;
40 import org.opendaylight.openflowjava.protocol.impl.serialization.SerializerRegistryImpl;
41 import org.opendaylight.openflowjava.protocol.spi.connection.SwitchConnectionProvider;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.config.rev140630.TransportProtocol;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OxmClassBase;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.property.header.QueueProperty;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.table.features.properties.grouping.TableFeatureProperties;
50 import org.slf4j.Logger;
51 import org.slf4j.LoggerFactory;
54 * Exposed class for server handling<br>
55 * C - {@link MatchEntrySerializerKey} parameter representing oxm_class (see specification)<br>
56 * F - {@link MatchEntrySerializerKey} parameter representing oxm_field (see specification)
58 * @author michal.polkorab
60 public class SwitchConnectionProviderImpl implements SwitchConnectionProvider, ConnectionInitializer {
62 private static final Logger LOG = LoggerFactory
63 .getLogger(SwitchConnectionProviderImpl.class);
64 private SwitchConnectionHandler switchConnectionHandler;
65 private ServerFacade serverFacade;
66 private ConnectionConfiguration connConfig;
67 private final SerializationFactory serializationFactory;
68 private final SerializerRegistry serializerRegistry;
69 private final DeserializerRegistry deserializerRegistry;
70 private final DeserializationFactory deserializationFactory;
71 private TcpConnectionInitializer connectionInitializer;
74 public SwitchConnectionProviderImpl() {
75 serializerRegistry = new SerializerRegistryImpl();
76 serializerRegistry.init();
77 serializationFactory = new SerializationFactory();
78 serializationFactory.setSerializerTable(serializerRegistry);
79 deserializerRegistry = new DeserializerRegistryImpl();
80 deserializerRegistry.init();
81 deserializationFactory = new DeserializationFactory();
82 deserializationFactory.setRegistry(deserializerRegistry);
86 public void setConfiguration(final ConnectionConfiguration connConfig) {
87 this.connConfig = connConfig;
91 public void setSwitchConnectionHandler(final SwitchConnectionHandler switchConnectionHandler) {
92 LOG.debug("setSwitchConnectionHandler");
93 this.switchConnectionHandler = switchConnectionHandler;
97 public ListenableFuture<Boolean> shutdown() {
98 LOG.debug("Shutdown summoned");
99 if(serverFacade == null){
100 LOG.warn("Can not shutdown - not configured or started");
101 throw new IllegalStateException("SwitchConnectionProvider is not started or not configured.");
103 return serverFacade.shutdown();
107 public ListenableFuture<Boolean> startup() {
108 LOG.debug("Startup summoned");
109 ListenableFuture<Boolean> result = null;
111 serverFacade = createAndConfigureServer();
112 if (switchConnectionHandler == null) {
113 throw new IllegalStateException("SwitchConnectionHandler is not set");
115 new Thread(serverFacade).start();
116 result = serverFacade.getIsOnlineFuture();
117 } catch (final Exception e) {
118 final SettableFuture<Boolean> exResult = SettableFuture.create();
119 exResult.setException(e);
128 private ServerFacade createAndConfigureServer() {
129 LOG.debug("Configuring ..");
130 ServerFacade server = null;
131 final ChannelInitializerFactory factory = new ChannelInitializerFactory();
132 factory.setSwitchConnectionHandler(switchConnectionHandler);
133 factory.setSwitchIdleTimeout(connConfig.getSwitchIdleTimeout());
134 factory.setTlsConfig(connConfig.getTlsConfiguration());
135 factory.setSerializationFactory(serializationFactory);
136 factory.setDeserializationFactory(deserializationFactory);
137 factory.setUseBarrier(connConfig.useBarrier());
138 final TransportProtocol transportProtocol = (TransportProtocol) connConfig.getTransferProtocol();
140 // Check if Epoll native transport is available.
141 // TODO : Add option to disable Epoll.
142 boolean isEpollEnabled = Epoll.isAvailable();
144 if (transportProtocol.equals(TransportProtocol.TCP) || transportProtocol.equals(TransportProtocol.TLS)) {
145 server = new TcpHandler(connConfig.getAddress(), connConfig.getPort());
146 final TcpChannelInitializer channelInitializer = factory.createPublishingChannelInitializer();
147 ((TcpHandler) server).setChannelInitializer(channelInitializer);
148 ((TcpHandler) server).initiateEventLoopGroups(connConfig.getThreadConfiguration(), isEpollEnabled);
150 final EventLoopGroup workerGroupFromTcpHandler = ((TcpHandler) server).getWorkerGroup();
151 connectionInitializer = new TcpConnectionInitializer(workerGroupFromTcpHandler, isEpollEnabled);
152 connectionInitializer.setChannelInitializer(channelInitializer);
153 connectionInitializer.run();
154 } else if (transportProtocol.equals(TransportProtocol.UDP)){
155 server = new UdpHandler(connConfig.getAddress(), connConfig.getPort());
156 ((UdpHandler) server).initiateEventLoopGroups(connConfig.getThreadConfiguration(), isEpollEnabled);
157 ((UdpHandler) server).setChannelInitializer(factory.createUdpChannelInitializer());
159 throw new IllegalStateException("Unknown transport protocol received: " + transportProtocol);
161 server.setThreadConfig(connConfig.getThreadConfiguration());
168 public ServerFacade getServerFacade() {
173 public void close() throws Exception {
178 public boolean unregisterSerializer(final ExperimenterSerializerKey key) {
179 return serializerRegistry.unregisterSerializer((MessageTypeKey<?>) key);
183 public boolean unregisterDeserializer(final ExperimenterDeserializerKey key) {
184 return deserializerRegistry.unregisterDeserializer((MessageCodeKey) key);
188 public void registerActionSerializer(final ActionSerializerKey<?> key,
189 final OFGeneralSerializer serializer) {
190 serializerRegistry.registerSerializer(key, serializer);
194 public void registerActionDeserializer(final ExperimenterActionDeserializerKey key,
195 final OFGeneralDeserializer deserializer) {
196 deserializerRegistry.registerDeserializer(key, deserializer);
200 public void registerInstructionSerializer(final InstructionSerializerKey<?> key,
201 final OFGeneralSerializer serializer) {
202 serializerRegistry.registerSerializer(key, serializer);
206 public void registerInstructionDeserializer(final ExperimenterInstructionDeserializerKey key,
207 final OFGeneralDeserializer deserializer) {
208 deserializerRegistry.registerDeserializer(key, deserializer);
212 public <C extends OxmClassBase, F extends MatchField> void registerMatchEntrySerializer(final MatchEntrySerializerKey<C, F> key,
213 final OFGeneralSerializer serializer) {
214 serializerRegistry.registerSerializer(key, serializer);
218 public void registerMatchEntryDeserializer(final MatchEntryDeserializerKey key,
219 final OFGeneralDeserializer deserializer) {
220 deserializerRegistry.registerDeserializer(key, deserializer);
224 public void registerErrorDeserializer(final ExperimenterIdDeserializerKey key,
225 final OFDeserializer<ErrorMessage> deserializer) {
226 deserializerRegistry.registerDeserializer(key, deserializer);
230 public void registerExperimenterMessageDeserializer(ExperimenterIdDeserializerKey key,
231 OFDeserializer<? extends ExperimenterDataOfChoice> deserializer) {
232 deserializerRegistry.registerDeserializer(key, deserializer);
236 public void registerMultipartReplyMessageDeserializer(ExperimenterIdDeserializerKey key,
237 OFDeserializer<? extends ExperimenterDataOfChoice> deserializer) {
238 deserializerRegistry.registerDeserializer(key, deserializer);
242 public void registerMultipartReplyTFDeserializer(final ExperimenterIdDeserializerKey key,
243 final OFGeneralDeserializer deserializer) {
244 deserializerRegistry.registerDeserializer(key, deserializer);
248 public void registerQueuePropertyDeserializer(final ExperimenterIdDeserializerKey key,
249 final OFDeserializer<QueueProperty> deserializer) {
250 deserializerRegistry.registerDeserializer(key, deserializer);
254 public void registerMeterBandDeserializer(final ExperimenterIdDeserializerKey key,
255 final OFDeserializer<MeterBandExperimenterCase> deserializer) {
256 deserializerRegistry.registerDeserializer(key, deserializer);
260 public void registerExperimenterMessageSerializer(ExperimenterIdSerializerKey<? extends ExperimenterDataOfChoice> key,
261 OFSerializer<? extends ExperimenterDataOfChoice> serializer) {
262 serializerRegistry.registerSerializer(key, serializer);
266 public void registerMultipartRequestSerializer(ExperimenterIdSerializerKey<? extends ExperimenterDataOfChoice> key,
267 OFSerializer<? extends ExperimenterDataOfChoice> serializer) {
268 serializerRegistry.registerSerializer(key, serializer);
272 public void registerMultipartRequestTFSerializer(final ExperimenterIdSerializerKey<TableFeatureProperties> key,
273 final OFGeneralSerializer serializer) {
274 serializerRegistry.registerSerializer(key, serializer);
279 * @deprecated Since we have used ExperimenterIdMeterSubTypeSerializerKey as MeterBandSerializer's key, in order to avoid
280 * the occurrence of an error, we should discard this function
283 public void registerMeterBandSerializer(final ExperimenterIdSerializerKey<MeterBandExperimenterCase> key,
284 final OFSerializer<MeterBandExperimenterCase> serializer) {
285 serializerRegistry.registerSerializer(key, serializer);
289 public void registerMeterBandSerializer(final ExperimenterIdMeterSubTypeSerializerKey<MeterBandExperimenterCase> key,
290 final OFSerializer<MeterBandExperimenterCase> serializer) {
291 serializerRegistry.registerSerializer(key, serializer);
295 public void initiateConnection(final String host, final int port) {
296 connectionInitializer.initiateConnection(host, port);
300 public ConnectionConfiguration getConfiguration() {
301 return this.connConfig;