ofproto/fail-open.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2013, 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 FAIL_OPEN_H
  18 #define FAIL_OPEN_H 1
  19
  20 #include <stdbool.h>
  21 #include <stdint.h>
  22 #include "ofproto-provider.h"
  23
  24 struct connmgr;
  25 struct fail_open;
  26 struct ofproto;
  27
  28 /* Priority of the rule added by the fail-open subsystem when a switch enters
  29  * fail-open mode.  This priority value uniquely identifies a fail-open flow
  30  * (OpenFlow priorities max out at 65535 and nothing else in Open vSwitch
  31  * creates flows with this priority).  And "f0" is mnemonic for "fail open"! */
  32 #define FAIL_OPEN_PRIORITY 0xf0f0f0
  33
  34 /* Returns true if 'rule' is one created by the "fail open" logic, false
  35  * otherwise. */
  36 static inline bool
  37 is_fail_open_rule(const struct rule *rule)
  38 {
  39     return rule->cr.priority == FAIL_OPEN_PRIORITY;
  40 }
  41
  42 struct fail_open *fail_open_create(struct ofproto *, struct connmgr *);
  43 void fail_open_destroy(struct fail_open *) OVS_REQUIRES(ofproto_mutex);
  44 void fail_open_wait(struct fail_open *);
  45 bool fail_open_is_active(const struct fail_open *);
  46 void fail_open_run(struct fail_open *);
  47 void fail_open_maybe_recover(struct fail_open *) OVS_EXCLUDED(ofproto_mutex);
  48 void fail_open_flushed(struct fail_open *) OVS_EXCLUDED(ofproto_mutex);
  49
  50 int fail_open_count_rules(const struct fail_open *);
  51
  52 #endif /* fail-open.h */