lib/ofp-parse.h

   1 /*
   2  * Copyright (c) 2010, 2011, 2012, 2013 Nicira, Inc.
   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 /* OpenFlow protocol string to flow parser. */
  18
  19 #ifndef OFP_PARSE_H
  20 #define OFP_PARSE_H 1
  21
  22 #include <stdbool.h>
  23 #include <stdint.h>
  24 #include <stdio.h>
  25 #include "compiler.h"
  26
  27 struct flow;
  28 struct ofpbuf;
  29 struct ofputil_flow_mod;
  30 struct ofputil_flow_monitor_request;
  31 struct ofputil_flow_stats_request;
  32 struct ofputil_group_mod;
  33 struct ofputil_meter_mod;
  34 struct ofputil_table_mod;
  35 struct simap;
  36 enum ofputil_protocol;
  37
  38 char *parse_ofp_str(struct ofputil_flow_mod *, int command, const char *str_,
  39                     enum ofputil_protocol *usable_protocols,
  40                     bool enforce_consistency)
  41     WARN_UNUSED_RESULT;
  42
  43 char *parse_ofp_flow_mod_str(struct ofputil_flow_mod *, const char *string,
  44                              uint16_t command,
  45                              enum ofputil_protocol *usable_protocols,
  46                              bool enforce_consistency)
  47     WARN_UNUSED_RESULT;
  48
  49 char *parse_ofp_table_mod(struct ofputil_table_mod *,
  50                           const char *table_id, const char *flow_miss_handling,
  51                           enum ofputil_protocol *usable_protocols)
  52     WARN_UNUSED_RESULT;
  53
  54 char *parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
  55                               struct ofputil_flow_mod **fms, size_t *n_fms,
  56                               enum ofputil_protocol *usable_protocols,
  57                               bool enforce_consistency)
  58     WARN_UNUSED_RESULT;
  59
  60 char *parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *,
  61                                        bool aggregate, const char *string,
  62                                        enum ofputil_protocol *usable_protocols,
  63                                        bool enforce_consistency)
  64     WARN_UNUSED_RESULT;
  65
  66 char *parse_ofpacts(const char *, struct ofpbuf *ofpacts,
  67                     enum ofputil_protocol *usable_protocols)
  68     WARN_UNUSED_RESULT;
  69
  70 char *parse_ofp_exact_flow(struct flow *flow, struct flow *mask, const char *s,
  71                            const struct simap *portno_names);
  72
  73 char *parse_ofp_meter_mod_str(struct ofputil_meter_mod *, const char *string,
  74                               int command,
  75                               enum ofputil_protocol *usable_protocols)
  76     WARN_UNUSED_RESULT;
  77
  78 char *parse_flow_monitor_request(struct ofputil_flow_monitor_request *,
  79                                  const char *,
  80                                  enum ofputil_protocol *usable_protocols)
  81     WARN_UNUSED_RESULT;
  82
  83 char *parse_ofp_group_mod_file(const char *file_name, uint16_t command,
  84                                struct ofputil_group_mod **gms, size_t *n_gms,
  85                                enum ofputil_protocol *usable_protocols)
  86     WARN_UNUSED_RESULT;
  87
  88 char *parse_ofp_group_mod_str(struct ofputil_group_mod *, uint16_t command,
  89                               const char *string,
  90                               enum ofputil_protocol *usable_protocols)
  91     WARN_UNUSED_RESULT;
  92
  93 #endif /* ofp-parse.h */