1 /* Copyright (c) 2010, 2011 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
22 #include "openvswitch/types.h"
28 struct flow_wildcards;
30 #define CFM_RANDOM_VLAN UINT16_MAX
32 #define CFM_FAULT_REASONS \
33 CFM_FAULT_REASON(RECV, recv) \
34 CFM_FAULT_REASON(RDI, rdi) \
35 CFM_FAULT_REASON(MAID, maid) \
36 CFM_FAULT_REASON(LOOPBACK, loopback) \
37 CFM_FAULT_REASON(OVERFLOW, overflow) \
38 CFM_FAULT_REASON(OVERRIDE, override)
40 enum cfm_fault_bit_index {
41 #define CFM_FAULT_REASON(NAME, STR) CFM_FAULT_INDEX_##NAME,
43 #undef CFM_FAULT_REASON
47 enum cfm_fault_reason {
48 #define CFM_FAULT_REASON(NAME, STR) \
49 CFM_FAULT_##NAME = 1 << CFM_FAULT_INDEX_##NAME,
51 #undef CFM_FAULT_REASON
55 uint64_t mpid; /* The MPID of this CFM. */
56 int interval; /* The requested transmission interval. */
57 bool extended; /* Run in extended mode. */
58 bool demand; /* Run in demand mode. */
59 bool opup; /* Operational State. */
60 uint16_t ccm_vlan; /* CCM Vlan tag. Zero if none.
61 CFM_RANDOM_VLAN if random. */
62 uint8_t ccm_pcp; /* CCM Priority. Zero if none. */
64 bool check_tnl_key; /* Verify inbound packet key? */
67 /* CFM status query. */
69 /* 0 if not faulted, otherwise a combination of one or more reasons. */
70 enum cfm_fault_reason faults;
72 /* 0 if the remote CFM endpoint is operationally down,
73 * 1 if the remote CFM endpoint is operationally up,
74 * -1 if we don't know because the remote CFM endpoint is not in extended
80 /* Ordinarily a "health status" in the range 0...100 inclusive, with 0
81 * being worst and 100 being best, or -1 if the health status is not
85 /* MPIDs of remote maintenance points whose CCMs have been received. */
91 struct cfm *cfm_create(const struct netdev *);
92 struct cfm *cfm_ref(const struct cfm *);
93 void cfm_unref(struct cfm *);
94 void cfm_run(struct cfm *);
95 bool cfm_should_send_ccm(struct cfm *);
96 void cfm_compose_ccm(struct cfm *, struct ofpbuf *packet, uint8_t eth_src[ETH_ADDR_LEN]);
97 void cfm_wait(struct cfm *);
98 bool cfm_configure(struct cfm *, const struct cfm_settings *);
99 void cfm_set_netdev(struct cfm *, const struct netdev *);
100 bool cfm_should_process_flow(const struct cfm *cfm, const struct flow *,
101 struct flow_wildcards *);
102 void cfm_process_heartbeat(struct cfm *, const struct ofpbuf *packet);
103 bool cfm_check_status_change(struct cfm *);
104 int cfm_get_fault(const struct cfm *);
105 uint64_t cfm_get_flap_count(const struct cfm *);
106 int cfm_get_health(const struct cfm *);
107 int cfm_get_opup(const struct cfm *);
108 void cfm_get_remote_mpids(const struct cfm *, uint64_t **rmps, size_t *n_rmps);
109 void cfm_get_status(const struct cfm *, struct cfm_status *);
110 const char *cfm_fault_reason_to_str(int fault);
112 long long int cfm_wake_time(struct cfm*);