openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/OFConstants.java

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