2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.openflowplugin.impl.statistics.services;
10 import com.google.common.base.Function;
11 import com.google.common.base.MoreObjects;
12 import com.google.common.util.concurrent.Futures;
13 import com.google.common.util.concurrent.JdkFutureAdapters;
14 import com.google.common.util.concurrent.ListenableFuture;
16 import java.io.Serializable;
17 import java.math.BigInteger;
18 import java.util.ArrayList;
19 import java.util.List;
20 import java.util.Objects;
21 import java.util.concurrent.Future;
22 import org.opendaylight.openflowplugin.api.OFConstants;
23 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
24 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
25 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
26 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
27 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
28 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
29 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
30 import org.opendaylight.openflowplugin.impl.services.CommonService;
31 import org.opendaylight.openflowplugin.impl.services.DataCrate;
32 import org.opendaylight.openflowplugin.impl.services.OFJResult2RequestCtxFuture;
33 import org.opendaylight.openflowplugin.impl.services.RequestInputUtils;
34 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.match.MatchReactor;
35 import org.opendaylight.openflowplugin.openflow.md.util.FlowCreatorUtil;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.AggregateFlowStatisticsUpdate;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAggregateFlowStatisticsFromFlowTableForAllFlowsInput;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAggregateFlowStatisticsFromFlowTableForGivenMatchInput;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutput;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutputBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAllFlowStatisticsFromFlowTableInput;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAllFlowStatisticsFromFlowTableOutput;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAllFlowsStatisticsFromAllFlowTablesInput;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAllFlowsStatisticsFromAllFlowTablesOutput;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetFlowStatisticsFromFlowTableInput;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetFlowStatisticsFromFlowTableOutput;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.OpendaylightFlowStatisticsService;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.get.aggregate.flow.statistics.from.flow.table._for.given.match.output.AggregatedFlowStatistics;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInputBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketIn;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyAggregateCase;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestAggregateCaseBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestFlowCaseBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.aggregate._case.MultipartRequestAggregateBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.flow._case.MultipartRequestFlowBuilder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
63 import org.opendaylight.yangtools.yang.common.RpcError;
64 import org.opendaylight.yangtools.yang.common.RpcResult;
65 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
66 import org.slf4j.Logger;
67 import org.slf4j.LoggerFactory;
69 import javax.annotation.Nullable;
74 public class OpendaylightFlowStatisticsServiceImpl extends CommonService implements OpendaylightFlowStatisticsService {
76 private static final Logger LOG = LoggerFactory.getLogger(OpendaylightFlowStatisticsServiceImpl.class);
78 public OpendaylightFlowStatisticsServiceImpl(final RequestContextStack requestContextStack, DeviceContext deviceContext) {
79 super(requestContextStack, deviceContext);
83 public Future<RpcResult<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput>> getAggregateFlowStatisticsFromFlowTableForAllFlows(
84 final GetAggregateFlowStatisticsFromFlowTableForAllFlowsInput input) {
87 return this.<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput, Void>handleServiceCall(
89 new Function<DataCrate<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput>, ListenableFuture<RpcResult<Void>>>() {
92 public ListenableFuture<RpcResult<Void>> apply(final DataCrate<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput> data) {
94 // Create multipart request body for fetch all the group stats
95 final MultipartRequestAggregateCaseBuilder multipartRequestAggregateCaseBuilder = new MultipartRequestAggregateCaseBuilder();
96 final MultipartRequestAggregateBuilder mprAggregateRequestBuilder = new MultipartRequestAggregateBuilder();
97 mprAggregateRequestBuilder.setTableId(input.getTableId().getValue());
98 mprAggregateRequestBuilder.setOutPort(OFConstants.OFPP_ANY);
99 mprAggregateRequestBuilder.setOutGroup(OFConstants.OFPG_ANY);
100 mprAggregateRequestBuilder.setCookie(OFConstants.DEFAULT_COOKIE);
101 mprAggregateRequestBuilder.setCookieMask(OFConstants.DEFAULT_COOKIE_MASK);
103 FlowCreatorUtil.setWildcardedFlowMatch(version, mprAggregateRequestBuilder);
105 // Set request body to main multipart request
106 multipartRequestAggregateCaseBuilder.setMultipartRequestAggregate(mprAggregateRequestBuilder
108 final Xid xid = data.getRequestContext().getXid();
109 final MultipartRequestInputBuilder mprInput = RequestInputUtils.createMultipartHeader(
110 MultipartType.OFPMPAGGREGATE, xid.getValue(), version);
112 mprInput.setMultipartRequestBody(multipartRequestAggregateCaseBuilder.build());
114 final Future<RpcResult<Void>> resultFromOFLib = deviceContext.getPrimaryConnectionContext()
115 .getConnectionAdapter().multipartRequest(mprInput.build());
117 return JdkFutureAdapters.listenInPoolThread(resultFromOFLib);
124 public Future<RpcResult<GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutput>> getAggregateFlowStatisticsFromFlowTableForGivenMatch(
125 final GetAggregateFlowStatisticsFromFlowTableForGivenMatchInput input) {
128 ListenableFuture<RpcResult<List<MultipartReply>>> rpcResultListenableFuture = handleServiceCall(
130 new Function<DataCrate<List<MultipartReply>>, ListenableFuture<RpcResult<Void>>>() {
133 public ListenableFuture<RpcResult<Void>> apply(final DataCrate<List<MultipartReply>> data) {
134 final Xid xid = data.getRequestContext().getXid();
135 deviceContext.getOpenflowMessageListenerFacade().registerMultipartXid(xid.getValue());
136 final MultipartRequestAggregateCaseBuilder multipartRequestAggregateCaseBuilder = new MultipartRequestAggregateCaseBuilder();
137 final MultipartRequestAggregateBuilder mprAggregateRequestBuilder = new MultipartRequestAggregateBuilder();
138 final short tableId = MoreObjects.firstNonNull(input.getTableId(), OFConstants.OFPTT_ALL).shortValue();
139 mprAggregateRequestBuilder.setTableId(tableId);
140 long outputPortValue = MoreObjects.firstNonNull(input.getOutPort(), OFConstants.OFPP_ANY).longValue();
141 mprAggregateRequestBuilder.setOutPort(outputPortValue);
142 // TODO: repeating code
143 if (version == OFConstants.OFP_VERSION_1_3) {
145 if (input.getCookie() == null) {
146 mprAggregateRequestBuilder.setCookie(OFConstants.DEFAULT_COOKIE);
148 mprAggregateRequestBuilder.setCookie(MoreObjects.firstNonNull(input.getCookie().getValue(), OFConstants.DEFAULT_COOKIE));
151 if (input.getCookieMask() == null) {
152 mprAggregateRequestBuilder.setCookieMask(OFConstants.DEFAULT_COOKIE_MASK);
154 mprAggregateRequestBuilder.setCookieMask(MoreObjects.firstNonNull(input.getCookieMask().getValue(), OFConstants.DEFAULT_COOKIE_MASK));
156 long outGroup = MoreObjects.firstNonNull(input.getOutGroup(), OFConstants.OFPG_ANY).longValue();
157 mprAggregateRequestBuilder.setOutGroup(outGroup);
159 mprAggregateRequestBuilder.setOutGroup(OFConstants.OFPG_ANY);
160 mprAggregateRequestBuilder.setCookie(OFConstants.DEFAULT_COOKIE);
161 mprAggregateRequestBuilder.setCookieMask(OFConstants.DEFAULT_COOKIE_MASK);
164 MatchReactor.getInstance().convert(input.getMatch(), version, mprAggregateRequestBuilder,
165 deviceContext.getPrimaryConnectionContext().getFeatures().getDatapathId());
167 FlowCreatorUtil.setWildcardedFlowMatch(version, mprAggregateRequestBuilder);
169 // Set request body to main multipart request
170 multipartRequestAggregateCaseBuilder.setMultipartRequestAggregate(mprAggregateRequestBuilder
173 final MultipartRequestInputBuilder mprInput = RequestInputUtils.createMultipartHeader(
174 MultipartType.OFPMPAGGREGATE, xid.getValue(), version);
176 mprInput.setMultipartRequestBody(multipartRequestAggregateCaseBuilder.build());
177 final Future<RpcResult<Void>> resultFromOFLib = deviceContext.getPrimaryConnectionContext()
178 .getConnectionAdapter().multipartRequest(mprInput.build());
179 return JdkFutureAdapters.listenInPoolThread(resultFromOFLib);
183 return Futures.transform(rpcResultListenableFuture, new Function<RpcResult<List<MultipartReply>>, RpcResult<GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutput>>() {
186 public RpcResult<GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutput> apply(RpcResult<List<MultipartReply>> input) {
187 TranslatorLibrary translatorLibrary = deviceContext.oook();
188 RpcResult<GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutput> rpcResult;
189 if(input.isSuccessful()) {
190 MultipartReply reply = input.getResult().get(0);
191 final TranslatorKey translatorKey = new TranslatorKey(reply.getVersion(), MultipartReplyAggregateCase.class.getName());
192 final MessageTranslator<MultipartReply, AggregatedFlowStatistics> messageTranslator = translatorLibrary.lookupTranslator(translatorKey);
193 List<AggregatedFlowStatistics> aggregStats = new ArrayList<AggregatedFlowStatistics>();
195 for (MultipartReply multipartReply : input.getResult()) {
196 aggregStats.add(messageTranslator.translate(multipartReply, deviceContext, null));
199 GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutputBuilder getAggregateFlowStatisticsFromFlowTableForGivenMatchOutputBuilder =
200 new GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutputBuilder();
201 getAggregateFlowStatisticsFromFlowTableForGivenMatchOutputBuilder.setAggregatedFlowStatistics(aggregStats);
203 rpcResult = RpcResultBuilder
204 .<GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutput>success()
205 .withResult(getAggregateFlowStatisticsFromFlowTableForGivenMatchOutputBuilder.build())
209 rpcResult = RpcResultBuilder
210 .<GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutput>failed()
211 .withRpcErrors(input.getErrors())
221 public Future<RpcResult<GetAllFlowStatisticsFromFlowTableOutput>> getAllFlowStatisticsFromFlowTable(
222 final GetAllFlowStatisticsFromFlowTableInput input) {
224 return this.<GetAllFlowStatisticsFromFlowTableOutput, Void>handleServiceCall(PRIMARY_CONNECTION,
225 new Function<DataCrate<GetAllFlowStatisticsFromFlowTableOutput>, ListenableFuture<RpcResult<Void>>>() {
228 public ListenableFuture<RpcResult<Void>> apply(final DataCrate<GetAllFlowStatisticsFromFlowTableOutput> data) {
230 final MultipartRequestFlowBuilder mprFlowRequestBuilder = new MultipartRequestFlowBuilder();
231 mprFlowRequestBuilder.setTableId(input.getTableId().getValue());
232 mprFlowRequestBuilder.setOutPort(OFConstants.OFPP_ANY);
233 mprFlowRequestBuilder.setOutGroup(OFConstants.OFPG_ANY);
234 mprFlowRequestBuilder.setCookie(OFConstants.DEFAULT_COOKIE);
235 mprFlowRequestBuilder.setCookieMask(OFConstants.DEFAULT_COOKIE_MASK);
236 FlowCreatorUtil.setWildcardedFlowMatch(version, mprFlowRequestBuilder);
238 final MultipartRequestFlowCaseBuilder multipartRequestFlowCaseBuilder = new MultipartRequestFlowCaseBuilder();
239 multipartRequestFlowCaseBuilder.setMultipartRequestFlow(mprFlowRequestBuilder.build());
241 final Xid xid = data.getRequestContext().getXid();
242 final MultipartRequestInputBuilder mprInput = RequestInputUtils.createMultipartHeader(
243 MultipartType.OFPMPFLOW, xid.getValue(), version);
245 mprInput.setMultipartRequestBody(multipartRequestFlowCaseBuilder.build());
246 final Future<RpcResult<Void>> resultFromOFLib = deviceContext.getPrimaryConnectionContext()
247 .getConnectionAdapter().multipartRequest(mprInput.build());
248 return JdkFutureAdapters.listenInPoolThread(resultFromOFLib);
254 public Future<RpcResult<GetAllFlowsStatisticsFromAllFlowTablesOutput>> getAllFlowsStatisticsFromAllFlowTables(
255 final GetAllFlowsStatisticsFromAllFlowTablesInput input) {
258 return this.<GetAllFlowsStatisticsFromAllFlowTablesOutput, Void>handleServiceCall(PRIMARY_CONNECTION,
259 new Function<DataCrate<GetAllFlowsStatisticsFromAllFlowTablesOutput>, ListenableFuture<RpcResult<Void>>>() {
262 public ListenableFuture<RpcResult<Void>> apply(final DataCrate<GetAllFlowsStatisticsFromAllFlowTablesOutput> data) {
264 final MultipartRequestFlowCaseBuilder multipartRequestFlowCaseBuilder = new MultipartRequestFlowCaseBuilder();
265 final MultipartRequestFlowBuilder mprFlowRequestBuilder = new MultipartRequestFlowBuilder();
266 mprFlowRequestBuilder.setTableId(OFConstants.OFPTT_ALL);
267 mprFlowRequestBuilder.setOutPort(OFConstants.OFPP_ANY);
268 mprFlowRequestBuilder.setOutGroup(OFConstants.OFPG_ANY);
269 mprFlowRequestBuilder.setCookie(OFConstants.DEFAULT_COOKIE);
270 mprFlowRequestBuilder.setCookieMask(OFConstants.DEFAULT_COOKIE_MASK);
271 FlowCreatorUtil.setWildcardedFlowMatch(version, mprFlowRequestBuilder);
273 final Xid xid = data.getRequestContext().getXid();
274 final MultipartRequestInputBuilder mprInput = RequestInputUtils.createMultipartHeader(
275 MultipartType.OFPMPFLOW, xid.getValue(), version);
277 multipartRequestFlowCaseBuilder.setMultipartRequestFlow(mprFlowRequestBuilder.build());
278 mprInput.setMultipartRequestBody(multipartRequestFlowCaseBuilder.build());
279 final Future<RpcResult<Void>> resultFromOFLib = deviceContext.getPrimaryConnectionContext()
280 .getConnectionAdapter().multipartRequest(mprInput.build());
281 return JdkFutureAdapters.listenInPoolThread(resultFromOFLib);
287 public Future<RpcResult<GetFlowStatisticsFromFlowTableOutput>> getFlowStatisticsFromFlowTable(
288 final GetFlowStatisticsFromFlowTableInput input) {
291 return this.<GetFlowStatisticsFromFlowTableOutput, Void>handleServiceCall(PRIMARY_CONNECTION,
292 new Function<DataCrate<GetFlowStatisticsFromFlowTableOutput>, ListenableFuture<RpcResult<Void>>>() {
295 public ListenableFuture<RpcResult<Void>> apply(final DataCrate<GetFlowStatisticsFromFlowTableOutput> data) {
297 final MultipartRequestFlowCaseBuilder multipartRequestFlowCaseBuilder = new MultipartRequestFlowCaseBuilder();
298 final MultipartRequestFlowBuilder mprFlowRequestBuilder = new MultipartRequestFlowBuilder();
299 mprFlowRequestBuilder.setTableId(input.getTableId());
301 if (input.getOutPort() != null) {
302 mprFlowRequestBuilder.setOutPort(input.getOutPort().longValue());
304 mprFlowRequestBuilder.setOutPort(OFConstants.OFPP_ANY);
307 if (input.getOutGroup() != null) {
308 mprFlowRequestBuilder.setOutGroup(input.getOutGroup());
310 mprFlowRequestBuilder.setOutGroup(OFConstants.OFPG_ANY);
313 if (input.getCookie() != null) {
314 mprFlowRequestBuilder.setCookie(input.getCookie().getValue());
316 mprFlowRequestBuilder.setCookie(OFConstants.DEFAULT_COOKIE);
319 if (input.getCookieMask() != null) {
320 mprFlowRequestBuilder.setCookieMask(input.getCookieMask().getValue());
322 mprFlowRequestBuilder.setCookieMask(OFConstants.DEFAULT_COOKIE_MASK);
325 // convert and inject match
326 MatchReactor.getInstance().convert(input.getMatch(), version, mprFlowRequestBuilder,
327 deviceContext.getPrimaryConnectionContext().getFeatures().getDatapathId());
329 // Set request body to main multipart request
330 final Xid xid = data.getRequestContext().getXid();
331 multipartRequestFlowCaseBuilder.setMultipartRequestFlow(mprFlowRequestBuilder.build());
332 final MultipartRequestInputBuilder mprInput = RequestInputUtils.createMultipartHeader(
333 MultipartType.OFPMPFLOW, xid.getValue(), version);
334 mprInput.setMultipartRequestBody(multipartRequestFlowCaseBuilder.build());
335 final Future<RpcResult<Void>> resultFromOFLib = deviceContext.getPrimaryConnectionContext()
336 .getConnectionAdapter().multipartRequest(mprInput.build());
337 return JdkFutureAdapters.listenInPoolThread(resultFromOFLib);
342 private <T> void convertRpcResultToRequestFuture(final RequestContext<T> requestContext,
343 final ListenableFuture<RpcResult<Void>> futureResultFromOfLib) {
344 final OFJResult2RequestCtxFuture<T> OFJResult2RequestCtxFuture = new OFJResult2RequestCtxFuture<>(requestContext, deviceContext);
345 OFJResult2RequestCtxFuture.processResultFromOfJava(futureResultFromOfLib);