X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fblueprint%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fblueprint%2FBlueprintBundleTracker.java;h=3f821ba731ac44e51dd380bb59fe0687b88f320d;hb=b2a5ec266ccdfca559cfb6c2ea0cac652f5f52cd;hp=5727c13ba1e888825d94b96bcc1c330bdf39fa1e;hpb=36de1fd1c214d98ae97e6d7725f323dd01e34977;p=controller.git diff --git a/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/BlueprintBundleTracker.java b/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/BlueprintBundleTracker.java index 5727c13ba1..3f821ba731 100644 --- a/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/BlueprintBundleTracker.java +++ b/opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/BlueprintBundleTracker.java @@ -7,24 +7,32 @@ */ package org.opendaylight.controller.blueprint; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; import java.util.Collections; import java.util.Dictionary; import java.util.Enumeration; +import java.util.HashSet; import java.util.Hashtable; import java.util.List; +import javax.annotation.Nullable; import org.apache.aries.blueprint.NamespaceHandler; import org.apache.aries.blueprint.services.BlueprintExtenderService; +import org.apache.aries.quiesce.participant.QuiesceParticipant; import org.apache.aries.util.AriesFrameworkUtil; import org.opendaylight.controller.blueprint.ext.OpendaylightNamespaceHandler; +import org.opendaylight.yangtools.util.xml.UntrustedXML; import org.osgi.framework.Bundle; import org.osgi.framework.BundleActivator; import org.osgi.framework.BundleContext; import org.osgi.framework.BundleEvent; import org.osgi.framework.ServiceReference; import org.osgi.framework.ServiceRegistration; -import org.osgi.service.blueprint.container.EventConstants; -import org.osgi.service.event.Event; -import org.osgi.service.event.EventHandler; +import org.osgi.framework.SynchronousBundleListener; +import org.osgi.service.blueprint.container.BlueprintContainer; +import org.osgi.service.blueprint.container.BlueprintEvent; +import org.osgi.service.blueprint.container.BlueprintListener; import org.osgi.util.tracker.BundleTracker; import org.osgi.util.tracker.BundleTrackerCustomizer; import org.osgi.util.tracker.ServiceTracker; @@ -40,15 +48,22 @@ import org.slf4j.LoggerFactory; * * @author Thomas Pantelis */ -public class BlueprintBundleTracker implements BundleActivator, BundleTrackerCustomizer, EventHandler { +public class BlueprintBundleTracker implements BundleActivator, BundleTrackerCustomizer, BlueprintListener, + SynchronousBundleListener { private static final Logger LOG = LoggerFactory.getLogger(BlueprintBundleTracker.class); private static final String BLUEPRINT_FILE_PATH = "org/opendaylight/blueprint/"; private static final String BLUEPRINT_FLE_PATTERN = "*.xml"; + private static final long SYSTEM_BUNDLE_ID = 0; - private ServiceTracker serviceTracker; + private ServiceTracker blueprintExtenderServiceTracker; + private ServiceTracker quiesceParticipantTracker; private BundleTracker bundleTracker; + private BundleContext bundleContext; private volatile BlueprintExtenderService blueprintExtenderService; + private volatile QuiesceParticipant quiesceParticipant; private volatile ServiceRegistration blueprintContainerRestartReg; + private volatile BlueprintContainerRestartServiceImpl restartService; + private volatile boolean shuttingDown; private ServiceRegistration eventHandlerReg; private ServiceRegistration namespaceReg; @@ -56,89 +71,149 @@ public class BlueprintBundleTracker implements BundleActivator, BundleTrackerCus * Implemented from BundleActivator. */ @Override - public void start(BundleContext context) { + public void start(final BundleContext context) { LOG.info("Starting {}", getClass().getSimpleName()); + // CONTROLLER-1867: force UntrustedXML initialization, so that it uses our TCCL to initialize + UntrustedXML.newDocumentBuilder(); + + restartService = new BlueprintContainerRestartServiceImpl(); + + bundleContext = context; + registerBlueprintEventHandler(context); registerNamespaceHandler(context); bundleTracker = new BundleTracker<>(context, Bundle.ACTIVE, this); - serviceTracker = new ServiceTracker<>(context, BlueprintExtenderService.class.getName(), + blueprintExtenderServiceTracker = new ServiceTracker<>(context, BlueprintExtenderService.class.getName(), new ServiceTrackerCustomizer() { @Override public BlueprintExtenderService addingService( - ServiceReference reference) { - blueprintExtenderService = reference.getBundle().getBundleContext().getService(reference); - bundleTracker.open(); + final ServiceReference reference) { + return onBlueprintExtenderServiceAdded(reference); + } - LOG.debug("Got BlueprintExtenderService"); + @Override + public void modifiedService(final ServiceReference reference, + final BlueprintExtenderService service) { + } - blueprintContainerRestartReg = context.registerService( - BlueprintContainerRestartService.class.getName(), - new BlueprintContainerRestartServiceImpl(blueprintExtenderService), new Hashtable<>()); + @Override + public void removedService(final ServiceReference reference, + final BlueprintExtenderService service) { + } + }); + blueprintExtenderServiceTracker.open(); - return blueprintExtenderService; + quiesceParticipantTracker = new ServiceTracker<>(context, QuiesceParticipant.class.getName(), + new ServiceTrackerCustomizer() { + @Override + public QuiesceParticipant addingService( + final ServiceReference reference) { + return onQuiesceParticipantAdded(reference); } @Override - public void modifiedService(ServiceReference reference, - BlueprintExtenderService service) { + public void modifiedService(final ServiceReference reference, + final QuiesceParticipant service) { } @Override - public void removedService(ServiceReference reference, - BlueprintExtenderService service) { + public void removedService(final ServiceReference reference, + final QuiesceParticipant service) { } }); - serviceTracker.open(); + quiesceParticipantTracker.open(); + } + + private QuiesceParticipant onQuiesceParticipantAdded(final ServiceReference reference) { + quiesceParticipant = reference.getBundle().getBundleContext().getService(reference); + + LOG.debug("Got QuiesceParticipant"); + + restartService.setQuiesceParticipant(quiesceParticipant); + + return quiesceParticipant; + } + + private BlueprintExtenderService onBlueprintExtenderServiceAdded( + final ServiceReference reference) { + blueprintExtenderService = reference.getBundle().getBundleContext().getService(reference); + bundleTracker.open(); + + bundleContext.addBundleListener(BlueprintBundleTracker.this); + + LOG.debug("Got BlueprintExtenderService"); + + restartService.setBlueprintExtenderService(blueprintExtenderService); + + blueprintContainerRestartReg = bundleContext.registerService( + BlueprintContainerRestartService.class.getName(), restartService, new Hashtable<>()); + + return blueprintExtenderService; } - private void registerNamespaceHandler(BundleContext context) { + private void registerNamespaceHandler(final BundleContext context) { Dictionary props = new Hashtable<>(); props.put("osgi.service.blueprint.namespace", OpendaylightNamespaceHandler.NAMESPACE_1_0_0); namespaceReg = context.registerService(NamespaceHandler.class.getName(), new OpendaylightNamespaceHandler(), props); } - private void registerBlueprintEventHandler(BundleContext context) { - Dictionary props = new Hashtable<>(); - props.put(org.osgi.service.event.EventConstants.EVENT_TOPIC, EventConstants.TOPIC_CREATED); - eventHandlerReg = context.registerService(EventHandler.class.getName(), this, props); + private void registerBlueprintEventHandler(final BundleContext context) { + eventHandlerReg = context.registerService(BlueprintListener.class.getName(), this, new Hashtable<>()); } /** * Implemented from BundleActivator. */ @Override - public void stop(BundleContext context) { + public void stop(final BundleContext context) { bundleTracker.close(); - serviceTracker.close(); + blueprintExtenderServiceTracker.close(); + quiesceParticipantTracker.close(); AriesFrameworkUtil.safeUnregisterService(eventHandlerReg); AriesFrameworkUtil.safeUnregisterService(namespaceReg); AriesFrameworkUtil.safeUnregisterService(blueprintContainerRestartReg); } + /** + * Implemented from SynchronousBundleListener. + */ + @Override + public void bundleChanged(final BundleEvent event) { + // If the system bundle (id 0) is stopping, do an orderly shutdown of all blueprint containers. On + // shutdown the system bundle is stopped first. + if (event.getBundle().getBundleId() == SYSTEM_BUNDLE_ID && event.getType() == BundleEvent.STOPPING) { + shutdownAllContainers(); + } + } + /** * Implemented from BundleActivator. */ @Override - public Bundle addingBundle(Bundle bundle, BundleEvent event) { + public Bundle addingBundle(final Bundle bundle, final BundleEvent event) { modifiedBundle(bundle, event, bundle); return bundle; } /** - * Implemented from BundleActivator. + * Implemented from BundleTrackerCustomizer. */ @Override - public void modifiedBundle(Bundle bundle, BundleEvent event, Bundle object) { - if(bundle.getState() == Bundle.ACTIVE) { + public void modifiedBundle(final Bundle bundle, final BundleEvent event, final Bundle object) { + if (shuttingDown) { + return; + } + + if (bundle.getState() == Bundle.ACTIVE) { List paths = findBlueprintPaths(bundle); - if(!paths.isEmpty()) { + if (!paths.isEmpty()) { LOG.info("Creating blueprint container for bundle {} with paths {}", bundle, paths); blueprintExtenderService.createContainer(bundle, paths); @@ -147,33 +222,150 @@ public class BlueprintBundleTracker implements BundleActivator, BundleTrackerCus } /** - * Implemented from BundleActivator. + * Implemented from BundleTrackerCustomizer. */ @Override - public void removedBundle(Bundle bundle, BundleEvent event, Bundle object) { + public void removedBundle(final Bundle bundle, final BundleEvent event, final Bundle object) { // BlueprintExtenderService will handle this. } /** - * Implemented from EventHandler to listen for blueprint events. + * Implemented from BlueprintListener to listen for blueprint events. * - * @param event + * @param event the event to handle */ @Override - public void handleEvent(Event event) { - if(EventConstants.TOPIC_CREATED.equals(event.getTopic())) { - LOG.info("Blueprint container for bundle {} was successfully created", - event.getProperty(EventConstants.BUNDLE)); + public void blueprintEvent(final BlueprintEvent event) { + if (event.getType() == BlueprintEvent.CREATED) { + LOG.info("Blueprint container for bundle {} was successfully created", event.getBundle()); + return; + } + + // If the container timed out waiting for dependencies, we'll destroy it and start it again. This + // is indicated via a non-null DEPENDENCIES property containing the missing dependencies. The + // default timeout is 5 min and ideally we would set this to infinite but the timeout can only + // be set at the bundle level in the manifest - there's no way to set it globally. + if (event.getType() == BlueprintEvent.FAILURE && event.getDependencies() != null) { + Bundle bundle = event.getBundle(); + + List paths = findBlueprintPaths(bundle); + if (!paths.isEmpty()) { + LOG.warn("Blueprint container for bundle {} timed out waiting for dependencies - restarting it", + bundle); + + restartService.restartContainer(bundle, paths); + } } } @SuppressWarnings({ "rawtypes", "unchecked" }) - static List findBlueprintPaths(Bundle bundle) { - Enumeration e = bundle.findEntries(BLUEPRINT_FILE_PATH, BLUEPRINT_FLE_PATTERN, false); - if(e == null) { + static List findBlueprintPaths(final Bundle bundle) { + Enumeration rntries = bundle.findEntries(BLUEPRINT_FILE_PATH, BLUEPRINT_FLE_PATTERN, false); + if (rntries == null) { return Collections.emptyList(); } else { - return Collections.list((Enumeration)e); + return Collections.list((Enumeration)rntries); + } + } + + private void shutdownAllContainers() { + shuttingDown = true; + + restartService.close(); + + LOG.info("Shutting down all blueprint containers..."); + + Collection containerBundles = new HashSet<>(Arrays.asList(bundleContext.getBundles())); + while (!containerBundles.isEmpty()) { + // For each iteration of getBundlesToDestroy, as containers are destroyed, other containers become + // eligible to be destroyed. We loop until we've destroyed them all. + for (Bundle bundle : getBundlesToDestroy(containerBundles)) { + containerBundles.remove(bundle); + BlueprintContainer container = blueprintExtenderService.getContainer(bundle); + if (container != null) { + blueprintExtenderService.destroyContainer(bundle, container); + } + } + } + + LOG.info("Shutdown of blueprint containers complete"); + } + + private List getBundlesToDestroy(final Collection containerBundles) { + List bundlesToDestroy = new ArrayList<>(); + + // Find all container bundles that either have no registered services or whose services are no + // longer in use. + for (Bundle bundle : containerBundles) { + ServiceReference[] references = bundle.getRegisteredServices(); + int usage = 0; + if (references != null) { + for (ServiceReference reference : references) { + usage += getServiceUsage(reference); + } + } + + LOG.debug("Usage for bundle {} is {}", bundle, usage); + if (usage == 0) { + bundlesToDestroy.add(bundle); + } + } + + if (!bundlesToDestroy.isEmpty()) { + bundlesToDestroy.sort((b1, b2) -> (int) (b2.getLastModified() - b1.getLastModified())); + + LOG.debug("Selected bundles {} for destroy (no services in use)", bundlesToDestroy); + } else { + // There's either no more container bundles or they all have services being used. For + // the latter it means there's either circular service usage or a service is being used + // by a non-container bundle. But we need to make progress so we pick the bundle with a + // used service with the highest service ID. Each service is assigned a monotonically + // increasing ID as they are registered. By picking the bundle with the highest service + // ID, we're picking the bundle that was (likely) started after all the others and thus + // is likely the safest to destroy at this point. + + Bundle bundle = findBundleWithHighestUsedServiceId(containerBundles); + if (bundle != null) { + bundlesToDestroy.add(bundle); + } + + LOG.debug("Selected bundle {} for destroy (lowest ranking service or highest service ID)", + bundlesToDestroy); + } + + return bundlesToDestroy; + } + + @Nullable + private Bundle findBundleWithHighestUsedServiceId(final Collection containerBundles) { + ServiceReference highestServiceRef = null; + for (Bundle bundle : containerBundles) { + ServiceReference[] references = bundle.getRegisteredServices(); + if (references == null) { + continue; + } + + for (ServiceReference reference : references) { + // We did check the service usage previously but it's possible the usage has changed since then. + if (getServiceUsage(reference) == 0) { + continue; + } + + // Choose 'reference' if it has a lower service ranking or, if the rankings are equal + // which is usually the case, if it has a higher service ID. For the latter the < 0 + // check looks backwards but that's how ServiceReference#compareTo is documented to work. + if (highestServiceRef == null || reference.compareTo(highestServiceRef) < 0) { + LOG.debug("Currently selecting bundle {} for destroy (with reference {})", bundle, reference); + highestServiceRef = reference; + } + } } + + return highestServiceRef == null ? null : highestServiceRef.getBundle(); + } + + private static int getServiceUsage(final ServiceReference ref) { + Bundle[] usingBundles = ref.getUsingBundles(); + return usingBundles != null ? usingBundles.length : 0; } }