Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.store.device.impl; |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 17 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 18 | import com.google.common.cache.Cache; |
| 19 | import com.google.common.cache.CacheBuilder; |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 20 | import org.onosproject.cluster.ClusterService; |
| 21 | import org.onosproject.cluster.NodeId; |
Yuta HIGUCHI | 33a847b | 2017-04-14 15:44:42 -0700 | [diff] [blame] | 22 | import org.onosproject.mastership.MastershipEvent; |
| 23 | import org.onosproject.mastership.MastershipEvent.Type; |
| 24 | import org.onosproject.mastership.MastershipListener; |
| 25 | import org.onosproject.mastership.MastershipService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 26 | import org.onosproject.mastership.MastershipTerm; |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 27 | import org.onosproject.mastership.MastershipTermService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 28 | import org.onosproject.net.DeviceId; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 29 | import org.onosproject.net.device.DeviceClockService; |
| 30 | import org.onosproject.store.Timestamp; |
| 31 | import org.onosproject.store.impl.MastershipBasedTimestamp; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 32 | import org.osgi.service.component.annotations.Activate; |
| 33 | import org.osgi.service.component.annotations.Component; |
| 34 | import org.osgi.service.component.annotations.Deactivate; |
| 35 | import org.osgi.service.component.annotations.Reference; |
| 36 | import org.osgi.service.component.annotations.ReferenceCardinality; |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 37 | import org.slf4j.Logger; |
| 38 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 39 | import java.util.Optional; |
| 40 | import java.util.concurrent.TimeUnit; |
| 41 | import java.util.concurrent.atomic.AtomicLong; |
| 42 | |
| 43 | import static org.slf4j.LoggerFactory.getLogger; |
Yuta HIGUCHI | 33a847b | 2017-04-14 15:44:42 -0700 | [diff] [blame] | 44 | |
Yuta HIGUCHI | 67a527f | 2014-10-02 22:23:54 -0700 | [diff] [blame] | 45 | /** |
| 46 | * Clock service to issue Timestamp based on Device Mastership. |
| 47 | */ |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 48 | @Component(immediate = true, service = DeviceClockService.class) |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 49 | public class DeviceClockManager implements DeviceClockService { |
Yuta HIGUCHI | 2e96389 | 2014-09-27 13:00:39 -0700 | [diff] [blame] | 50 | |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 51 | private final Logger log = getLogger(getClass()); |
| 52 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 53 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 54 | protected MastershipTermService mastershipTermService; |
| 55 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 56 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Yuta HIGUCHI | 33a847b | 2017-04-14 15:44:42 -0700 | [diff] [blame] | 57 | protected MastershipService mastershipService; |
| 58 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 59 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 60 | protected ClusterService clusterService; |
| 61 | |
| 62 | protected NodeId localNodeId; |
| 63 | |
Madan Jampani | 15d773c | 2015-02-25 15:31:55 -0800 | [diff] [blame] | 64 | private final AtomicLong ticker = new AtomicLong(0); |
Yuta HIGUCHI | 2e96389 | 2014-09-27 13:00:39 -0700 | [diff] [blame] | 65 | |
Yuta HIGUCHI | 33a847b | 2017-04-14 15:44:42 -0700 | [diff] [blame] | 66 | // Map from DeviceId -> last known term number for this node. |
| 67 | // using Cache class but using it as Map which will age out old entries |
| 68 | private final Cache<DeviceId, Long> myLastKnownTerm = |
| 69 | CacheBuilder.newBuilder() |
| 70 | .expireAfterAccess(5, TimeUnit.MINUTES) |
| 71 | .build(); |
| 72 | |
| 73 | private MastershipListener listener; |
| 74 | |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 75 | @Activate |
| 76 | public void activate() { |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 77 | localNodeId = clusterService.getLocalNode().id(); |
Yuta HIGUCHI | 33a847b | 2017-04-14 15:44:42 -0700 | [diff] [blame] | 78 | |
| 79 | listener = new InnerMastershipListener(); |
| 80 | mastershipService.addListener(listener); |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 81 | log.info("Started"); |
| 82 | } |
| 83 | |
| 84 | @Deactivate |
| 85 | public void deactivate() { |
Yuta HIGUCHI | 33a847b | 2017-04-14 15:44:42 -0700 | [diff] [blame] | 86 | mastershipService.removeListener(listener); |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 87 | log.info("Stopped"); |
| 88 | } |
Yuta HIGUCHI | 2e96389 | 2014-09-27 13:00:39 -0700 | [diff] [blame] | 89 | |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 90 | @Override |
| 91 | public Timestamp getTimestamp(DeviceId deviceId) { |
Yuta HIGUCHI | 33a847b | 2017-04-14 15:44:42 -0700 | [diff] [blame] | 92 | Long termNumber = refreshLastKnownTerm(deviceId); |
| 93 | if (termNumber == null) { |
| 94 | log.warn("Requested timestamp for {} which {}" |
| 95 | + "doesn't have known recent mastership term", |
| 96 | deviceId, localNodeId); |
HIGUCHI Yuta | 3a6f7cd | 2015-02-25 18:51:25 -0800 | [diff] [blame] | 97 | throw new IllegalStateException("Requesting timestamp for " + deviceId + " without mastership"); |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 98 | } |
Yuta HIGUCHI | 33a847b | 2017-04-14 15:44:42 -0700 | [diff] [blame] | 99 | return new MastershipBasedTimestamp(termNumber, ticker.incrementAndGet()); |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | @Override |
Yuta HIGUCHI | 13c0b87 | 2014-10-30 18:09:22 -0700 | [diff] [blame] | 103 | public boolean isTimestampAvailable(DeviceId deviceId) { |
Yuta HIGUCHI | 33a847b | 2017-04-14 15:44:42 -0700 | [diff] [blame] | 104 | return myLastKnownTerm.getIfPresent(deviceId) != null || |
| 105 | refreshLastKnownTerm(deviceId) != null; |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Refreshes this node's last known term number to the latest state. |
| 110 | * |
| 111 | * @param deviceId of the Device to refresh mastership term |
| 112 | * @return latest mastership term number or null if this node |
| 113 | * did not have a term number recently |
| 114 | */ |
| 115 | private Long refreshLastKnownTerm(DeviceId deviceId) { |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 116 | MastershipTerm term = mastershipTermService.getMastershipTerm(deviceId); |
Yuta HIGUCHI | 33a847b | 2017-04-14 15:44:42 -0700 | [diff] [blame] | 117 | return myLastKnownTerm.asMap().compute(deviceId, (key, old) -> { |
| 118 | if (old == null) { |
| 119 | return Optional.ofNullable(term) |
| 120 | .filter(t -> localNodeId.equals(t.master())) |
| 121 | .map(MastershipTerm::termNumber) |
| 122 | .orElse(null); |
| 123 | } |
| 124 | return Optional.ofNullable(term) |
| 125 | .filter(t -> localNodeId.equals(t.master())) |
| 126 | .map(MastershipTerm::termNumber) |
| 127 | // TODO make following integer wrap-safe |
| 128 | .map(tn -> Math.max(old, tn)) |
| 129 | .orElse(old); |
| 130 | }); |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Refreshes {@link DeviceClockManager#myLastKnownTerm} on Master update event. |
| 135 | */ |
| 136 | private final class InnerMastershipListener implements MastershipListener { |
| 137 | |
| 138 | @Override |
| 139 | public boolean isRelevant(MastershipEvent event) { |
| 140 | return event.type() == Type.MASTER_CHANGED; |
| 141 | } |
| 142 | |
| 143 | @Override |
| 144 | public void event(MastershipEvent event) { |
| 145 | if (localNodeId.equals(event.roleInfo().master())) { |
| 146 | refreshLastKnownTerm(event.subject()); |
| 147 | } |
| 148 | } |
Yuta HIGUCHI | 13c0b87 | 2014-10-30 18:09:22 -0700 | [diff] [blame] | 149 | } |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 150 | } |