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"
27 #define CFM_RANDOM_VLAN UINT16_MAX
29 #define CFM_FAULT_REASONS \
30 CFM_FAULT_REASON(RECV, recv) \
31 CFM_FAULT_REASON(RDI, rdi) \
32 CFM_FAULT_REASON(MAID, maid) \
33 CFM_FAULT_REASON(LOOPBACK, loopback) \
34 CFM_FAULT_REASON(OVERFLOW, overflow) \
35 CFM_FAULT_REASON(OVERRIDE, override) \
36 CFM_FAULT_REASON(INTERVAL, interval) \
37 CFM_FAULT_REASON(SEQUENCE, sequence)
39 enum cfm_fault_bit_index {
40 #define CFM_FAULT_REASON(NAME, STR) CFM_FAULT_INDEX_##NAME,
42 #undef CFM_FAULT_REASON
46 enum cfm_fault_reason {
47 #define CFM_FAULT_REASON(NAME, STR) \
48 CFM_FAULT_##NAME = 1 << CFM_FAULT_INDEX_##NAME,
50 #undef CFM_FAULT_REASON
54 uint64_t mpid; /* The MPID of this CFM. */
55 int interval; /* The requested transmission interval. */
56 bool extended; /* Run in extended mode. */
57 bool opup; /* Operational State. */
58 uint16_t ccm_vlan; /* CCM Vlan tag. Zero if none.
59 CFM_RANDOM_VLAN if random. */
60 uint8_t ccm_pcp; /* CCM Priority. Zero if none. */
64 struct cfm *cfm_create(const char *name);
65 void cfm_destroy(struct cfm *);
66 void cfm_run(struct cfm *);
67 bool cfm_should_send_ccm(struct cfm *);
68 void cfm_compose_ccm(struct cfm *, struct ofpbuf *packet, uint8_t eth_src[6]);
69 void cfm_wait(struct cfm *);
70 bool cfm_configure(struct cfm *, const struct cfm_settings *);
71 bool cfm_should_process_flow(const struct cfm *cfm, const struct flow *);
72 void cfm_process_heartbeat(struct cfm *, const struct ofpbuf *packet);
73 int cfm_get_fault(const struct cfm *);
74 int cfm_get_health(const struct cfm *);
75 bool cfm_get_opup(const struct cfm *);
76 void cfm_get_remote_mpids(const struct cfm *, const uint64_t **rmps,
78 const char *cfm_fault_reason_to_str(int fault);