Fix (and suppress) some static code analysis warnings in blueprint
[controller.git] / opendaylight / blueprint / src / main / java / org / opendaylight / controller / blueprint / BlueprintContainerRestartServiceImpl.java
1 /*
2  * Copyright (c) 2016 Brocade Communications 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 package org.opendaylight.controller.blueprint;
9
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.Lists;
13 import com.google.common.util.concurrent.ThreadFactoryBuilder;
14 import java.lang.management.ManagementFactory;
15 import java.util.AbstractMap.SimpleEntry;
16 import java.util.ArrayDeque;
17 import java.util.ArrayList;
18 import java.util.Arrays;
19 import java.util.Collections;
20 import java.util.Deque;
21 import java.util.Dictionary;
22 import java.util.Hashtable;
23 import java.util.LinkedHashSet;
24 import java.util.List;
25 import java.util.Map.Entry;
26 import java.util.Set;
27 import java.util.concurrent.CountDownLatch;
28 import java.util.concurrent.ExecutorService;
29 import java.util.concurrent.Executors;
30 import java.util.concurrent.TimeUnit;
31 import javax.annotation.Nullable;
32 import javax.management.InstanceNotFoundException;
33 import javax.management.ObjectName;
34 import javax.xml.parsers.ParserConfigurationException;
35 import org.apache.aries.blueprint.services.BlueprintExtenderService;
36 import org.apache.aries.quiesce.participant.QuiesceParticipant;
37 import org.apache.aries.util.AriesFrameworkUtil;
38 import org.opendaylight.controller.config.api.ConfigRegistry;
39 import org.opendaylight.controller.config.api.ConflictingVersionException;
40 import org.opendaylight.controller.config.api.ModuleIdentifier;
41 import org.opendaylight.controller.config.api.ValidationException;
42 import org.opendaylight.controller.config.facade.xml.ConfigExecution;
43 import org.opendaylight.controller.config.facade.xml.ConfigSubsystemFacade;
44 import org.opendaylight.controller.config.facade.xml.ConfigSubsystemFacadeFactory;
45 import org.opendaylight.controller.config.facade.xml.TestOption;
46 import org.opendaylight.controller.config.facade.xml.mapping.config.Config;
47 import org.opendaylight.controller.config.facade.xml.strategy.EditStrategyType;
48 import org.opendaylight.controller.config.util.ConfigRegistryJMXClient;
49 import org.opendaylight.controller.config.util.xml.DocumentedException;
50 import org.opendaylight.controller.config.util.xml.XmlElement;
51 import org.opendaylight.controller.config.util.xml.XmlMappingConstants;
52 import org.opendaylight.controller.config.util.xml.XmlUtil;
53 import org.osgi.framework.Bundle;
54 import org.osgi.framework.BundleContext;
55 import org.osgi.framework.ServiceReference;
56 import org.osgi.framework.ServiceRegistration;
57 import org.osgi.service.blueprint.container.EventConstants;
58 import org.osgi.service.event.EventHandler;
59 import org.slf4j.Logger;
60 import org.slf4j.LoggerFactory;
61 import org.w3c.dom.Document;
62 import org.w3c.dom.Element;
63
64 /**
65  * Implementation of the BlueprintContainerRestartService.
66  *
67  * @author Thomas Pantelis
68  */
69 class BlueprintContainerRestartServiceImpl implements AutoCloseable, BlueprintContainerRestartService {
70     private static final Logger LOG = LoggerFactory.getLogger(BlueprintContainerRestartServiceImpl.class);
71     private static final int CONTAINER_CREATE_TIMEOUT_IN_MINUTES = 5;
72     private static final String CONFIG_MODULE_NAMESPACE_PROP = "config-module-namespace";
73     private static final String CONFIG_MODULE_NAME_PROP = "config-module-name";
74     private static final String CONFIG_INSTANCE_NAME_PROP = "config-instance-name";
75
76     private final ExecutorService restartExecutor = Executors.newSingleThreadExecutor(new ThreadFactoryBuilder()
77             .setDaemon(true).setNameFormat("BlueprintContainerRestartService").build());
78
79     private BlueprintExtenderService blueprintExtenderService;
80     private QuiesceParticipant quiesceParticipant;
81
82     void setBlueprintExtenderService(final BlueprintExtenderService blueprintExtenderService) {
83         this.blueprintExtenderService = blueprintExtenderService;
84     }
85
86     void setQuiesceParticipant(final QuiesceParticipant quiesceParticipant) {
87         this.quiesceParticipant = quiesceParticipant;
88     }
89
90     public void restartContainer(final Bundle bundle, final List<Object> paths) {
91         if (restartExecutor.isShutdown()) {
92             return;
93         }
94
95         LOG.debug("restartContainer for bundle {}", bundle);
96
97         restartExecutor.execute(() -> {
98             blueprintExtenderService.destroyContainer(bundle, blueprintExtenderService.getContainer(bundle));
99             blueprintExtenderService.createContainer(bundle, paths);
100         });
101     }
102
103     @Override
104     public void restartContainerAndDependents(final Bundle bundle) {
105         if (restartExecutor.isShutdown()) {
106             return;
107         }
108
109         LOG.debug("restartContainerAndDependents for bundle {}", bundle);
110
111         restartExecutor.execute(() -> restartContainerAndDependentsInternal(bundle));
112     }
113
114     private void restartContainerAndDependentsInternal(Bundle forBundle) {
115         Preconditions.checkNotNull(blueprintExtenderService);
116         Preconditions.checkNotNull(quiesceParticipant);
117
118         // We use a LinkedHashSet to preserve insertion order as we walk the service usage hierarchy.
119         Set<Bundle> containerBundlesSet = new LinkedHashSet<>();
120         List<Entry<String, ModuleIdentifier>> configModules = new ArrayList<>();
121         findDependentContainersRecursively(forBundle, containerBundlesSet, configModules);
122
123         List<Bundle> containerBundles = new ArrayList<>(containerBundlesSet);
124
125         LOG.info("Restarting blueprint containers for bundle {} and its dependent bundles {}", forBundle,
126                 containerBundles.subList(1, containerBundles.size()));
127
128         // The blueprint containers are created asynchronously so we register a handler for blueprint events
129         // that are sent when a container is complete, successful or not. The CountDownLatch tells when all
130         // containers are complete. This is done to ensure all blueprint containers are finished before we
131         // restart config modules.
132         final CountDownLatch containerCreationComplete = new CountDownLatch(containerBundles.size());
133         ServiceRegistration<?> eventHandlerReg = registerEventHandler(forBundle.getBundleContext(), event -> {
134             final Bundle bundle = (Bundle) event.getProperty(EventConstants.BUNDLE);
135             LOG.debug("handleEvent {} for bundle {}", event.getTopic(), bundle);
136             if (containerBundles.contains(bundle)) {
137                 containerCreationComplete.countDown();
138             }
139         });
140
141         final Runnable createContainerCallback = () -> createContainers(containerBundles);
142
143         // Destroy the container down-top recursively and once done, restart the container top-down
144         destroyContainers(new ArrayDeque<>(Lists.reverse(containerBundles)), createContainerCallback);
145
146
147         try {
148             if (!containerCreationComplete.await(CONTAINER_CREATE_TIMEOUT_IN_MINUTES, TimeUnit.MINUTES)) {
149                 LOG.warn("Failed to restart all blueprint containers within {} minutes. Attempted to restart {} {} "
150                         + "but only {} completed restart", CONTAINER_CREATE_TIMEOUT_IN_MINUTES, containerBundles.size(),
151                         containerBundles, containerBundles.size() - containerCreationComplete.getCount());
152                 return;
153             }
154         } catch (InterruptedException e) {
155             LOG.debug("CountDownLatch await was interrupted - returning");
156             return;
157         }
158
159         AriesFrameworkUtil.safeUnregisterService(eventHandlerReg);
160
161         // Now restart any associated config system Modules.
162         restartConfigModules(forBundle.getBundleContext(), configModules);
163     }
164
165     /**
166      * Recursively quiesce and destroy the bundles one by one in order to maintain synchronicity and ordering.
167      * @param remainingBundlesToDestroy the list of remaining bundles to destroy.
168      * @param createContainerCallback a {@link Runnable} to {@code run()} when the recursive function is completed.
169      */
170     private void destroyContainers(final Deque<Bundle> remainingBundlesToDestroy,
171             final Runnable createContainerCallback) {
172
173         final Bundle nextBundle;
174         synchronized (remainingBundlesToDestroy) {
175             if (remainingBundlesToDestroy.isEmpty()) {
176                 LOG.debug("All blueprint containers were quiesced and destroyed");
177                 createContainerCallback.run();
178                 return;
179             }
180
181             nextBundle = remainingBundlesToDestroy.poll();
182         }
183
184         // The Quiesce capability is a like a soft-stop, clean-stop. In the case of the Blueprint extender, in flight
185         // service calls are allowed to finish; they're counted in and counted out, and no new calls are allowed. When
186         // there are no in flight service calls, the bundle is told to stop. The Blueprint bundle itself doesn't know
187         // this is happening which is a key design point. In the case of Blueprint, the extender ensures no new Entity
188         // Managers(EMs) are created. Then when all those EMs are closed the quiesce operation reports that it is
189         // finished.
190         // To properly restart the blueprint containers, first we have to quiesce the list of bundles, and once done, it
191         // is safe to destroy their BlueprintContainer, so no reference is retained.
192         //
193         // Mail - thread explaining Quiesce API:
194         //      https://www.mail-archive.com/dev@aries.apache.org/msg08403.html
195
196         // Quiesced the bundle to unregister the associated BlueprintContainer
197         quiesceParticipant.quiesce(bundlesQuiesced -> {
198
199             // Destroy the container once Quiesced
200             Arrays.stream(bundlesQuiesced).forEach(quiescedBundle -> {
201                 LOG.debug("Quiesced bundle {}", quiescedBundle);
202                 blueprintExtenderService.destroyContainer(
203                         quiescedBundle, blueprintExtenderService.getContainer(quiescedBundle));
204             });
205
206             destroyContainers(remainingBundlesToDestroy, createContainerCallback);
207
208         }, Collections.singletonList(nextBundle));
209     }
210
211     private void createContainers(List<Bundle> containerBundles) {
212         containerBundles.forEach(bundle -> {
213             List<Object> paths = BlueprintBundleTracker.findBlueprintPaths(bundle);
214
215             LOG.info("Restarting blueprint container for bundle {} with paths {}", bundle, paths);
216
217             blueprintExtenderService.createContainer(bundle, paths);
218         });
219     }
220
221     private void restartConfigModules(BundleContext bundleContext, List<Entry<String,
222             ModuleIdentifier>> configModules) {
223         if (configModules.isEmpty()) {
224             return;
225         }
226
227         ServiceReference<ConfigSubsystemFacadeFactory> configFacadeFactoryRef = bundleContext
228                 .getServiceReference(ConfigSubsystemFacadeFactory.class);
229         if (configFacadeFactoryRef == null) {
230             LOG.debug("ConfigSubsystemFacadeFactory service reference not found");
231             return;
232         }
233
234         ConfigSubsystemFacadeFactory configFacadeFactory = bundleContext.getService(configFacadeFactoryRef);
235         if (configFacadeFactory == null) {
236             LOG.debug("ConfigSubsystemFacadeFactory service not found");
237             return;
238         }
239
240         try (ConfigSubsystemFacade configFacade = configFacadeFactory.createFacade(
241                 "BlueprintContainerRestartService")) {
242             restartConfigModules(configModules, configFacade);
243         } catch (ParserConfigurationException | DocumentedException | ValidationException
244                 | ConflictingVersionException e) {
245             LOG.error("Error restarting config modules", e);
246         } finally {
247             bundleContext.ungetService(configFacadeFactoryRef);
248         }
249
250     }
251
252     private void restartConfigModules(List<Entry<String, ModuleIdentifier>> configModules,
253             ConfigSubsystemFacade configFacade) throws ParserConfigurationException, DocumentedException,
254                     ValidationException, ConflictingVersionException {
255
256         Document document = XmlUtil.newDocument();
257         Element dataElement = XmlUtil.createElement(document, XmlMappingConstants.DATA_KEY, Optional.<String>absent());
258         Element modulesElement = XmlUtil.createElement(document, XmlMappingConstants.MODULES_KEY,
259                 Optional.of(XmlMappingConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG));
260         dataElement.appendChild(modulesElement);
261
262         Config configMapping = configFacade.getConfigMapping();
263
264         ConfigRegistry configRegistryClient = new ConfigRegistryJMXClient(ManagementFactory.getPlatformMBeanServer());
265         for (Entry<String, ModuleIdentifier> entry : configModules) {
266             String moduleNamespace = entry.getKey();
267             ModuleIdentifier moduleId = entry.getValue();
268             try {
269                 ObjectName instanceON = configRegistryClient.lookupConfigBean(moduleId.getFactoryName(),
270                         moduleId.getInstanceName());
271
272                 LOG.debug("Found config module instance ObjectName: {}", instanceON);
273
274                 Element moduleElement = configMapping.moduleToXml(moduleNamespace, moduleId.getFactoryName(),
275                         moduleId.getInstanceName(), instanceON, document);
276                 modulesElement.appendChild(moduleElement);
277             } catch (InstanceNotFoundException e) {
278                 LOG.warn("Error looking up config module: namespace {}, module name {}, instance {}",
279                         moduleNamespace, moduleId.getFactoryName(), moduleId.getInstanceName(), e);
280             }
281         }
282
283         if (LOG.isDebugEnabled()) {
284             LOG.debug("Pushing config xml: {}", XmlUtil.toString(dataElement));
285         }
286
287         ConfigExecution execution = new ConfigExecution(configMapping, XmlElement.fromDomElement(dataElement),
288                 TestOption.testThenSet, EditStrategyType.recreate);
289         configFacade.executeConfigExecution(execution);
290         configFacade.commitSilentTransaction();
291     }
292
293     /**
294      * Recursively finds the services registered by the given bundle and the bundles using those services.
295      * User bundles that have an associated blueprint container are added to containerBundles. In addition,
296      * if a registered service has an associated config system Module, as determined via the presence of
297      * certain service properties, the ModuleIdentifier is added to the configModules list.
298      *
299      * @param bundle the bundle to traverse
300      * @param containerBundles the current set of bundles containing blueprint containers
301      * @param configModules the current set of bundles containing config modules
302      */
303     private void findDependentContainersRecursively(Bundle bundle, Set<Bundle> containerBundles,
304             List<Entry<String, ModuleIdentifier>> configModules) {
305         if (!containerBundles.add(bundle)) {
306             // Already seen this bundle...
307             return;
308         }
309
310         ServiceReference<?>[] references = bundle.getRegisteredServices();
311         if (references != null) {
312             for (ServiceReference<?> reference : references) {
313                 possiblyAddConfigModuleIdentifier(reference, configModules);
314
315                 Bundle[] usingBundles = reference.getUsingBundles();
316                 if (usingBundles != null) {
317                     for (Bundle usingBundle : usingBundles) {
318                         if (blueprintExtenderService.getContainer(usingBundle) != null) {
319                             findDependentContainersRecursively(usingBundle, containerBundles, configModules);
320                         }
321                     }
322                 }
323             }
324         }
325     }
326
327     private void possiblyAddConfigModuleIdentifier(ServiceReference<?> reference,
328             List<Entry<String, ModuleIdentifier>> configModules) {
329         Object moduleNamespace = reference.getProperty(CONFIG_MODULE_NAMESPACE_PROP);
330         if (moduleNamespace == null) {
331             return;
332         }
333
334         String moduleName = getRequiredConfigModuleProperty(CONFIG_MODULE_NAME_PROP, moduleNamespace,
335                 reference);
336         String instanceName = getRequiredConfigModuleProperty(CONFIG_INSTANCE_NAME_PROP, moduleNamespace,
337                 reference);
338         if (moduleName == null || instanceName == null) {
339             return;
340         }
341
342         LOG.debug("Found service with config module: namespace {}, module name {}, instance {}",
343                 moduleNamespace, moduleName, instanceName);
344
345         configModules.add(new SimpleEntry<>(moduleNamespace.toString(),
346                 new ModuleIdentifier(moduleName, instanceName)));
347     }
348
349     @Nullable
350     private String getRequiredConfigModuleProperty(String propName, Object moduleNamespace,
351             ServiceReference<?> reference) {
352         Object value = reference.getProperty(propName);
353         if (value == null) {
354             LOG.warn(
355                 "OSGi service with {} property is missing property {} therefore the config module can't be restarted",
356                 CONFIG_MODULE_NAMESPACE_PROP, propName);
357             return null;
358         }
359
360         return value.toString();
361     }
362
363     private ServiceRegistration<?> registerEventHandler(BundleContext bundleContext, EventHandler handler) {
364         Dictionary<String, Object> props = new Hashtable<>();
365         props.put(org.osgi.service.event.EventConstants.EVENT_TOPIC,
366                 new String[]{EventConstants.TOPIC_CREATED, EventConstants.TOPIC_FAILURE});
367         return bundleContext.registerService(EventHandler.class.getName(), handler, props);
368     }
369
370     @Override
371     public void close() {
372         restartExecutor.shutdownNow();
373     }
374 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.