plugin/src/main/java/org/opendaylight/ovsdb/plugin/impl/ConnectionServiceImpl.java

   1 /*
   2  * Copyright (C) 2013 Red Hat, Inc.
   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  * Authors : Madhu Venugopal, Brent Salisbury, Evan Zeller
   9  */
  10 package org.opendaylight.ovsdb.plugin.impl;
  11
  12 import io.netty.channel.ChannelHandler;
  13
  14 import java.io.IOException;
  15 import java.net.InetAddress;
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.HashSet;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.Set;
  22 import java.util.concurrent.ConcurrentHashMap;
  23 import java.util.concurrent.ConcurrentMap;
  24 import java.util.concurrent.ExecutionException;
  25
  26 import org.opendaylight.controller.sal.core.Node;
  27 import org.opendaylight.controller.sal.core.Property;
  28 import org.opendaylight.controller.sal.utils.Status;
  29 import org.opendaylight.controller.sal.utils.StatusCode;
  30 import org.opendaylight.ovsdb.lib.MonitorCallBack;
  31 import org.opendaylight.ovsdb.lib.OvsdbClient;
  32 import org.opendaylight.ovsdb.lib.OvsdbConnection;
  33 import org.opendaylight.ovsdb.lib.OvsdbConnectionInfo;
  34 import org.opendaylight.ovsdb.lib.OvsdbConnectionListener;
  35 import org.opendaylight.ovsdb.lib.message.MonitorRequest;
  36 import org.opendaylight.ovsdb.lib.message.MonitorRequestBuilder;
  37 import org.opendaylight.ovsdb.lib.message.MonitorSelect;
  38 import org.opendaylight.ovsdb.lib.message.TableUpdates;
  39 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
  40 import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
  41 import org.opendaylight.ovsdb.lib.schema.TableSchema;
  42 import org.opendaylight.ovsdb.plugin.api.Connection;
  43 import org.opendaylight.ovsdb.plugin.api.ConnectionConstants;
  44 import org.opendaylight.ovsdb.plugin.internal.IPAddressProperty;
  45 import org.opendaylight.ovsdb.plugin.internal.L4PortProperty;
  46 import org.opendaylight.ovsdb.plugin.api.OvsdbConnectionService;
  47 import org.opendaylight.ovsdb.plugin.api.OvsdbInventoryService;
  48 import org.opendaylight.ovsdb.utils.config.ConfigProperties;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 import com.google.common.collect.Lists;
  53
  54
  55 /**
  56  * Represents the openflow plugin component in charge of programming the flows
  57  * the flow programming and relay them to functional modules above SAL.
  58  */
  59 public class ConnectionServiceImpl implements OvsdbConnectionService,
  60                                               OvsdbConnectionListener {
  61     protected static final Logger logger = LoggerFactory.getLogger(ConnectionServiceImpl.class);
  62
  63     // Properties that can be set in config.ini
  64     private static final Integer DEFAULT_OVSDB_PORT = 6640;
  65     private static final String OVSDB_LISTENPORT = "ovsdb.listenPort";
  66
  67
  68     private ConcurrentMap<String, Connection> ovsdbConnections = new ConcurrentHashMap<String, Connection>();
  69     private List<ChannelHandler> handlers = null;
  70
  71     private volatile OvsdbInventoryService ovsdbInventoryService;
  72     private volatile OvsdbConnection connectionLib;
  73
  74     public void setOvsdbInventoryService(OvsdbInventoryService inventoryService) {
  75         this.ovsdbInventoryService = inventoryService;
  76     }
  77
  78     public void setOvsdbConnection(OvsdbConnection ovsdbConnection) {
  79         this.connectionLib = ovsdbConnection;
  80     }
  81
  82     public void init() {
  83     }
  84
  85     /**
  86      * Function called by the dependency manager when at least one dependency
  87      * become unsatisfied or when the component is shutting down because for
  88      * example bundle is being stopped.
  89      */
  90     void destroy() {
  91     }
  92
  93     /**
  94      * Function called by dependency manager after "init ()" is called and after
  95      * the services provided by the class are registered in the service registry
  96      */
  97     void start() {
  98         /* Start ovsdb server before getting connection clients */
  99         String portString = ConfigProperties.getProperty(OvsdbConnectionService.class, OVSDB_LISTENPORT);
 100         int ovsdbListenPort = DEFAULT_OVSDB_PORT;
 101         if (portString != null) {
 102             ovsdbListenPort = Integer.decode(portString).intValue();
 103         }
 104
 105         if (!connectionLib.startOvsdbManager(ovsdbListenPort)) {
 106             logger.warn("Start OVSDB manager call from ConnectionService was not necessary");
 107         }
 108
 109         /* Then get connection clients */
 110         Collection<OvsdbClient> connections = connectionLib.getConnections();
 111         for (OvsdbClient client : connections) {
 112             logger.info("CONNECT start connected clients client = {}", client);
 113             this.connected(client);
 114         }
 115     }
 116
 117     /**
 118      * Function called by the dependency manager before the services exported by
 119      * the component are unregistered, this will be followed by a "destroy ()"
 120      * calls
 121      */
 122     void stopping() {
 123         for (Connection connection : ovsdbConnections.values()) {
 124             connection.disconnect();
 125         }
 126     }
 127
 128     public Status disconnect(Node node) {
 129         String identifier = (String) node.getID();
 130         Connection connection = ovsdbConnections.get(identifier);
 131         if (connection != null) {
 132             ovsdbConnections.remove(identifier);
 133             connection.disconnect();
 134             ovsdbInventoryService.removeNode(node);
 135             return new Status(StatusCode.SUCCESS);
 136         } else {
 137             return new Status(StatusCode.NOTFOUND);
 138         }
 139     }
 140
 141     public Node connect(String identifier, Map<ConnectionConstants, String> params) {
 142         InetAddress address;
 143         Integer port;
 144
 145         try {
 146             address = InetAddress.getByName(params.get(ConnectionConstants.ADDRESS));
 147         } catch (Exception e) {
 148             logger.error("Unable to resolve " + params.get(ConnectionConstants.ADDRESS), e);
 149             return null;
 150         }
 151
 152         try {
 153             port = Integer.parseInt(params.get(ConnectionConstants.PORT));
 154             if (port == 0) port = DEFAULT_OVSDB_PORT;
 155         } catch (Exception e) {
 156             port = DEFAULT_OVSDB_PORT;
 157         }
 158
 159         try {
 160             OvsdbClient client = connectionLib.connect(address, port);
 161             return handleNewConnection(identifier, client);
 162         } catch (InterruptedException e) {
 163             logger.error("Thread was interrupted during connect", e);
 164         } catch (ExecutionException e) {
 165             logger.error("ExecutionException in handleNewConnection for identifier " + identifier, e);
 166         }
 167         return null;
 168     }
 169
 170     public List<ChannelHandler> getHandlers() {
 171         return handlers;
 172     }
 173
 174     public void setHandlers(List<ChannelHandler> handlers) {
 175         this.handlers = handlers;
 176     }
 177
 178     @Override
 179     public Connection getConnection(Node node) {
 180         String identifier = (String) node.getID();
 181         return ovsdbConnections.get(identifier);
 182     }
 183
 184     @Override
 185     public List<Node> getNodes() {
 186         List<Node> nodes = new ArrayList<Node>();
 187         for (Connection connection : ovsdbConnections.values()) {
 188             nodes.add(connection.getNode());
 189         }
 190         return nodes;
 191     }
 192
 193     private Node handleNewConnection(String identifier, OvsdbClient client) throws InterruptedException, ExecutionException {
 194         Connection connection = new Connection(identifier, client);
 195         Node node = connection.getNode();
 196         ovsdbConnections.put(identifier, connection);
 197         List<String> dbs = client.getDatabases().get();
 198         for (String db : dbs) {
 199             client.getSchema(db).get();
 200         }
 201         // Keeping the Initial inventory update(s) on its own thread.
 202         new Thread() {
 203             Connection connection;
 204             String identifier;
 205
 206             @Override
 207             public void run() {
 208                 try {
 209                     logger.info("Initialize inventory for {}", connection.toString());
 210                     initializeInventoryForNewNode(connection);
 211                 } catch (InterruptedException | ExecutionException | IOException e) {
 212                     logger.error("Failed to initialize inventory for node with identifier " + identifier, e);
 213                     ovsdbConnections.remove(identifier);
 214                 }
 215             }
 216             public Thread initializeConnectionParams(String identifier, Connection connection) {
 217                 this.identifier = identifier;
 218                 this.connection = connection;
 219                 return this;
 220             }
 221         }.initializeConnectionParams(identifier, connection).start();
 222         return node;
 223     }
 224
 225     public void channelClosed(Node node) throws Exception {
 226         logger.info("Connection to Node : {} closed", node);
 227         disconnect(node);
 228         ovsdbInventoryService.removeNode(node);
 229     }
 230
 231     private void initializeInventoryForNewNode (Connection connection) throws InterruptedException, ExecutionException, IOException {
 232         OvsdbClient client = connection.getClient();
 233         InetAddress address = client.getConnectionInfo().getRemoteAddress();
 234         int port = client.getConnectionInfo().getRemotePort();
 235         IPAddressProperty addressProp = new IPAddressProperty(address);
 236         L4PortProperty l4Port = new L4PortProperty(port);
 237         Set<Property> props = new HashSet<Property>();
 238         props.add(addressProp);
 239         props.add(l4Port);
 240         logger.info("Add node to ovsdb inventory service {}", connection.getNode().toString());
 241         ovsdbInventoryService.addNode(connection.getNode(), props);
 242
 243         List<String> databases = client.getDatabases().get();
 244         if (databases == null) {
 245             logger.error("Unable to get Databases for the ovsdb connection : {}", client.getConnectionInfo());
 246             return;
 247         }
 248         for (String database : databases) {
 249             DatabaseSchema dbSchema = client.getSchema(database).get();
 250             TableUpdates updates = this.monitorTables(connection.getNode(), dbSchema);
 251             ovsdbInventoryService.processTableUpdates(connection.getNode(), dbSchema.getName(), updates);
 252         }
 253         logger.info("Notifying Inventory Listeners for Node Added: {}", connection.getNode().toString());
 254         ovsdbInventoryService.notifyNodeAdded(connection.getNode(), address, port);
 255     }
 256
 257     public TableUpdates monitorTables(Node node, DatabaseSchema dbSchema) throws ExecutionException, InterruptedException, IOException {
 258         String identifier = (String) node.getID();
 259         Connection connection = ovsdbConnections.get(identifier);
 260         OvsdbClient client = connection.getClient();
 261         if (dbSchema == null) {
 262             logger.error("Unable to get Database Schema for the ovsdb connection : {}", client.getConnectionInfo());
 263             return null;
 264         }
 265         Set<String> tables = dbSchema.getTables();
 266         if (tables == null) {
 267             logger.warn("Database {} without any tables. Strange !", dbSchema.getName());
 268             return null;
 269         }
 270         List<MonitorRequest<GenericTableSchema>> monitorRequests = Lists.newArrayList();
 271         for (String tableName : tables) {
 272             GenericTableSchema tableSchema = dbSchema.table(tableName, GenericTableSchema.class);
 273             monitorRequests.add(this.getAllColumnsMonitorRequest(tableSchema));
 274         }
 275         return client.monitor(dbSchema, monitorRequests, new UpdateMonitor(node));
 276     }
 277
 278     /**
 279      * As per RFC 7047, section 4.1.5, if a Monitor request is sent without any columns, the update response will not include
 280      * the _uuid column.
 281      * ----------------------------------------------------------------------------------------------------------------------------------
 282      * Each <monitor-request> specifies one or more columns and the manner in which the columns (or the entire table) are to be monitored.
 283      * The "columns" member specifies the columns whose values are monitored. It MUST NOT contain duplicates.
 284      * If "columns" is omitted, all columns in the table, except for "_uuid", are monitored.
 285      * ----------------------------------------------------------------------------------------------------------------------------------
 286      * In order to overcome this limitation, this method
 287      *
 288      * @return MonitorRequest that includes all the Bridge Columns including _uuid
 289      */
 290     public <T extends TableSchema<T>> MonitorRequest<T> getAllColumnsMonitorRequest (T tableSchema) {
 291         Set<String> columns = tableSchema.getColumns();
 292         MonitorRequestBuilder<T> monitorBuilder = MonitorRequestBuilder.builder(tableSchema);
 293         for (String column : columns) {
 294             monitorBuilder.addColumn(column);
 295         }
 296         return monitorBuilder.with(new MonitorSelect(true, true, true, true)).build();
 297     }
 298
 299     private class UpdateMonitor implements MonitorCallBack {
 300         Node node = null;
 301         public UpdateMonitor(Node node) {
 302             this.node = node;
 303         }
 304
 305         @Override
 306         public void update(TableUpdates result, DatabaseSchema dbSchema) {
 307             ovsdbInventoryService.processTableUpdates(node, dbSchema.getName(), result);
 308         }
 309
 310         @Override
 311         public void exception(Throwable t) {
 312             System.out.println("Exception t = " + t);
 313         }
 314     }
 315
 316     private String getConnectionIdentifier(OvsdbClient client) {
 317         OvsdbConnectionInfo info = client.getConnectionInfo();
 318         return info.getRemoteAddress().getHostAddress()+":"+info.getRemotePort();
 319     }
 320
 321
 322     @Override
 323     public void connected(OvsdbClient client) {
 324         String identifier = getConnectionIdentifier(client);
 325         try {
 326             this.handleNewConnection(identifier, client);
 327         } catch (InterruptedException | ExecutionException e) {
 328             e.printStackTrace();
 329         }
 330     }
 331
 332     @Override
 333     public void disconnected(OvsdbClient client) {
 334         Connection connection = ovsdbConnections.get(this.getConnectionIdentifier(client));
 335         if (connection == null) return;
 336         this.disconnect(connection.getNode());
 337     }
 338 }