summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Barach <dave@barachs.net>2020-05-19 09:56:22 -0400
committerDave Wallace <dwallacelf@gmail.com>2020-06-11 14:42:33 +0000
commita37c63c6d841168cb59aa428f89a3effc5f9669e (patch)
treed13b87c951dfbb5d980b573b315ce089a5b81db9
parentecbca13d7eb7f07fa27915ba1decac10fc98c89e (diff)
vppinfra: refactor mpcap.h
vppinfra source files MUST NOT #include <vlib/vlib.h>, <vnet/vnet.h> or similar. Move mpcap_add_packet(...), mpcap_add_buffer(...) to a new file: src/vnet/mpcap.h. Type: refactor Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: Id517aef6fe49b618f853ce32940b91ba45a1e60d (cherry picked from commit 2a41919e39d4672f76a654f30be9c2093cef4fad)
-rw-r--r--src/plugins/unittest/mpcap_node.c2
-rw-r--r--src/vnet/mpcap.h113
-rw-r--r--src/vppinfra/mpcap.h92
3 files changed, 118 insertions, 89 deletions
diff --git a/src/plugins/unittest/mpcap_node.c b/src/plugins/unittest/mpcap_node.c
index 8c0bc8677be..f3c24843d82 100644
--- a/src/plugins/unittest/mpcap_node.c
+++ b/src/plugins/unittest/mpcap_node.c
@@ -18,7 +18,7 @@
#include <vnet/vnet.h>
#include <vnet/pg/pg.h>
#include <vppinfra/error.h>
-#include <vppinfra/mpcap.h>
+#include <vnet/mpcap.h>
#include <vnet/ethernet/ethernet.h>
static mpcap_main_t test_mpcap_main = {
diff --git a/src/vnet/mpcap.h b/src/vnet/mpcap.h
new file mode 100644
index 00000000000..1c60454c198
--- /dev/null
+++ b/src/vnet/mpcap.h
@@ -0,0 +1,113 @@
+/*
+ * Copyright (c) 2020 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef included_vnet_mpcap_h
+#define included_vnet_mpcap_h
+
+#include <vnet/vnet.h>
+#include <vppinfra/mpcap.h>
+
+/**
+ * @brief Add packet
+ *
+ * @param *pm - mpcap_main_t
+ * @param time_now - f64
+ * @param n_bytes_in_trace - u32
+ * @param n_bytes_in_packet - u32
+ *
+ * @return Packet Data
+ *
+ */
+static inline void *
+mpcap_add_packet (mpcap_main_t * pm,
+ f64 time_now, u32 n_bytes_in_trace, u32 n_bytes_in_packet)
+{
+ mpcap_packet_header_t *h;
+ u8 *d;
+
+ /* File already closed? */
+ if (PREDICT_FALSE (pm->flags & MPCAP_FLAG_INIT_DONE) == 0)
+ return 0;
+
+ d = pm->current_va;
+ pm->current_va += sizeof (h[0]) + n_bytes_in_trace;
+
+ /* Out of space? */
+ if (PREDICT_FALSE (pm->current_va >= pm->file_baseva + pm->max_file_size))
+ return 0;
+ h = (void *) (d);
+ h->time_in_sec = time_now;
+ h->time_in_usec = 1e6 * (time_now - h->time_in_sec);
+ h->n_packet_bytes_stored_in_file = n_bytes_in_trace;
+ h->n_bytes_in_packet = n_bytes_in_packet;
+ pm->n_packets_captured++;
+ return h->data;
+}
+
+/**
+ * @brief Add buffer (vlib_buffer_t) to the trace
+ *
+ * @param *pm - mpcap_main_t
+ * @param *vm - vlib_main_t
+ * @param time_now - f64
+ * @param buffer_index - u32
+ * @param n_bytes_in_trace - u32
+ *
+ */
+static inline void
+mpcap_add_buffer (mpcap_main_t * pm,
+ vlib_main_t * vm,
+ f64 time_now, u32 buffer_index, u32 n_bytes_in_trace)
+{
+ vlib_buffer_t *b = vlib_get_buffer (vm, buffer_index);
+ u32 n = vlib_buffer_length_in_chain (vm, b);
+ i32 n_left = clib_min (n_bytes_in_trace, n);
+ void *d;
+
+ clib_spinlock_lock_if_init (&pm->lock);
+
+ d = mpcap_add_packet (pm, time_now, n_left, n);
+ if (PREDICT_FALSE (d == 0))
+ {
+ mpcap_close (pm);
+ clib_spinlock_unlock_if_init (&pm->lock);
+ return;
+ }
+
+ while (1)
+ {
+ u32 copy_length = clib_min ((u32) n_left, b->current_length);
+ clib_memcpy (d, b->data + b->current_data, copy_length);
+ n_left -= b->current_length;
+ if (n_left <= 0)
+ break;
+ d += b->current_length;
+ ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
+ b = vlib_get_buffer (vm, b->next_buffer);
+ }
+ if (pm->n_packets_captured >= pm->n_packets_to_capture)
+ mpcap_close (pm);
+
+ clib_spinlock_unlock_if_init (&pm->lock);
+}
+#endif /* included_vnet_mpcap_h */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/src/vppinfra/mpcap.h b/src/vppinfra/mpcap.h
index 1710702d8bd..84f3332d71f 100644
--- a/src/vppinfra/mpcap.h
+++ b/src/vppinfra/mpcap.h
@@ -17,14 +17,14 @@
* @file
* @brief MPCAP utility definitions
*/
-#ifndef included_vnet_mpcap_h
-#define included_vnet_mpcap_h
+#ifndef included_vppinfra_mpcap_h
+#define included_vppinfra_mpcap_h
-#include <vlib/vlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <vppinfra/time_range.h>
+#include <vppinfra/lock.h>
/**
* @brief Packet types supported by MPCAP
@@ -162,91 +162,7 @@ clib_error_t *mpcap_close (mpcap_main_t * pm);
/** mmap a mpcap data file. */
clib_error_t *mpcap_map (mpcap_main_t * pm);
-/**
- * @brief Add packet
- *
- * @param *pm - mpcap_main_t
- * @param time_now - f64
- * @param n_bytes_in_trace - u32
- * @param n_bytes_in_packet - u32
- *
- * @return Packet Data
- *
- */
-static inline void *
-mpcap_add_packet (mpcap_main_t * pm,
- f64 time_now, u32 n_bytes_in_trace, u32 n_bytes_in_packet)
-{
- mpcap_packet_header_t *h;
- u8 *d;
-
- /* File already closed? */
- if (PREDICT_FALSE (pm->flags & MPCAP_FLAG_INIT_DONE) == 0)
- return 0;
-
- d = pm->current_va;
- pm->current_va += sizeof (h[0]) + n_bytes_in_trace;
-
- /* Out of space? */
- if (PREDICT_FALSE (pm->current_va >= pm->file_baseva + pm->max_file_size))
- return 0;
- h = (void *) (d);
- h->time_in_sec = time_now;
- h->time_in_usec = 1e6 * (time_now - h->time_in_sec);
- h->n_packet_bytes_stored_in_file = n_bytes_in_trace;
- h->n_bytes_in_packet = n_bytes_in_packet;
- pm->n_packets_captured++;
- return h->data;
-}
-
-/**
- * @brief Add buffer (vlib_buffer_t) to the trace
- *
- * @param *pm - mpcap_main_t
- * @param *vm - vlib_main_t
- * @param time_now - f64
- * @param buffer_index - u32
- * @param n_bytes_in_trace - u32
- *
- */
-static inline void
-mpcap_add_buffer (mpcap_main_t * pm,
- vlib_main_t * vm,
- f64 time_now, u32 buffer_index, u32 n_bytes_in_trace)
-{
- vlib_buffer_t *b = vlib_get_buffer (vm, buffer_index);
- u32 n = vlib_buffer_length_in_chain (vm, b);
- i32 n_left = clib_min (n_bytes_in_trace, n);
- void *d;
-
- clib_spinlock_lock_if_init (&pm->lock);
-
- d = mpcap_add_packet (pm, time_now, n_left, n);
- if (PREDICT_FALSE (d == 0))
- {
- mpcap_close (pm);
- clib_spinlock_unlock_if_init (&pm->lock);
- return;
- }
-
- while (1)
- {
- u32 copy_length = clib_min ((u32) n_left, b->current_length);
- clib_memcpy (d, b->data + b->current_data, copy_length);
- n_left -= b->current_length;
- if (n_left <= 0)
- break;
- d += b->current_length;
- ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
- b = vlib_get_buffer (vm, b->next_buffer);
- }
- if (pm->n_packets_captured >= pm->n_packets_to_capture)
- mpcap_close (pm);
-
- clib_spinlock_unlock_if_init (&pm->lock);
-}
-
-#endif /* included_vnet_mpcap_h */
+#endif /* included_vppinfra_mpcap_h */
/*
* fd.io coding-style-patch-verification: ON