-/*
- * Copyright (c) 2010 Nicira Networks.
+/* Copyright (c) 2010, 2011 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <stdint.h>
#include "hmap.h"
-#include "packets.h"
+#include "openvswitch/types.h"
struct flow;
-
-/* Ethernet destination address of CCM packets. */
-static const uint8_t eth_addr_ccm[ETH_ADDR_LEN] OVS_UNUSED
- = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x30 };
-
-/* A 'cfm' represent a local Maintenance Point (MP) and its Connectivity Fault
- * Management (CFM) state machine. Its configuration variables should be set
- * by clients of the CFM library. */
-struct cfm {
- /* Configuration Variables. */
- uint16_t mpid; /* The MPID of this CFM. */
- uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
- int interval; /* The requested transmission interval. */
- uint8_t eth_src[ETH_ADDR_LEN];
-
- /* Statistics. */
- struct hmap remote_mps; /* Expected remote MPs. */
- struct hmap x_remote_mps; /* Unexpected remote MPs. */
- struct hmap x_remote_maids; /* Unexpected remote MAIDs. */
- bool fault; /* Indicates connectivity vaults. */
+struct ofpbuf;
+
+#define CFM_RANDOM_VLAN UINT16_MAX
+
+#define CFM_FAULT_REASONS \
+ CFM_FAULT_REASON(RECV, recv) \
+ CFM_FAULT_REASON(RDI, rdi) \
+ CFM_FAULT_REASON(MAID, maid) \
+ CFM_FAULT_REASON(LOOPBACK, loopback) \
+ CFM_FAULT_REASON(OVERFLOW, overflow) \
+ CFM_FAULT_REASON(OVERRIDE, override) \
+ CFM_FAULT_REASON(INTERVAL, interval)
+
+enum cfm_fault_bit_index {
+#define CFM_FAULT_REASON(NAME, STR) CFM_FAULT_INDEX_##NAME,
+ CFM_FAULT_REASONS
+#undef CFM_FAULT_REASON
+ CFM_FAULT_N_REASONS
};
-/* Remote MPs represent foreign network entities that are configured to have
- * the same MAID as this CFM instance. */
-struct remote_mp {
- uint16_t mpid; /* The Maintenance Point ID of this 'remote_mp'. */
- struct hmap_node node; /* In 'cfm' 'remote_mps' or 'x_remote_mps'. */
-
- long long recv_time; /* Time the most recent CCM was received. */
- bool fault; /* Indicates a connectivity fault. */
+enum cfm_fault_reason {
+#define CFM_FAULT_REASON(NAME, STR) \
+ CFM_FAULT_##NAME = 1 << CFM_FAULT_INDEX_##NAME,
+ CFM_FAULT_REASONS
+#undef CFM_FAULT_REASON
};
-/* Remote MAIDs keep track of incoming CCM messages which have a different MAID
- * than this CFM instance. */
-struct remote_maid {
- uint8_t maid[CCM_MAID_LEN]; /* The remote MAID. */
- struct hmap_node node; /* In 'cfm' 'x_remote_maids'. */
+struct cfm_settings {
+ uint64_t mpid; /* The MPID of this CFM. */
+ int interval; /* The requested transmission interval. */
+ bool extended; /* Run in extended mode. */
+ bool opup; /* Operational State. */
+ uint16_t ccm_vlan; /* CCM Vlan tag. Zero if none.
+ CFM_RANDOM_VLAN if random. */
+ uint8_t ccm_pcp; /* CCM Priority. Zero if none. */
- long long recv_time; /* Most recent receive time for this 'remote_maid'. */
+ bool check_tnl_key; /* Verify inbound packet key? */
};
-struct cfm *cfm_create(void);
-
+void cfm_init(void);
+struct cfm *cfm_create(const char *name);
void cfm_destroy(struct cfm *);
-
-struct ofpbuf *cfm_run(struct cfm *);
-
+void cfm_run(struct cfm *);
+bool cfm_should_send_ccm(struct cfm *);
+void cfm_compose_ccm(struct cfm *, struct ofpbuf *packet, uint8_t eth_src[6]);
void cfm_wait(struct cfm *);
-
-bool cfm_configure(struct cfm *);
-
-void cfm_update_remote_mps(struct cfm *, const uint16_t *mpid, size_t n_mpids);
-
-const struct remote_mp *cfm_get_remote_mp(const struct cfm *, uint16_t mpid);
-
-bool cfm_generate_maid(const char *md_name, const char *ma_name,
- uint8_t maid[CCM_MAID_LEN]);
-
-bool cfm_should_process_flow(const struct flow *);
-
+bool cfm_configure(struct cfm *, const struct cfm_settings *);
+bool cfm_should_process_flow(const struct cfm *cfm, const struct flow *);
void cfm_process_heartbeat(struct cfm *, const struct ofpbuf *packet);
+int cfm_get_fault(const struct cfm *);
+int cfm_get_health(const struct cfm *);
+int cfm_get_opup(const struct cfm *);
+void cfm_get_remote_mpids(const struct cfm *, const uint64_t **rmps,
+ size_t *n_rmps);
+const char *cfm_fault_reason_to_str(int fault);
#endif /* cfm.h */