lib/learn.h

   1 /*
   2  * Copyright (c) 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 #ifndef LEARN_H
  18 #define LEARN_H 1
  19
  20 #include "compiler.h"
  21 #include "ofp-errors.h"
  22
  23 struct ds;
  24 struct flow;
  25 struct flow_wildcards;
  26 struct ofpbuf;
  27 struct ofpact_learn;
  28 struct ofputil_flow_mod;
  29 struct nx_action_learn;
  30
  31 /* NXAST_LEARN helper functions.
  32  *
  33  * See include/openflow/nicira-ext.h for NXAST_LEARN specification.
  34  */
  35
  36 enum ofperr learn_from_openflow(const struct nx_action_learn *,
  37                                 struct ofpbuf *ofpacts);
  38 enum ofperr learn_check(const struct ofpact_learn *, const struct flow *);
  39 void learn_to_nxast(const struct ofpact_learn *, struct ofpbuf *openflow);
  40
  41 void learn_execute(const struct ofpact_learn *, const struct flow *,
  42                    struct ofputil_flow_mod *, struct ofpbuf *ofpacts);
  43 void learn_mask(const struct ofpact_learn *, struct flow_wildcards *);
  44
  45 char *learn_parse(char *, struct ofpbuf *ofpacts) WARN_UNUSED_RESULT;
  46 void learn_format(const struct ofpact_learn *, struct ds *);
  47
  48 #endif /* learn.h */