2 * Copyright (c) 2013 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.api;
10 import java.util.List;
11 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie;
12 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Match;
13 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
14 import org.opendaylight.yangtools.yang.common.Uint16;
15 import org.opendaylight.yangtools.yang.common.Uint32;
16 import org.opendaylight.yangtools.yang.common.Uint64;
17 import org.opendaylight.yangtools.yang.common.Uint8;
20 * OFP related constants.
22 public final class OFConstants {
24 private OFConstants() {
25 throw new UnsupportedOperationException("OF plugin Constants holder class");
28 /** enum ofp_port_no, reserved port: process with normal L2/L3 switching. */
29 public static final short OFPP_NORMAL = (short)0xfffa;
30 /** enum ofp_port_no, reserved port: all physical ports except input port. */
31 public static final short OFPP_ALL = (short)0xfffc;
32 /** enum ofp_port_no, reserved port: local openflow port. */
33 public static final short OFPP_LOCAL = (short)0xfffe;
35 /** openflow protocol 1.0 - version identifier. */
36 public static final Uint8 OFP_VERSION_1_0 = Uint8.ONE;
37 /** openflow protocol 1.3 - version identifier. */
38 public static final Uint8 OFP_VERSION_1_3 = Uint8.valueOf(0x04);
40 public static final String OF_URI_PREFIX = "openflow:";
42 /** enum ofp_table: Table numbering, wildcard table used for table config, flow stats and flow deletes. */
43 public static final Uint8 OFPTT_ALL = Uint8.MAX_VALUE;
44 public static final Uint32 ANY = Uint32.MAX_VALUE;
45 /** Wildcard port used only for flow mod (delete) and flow stats requests. Selects
46 * all flows regardless of output port (including flows with no output port).*/
47 public static final Uint32 OFPP_ANY = ANY;
48 /** enum ofp_group: For OFPFC_DELETE* commands, require matching entries to include this as an
49 * output group. A value of OFPG_ANY indicates no restriction. */
50 public static final Uint32 OFPG_ANY = ANY;
51 /** enum ofp_group: Represents all groups for group delete commands. */
52 public static final Uint32 OFPG_ALL = Uint32.valueOf(0xfffffffcL).intern();
53 /** Refers to all queues configured at the specified port. */
54 public static final Uint32 OFPQ_ALL = ANY;
55 /** Represents all meters for stat requests commands. */
56 public static final Uint32 OFPM_ALL = ANY;
57 /** Default cookie. */
58 public static final Uint64 DEFAULT_COOKIE = Uint64.ZERO;
59 public static final Uint64 DEFAULT_COOKIE_MASK = Uint64.ZERO;
60 public static final FlowCookie DEFAULT_FLOW_COOKIE = new FlowCookie(DEFAULT_COOKIE);
61 public static final Uint16 DEFAULT_FLOW_PRIORITY = Uint16.valueOf(0x8000).intern();
62 /** Empty flow match. */
63 public static final Match EMPTY_MATCH = new MatchBuilder().build();
65 /** indicates that no buffering should be applied and the whole packet is to be
66 * sent to the controller. */
67 public static final Uint32 OFP_NO_BUFFER = Uint32.valueOf(0xffffffffL).intern();
68 /** enum ofp_controller_max_len: indicates that no buffering should be applied and the whole packet is to be
69 * sent to the controller. */
70 public static final Uint16 OFPCML_NO_BUFFER = Uint16.MAX_VALUE;
72 public static final int MAC_ADDRESS_LENGTH = 6;
73 public static final int SIGNUM_UNSIGNED = 1;
75 /** RpcError application tag. */
76 public static final String APPLICATION_TAG = "OPENFLOW_PLUGIN";
77 /** RpcError tag - timeout. */
78 public static final String ERROR_TAG_TIMEOUT = "TIMOUT";
80 /** Persistent ID of OpenFlowPlugin configuration file. */
81 public static final String CONFIG_FILE_ID = "org.opendaylight.openflowplugin";
83 /** supported version ordered by height (highest version is at the beginning). */
84 public static final List<Uint8> VERSION_ORDER = List.of(OFP_VERSION_1_3, OFP_VERSION_1_0);