Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [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 | bfc5c48 | 2016-04-05 18:57:00 -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 | */ |
Ray Milkey | 69ec871 | 2017-08-08 13:00:43 -0700 | [diff] [blame] | 16 | package org.onosproject.routeservice.cli; |
Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [diff] [blame] | 17 | |
Jonathan Hart | b211134 | 2016-04-20 16:57:37 -0700 | [diff] [blame] | 18 | import com.fasterxml.jackson.databind.JsonNode; |
| 19 | import com.fasterxml.jackson.databind.ObjectMapper; |
| 20 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 21 | import com.fasterxml.jackson.databind.node.ObjectNode; |
Ray Milkey | 86ad7bb | 2018-09-27 12:32:28 -0700 | [diff] [blame] | 22 | import org.apache.karaf.shell.api.action.Command; |
Ray Milkey | 7a2dee5 | 2018-09-28 10:58:28 -0700 | [diff] [blame] | 23 | import org.apache.karaf.shell.api.action.lifecycle.Service; |
Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [diff] [blame] | 24 | import org.onosproject.cli.AbstractShellCommand; |
Ray Milkey | 69ec871 | 2017-08-08 13:00:43 -0700 | [diff] [blame] | 25 | import org.onosproject.routeservice.ResolvedRoute; |
Seyeon Jeong | 8d3cad2 | 2020-02-28 01:17:34 -0800 | [diff] [blame] | 26 | import org.onosproject.routeservice.Route; |
Ray Milkey | 69ec871 | 2017-08-08 13:00:43 -0700 | [diff] [blame] | 27 | import org.onosproject.routeservice.RouteInfo; |
| 28 | import org.onosproject.routeservice.RouteService; |
| 29 | import org.onosproject.routeservice.RouteTableId; |
Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [diff] [blame] | 30 | |
| 31 | import java.util.Collection; |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 32 | import java.util.Comparator; |
| 33 | import java.util.Objects; |
| 34 | import java.util.Optional; |
Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [diff] [blame] | 35 | |
| 36 | /** |
| 37 | * Command to show the routes in the routing tables. |
| 38 | */ |
Ray Milkey | 7a2dee5 | 2018-09-28 10:58:28 -0700 | [diff] [blame] | 39 | @Service |
Jonathan Hart | 92ca5d3 | 2016-04-14 18:05:52 -0700 | [diff] [blame] | 40 | @Command(scope = "onos", name = "routes", |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 41 | description = "Lists routes in the route store") |
Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [diff] [blame] | 42 | public class RoutesListCommand extends AbstractShellCommand { |
| 43 | |
Charles Chan | 92ca94d | 2017-03-17 18:05:22 -0700 | [diff] [blame] | 44 | private static final String NETWORK = "Network"; |
| 45 | private static final String NEXTHOP = "Next Hop"; |
| 46 | private static final String SOURCE = "Source"; |
Jonathan Hart | 10dbafd | 2017-05-18 15:53:03 -0700 | [diff] [blame] | 47 | private static final String NODE = "Node"; |
Charles Chan | 92ca94d | 2017-03-17 18:05:22 -0700 | [diff] [blame] | 48 | |
Charles Chan | 32a31aa | 2018-04-11 11:10:42 -0400 | [diff] [blame] | 49 | private static final String FORMAT_ROUTE = "%-1s %-1s %-18s %-15s %s (%s)"; |
| 50 | private static final String FORMAT_ROUTE6 = "%-1s %-1s %-43s %-39s %s (%s)"; |
Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [diff] [blame] | 51 | |
| 52 | private static final String FORMAT_TABLE = "Table: %s"; |
| 53 | private static final String FORMAT_TOTAL = " Total: %d"; |
| 54 | |
| 55 | @Override |
Ray Milkey | 86ad7bb | 2018-09-27 12:32:28 -0700 | [diff] [blame] | 56 | protected void doExecute() { |
Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [diff] [blame] | 57 | RouteService service = AbstractShellCommand.get(RouteService.class); |
| 58 | |
Jonathan Hart | b211134 | 2016-04-20 16:57:37 -0700 | [diff] [blame] | 59 | if (outputJson()) { |
| 60 | ObjectMapper mapper = new ObjectMapper(); |
| 61 | ObjectNode result = mapper.createObjectNode(); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 62 | result.set("routes4", json(service.getRoutes(new RouteTableId("ipv4")))); |
| 63 | result.set("routes6", json(service.getRoutes(new RouteTableId("ipv6")))); |
Jonathan Hart | b211134 | 2016-04-20 16:57:37 -0700 | [diff] [blame] | 64 | print("%s", result); |
| 65 | } else { |
Charles Chan | 32a31aa | 2018-04-11 11:10:42 -0400 | [diff] [blame] | 66 | print("B: Best route, R: Resolved route\n"); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 67 | service.getRouteTables().forEach(id -> { |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 68 | Collection<RouteInfo> tableRoutes = service.getRoutes(id); |
| 69 | |
Charles Chan | 92ca94d | 2017-03-17 18:05:22 -0700 | [diff] [blame] | 70 | String format = tableRoutes.stream().anyMatch(route -> route.prefix().isIp6()) ? |
| 71 | FORMAT_ROUTE6 : FORMAT_ROUTE; |
| 72 | |
| 73 | // Print header |
| 74 | print(FORMAT_TABLE, id); |
Charles Chan | 32a31aa | 2018-04-11 11:10:42 -0400 | [diff] [blame] | 75 | print(format, "B", "R", NETWORK, NEXTHOP, SOURCE, NODE); |
Charles Chan | 92ca94d | 2017-03-17 18:05:22 -0700 | [diff] [blame] | 76 | |
| 77 | // Print routing entries |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 78 | tableRoutes.stream() |
| 79 | .sorted(Comparator.comparing(r -> r.prefix().address())) |
Charles Chan | 92ca94d | 2017-03-17 18:05:22 -0700 | [diff] [blame] | 80 | .forEach(route -> this.print(format, route)); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 81 | |
| 82 | print(FORMAT_TOTAL, tableRoutes.size()); |
Jonathan Hart | b211134 | 2016-04-20 16:57:37 -0700 | [diff] [blame] | 83 | print(""); |
| 84 | }); |
| 85 | } |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 86 | } |
Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [diff] [blame] | 87 | |
Charles Chan | 92ca94d | 2017-03-17 18:05:22 -0700 | [diff] [blame] | 88 | private void print(String format, RouteInfo routeInfo) { |
Jonathan Hart | 58ea8f2 | 2017-05-08 15:09:31 -0700 | [diff] [blame] | 89 | routeInfo.allRoutes().stream() |
Charles Chan | 32a31aa | 2018-04-11 11:10:42 -0400 | [diff] [blame] | 90 | .sorted(Comparator.comparing(ResolvedRoute::nextHop)) |
| 91 | .forEach(r -> print(format, |
| 92 | isBestRoute(routeInfo.bestRoute(), r) ? ">" : "", |
| 93 | isResolvedRoute(r) ? "*" : "", |
Jonathan Hart | 10dbafd | 2017-05-18 15:53:03 -0700 | [diff] [blame] | 94 | r.prefix(), r.nextHop(), r.route().source(), r.route().sourceNode())); |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 95 | } |
| 96 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 97 | private boolean isBestRoute(Optional<ResolvedRoute> bestRoute, ResolvedRoute route) { |
| 98 | return Objects.equals(bestRoute.orElse(null), route); |
Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [diff] [blame] | 99 | } |
| 100 | |
Charles Chan | 32a31aa | 2018-04-11 11:10:42 -0400 | [diff] [blame] | 101 | private boolean isResolvedRoute(ResolvedRoute route) { |
| 102 | return route.nextHopMac() != null && route.nextHopVlan() != null; |
| 103 | } |
| 104 | |
Jonathan Hart | b211134 | 2016-04-20 16:57:37 -0700 | [diff] [blame] | 105 | /** |
| 106 | * Produces a JSON array of routes. |
| 107 | * |
| 108 | * @param routes the routes with the data |
| 109 | * @return JSON array with the routes |
| 110 | */ |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 111 | private JsonNode json(Collection<RouteInfo> routes) { |
Jonathan Hart | b211134 | 2016-04-20 16:57:37 -0700 | [diff] [blame] | 112 | ObjectMapper mapper = new ObjectMapper(); |
| 113 | ArrayNode result = mapper.createArrayNode(); |
| 114 | |
Jonathan Hart | 96c146b | 2017-02-24 16:32:00 -0800 | [diff] [blame] | 115 | routes.stream() |
| 116 | .flatMap(ri -> ri.allRoutes().stream()) |
Seyeon Jeong | 8d3cad2 | 2020-02-28 01:17:34 -0800 | [diff] [blame] | 117 | .forEach(r -> { |
| 118 | // use RouteCodec to encode the Route object inside ResolvedRoute |
| 119 | ObjectNode routeNode = jsonForEntity(r.route(), Route.class); |
| 120 | if (r.nextHopMac() != null) { |
| 121 | routeNode.put("nextHopMac", r.nextHopMac().toString()); |
| 122 | } |
| 123 | if (r.nextHopVlan() != null) { |
| 124 | routeNode.put("nextHopVlan", r.nextHopVlan().toString()); |
| 125 | } |
| 126 | result.add(routeNode); |
| 127 | }); |
Jonathan Hart | b211134 | 2016-04-20 16:57:37 -0700 | [diff] [blame] | 128 | |
| 129 | return result; |
| 130 | } |
| 131 | |
Jonathan Hart | bfc5c48 | 2016-04-05 18:57:00 -0700 | [diff] [blame] | 132 | } |