Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present Open Networking Laboratory |
| 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 | |
| 17 | package org.onosproject.incubator.store.routing.impl; |
| 18 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 19 | import com.google.common.collect.ImmutableSet; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 20 | import org.onlab.packet.IpAddress; |
| 21 | import org.onlab.packet.IpPrefix; |
| 22 | import org.onlab.util.KryoNamespace; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 23 | import org.onosproject.incubator.net.routing.InternalRouteEvent; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 24 | import org.onosproject.incubator.net.routing.NextHopData; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 25 | import org.onosproject.incubator.net.routing.Route; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 26 | import org.onosproject.incubator.net.routing.RouteSet; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 27 | import org.onosproject.incubator.net.routing.RouteStore; |
| 28 | import org.onosproject.incubator.net.routing.RouteStoreDelegate; |
| 29 | import org.onosproject.incubator.net.routing.RouteTableId; |
| 30 | import org.onosproject.store.AbstractStore; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 31 | import org.onosproject.store.service.DistributedSet; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 32 | import org.onosproject.store.service.Serializer; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 33 | import org.onosproject.store.service.SetEvent; |
| 34 | import org.onosproject.store.service.SetEventListener; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 35 | import org.onosproject.store.service.StorageService; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 36 | import org.slf4j.Logger; |
| 37 | import org.slf4j.LoggerFactory; |
| 38 | |
| 39 | import java.util.Collection; |
| 40 | import java.util.Collections; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 41 | import java.util.Map; |
| 42 | import java.util.Set; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 43 | import java.util.concurrent.ConcurrentHashMap; |
| 44 | import java.util.concurrent.ExecutorService; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 45 | import java.util.concurrent.Executors; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 46 | |
| 47 | /** |
| 48 | * Route store based on distributed storage. |
| 49 | */ |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 50 | public class DistributedRouteStore extends AbstractStore<InternalRouteEvent, RouteStoreDelegate> |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 51 | implements RouteStore { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 52 | |
| 53 | protected StorageService storageService; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 54 | |
| 55 | private static final RouteTableId IPV4 = new RouteTableId("ipv4"); |
| 56 | private static final RouteTableId IPV6 = new RouteTableId("ipv6"); |
| 57 | private static final Logger log = LoggerFactory.getLogger(DistributedRouteStore.class); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 58 | private final SetEventListener<RouteTableId> masterRouteTableListener = |
| 59 | new MasterRouteTableListener(); |
| 60 | private final RouteStoreDelegate ourDelegate = new InternalRouteStoreDelegate(); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 61 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 62 | // Stores the route tables that have been created |
| 63 | private DistributedSet<RouteTableId> masterRouteTable; |
| 64 | // Local memory map to store route table object |
| 65 | private Map<RouteTableId, RouteTable> routeTables; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 66 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 67 | private ExecutorService executor; |
| 68 | |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 69 | public DistributedRouteStore(StorageService storageService) { |
| 70 | this.storageService = storageService; |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Sets up distributed route store. |
| 75 | */ |
| 76 | public void activate() { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 77 | routeTables = new ConcurrentHashMap<>(); |
| 78 | executor = Executors.newSingleThreadExecutor(); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 79 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 80 | KryoNamespace masterRouteTableSerializer = KryoNamespace.newBuilder() |
| 81 | .register(RouteTableId.class) |
| 82 | .build(); |
| 83 | |
| 84 | masterRouteTable = storageService.<RouteTableId>setBuilder() |
| 85 | .withName("onos-master-route-table") |
| 86 | .withSerializer(Serializer.using(masterRouteTableSerializer)) |
| 87 | .build() |
| 88 | .asDistributedSet(); |
| 89 | |
| 90 | masterRouteTable.forEach(this::createRouteTable); |
| 91 | |
| 92 | masterRouteTable.addListener(masterRouteTableListener); |
| 93 | |
| 94 | // Add default tables (add is idempotent) |
| 95 | masterRouteTable.add(IPV4); |
| 96 | masterRouteTable.add(IPV6); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 97 | |
| 98 | log.info("Started"); |
| 99 | } |
| 100 | |
| 101 | /** |
| 102 | * Cleans up distributed route store. |
| 103 | */ |
| 104 | public void deactivate() { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 105 | masterRouteTable.removeListener(masterRouteTableListener); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 106 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 107 | routeTables.values().forEach(RouteTable::shutdown); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 108 | |
| 109 | log.info("Stopped"); |
| 110 | } |
| 111 | |
| 112 | @Override |
| 113 | public void updateRoute(Route route) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 114 | getDefaultRouteTable(route).update(route); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | @Override |
| 118 | public void removeRoute(Route route) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 119 | getDefaultRouteTable(route).remove(route); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 120 | } |
| 121 | |
| 122 | @Override |
| 123 | public Set<RouteTableId> getRouteTables() { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 124 | return ImmutableSet.copyOf(masterRouteTable); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 125 | } |
| 126 | |
| 127 | @Override |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 128 | public Collection<RouteSet> getRoutes(RouteTableId table) { |
| 129 | RouteTable routeTable = routeTables.get(table); |
| 130 | if (routeTable == null) { |
| 131 | return Collections.emptySet(); |
| 132 | } else { |
| 133 | return ImmutableSet.copyOf(routeTable.getRoutes()); |
| 134 | } |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 135 | } |
| 136 | |
| 137 | @Override |
| 138 | public Route longestPrefixMatch(IpAddress ip) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 139 | // Not supported |
| 140 | return null; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 141 | } |
| 142 | |
| 143 | @Override |
| 144 | public Collection<Route> getRoutesForNextHop(IpAddress ip) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 145 | return getDefaultRouteTable(ip).getRoutesForNextHop(ip); |
| 146 | } |
| 147 | |
| 148 | @Override |
| 149 | public RouteSet getRoutes(IpPrefix prefix) { |
| 150 | return getDefaultRouteTable(prefix.address()).getRoutes(prefix); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 151 | } |
| 152 | |
| 153 | @Override |
| 154 | public void updateNextHop(IpAddress ip, NextHopData nextHopData) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 155 | // Not supported |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 156 | } |
| 157 | |
| 158 | @Override |
| 159 | public void removeNextHop(IpAddress ip, NextHopData nextHopData) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 160 | // Not supported |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 161 | } |
| 162 | |
| 163 | @Override |
| 164 | public NextHopData getNextHop(IpAddress ip) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 165 | // Not supported |
| 166 | return null; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 167 | } |
| 168 | |
| 169 | @Override |
| 170 | public Map<IpAddress, NextHopData> getNextHops() { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 171 | // Not supported |
| 172 | return Collections.emptyMap(); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 173 | } |
| 174 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 175 | private void createRouteTable(RouteTableId tableId) { |
| 176 | routeTables.computeIfAbsent(tableId, id -> new DefaultRouteTable(id, ourDelegate, storageService)); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 177 | } |
| 178 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 179 | private void destroyRouteTable(RouteTableId tableId) { |
| 180 | RouteTable table = routeTables.remove(tableId); |
| 181 | if (table != null) { |
| 182 | table.destroy(); |
| 183 | } |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 184 | } |
| 185 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 186 | private RouteTable getDefaultRouteTable(Route route) { |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 187 | return getDefaultRouteTable(route.prefix().address()); |
| 188 | } |
| 189 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 190 | private RouteTable getDefaultRouteTable(IpAddress ip) { |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 191 | RouteTableId routeTableId = (ip.isIp4()) ? IPV4 : IPV6; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 192 | return routeTables.getOrDefault(routeTableId, EmptyRouteTable.instance()); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 193 | } |
| 194 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 195 | private class InternalRouteStoreDelegate implements RouteStoreDelegate { |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 196 | @Override |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 197 | public void notify(InternalRouteEvent event) { |
| 198 | executor.execute(() -> DistributedRouteStore.this.notifyDelegate(event)); |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 199 | } |
| 200 | } |
| 201 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 202 | private class MasterRouteTableListener implements SetEventListener<RouteTableId> { |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 203 | @Override |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 204 | public void event(SetEvent<RouteTableId> event) { |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 205 | switch (event.type()) { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame^] | 206 | case ADD: |
| 207 | executor.execute(() -> createRouteTable(event.entry())); |
| 208 | break; |
| 209 | case REMOVE: |
| 210 | executor.execute(() -> destroyRouteTable(event.entry())); |
| 211 | break; |
| 212 | default: |
| 213 | break; |
Charles Chan | 0214ded | 2016-11-18 17:48:37 -0800 | [diff] [blame] | 214 | } |
| 215 | } |
| 216 | } |
| 217 | } |