lib/tun-metadata.h

   1 /*
   2  * Copyright (c) 2015 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 #ifndef TUN_METADATA_H
  18 #define TUN_METADATA_H 1
  19
  20 #include <stdint.h>
  21
  22 #include "openvswitch/dynamic-string.h"
  23 #include "netlink.h"
  24 #include "openvswitch/ofpbuf.h"
  25 #include "openflow/openflow.h"
  26 #include "openvswitch/tun-metadata.h"
  27
  28 struct flow_tnl;
  29 struct match;
  30 struct mf_field;
  31 union mf_value;
  32 struct ofputil_tlv_table_mod;
  33 struct ofputil_tlv_table_reply;
  34 struct tun_table;
  35
  36 struct tun_table *tun_metadata_alloc(const struct tun_table *old_map);
  37 void tun_metadata_free(struct tun_table *);
  38 void tun_metadata_postpone_free(struct tun_table *);
  39
  40 enum ofperr tun_metadata_table_mod(struct ofputil_tlv_table_mod *,
  41                                    const struct tun_table *old_tab,
  42                                    struct tun_table **new_tab);
  43 void tun_metadata_table_request(const struct tun_table *,
  44                                 struct ofputil_tlv_table_reply *);
  45
  46 void tun_metadata_read(const struct flow_tnl *,
  47                        const struct mf_field *, union mf_value *);
  48 void tun_metadata_write(struct flow_tnl *,
  49                         const struct mf_field *, const union mf_value *);
  50 void tun_metadata_delete(struct flow_tnl *, const struct mf_field *);
  51 void tun_metadata_set_match(const struct mf_field *,
  52                             const union mf_value *value,
  53                             const union mf_value *mask, struct match *,
  54                             char **err_str);
  55 void tun_metadata_get_fmd(const struct flow_tnl *, struct match *flow_metadata);
  56
  57 void tun_metadata_from_geneve_nlattr(const struct nlattr *attr, bool is_mask,
  58                                      struct flow_tnl *tun);
  59 void tun_metadata_to_geneve_nlattr(const struct flow_tnl *tun,
  60                                    const struct flow_tnl *flow,
  61                                    const struct ofpbuf *key,
  62                                    struct ofpbuf *);
  63
  64 int tun_metadata_from_geneve_udpif(const struct tun_table *,
  65                                    const struct flow_tnl *flow,
  66                                    const struct flow_tnl *src,
  67                                    struct flow_tnl *dst);
  68 void tun_metadata_to_geneve_udpif_mask(const struct flow_tnl *flow_src,
  69                                        const struct flow_tnl *mask_src,
  70                                        const struct geneve_opt *flow_src_opt,
  71                                        int opts_len, struct geneve_opt *dst);
  72
  73 int tun_metadata_to_geneve_header(const struct flow_tnl *flow,
  74                                   struct geneve_opt *, bool *crit_opt);
  75
  76 void tun_metadata_to_nx_match(struct ofpbuf *b, enum ofp_version oxm,
  77                               const struct match *);
  78 void tun_metadata_match_format(struct ds *, const struct match *);
  79
  80 #endif /* tun-metadata.h */