2 * Copyright (c) 2016 Brocade Communications 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
8 package org.opendaylight.controller.blueprint;
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;
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;
65 * Implementation of the BlueprintContainerRestartService.
67 * @author Thomas Pantelis
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";
76 private final ExecutorService restartExecutor = Executors.newSingleThreadExecutor(new ThreadFactoryBuilder()
77 .setDaemon(true).setNameFormat("BlueprintContainerRestartService").build());
79 private BlueprintExtenderService blueprintExtenderService;
80 private QuiesceParticipant quiesceParticipant;
82 void setBlueprintExtenderService(final BlueprintExtenderService blueprintExtenderService) {
83 this.blueprintExtenderService = blueprintExtenderService;
86 void setQuiesceParticipant(final QuiesceParticipant quiesceParticipant) {
87 this.quiesceParticipant = quiesceParticipant;
90 public void restartContainer(final Bundle bundle, final List<Object> paths) {
91 if (restartExecutor.isShutdown()) {
95 LOG.debug("restartContainer for bundle {}", bundle);
97 restartExecutor.execute(() -> {
98 blueprintExtenderService.destroyContainer(bundle, blueprintExtenderService.getContainer(bundle));
99 blueprintExtenderService.createContainer(bundle, paths);
104 public void restartContainerAndDependents(final Bundle bundle) {
105 if (restartExecutor.isShutdown()) {
109 LOG.debug("restartContainerAndDependents for bundle {}", bundle);
111 restartExecutor.execute(() -> restartContainerAndDependentsInternal(bundle));
114 private void restartContainerAndDependentsInternal(final Bundle forBundle) {
115 Preconditions.checkNotNull(blueprintExtenderService);
116 Preconditions.checkNotNull(quiesceParticipant);
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);
123 List<Bundle> containerBundles = new ArrayList<>(containerBundlesSet);
125 LOG.info("Restarting blueprint containers for bundle {} and its dependent bundles {}", forBundle,
126 containerBundles.subList(1, containerBundles.size()));
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();
141 final Runnable createContainerCallback = () -> createContainers(containerBundles);
143 // Destroy the container down-top recursively and once done, restart the container top-down
144 destroyContainers(new ArrayDeque<>(Lists.reverse(containerBundles)), createContainerCallback);
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());
154 } catch (final InterruptedException e) {
155 LOG.debug("CountDownLatch await was interrupted - returning");
159 AriesFrameworkUtil.safeUnregisterService(eventHandlerReg);
161 // Now restart any associated config system Modules.
162 restartConfigModules(forBundle.getBundleContext(), configModules);
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.
170 private void destroyContainers(final Deque<Bundle> remainingBundlesToDestroy,
171 final Runnable createContainerCallback) {
173 final Bundle nextBundle;
174 synchronized (remainingBundlesToDestroy) {
175 if (remainingBundlesToDestroy.isEmpty()) {
176 LOG.debug("All blueprint containers were quiesced and destroyed");
177 createContainerCallback.run();
181 nextBundle = remainingBundlesToDestroy.poll();
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
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.
193 // Mail - thread explaining Quiesce API:
194 // https://www.mail-archive.com/dev@aries.apache.org/msg08403.html
196 // Quiesced the bundle to unregister the associated BlueprintContainer
197 quiesceParticipant.quiesce(bundlesQuiesced -> {
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));
206 destroyContainers(remainingBundlesToDestroy, createContainerCallback);
208 }, Collections.singletonList(nextBundle));
211 private void createContainers(final List<Bundle> containerBundles) {
212 containerBundles.forEach(bundle -> {
213 List<Object> paths = BlueprintBundleTracker.findBlueprintPaths(bundle);
215 LOG.info("Restarting blueprint container for bundle {} with paths {}", bundle, paths);
217 blueprintExtenderService.createContainer(bundle, paths);
221 private void restartConfigModules(final BundleContext bundleContext, final List<Entry<String,
222 ModuleIdentifier>> configModules) {
223 if (configModules.isEmpty()) {
227 ServiceReference<ConfigSubsystemFacadeFactory> configFacadeFactoryRef = bundleContext
228 .getServiceReference(ConfigSubsystemFacadeFactory.class);
229 if (configFacadeFactoryRef == null) {
230 LOG.debug("ConfigSubsystemFacadeFactory service reference not found");
234 ConfigSubsystemFacadeFactory configFacadeFactory = bundleContext.getService(configFacadeFactoryRef);
235 if (configFacadeFactory == null) {
236 LOG.debug("ConfigSubsystemFacadeFactory service not found");
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);
247 bundleContext.ungetService(configFacadeFactoryRef);
252 private void restartConfigModules(final List<Entry<String, ModuleIdentifier>> configModules,
253 final ConfigSubsystemFacade configFacade) throws ParserConfigurationException, DocumentedException,
254 ValidationException, ConflictingVersionException {
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);
262 Config configMapping = configFacade.getConfigMapping();
264 ConfigRegistry configRegistryClient = new ConfigRegistryJMXClient(ManagementFactory.getPlatformMBeanServer());
265 for (Entry<String, ModuleIdentifier> entry : configModules) {
266 String moduleNamespace = entry.getKey();
267 ModuleIdentifier moduleId = entry.getValue();
269 ObjectName instanceON = configRegistryClient.lookupConfigBean(moduleId.getFactoryName(),
270 moduleId.getInstanceName());
272 LOG.debug("Found config module instance ObjectName: {}", instanceON);
274 Element moduleElement = configMapping.moduleToXml(moduleNamespace, moduleId.getFactoryName(),
275 moduleId.getInstanceName(), instanceON, document);
276 modulesElement.appendChild(moduleElement);
277 } catch (final InstanceNotFoundException e) {
278 LOG.warn("Error looking up config module: namespace {}, module name {}, instance {}",
279 moduleNamespace, moduleId.getFactoryName(), moduleId.getInstanceName(), e);
283 if (LOG.isDebugEnabled()) {
284 LOG.debug("Pushing config xml: {}", XmlUtil.toString(dataElement));
287 ConfigExecution execution = new ConfigExecution(configMapping, XmlElement.fromDomElement(dataElement),
288 TestOption.testThenSet, EditStrategyType.recreate);
289 configFacade.executeConfigExecution(execution);
290 configFacade.commitSilentTransaction();
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.
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
303 private void findDependentContainersRecursively(final Bundle bundle, final Set<Bundle> containerBundles,
304 final List<Entry<String, ModuleIdentifier>> configModules) {
305 if (!containerBundles.add(bundle)) {
306 // Already seen this bundle...
310 ServiceReference<?>[] references = bundle.getRegisteredServices();
311 if (references != null) {
312 for (ServiceReference<?> reference : references) {
313 possiblyAddConfigModuleIdentifier(reference, configModules);
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);
327 private void possiblyAddConfigModuleIdentifier(final ServiceReference<?> reference,
328 final List<Entry<String, ModuleIdentifier>> configModules) {
329 Object moduleNamespace = reference.getProperty(CONFIG_MODULE_NAMESPACE_PROP);
330 if (moduleNamespace == null) {
334 String moduleName = getRequiredConfigModuleProperty(CONFIG_MODULE_NAME_PROP, moduleNamespace,
336 String instanceName = getRequiredConfigModuleProperty(CONFIG_INSTANCE_NAME_PROP, moduleNamespace,
338 if (moduleName == null || instanceName == null) {
342 LOG.debug("Found service with config module: namespace {}, module name {}, instance {}",
343 moduleNamespace, moduleName, instanceName);
345 configModules.add(new SimpleEntry<>(moduleNamespace.toString(),
346 new ModuleIdentifier(moduleName, instanceName)));
350 private String getRequiredConfigModuleProperty(final String propName, final Object moduleNamespace,
351 final ServiceReference<?> reference) {
352 Object value = reference.getProperty(propName);
355 "OSGi service with {} property is missing property {} therefore the config module can't be restarted",
356 CONFIG_MODULE_NAMESPACE_PROP, propName);
360 return value.toString();
363 private ServiceRegistration<?> registerEventHandler(final BundleContext bundleContext, final 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);
371 public void close() {
372 restartExecutor.shutdownNow();