lib/ofp-parse.h

   1 /*
   2  * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 #include "openvswitch/types.h"
  27
  28 struct flow;
  29 struct ofpbuf;
  30 struct ofputil_flow_mod;
  31 struct ofputil_flow_monitor_request;
  32 struct ofputil_flow_stats_request;
  33 struct ofputil_group_mod;
  34 struct ofputil_meter_mod;
  35 struct ofputil_table_mod;
  36 struct ofputil_tlv_table_mod;
  37 struct simap;
  38 enum ofputil_protocol;
  39
  40 char *parse_ofp_str(struct ofputil_flow_mod *, int command, const char *str_,
  41                     enum ofputil_protocol *usable_protocols)
  42     OVS_WARN_UNUSED_RESULT;
  43
  44 char *parse_ofp_flow_mod_str(struct ofputil_flow_mod *, const char *string,
  45                              int command,
  46                              enum ofputil_protocol *usable_protocols)
  47     OVS_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                           uint32_t *usable_versions)
  52     OVS_WARN_UNUSED_RESULT;
  53
  54 char *parse_ofp_flow_mod_file(const char *file_name, int command,
  55                               struct ofputil_flow_mod **fms, size_t *n_fms,
  56                               enum ofputil_protocol *usable_protocols)
  57     OVS_WARN_UNUSED_RESULT;
  58
  59 char *parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *,
  60                                        bool aggregate, const char *string,
  61                                        enum ofputil_protocol *usable_protocols)
  62     OVS_WARN_UNUSED_RESULT;
  63
  64 char *parse_ofp_exact_flow(struct flow *flow, struct flow *mask, const char *s,
  65                            const struct simap *portno_names);
  66
  67 char *parse_ofp_meter_mod_str(struct ofputil_meter_mod *, const char *string,
  68                               int command,
  69                               enum ofputil_protocol *usable_protocols)
  70     OVS_WARN_UNUSED_RESULT;
  71
  72 char *parse_flow_monitor_request(struct ofputil_flow_monitor_request *,
  73                                  const char *,
  74                                  enum ofputil_protocol *usable_protocols)
  75     OVS_WARN_UNUSED_RESULT;
  76
  77 char *parse_ofp_group_mod_file(const char *file_name, uint16_t command,
  78                                struct ofputil_group_mod **gms, size_t *n_gms,
  79                                enum ofputil_protocol *usable_protocols)
  80     OVS_WARN_UNUSED_RESULT;
  81
  82 char *parse_ofp_group_mod_str(struct ofputil_group_mod *, uint16_t command,
  83                               const char *string,
  84                               enum ofputil_protocol *usable_protocols)
  85     OVS_WARN_UNUSED_RESULT;
  86
  87 char *parse_ofp_tlv_table_mod_str(struct ofputil_tlv_table_mod *,
  88                                      uint16_t command, const char *string,
  89                                      enum ofputil_protocol *usable_protocols)
  90     OVS_WARN_UNUSED_RESULT;
  91
  92 char *str_to_u8(const char *str, const char *name, uint8_t *valuep)
  93     OVS_WARN_UNUSED_RESULT;
  94 char *str_to_u16(const char *str, const char *name, uint16_t *valuep)
  95     OVS_WARN_UNUSED_RESULT;
  96 char *str_to_u32(const char *str, uint32_t *valuep) OVS_WARN_UNUSED_RESULT;
  97 char *str_to_u64(const char *str, uint64_t *valuep) OVS_WARN_UNUSED_RESULT;
  98 char *str_to_be64(const char *str, ovs_be64 *valuep) OVS_WARN_UNUSED_RESULT;
  99 char *str_to_mac(const char *str, struct eth_addr *mac) OVS_WARN_UNUSED_RESULT;
 100 char *str_to_ip(const char *str, ovs_be32 *ip) OVS_WARN_UNUSED_RESULT;
 101 char *str_to_connhelper(const char *str, uint16_t *alg) OVS_WARN_UNUSED_RESULT;
 102 char *parse_ofp_table_vacancy(struct ofputil_table_mod *,
 103                               const char *flow_miss_handling)
 104     OVS_WARN_UNUSED_RESULT;
 105
 106 #endif /* ofp-parse.h */