Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -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 | |
Ray Milkey | 69ec871 | 2017-08-08 13:00:43 -0700 | [diff] [blame] | 17 | package org.onosproject.routeservice.store; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 18 | |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 19 | import java.util.Collection; |
| 20 | import java.util.Collections; |
| 21 | import java.util.Map; |
| 22 | import java.util.concurrent.ExecutorService; |
| 23 | import java.util.function.Consumer; |
| 24 | import java.util.stream.Collectors; |
| 25 | |
Daniel Ginsburg | 83b7645 | 2018-06-09 01:43:59 +0300 | [diff] [blame] | 26 | import com.google.common.collect.Sets; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 27 | import org.onlab.packet.IpAddress; |
| 28 | import org.onlab.packet.IpPrefix; |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 29 | import org.onosproject.cluster.NodeId; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 30 | import org.onlab.util.KryoNamespace; |
Ray Milkey | 69ec871 | 2017-08-08 13:00:43 -0700 | [diff] [blame] | 31 | import org.onosproject.routeservice.InternalRouteEvent; |
| 32 | import org.onosproject.routeservice.Route; |
| 33 | import org.onosproject.routeservice.RouteSet; |
| 34 | import org.onosproject.routeservice.RouteStoreDelegate; |
| 35 | import org.onosproject.routeservice.RouteTableId; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 36 | import org.onosproject.store.serializers.KryoNamespaces; |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 37 | import org.onosproject.store.service.ConsistentMultimap; |
Jonathan Hart | 1f67d28 | 2017-05-25 14:23:01 -0700 | [diff] [blame] | 38 | import org.onosproject.store.service.DistributedPrimitive; |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 39 | import org.onosproject.store.service.MultimapEvent; |
| 40 | import org.onosproject.store.service.MultimapEventListener; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 41 | import org.onosproject.store.service.Serializer; |
| 42 | import org.onosproject.store.service.StorageService; |
| 43 | import org.onosproject.store.service.Versioned; |
| 44 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 45 | import static com.google.common.base.Preconditions.checkNotNull; |
| 46 | |
| 47 | /** |
| 48 | * Default implementation of a route table based on a consistent map. |
| 49 | */ |
| 50 | public class DefaultRouteTable implements RouteTable { |
| 51 | |
| 52 | private final RouteTableId id; |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 53 | |
| 54 | // The route map stores RawRoute instead of Route to translate the polymorphic IpPrefix and IpAddress types |
| 55 | // into monomorphic types (specifically String). Using strings in the stored RawRoute is necessary to ensure |
| 56 | // the serialized bytes are consistent whether e.g. IpAddress or Ip4Address is used when storing a route. |
| 57 | private final ConsistentMultimap<String, RawRoute> routes; |
| 58 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 59 | private final RouteStoreDelegate delegate; |
Jonathan Hart | 1f67d28 | 2017-05-25 14:23:01 -0700 | [diff] [blame] | 60 | private final ExecutorService executor; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 61 | private final RouteTableListener listener = new RouteTableListener(); |
| 62 | |
Jonathan Hart | 1f67d28 | 2017-05-25 14:23:01 -0700 | [diff] [blame] | 63 | private final Consumer<DistributedPrimitive.Status> statusChangeListener; |
| 64 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 65 | /** |
| 66 | * Creates a new route table. |
| 67 | * |
| 68 | * @param id route table ID |
| 69 | * @param delegate route store delegate to notify of events |
| 70 | * @param storageService storage service |
Jonathan Hart | 1f67d28 | 2017-05-25 14:23:01 -0700 | [diff] [blame] | 71 | * @param executor executor service |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 72 | */ |
| 73 | public DefaultRouteTable(RouteTableId id, RouteStoreDelegate delegate, |
Jonathan Hart | 1f67d28 | 2017-05-25 14:23:01 -0700 | [diff] [blame] | 74 | StorageService storageService, ExecutorService executor) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 75 | this.delegate = checkNotNull(delegate); |
| 76 | this.id = checkNotNull(id); |
| 77 | this.routes = buildRouteMap(checkNotNull(storageService)); |
Jonathan Hart | 1f67d28 | 2017-05-25 14:23:01 -0700 | [diff] [blame] | 78 | this.executor = checkNotNull(executor); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 79 | |
Jonathan Hart | 1f67d28 | 2017-05-25 14:23:01 -0700 | [diff] [blame] | 80 | statusChangeListener = status -> { |
| 81 | if (status.equals(DistributedPrimitive.Status.ACTIVE)) { |
| 82 | executor.execute(this::notifyExistingRoutes); |
| 83 | } |
| 84 | }; |
| 85 | routes.addStatusChangeListener(statusChangeListener); |
| 86 | |
| 87 | notifyExistingRoutes(); |
| 88 | |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 89 | routes.addListener(listener, executor); |
Jonathan Hart | 1f67d28 | 2017-05-25 14:23:01 -0700 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | private void notifyExistingRoutes() { |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 93 | getRoutes().forEach(routeSet -> delegate.notify( |
| 94 | new InternalRouteEvent(InternalRouteEvent.Type.ROUTE_ADDED, routeSet))); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 95 | } |
| 96 | |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 97 | private ConsistentMultimap<String, RawRoute> buildRouteMap(StorageService storageService) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 98 | KryoNamespace routeTableSerializer = KryoNamespace.newBuilder() |
| 99 | .register(KryoNamespaces.API) |
| 100 | .register(Route.class) |
| 101 | .register(Route.Source.class) |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 102 | .register(RawRoute.class) |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 103 | .build(); |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 104 | return storageService.<String, RawRoute>consistentMultimapBuilder() |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 105 | .withName("onos-routes-" + id.name()) |
| 106 | .withRelaxedReadConsistency() |
| 107 | .withSerializer(Serializer.using(routeTableSerializer)) |
| 108 | .build(); |
| 109 | } |
| 110 | |
| 111 | @Override |
| 112 | public RouteTableId id() { |
| 113 | return id; |
| 114 | } |
| 115 | |
| 116 | @Override |
| 117 | public void shutdown() { |
Jonathan Hart | 1f67d28 | 2017-05-25 14:23:01 -0700 | [diff] [blame] | 118 | routes.removeStatusChangeListener(statusChangeListener); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 119 | routes.removeListener(listener); |
| 120 | } |
| 121 | |
| 122 | @Override |
| 123 | public void destroy() { |
| 124 | shutdown(); |
| 125 | routes.destroy(); |
| 126 | } |
| 127 | |
| 128 | @Override |
| 129 | public void update(Route route) { |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 130 | routes.put(route.prefix().toString(), new RawRoute(route)); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | @Override |
| 134 | public void remove(Route route) { |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 135 | routes.remove(route.prefix().toString(), new RawRoute(route)); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 136 | } |
| 137 | |
| 138 | @Override |
Daniel Ginsburg | 83b7645 | 2018-06-09 01:43:59 +0300 | [diff] [blame] | 139 | public void replace(Route route) { |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 140 | routes.replaceValues(route.prefix().toString(), Sets.newHashSet(new RawRoute(route))); |
Daniel Ginsburg | 83b7645 | 2018-06-09 01:43:59 +0300 | [diff] [blame] | 141 | } |
| 142 | |
| 143 | @Override |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 144 | public Collection<RouteSet> getRoutes() { |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 145 | return routes.stream() |
| 146 | .map(Map.Entry::getValue) |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 147 | .collect(Collectors.groupingBy(RawRoute::prefix)) |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 148 | .entrySet() |
| 149 | .stream() |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 150 | .map(entry -> new RouteSet(id, |
| 151 | IpPrefix.valueOf(entry.getKey()), |
| 152 | entry.getValue().stream().map(RawRoute::route).collect(Collectors.toSet()))) |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 153 | .collect(Collectors.toList()); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 154 | } |
| 155 | |
| 156 | @Override |
| 157 | public RouteSet getRoutes(IpPrefix prefix) { |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 158 | Versioned<Collection<? extends RawRoute>> routeSet = routes.get(prefix.toString()); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 159 | if (routeSet != null) { |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 160 | return new RouteSet(id, prefix, routeSet.value().stream().map(RawRoute::route).collect(Collectors.toSet())); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 161 | } |
| 162 | return null; |
| 163 | } |
| 164 | |
| 165 | @Override |
| 166 | public Collection<Route> getRoutesForNextHop(IpAddress nextHop) { |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 167 | return routes.stream() |
| 168 | .map(Map.Entry::getValue) |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 169 | .filter(r -> IpAddress.valueOf(r.nextHop()).equals(nextHop)) |
| 170 | .map(RawRoute::route) |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 171 | .collect(Collectors.toSet()); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 172 | } |
| 173 | |
| 174 | private class RouteTableListener |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 175 | implements MultimapEventListener<String, RawRoute> { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 176 | |
| 177 | private InternalRouteEvent createRouteEvent( |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 178 | InternalRouteEvent.Type type, MultimapEvent<String, RawRoute> event) { |
| 179 | Collection<? extends RawRoute> currentRoutes = Versioned.valueOrNull(routes.get(event.key())); |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 180 | return new InternalRouteEvent(type, new RouteSet( |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 181 | id, IpPrefix.valueOf(event.key()), currentRoutes != null ? |
| 182 | currentRoutes.stream().map(RawRoute::route).collect(Collectors.toSet()) |
| 183 | : Collections.emptySet())); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 184 | } |
| 185 | |
| 186 | @Override |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 187 | public void event(MultimapEvent<String, RawRoute> event) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 188 | InternalRouteEvent ire = null; |
| 189 | switch (event.type()) { |
| 190 | case INSERT: |
| 191 | ire = createRouteEvent(InternalRouteEvent.Type.ROUTE_ADDED, event); |
| 192 | break; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 193 | case REMOVE: |
| 194 | ire = createRouteEvent(InternalRouteEvent.Type.ROUTE_REMOVED, event); |
| 195 | break; |
| 196 | default: |
| 197 | break; |
| 198 | } |
Jordan Halterman | 3b13737 | 2018-04-30 14:42:41 -0700 | [diff] [blame] | 199 | delegate.notify(ire); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 200 | } |
| 201 | } |
Jonathan Hart | 1f67d28 | 2017-05-25 14:23:01 -0700 | [diff] [blame] | 202 | |
Jordan Halterman | 5f5ceb6 | 2018-10-01 23:17:57 -0700 | [diff] [blame^] | 203 | /** |
| 204 | * Represents a route object stored in the underlying ConsistentMultimap. |
| 205 | */ |
| 206 | private static class RawRoute { |
| 207 | private Route.Source source; |
| 208 | private String prefix; |
| 209 | private String nextHop; |
| 210 | private NodeId sourceNode; |
| 211 | |
| 212 | RawRoute(Route route) { |
| 213 | this.source = route.source(); |
| 214 | this.prefix = route.prefix().toString(); |
| 215 | this.nextHop = route.nextHop().toString(); |
| 216 | this.sourceNode = route.sourceNode(); |
| 217 | } |
| 218 | |
| 219 | String prefix() { |
| 220 | return prefix; |
| 221 | } |
| 222 | |
| 223 | String nextHop() { |
| 224 | return nextHop; |
| 225 | } |
| 226 | |
| 227 | Route route() { |
| 228 | return new Route(source, IpPrefix.valueOf(prefix), IpAddress.valueOf(nextHop), sourceNode); |
| 229 | } |
| 230 | } |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 231 | } |