Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.store.app; |
| 17 | |
Yuta HIGUCHI | 8029205 | 2015-02-10 23:11:59 -0800 | [diff] [blame] | 18 | import com.google.common.base.Charsets; |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 19 | import com.google.common.base.MoreObjects; |
| 20 | import com.google.common.base.Preconditions; |
Yuta HIGUCHI | 1d6fef3 | 2018-05-07 18:24:20 -0700 | [diff] [blame] | 21 | import com.google.common.base.Throwables; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 22 | import com.google.common.collect.ImmutableSet; |
Andrea Campanella | c8eca24 | 2016-04-06 19:34:32 -0700 | [diff] [blame] | 23 | import com.google.common.collect.Lists; |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 24 | import com.google.common.collect.Maps; |
| 25 | import com.google.common.collect.Multimap; |
| 26 | import com.google.common.collect.Sets; |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 27 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 28 | import org.apache.felix.scr.annotations.Activate; |
| 29 | import org.apache.felix.scr.annotations.Component; |
| 30 | import org.apache.felix.scr.annotations.Deactivate; |
| 31 | import org.apache.felix.scr.annotations.Reference; |
| 32 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 33 | import org.apache.felix.scr.annotations.Service; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 34 | import org.onosproject.app.ApplicationDescription; |
| 35 | import org.onosproject.app.ApplicationEvent; |
| 36 | import org.onosproject.app.ApplicationException; |
| 37 | import org.onosproject.app.ApplicationState; |
| 38 | import org.onosproject.app.ApplicationStore; |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 39 | import org.onosproject.app.ApplicationStoreDelegate; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 40 | import org.onosproject.cluster.ClusterService; |
| 41 | import org.onosproject.cluster.ControllerNode; |
| 42 | import org.onosproject.common.app.ApplicationArchive; |
| 43 | import org.onosproject.core.Application; |
| 44 | import org.onosproject.core.ApplicationId; |
sangyun-han | 6d33e80 | 2016-08-05 13:36:33 +0900 | [diff] [blame] | 45 | import org.onosproject.app.ApplicationIdStore; |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 46 | import org.onosproject.core.CoreService; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 47 | import org.onosproject.core.DefaultApplication; |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 48 | import org.onosproject.core.Version; |
| 49 | import org.onosproject.core.VersionService; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 50 | import org.onosproject.security.Permission; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 51 | import org.onosproject.store.cluster.messaging.ClusterCommunicationService; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 52 | import org.onosproject.store.cluster.messaging.MessageSubject; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 53 | import org.onosproject.store.serializers.KryoNamespaces; |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 54 | import org.onosproject.store.service.ConsistentMap; |
| 55 | import org.onosproject.store.service.MapEvent; |
| 56 | import org.onosproject.store.service.MapEventListener; |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 57 | import org.onosproject.store.service.RevisionType; |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 58 | import org.onosproject.store.service.Serializer; |
Madan Jampani | 01e05fb | 2015-08-13 13:29:36 -0700 | [diff] [blame] | 59 | import org.onosproject.store.service.StorageException; |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 60 | import org.onosproject.store.service.StorageService; |
Madan Jampani | c5a1754 | 2016-08-22 10:26:11 -0700 | [diff] [blame] | 61 | import org.onosproject.store.service.Topic; |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 62 | import org.onosproject.store.service.Versioned; |
| 63 | import org.onosproject.store.service.DistributedPrimitive.Status; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 64 | import org.slf4j.Logger; |
| 65 | |
| 66 | import java.io.ByteArrayInputStream; |
Madan Jampani | 01e05fb | 2015-08-13 13:29:36 -0700 | [diff] [blame] | 67 | import java.io.IOException; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 68 | import java.io.InputStream; |
Andrea Campanella | c8eca24 | 2016-04-06 19:34:32 -0700 | [diff] [blame] | 69 | import java.util.List; |
| 70 | import java.util.Optional; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 71 | import java.util.Set; |
| 72 | import java.util.concurrent.CountDownLatch; |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 73 | import java.util.concurrent.ExecutorService; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 74 | import java.util.concurrent.ScheduledExecutorService; |
Jonathan Hart | d6fb053 | 2016-01-21 17:28:20 -0800 | [diff] [blame] | 75 | import java.util.concurrent.TimeUnit; |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 76 | import java.util.concurrent.atomic.AtomicBoolean; |
| 77 | import java.util.function.Consumer; |
Madan Jampani | 2bfa94c | 2015-04-11 05:03:49 -0700 | [diff] [blame] | 78 | import java.util.function.Function; |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 79 | import java.util.stream.Collectors; |
Madan Jampani | 2bfa94c | 2015-04-11 05:03:49 -0700 | [diff] [blame] | 80 | |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 81 | import static com.google.common.collect.Multimaps.newSetMultimap; |
| 82 | import static com.google.common.collect.Multimaps.synchronizedSetMultimap; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 83 | import static com.google.common.io.ByteStreams.toByteArray; |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 84 | import static java.util.concurrent.Executors.newSingleThreadExecutor; |
HIGUCHI Yuta | 060da9a | 2016-03-11 19:16:35 -0800 | [diff] [blame] | 85 | import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 86 | import static java.util.concurrent.TimeUnit.MILLISECONDS; |
Thomas Vachuska | 6f94ded | 2015-02-21 14:02:38 -0800 | [diff] [blame] | 87 | import static org.onlab.util.Tools.groupedThreads; |
Thomas Vachuska | adba152 | 2015-06-04 15:08:30 -0700 | [diff] [blame] | 88 | import static org.onlab.util.Tools.randomDelay; |
Thomas Vachuska | d0d5854 | 2015-06-03 12:38:44 -0700 | [diff] [blame] | 89 | import static org.onosproject.app.ApplicationEvent.Type.*; |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 90 | import static org.onosproject.store.app.DistributedApplicationStore.InternalState.*; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 91 | import static org.slf4j.LoggerFactory.getLogger; |
| 92 | |
| 93 | /** |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 94 | * Manages inventory of applications in a distributed data store providing |
| 95 | * stronger consistency guarantees. |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 96 | */ |
Thomas Vachuska | bddbb25 | 2016-08-08 14:25:05 -0700 | [diff] [blame] | 97 | @Component(immediate = true) |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 98 | @Service |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 99 | public class DistributedApplicationStore extends ApplicationArchive |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 100 | implements ApplicationStore { |
| 101 | |
| 102 | private final Logger log = getLogger(getClass()); |
| 103 | |
| 104 | private static final MessageSubject APP_BITS_REQUEST = new MessageSubject("app-bits-request"); |
| 105 | |
Thomas Vachuska | adba152 | 2015-06-04 15:08:30 -0700 | [diff] [blame] | 106 | private static final int MAX_LOAD_RETRIES = 5; |
Thomas Vachuska | d0d5854 | 2015-06-03 12:38:44 -0700 | [diff] [blame] | 107 | private static final int RETRY_DELAY_MS = 2_000; |
| 108 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 109 | private static final int FETCH_TIMEOUT_MS = 10_000; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 110 | |
Jonathan Hart | d6fb053 | 2016-01-21 17:28:20 -0800 | [diff] [blame] | 111 | private static final int APP_LOAD_DELAY_MS = 500; |
| 112 | |
Andrea Campanella | c8eca24 | 2016-04-06 19:34:32 -0700 | [diff] [blame] | 113 | private static List<String> pendingApps = Lists.newArrayList(); |
| 114 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 115 | public enum InternalState { |
| 116 | INSTALLED, ACTIVATED, DEACTIVATED |
| 117 | } |
| 118 | |
Madan Jampani | 6b5b717 | 2015-02-23 13:02:26 -0800 | [diff] [blame] | 119 | private ScheduledExecutorService executor; |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 120 | private ExecutorService messageHandlingExecutor, activationExecutor; |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 121 | |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 122 | private ConsistentMap<ApplicationId, InternalApplicationHolder> apps; |
Madan Jampani | c5a1754 | 2016-08-22 10:26:11 -0700 | [diff] [blame] | 123 | private Topic<Application> appActivationTopic; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 124 | |
| 125 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 126 | protected ClusterCommunicationService clusterCommunicator; |
| 127 | |
| 128 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 129 | protected ClusterService clusterService; |
| 130 | |
| 131 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 132 | protected StorageService storageService; |
| 133 | |
| 134 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Madan Jampani | 3e033bd | 2015-04-08 13:03:49 -0700 | [diff] [blame] | 135 | protected ApplicationIdStore idStore; |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 136 | |
Jordan Halterman | fedad5b | 2017-10-09 23:16:27 -0700 | [diff] [blame] | 137 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 138 | protected VersionService versionService; |
Jordan Halterman | fedad5b | 2017-10-09 23:16:27 -0700 | [diff] [blame] | 139 | |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 140 | private final InternalAppsListener appsListener = new InternalAppsListener(); |
Madan Jampani | c5a1754 | 2016-08-22 10:26:11 -0700 | [diff] [blame] | 141 | private final Consumer<Application> appActivator = new AppActivator(); |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 142 | |
| 143 | private Consumer<Status> statusChangeListener; |
| 144 | |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 145 | // Multimap to track which apps are required by others apps |
| 146 | // app -> { required-by, ... } |
| 147 | // Apps explicitly activated will be required by the CORE app |
| 148 | private final Multimap<ApplicationId, ApplicationId> requiredBy = |
| 149 | synchronizedSetMultimap(newSetMultimap(Maps.newHashMap(), Sets::newHashSet)); |
| 150 | |
| 151 | private ApplicationId coreAppId; |
| 152 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 153 | @Activate |
| 154 | public void activate() { |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 155 | messageHandlingExecutor = newSingleThreadExecutor(groupedThreads("onos/store/app", |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 156 | "message-handler", log)); |
Thomas Vachuska | bddbb25 | 2016-08-08 14:25:05 -0700 | [diff] [blame] | 157 | clusterCommunicator.addSubscriber(APP_BITS_REQUEST, |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 158 | bytes -> new String(bytes, Charsets.UTF_8), |
| 159 | name -> { |
| 160 | try { |
| 161 | log.info("Sending bits for application {}", name); |
| 162 | return toByteArray(getApplicationInputStream(name)); |
| 163 | } catch (IOException e) { |
| 164 | throw new StorageException(e); |
| 165 | } |
| 166 | }, |
| 167 | Function.identity(), |
| 168 | messageHandlingExecutor); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 169 | |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 170 | apps = storageService.<ApplicationId, InternalApplicationHolder>consistentMapBuilder() |
| 171 | .withName("onos-apps") |
| 172 | .withRelaxedReadConsistency() |
| 173 | .withSerializer(Serializer.using(KryoNamespaces.API, |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 174 | InternalApplicationHolder.class, |
| 175 | InternalState.class)) |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 176 | .withVersion(versionService.version()) |
| 177 | .withRevisionType(RevisionType.PROPAGATE) |
| 178 | .withCompatibilityFunction(this::convertApplication) |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 179 | .build(); |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 180 | |
Jordan Halterman | 400bbe5 | 2018-04-05 23:07:47 -0700 | [diff] [blame] | 181 | appActivationTopic = storageService.<Application>topicBuilder() |
| 182 | .withName("onos-apps-activation-topic") |
| 183 | .withSerializer(Serializer.using(KryoNamespaces.API)) |
| 184 | .withVersion(versionService.version()) |
| 185 | .withRevisionType(RevisionType.PROPAGATE) |
| 186 | .withCompatibilityFunction(this::convertApplication) |
| 187 | .build(); |
Madan Jampani | ae538ff | 2016-08-19 12:42:43 -0700 | [diff] [blame] | 188 | |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 189 | activationExecutor = newSingleThreadExecutor(groupedThreads("onos/store/app", |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 190 | "app-activation", log)); |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 191 | appActivationTopic.subscribe(appActivator, activationExecutor); |
Madan Jampani | ae538ff | 2016-08-19 12:42:43 -0700 | [diff] [blame] | 192 | |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 193 | executor = newSingleThreadScheduledExecutor(groupedThreads("onos/app", "store", log)); |
| 194 | statusChangeListener = status -> { |
| 195 | if (status == Status.ACTIVE) { |
| 196 | executor.execute(this::bootstrapExistingApplications); |
| 197 | } |
| 198 | }; |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 199 | apps.addListener(appsListener, activationExecutor); |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 200 | apps.addStatusChangeListener(statusChangeListener); |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 201 | coreAppId = getId(CoreService.CORE_APP_NAME); |
Jordan Halterman | fedad5b | 2017-10-09 23:16:27 -0700 | [diff] [blame] | 202 | |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 203 | activateExistingApplications(); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 204 | log.info("Started"); |
| 205 | } |
| 206 | |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 207 | /** |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 208 | * Converts the versions of stored applications propagated from the prior version to the local application versions. |
Jordan Halterman | fedad5b | 2017-10-09 23:16:27 -0700 | [diff] [blame] | 209 | */ |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 210 | private InternalApplicationHolder convertApplication(InternalApplicationHolder appHolder, Version version) { |
| 211 | // Load the application description from disk. If the version doesn't match the persisted |
| 212 | // version, update the stored application with the new version. |
| 213 | ApplicationDescription appDesc = getApplicationDescription(appHolder.app.id().name()); |
| 214 | if (!appDesc.version().equals(appHolder.app().version())) { |
Jordan Halterman | 400bbe5 | 2018-04-05 23:07:47 -0700 | [diff] [blame] | 215 | Application newApplication = DefaultApplication.builder(appDesc) |
| 216 | .withAppId(appHolder.app.id()) |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 217 | .build(); |
| 218 | return new InternalApplicationHolder( |
| 219 | newApplication, appHolder.state, appHolder.permissions); |
| 220 | } |
| 221 | return appHolder; |
| 222 | } |
| 223 | |
| 224 | /** |
Jordan Halterman | 400bbe5 | 2018-04-05 23:07:47 -0700 | [diff] [blame] | 225 | * Converts the versions of stored applications propagated from the prior version to the local application versions. |
| 226 | */ |
| 227 | private Application convertApplication(Application app, Version version) { |
| 228 | // Load the application description from disk. If the version doesn't match the persisted |
| 229 | // version, update the stored application with the new version. |
| 230 | ApplicationDescription appDesc = getApplicationDescription(app.id().name()); |
| 231 | if (!appDesc.version().equals(app.version())) { |
| 232 | return DefaultApplication.builder(appDesc) |
| 233 | .withAppId(app.id()) |
| 234 | .build(); |
| 235 | } |
| 236 | return app; |
| 237 | } |
| 238 | |
| 239 | /** |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 240 | * Activates applications that should be activated according to the distributed store. |
| 241 | */ |
| 242 | private void activateExistingApplications() { |
Jon Hall | 8069fdd | 2018-02-02 10:48:20 -0800 | [diff] [blame] | 243 | getApplicationNames().forEach(appName -> { |
| 244 | // Only update the application version if the application has already been installed. |
| 245 | ApplicationId appId = getId(appName); |
| 246 | if (appId != null) { |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 247 | ApplicationDescription appDesc = getApplicationDescription(appName); |
| 248 | InternalApplicationHolder appHolder = Versioned.valueOrNull(apps.get(appId)); |
Jordan Halterman | fedad5b | 2017-10-09 23:16:27 -0700 | [diff] [blame] | 249 | |
Jordan Halterman | a84936d | 2018-04-04 15:45:47 -0700 | [diff] [blame] | 250 | // If the application has already been activated, set the local state to active. |
| 251 | if (appHolder != null |
| 252 | && appDesc.version().equals(appHolder.app().version()) |
| 253 | && appHolder.state == ACTIVATED) { |
| 254 | setActive(appName); |
| 255 | updateTime(appName); |
Jordan Halterman | fedad5b | 2017-10-09 23:16:27 -0700 | [diff] [blame] | 256 | } |
Jon Hall | 8069fdd | 2018-02-02 10:48:20 -0800 | [diff] [blame] | 257 | } |
| 258 | }); |
Jordan Halterman | fedad5b | 2017-10-09 23:16:27 -0700 | [diff] [blame] | 259 | } |
| 260 | |
Jon Hall | 8069fdd | 2018-02-02 10:48:20 -0800 | [diff] [blame] | 261 | |
Jordan Halterman | fedad5b | 2017-10-09 23:16:27 -0700 | [diff] [blame] | 262 | /** |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 263 | * Processes existing applications from the distributed map. This is done to |
| 264 | * account for events that this instance may be have missed due to a staggered start. |
| 265 | */ |
Thomas Vachuska | bddbb25 | 2016-08-08 14:25:05 -0700 | [diff] [blame] | 266 | private void bootstrapExistingApplications() { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 267 | apps.asJavaMap().forEach((appId, holder) -> setupApplicationAndNotify(appId, holder.app(), holder.state())); |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 268 | } |
| 269 | |
| 270 | /** |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 271 | * Loads the application inventory from the disk and activates apps if |
| 272 | * they are marked to be active. |
| 273 | */ |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 274 | private void loadFromDisk() { |
Charles Chan | e889e2d | 2015-11-17 12:01:02 -0800 | [diff] [blame] | 275 | getApplicationNames().forEach(appName -> { |
| 276 | Application app = loadFromDisk(appName); |
| 277 | if (app != null && isActive(app.id().name())) { |
Thomas Vachuska | ad2965b | 2018-04-02 15:23:31 -0700 | [diff] [blame] | 278 | // For now, apps loaded from disk will be marked as having been |
| 279 | // activated explicitly, which means they won't deactivate |
| 280 | // implicitly when all dependent apps have been deactivated. |
| 281 | requiredBy.put(app.id(), coreAppId); |
Charles Chan | e889e2d | 2015-11-17 12:01:02 -0800 | [diff] [blame] | 282 | activate(app.id(), false); |
| 283 | // TODO Load app permissions |
| 284 | } |
| 285 | }); |
| 286 | } |
| 287 | |
| 288 | private Application loadFromDisk(String appName) { |
Andrea Campanella | c8eca24 | 2016-04-06 19:34:32 -0700 | [diff] [blame] | 289 | pendingApps.add(appName); |
| 290 | |
Charles Chan | e889e2d | 2015-11-17 12:01:02 -0800 | [diff] [blame] | 291 | for (int i = 0; i < MAX_LOAD_RETRIES; i++) { |
| 292 | try { |
| 293 | // Directly return if app already exists |
| 294 | ApplicationId appId = getId(appName); |
| 295 | if (appId != null) { |
Ray Milkey | 64591a6 | 2016-01-12 09:50:45 -0800 | [diff] [blame] | 296 | Application application = getApplication(appId); |
| 297 | if (application != null) { |
Andrea Campanella | c8eca24 | 2016-04-06 19:34:32 -0700 | [diff] [blame] | 298 | pendingApps.remove(appName); |
Ray Milkey | 64591a6 | 2016-01-12 09:50:45 -0800 | [diff] [blame] | 299 | return application; |
| 300 | } |
Thomas Vachuska | 62f04a4 | 2015-04-22 14:38:34 -0700 | [diff] [blame] | 301 | } |
Charles Chan | e889e2d | 2015-11-17 12:01:02 -0800 | [diff] [blame] | 302 | |
| 303 | ApplicationDescription appDesc = getApplicationDescription(appName); |
Andrea Campanella | c8eca24 | 2016-04-06 19:34:32 -0700 | [diff] [blame] | 304 | |
| 305 | Optional<String> loop = appDesc.requiredApps().stream() |
| 306 | .filter(app -> pendingApps.contains(app)).findAny(); |
| 307 | if (loop.isPresent()) { |
| 308 | log.error("Circular app dependency detected: {} -> {}", pendingApps, loop.get()); |
| 309 | pendingApps.remove(appName); |
| 310 | return null; |
| 311 | } |
| 312 | |
Charles Chan | e889e2d | 2015-11-17 12:01:02 -0800 | [diff] [blame] | 313 | boolean success = appDesc.requiredApps().stream() |
| 314 | .noneMatch(requiredApp -> loadFromDisk(requiredApp) == null); |
Andrea Campanella | c8eca24 | 2016-04-06 19:34:32 -0700 | [diff] [blame] | 315 | pendingApps.remove(appName); |
| 316 | |
Charles Chan | e889e2d | 2015-11-17 12:01:02 -0800 | [diff] [blame] | 317 | return success ? create(appDesc, false) : null; |
Andrea Campanella | c8eca24 | 2016-04-06 19:34:32 -0700 | [diff] [blame] | 318 | |
Charles Chan | e889e2d | 2015-11-17 12:01:02 -0800 | [diff] [blame] | 319 | } catch (Exception e) { |
Yuta HIGUCHI | 1d6fef3 | 2018-05-07 18:24:20 -0700 | [diff] [blame] | 320 | log.warn("Unable to load application {} from disk: {}; retrying", |
| 321 | appName, |
| 322 | Throwables.getRootCause(e).getMessage()); |
| 323 | log.debug("Full error details:", e); |
Charles Chan | e889e2d | 2015-11-17 12:01:02 -0800 | [diff] [blame] | 324 | randomDelay(RETRY_DELAY_MS); //FIXME: This is a deliberate hack; fix in Falcon |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 325 | } |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 326 | } |
Andrea Campanella | c8eca24 | 2016-04-06 19:34:32 -0700 | [diff] [blame] | 327 | pendingApps.remove(appName); |
Charles Chan | e889e2d | 2015-11-17 12:01:02 -0800 | [diff] [blame] | 328 | return null; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 329 | } |
| 330 | |
| 331 | @Deactivate |
| 332 | public void deactivate() { |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 333 | clusterCommunicator.removeSubscriber(APP_BITS_REQUEST); |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 334 | apps.removeStatusChangeListener(statusChangeListener); |
| 335 | apps.removeListener(appsListener); |
Madan Jampani | c5a1754 | 2016-08-22 10:26:11 -0700 | [diff] [blame] | 336 | appActivationTopic.unsubscribe(appActivator); |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 337 | messageHandlingExecutor.shutdown(); |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 338 | activationExecutor.shutdown(); |
Madan Jampani | 6b5b717 | 2015-02-23 13:02:26 -0800 | [diff] [blame] | 339 | executor.shutdown(); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 340 | log.info("Stopped"); |
| 341 | } |
| 342 | |
| 343 | @Override |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 344 | public void setDelegate(ApplicationStoreDelegate delegate) { |
| 345 | super.setDelegate(delegate); |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 346 | executor.execute(this::bootstrapExistingApplications); |
Thomas Vachuska | bddbb25 | 2016-08-08 14:25:05 -0700 | [diff] [blame] | 347 | executor.schedule((Runnable) this::loadFromDisk, APP_LOAD_DELAY_MS, TimeUnit.MILLISECONDS); |
Thomas Vachuska | cf96011 | 2015-03-06 22:36:51 -0800 | [diff] [blame] | 348 | } |
| 349 | |
| 350 | @Override |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 351 | public Set<Application> getApplications() { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 352 | return ImmutableSet.copyOf(apps.values() |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 353 | .stream() |
| 354 | .map(Versioned::value) |
| 355 | .map(InternalApplicationHolder::app) |
| 356 | .collect(Collectors.toSet())); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 357 | } |
| 358 | |
| 359 | @Override |
| 360 | public ApplicationId getId(String name) { |
| 361 | return idStore.getAppId(name); |
| 362 | } |
| 363 | |
| 364 | @Override |
| 365 | public Application getApplication(ApplicationId appId) { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 366 | InternalApplicationHolder appHolder = Versioned.valueOrNull(apps.get(appId)); |
| 367 | return appHolder != null ? appHolder.app() : null; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 368 | } |
| 369 | |
| 370 | @Override |
| 371 | public ApplicationState getState(ApplicationId appId) { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 372 | InternalApplicationHolder appHolder = Versioned.valueOrNull(apps.get(appId)); |
| 373 | InternalState state = appHolder != null ? appHolder.state() : null; |
| 374 | return state == null ? null : state == ACTIVATED ? ApplicationState.ACTIVE : ApplicationState.INSTALLED; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 375 | } |
| 376 | |
| 377 | @Override |
| 378 | public Application create(InputStream appDescStream) { |
| 379 | ApplicationDescription appDesc = saveApplication(appDescStream); |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 380 | if (hasPrerequisites(appDesc)) { |
| 381 | return create(appDesc, true); |
| 382 | } |
Jonathan Hart | 14651b5 | 2016-06-07 17:59:53 -0700 | [diff] [blame] | 383 | // Purge bits off disk if we don't have prerequisites to allow app to be |
| 384 | // reinstalled later |
| 385 | purgeApplication(appDesc.name()); |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 386 | throw new ApplicationException("Missing dependencies for app " + appDesc.name()); |
| 387 | } |
| 388 | |
| 389 | private boolean hasPrerequisites(ApplicationDescription app) { |
Yuta HIGUCHI | 56a7a6b | 2017-02-22 15:17:42 -0800 | [diff] [blame] | 390 | for (String required : app.requiredApps()) { |
| 391 | ApplicationId id = getId(required); |
| 392 | if (id == null || getApplication(id) == null) { |
| 393 | log.error("{} required for {} not available", required, app.name()); |
| 394 | return false; |
| 395 | } |
| 396 | } |
| 397 | return true; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 398 | } |
| 399 | |
Thomas Vachuska | 161baf5 | 2015-03-27 16:15:39 -0700 | [diff] [blame] | 400 | private Application create(ApplicationDescription appDesc, boolean updateTime) { |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 401 | Application app = registerApp(appDesc); |
Thomas Vachuska | 161baf5 | 2015-03-27 16:15:39 -0700 | [diff] [blame] | 402 | if (updateTime) { |
| 403 | updateTime(app.id().name()); |
| 404 | } |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 405 | InternalApplicationHolder previousApp = |
| 406 | Versioned.valueOrNull(apps.putIfAbsent(app.id(), new InternalApplicationHolder(app, INSTALLED, null))); |
| 407 | return previousApp != null ? previousApp.app() : app; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 408 | } |
| 409 | |
| 410 | @Override |
| 411 | public void remove(ApplicationId appId) { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 412 | uninstallDependentApps(appId); |
| 413 | apps.remove(appId); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 414 | } |
| 415 | |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 416 | // Uninstalls all apps that depend on the given app. |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 417 | private void uninstallDependentApps(ApplicationId appId) { |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 418 | getApplications().stream() |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 419 | .filter(a -> a.requiredApps().contains(appId.name())) |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 420 | .forEach(a -> remove(a.id())); |
| 421 | } |
| 422 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 423 | @Override |
| 424 | public void activate(ApplicationId appId) { |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 425 | activate(appId, coreAppId); |
| 426 | } |
| 427 | |
| 428 | private void activate(ApplicationId appId, ApplicationId forAppId) { |
| 429 | requiredBy.put(appId, forAppId); |
Thomas Vachuska | 161baf5 | 2015-03-27 16:15:39 -0700 | [diff] [blame] | 430 | activate(appId, true); |
| 431 | } |
| 432 | |
| 433 | private void activate(ApplicationId appId, boolean updateTime) { |
Jonathan Hart | bd85f78 | 2016-06-20 16:13:37 -0700 | [diff] [blame] | 434 | Versioned<InternalApplicationHolder> vAppHolder = apps.get(appId); |
| 435 | if (vAppHolder != null) { |
Thomas Vachuska | 161baf5 | 2015-03-27 16:15:39 -0700 | [diff] [blame] | 436 | if (updateTime) { |
| 437 | updateTime(appId.name()); |
| 438 | } |
Jonathan Hart | bd85f78 | 2016-06-20 16:13:37 -0700 | [diff] [blame] | 439 | activateRequiredApps(vAppHolder.value().app()); |
| 440 | |
| 441 | apps.computeIf(appId, v -> v != null && v.state() != ACTIVATED, |
| 442 | (k, v) -> new InternalApplicationHolder( |
| 443 | v.app(), ACTIVATED, v.permissions())); |
Madan Jampani | c5a1754 | 2016-08-22 10:26:11 -0700 | [diff] [blame] | 444 | appActivationTopic.publish(vAppHolder.value().app()); |
Thomas Vachuska | 484ae54 | 2017-08-29 15:21:57 -0700 | [diff] [blame] | 445 | appActivationTopic.publish(null); // FIXME: Once ONOS-6977 is fixed |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 446 | } |
| 447 | } |
| 448 | |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 449 | // Activates all apps required by this application. |
| 450 | private void activateRequiredApps(Application app) { |
| 451 | app.requiredApps().stream().map(this::getId).forEach(id -> activate(id, app.id())); |
| 452 | } |
| 453 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 454 | @Override |
| 455 | public void deactivate(ApplicationId appId) { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 456 | deactivateDependentApps(appId); |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 457 | deactivate(appId, coreAppId); |
| 458 | } |
| 459 | |
| 460 | private void deactivate(ApplicationId appId, ApplicationId forAppId) { |
| 461 | requiredBy.remove(appId, forAppId); |
| 462 | if (requiredBy.get(appId).isEmpty()) { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 463 | AtomicBoolean stateChanged = new AtomicBoolean(false); |
| 464 | apps.computeIf(appId, |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 465 | v -> v != null && v.state() != DEACTIVATED, |
| 466 | (k, v) -> { |
| 467 | stateChanged.set(true); |
| 468 | return new InternalApplicationHolder(v.app(), DEACTIVATED, v.permissions()); |
| 469 | }); |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 470 | if (stateChanged.get()) { |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 471 | updateTime(appId.name()); |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 472 | deactivateRequiredApps(appId); |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 473 | } |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 474 | } |
| 475 | } |
| 476 | |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 477 | // Deactivates all apps that require this application. |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 478 | private void deactivateDependentApps(ApplicationId appId) { |
| 479 | apps.values() |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 480 | .stream() |
| 481 | .map(Versioned::value) |
| 482 | .filter(a -> a.state() == ACTIVATED) |
| 483 | .filter(a -> a.app().requiredApps().contains(appId.name())) |
| 484 | .forEach(a -> deactivate(a.app().id())); |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 485 | } |
| 486 | |
| 487 | // Deactivates all apps required by this application. |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 488 | private void deactivateRequiredApps(ApplicationId appId) { |
| 489 | getApplication(appId).requiredApps() |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 490 | .stream() |
| 491 | .map(this::getId) |
| 492 | .map(apps::get) |
| 493 | .map(Versioned::value) |
| 494 | .filter(a -> a.state() == ACTIVATED) |
| 495 | .forEach(a -> deactivate(a.app().id(), appId)); |
Thomas Vachuska | 761f004 | 2015-11-11 19:10:17 -0800 | [diff] [blame] | 496 | } |
| 497 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 498 | @Override |
| 499 | public Set<Permission> getPermissions(ApplicationId appId) { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 500 | InternalApplicationHolder app = Versioned.valueOrNull(apps.get(appId)); |
| 501 | return app != null ? ImmutableSet.copyOf(app.permissions()) : ImmutableSet.of(); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 502 | } |
| 503 | |
| 504 | @Override |
| 505 | public void setPermissions(ApplicationId appId, Set<Permission> permissions) { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 506 | AtomicBoolean permissionsChanged = new AtomicBoolean(false); |
| 507 | Versioned<InternalApplicationHolder> appHolder = apps.computeIf(appId, |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 508 | v -> v != null && !Sets.symmetricDifference(v.permissions(), permissions).isEmpty(), |
| 509 | (k, v) -> { |
| 510 | permissionsChanged.set(true); |
| 511 | return new InternalApplicationHolder(v.app(), v.state(), ImmutableSet.copyOf(permissions)); |
| 512 | }); |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 513 | if (permissionsChanged.get()) { |
Ray Milkey | 2f6f907 | 2016-08-23 13:18:50 -0700 | [diff] [blame] | 514 | notifyDelegate(new ApplicationEvent(APP_PERMISSIONS_CHANGED, appHolder.value().app())); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 515 | } |
| 516 | } |
| 517 | |
Thomas Vachuska | 08b4dec | 2017-08-31 15:20:17 -0700 | [diff] [blame] | 518 | @Override |
| 519 | public InputStream getApplicationArchive(ApplicationId appId) { |
| 520 | return getApplicationInputStream(appId.name()); |
| 521 | } |
| 522 | |
Madan Jampani | c5a1754 | 2016-08-22 10:26:11 -0700 | [diff] [blame] | 523 | private class AppActivator implements Consumer<Application> { |
Madan Jampani | ae538ff | 2016-08-19 12:42:43 -0700 | [diff] [blame] | 524 | @Override |
Madan Jampani | c5a1754 | 2016-08-22 10:26:11 -0700 | [diff] [blame] | 525 | public void accept(Application app) { |
Thomas Vachuska | 484ae54 | 2017-08-29 15:21:57 -0700 | [diff] [blame] | 526 | if (app != null) { // FIXME: Once ONOS-6977 is fixed |
| 527 | String appName = app.id().name(); |
| 528 | installAppIfNeeded(app); |
| 529 | setActive(appName); |
| 530 | notifyDelegate(new ApplicationEvent(APP_ACTIVATED, app)); |
| 531 | } |
Madan Jampani | ae538ff | 2016-08-19 12:42:43 -0700 | [diff] [blame] | 532 | } |
| 533 | } |
| 534 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 535 | /** |
| 536 | * Listener to application state distributed map changes. |
| 537 | */ |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 538 | private final class InternalAppsListener |
| 539 | implements MapEventListener<ApplicationId, InternalApplicationHolder> { |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 540 | @Override |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 541 | public void event(MapEvent<ApplicationId, InternalApplicationHolder> event) { |
Thomas Vachuska | 4fcdae7 | 2015-03-24 10:22:54 -0700 | [diff] [blame] | 542 | if (delegate == null) { |
| 543 | return; |
| 544 | } |
| 545 | |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 546 | ApplicationId appId = event.key(); |
| 547 | InternalApplicationHolder newApp = event.newValue() == null ? null : event.newValue().value(); |
| 548 | InternalApplicationHolder oldApp = event.oldValue() == null ? null : event.oldValue().value(); |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 549 | if (event.type() == MapEvent.Type.UPDATE && (newApp == null || oldApp == null || |
| 550 | newApp.state() == oldApp.state())) { |
| 551 | log.warn("Can't update the application {}", event.key()); |
Ray Milkey | 74e5913 | 2018-01-17 15:24:52 -0800 | [diff] [blame] | 552 | return; |
| 553 | } |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 554 | if ((event.type() == MapEvent.Type.INSERT || event.type() == MapEvent.Type.UPDATE) && newApp != null) { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 555 | setupApplicationAndNotify(appId, newApp.app(), newApp.state()); |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 556 | } else if (event.type() == MapEvent.Type.REMOVE && oldApp != null) { |
Deepa Vadireddy | 9719eb0 | 2017-11-23 10:12:30 +0000 | [diff] [blame] | 557 | notifyDelegate(new ApplicationEvent(APP_UNINSTALLED, oldApp.app())); |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 558 | purgeApplication(appId.name()); |
| 559 | } else { |
| 560 | log.warn("Can't perform {} on application {}", event.type(), event.key()); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 561 | } |
| 562 | } |
| 563 | } |
| 564 | |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 565 | private void setupApplicationAndNotify(ApplicationId appId, Application app, InternalState state) { |
Madan Jampani | ae538ff | 2016-08-19 12:42:43 -0700 | [diff] [blame] | 566 | // ACTIVATED state is handled separately in NextAppToActivateValueListener |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 567 | if (state == INSTALLED) { |
| 568 | fetchBitsIfNeeded(app); |
Ray Milkey | 2f6f907 | 2016-08-23 13:18:50 -0700 | [diff] [blame] | 569 | notifyDelegate(new ApplicationEvent(APP_INSTALLED, app)); |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 570 | } else if (state == DEACTIVATED) { |
| 571 | clearActive(appId.name()); |
Ray Milkey | 2f6f907 | 2016-08-23 13:18:50 -0700 | [diff] [blame] | 572 | notifyDelegate(new ApplicationEvent(APP_DEACTIVATED, app)); |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 573 | } |
| 574 | } |
| 575 | |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 576 | /** |
| 577 | * Determines if the application bits are available locally. |
| 578 | */ |
| 579 | private boolean appBitsAvailable(Application app) { |
| 580 | try { |
| 581 | ApplicationDescription appDesc = getApplicationDescription(app.id().name()); |
| 582 | return appDesc.version().equals(app.version()); |
| 583 | } catch (ApplicationException e) { |
| 584 | return false; |
| 585 | } |
| 586 | } |
| 587 | |
| 588 | /** |
| 589 | * Fetches the bits from the cluster peers if necessary. |
| 590 | */ |
| 591 | private void fetchBitsIfNeeded(Application app) { |
| 592 | if (!appBitsAvailable(app)) { |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 593 | fetchBits(app, false); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 594 | } |
| 595 | } |
| 596 | |
| 597 | /** |
| 598 | * Installs the application if necessary from the application peers. |
| 599 | */ |
| 600 | private void installAppIfNeeded(Application app) { |
| 601 | if (!appBitsAvailable(app)) { |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 602 | fetchBits(app, true); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 603 | } |
| 604 | } |
| 605 | |
| 606 | /** |
| 607 | * Fetches the bits from the cluster peers. |
| 608 | */ |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 609 | private void fetchBits(Application app, boolean delegateInstallation) { |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 610 | ControllerNode localNode = clusterService.getLocalNode(); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 611 | CountDownLatch latch = new CountDownLatch(1); |
| 612 | |
| 613 | // FIXME: send message with name & version to make sure we don't get served old bits |
| 614 | |
| 615 | log.info("Downloading bits for application {}", app.id().name()); |
| 616 | for (ControllerNode node : clusterService.getNodes()) { |
Madan Jampani | 2bfa94c | 2015-04-11 05:03:49 -0700 | [diff] [blame] | 617 | if (latch.getCount() == 0) { |
| 618 | break; |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 619 | } |
Madan Jampani | 2bfa94c | 2015-04-11 05:03:49 -0700 | [diff] [blame] | 620 | if (node.equals(localNode)) { |
| 621 | continue; |
| 622 | } |
| 623 | clusterCommunicator.sendAndReceive(app.id().name(), |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 624 | APP_BITS_REQUEST, |
| 625 | s -> s.getBytes(Charsets.UTF_8), |
| 626 | Function.identity(), |
| 627 | node.id()) |
Thomas Vachuska | d0d5854 | 2015-06-03 12:38:44 -0700 | [diff] [blame] | 628 | .whenCompleteAsync((bits, error) -> { |
| 629 | if (error == null && latch.getCount() > 0) { |
| 630 | saveApplication(new ByteArrayInputStream(bits)); |
| 631 | log.info("Downloaded bits for application {} from node {}", |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 632 | app.id().name(), node.id()); |
Thomas Vachuska | d0d5854 | 2015-06-03 12:38:44 -0700 | [diff] [blame] | 633 | latch.countDown(); |
Thomas Vachuska | 62ba45f | 2017-10-02 13:17:28 -0700 | [diff] [blame] | 634 | if (delegateInstallation) { |
| 635 | notifyDelegate(new ApplicationEvent(APP_INSTALLED, app)); |
| 636 | } |
Thomas Vachuska | d0d5854 | 2015-06-03 12:38:44 -0700 | [diff] [blame] | 637 | } else if (error != null) { |
| 638 | log.warn("Unable to fetch bits for application {} from node {}", |
Andrea Campanella | aaa9f11 | 2018-01-26 12:45:24 +0100 | [diff] [blame] | 639 | app.id().name(), node.id()); |
Thomas Vachuska | d0d5854 | 2015-06-03 12:38:44 -0700 | [diff] [blame] | 640 | } |
Jordan Halterman | 85f560d | 2017-09-20 11:57:58 -0700 | [diff] [blame] | 641 | }, messageHandlingExecutor); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 642 | } |
| 643 | |
| 644 | try { |
| 645 | if (!latch.await(FETCH_TIMEOUT_MS, MILLISECONDS)) { |
| 646 | log.warn("Unable to fetch bits for application {}", app.id().name()); |
| 647 | } |
| 648 | } catch (InterruptedException e) { |
| 649 | log.warn("Interrupted while fetching bits for application {}", app.id().name()); |
Ray Milkey | 5c7d488 | 2018-02-05 14:50:39 -0800 | [diff] [blame] | 650 | Thread.currentThread().interrupt(); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 651 | } |
| 652 | } |
| 653 | |
| 654 | /** |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 655 | * Produces a registered application from the supplied description. |
| 656 | */ |
| 657 | private Application registerApp(ApplicationDescription appDesc) { |
| 658 | ApplicationId appId = idStore.registerApplication(appDesc.name()); |
Ray Milkey | 47c9541 | 2017-09-15 10:40:48 -0700 | [diff] [blame] | 659 | return DefaultApplication |
| 660 | .builder(appDesc) |
| 661 | .withAppId(appId) |
| 662 | .build(); |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 663 | } |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 664 | |
| 665 | /** |
| 666 | * Internal class for holding app information. |
| 667 | */ |
Thomas Vachuska | bddbb25 | 2016-08-08 14:25:05 -0700 | [diff] [blame] | 668 | private static final class InternalApplicationHolder { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 669 | private final Application app; |
| 670 | private final InternalState state; |
| 671 | private final Set<Permission> permissions; |
| 672 | |
| 673 | @SuppressWarnings("unused") |
| 674 | private InternalApplicationHolder() { |
| 675 | app = null; |
| 676 | state = null; |
| 677 | permissions = null; |
| 678 | } |
| 679 | |
Thomas Vachuska | bddbb25 | 2016-08-08 14:25:05 -0700 | [diff] [blame] | 680 | private InternalApplicationHolder(Application app, InternalState state, Set<Permission> permissions) { |
Madan Jampani | 6c02d9e | 2016-05-24 15:09:47 -0700 | [diff] [blame] | 681 | this.app = Preconditions.checkNotNull(app); |
| 682 | this.state = state; |
| 683 | this.permissions = permissions == null ? null : ImmutableSet.copyOf(permissions); |
| 684 | } |
| 685 | |
| 686 | public Application app() { |
| 687 | return app; |
| 688 | } |
| 689 | |
| 690 | public InternalState state() { |
| 691 | return state; |
| 692 | } |
| 693 | |
| 694 | public Set<Permission> permissions() { |
| 695 | return permissions; |
| 696 | } |
| 697 | |
| 698 | @Override |
| 699 | public String toString() { |
| 700 | return MoreObjects.toStringHelper(getClass()) |
| 701 | .add("app", app.id()) |
| 702 | .add("state", state) |
| 703 | .toString(); |
| 704 | } |
| 705 | } |
Thomas Vachuska | 90b453f | 2015-01-30 18:57:14 -0800 | [diff] [blame] | 706 | } |