Changeset a330384

Timestamp:

03/25/15 14:22:27 (6 years ago)

Author:

Richard Sanger <rsangerarj@…>

Branches:

4.0.1-hotfixes, cachetimestamps, develop, dpdk-ndag, etsilive, libtrace4, master, ndag_format, pfring, rc-4.0.1, rc-4.0.2, rc-4.0.3, rc-4.0.4, ringdecrementfix, ringperformance, ringtimestampfixes

Children:

f01c479

Parents:

e0be8382

Message:

Add const modifier to trace_get_first_packet

Plus some other doc fixes

Files:

• lib/libtrace_parallel.h (modified) (5 diffs)
• lib/trace_parallel.c (modified) (5 diffs)
• tools/tracertstats/tracertstats_parallel.c (modified) (1 diff)

lib/libtrace_parallel.h

@@ -594 +594 @@
  *
  * @param[in] trace The parallel input trace
- * @param[in] interval The interval in milliseconds. If 0 this is disabled [default].
+ * @param[in] millisec The interval in milliseconds. If 0 this is disabled [default].
  * @return 0 if successful otherwise -1
  *
@@ -606 +606 @@
  * @see MESSAGE_TICK_INTERVAL, trace_set_tick_count()
  */
-DLLEXPORT int trace_set_tick_interval(libtrace_t *trace, size_t interval);
+DLLEXPORT int trace_set_tick_interval(libtrace_t *trace, size_t millisec);
 
 /** Set the count between tick messages.
@@ -1008 +1008 @@
 
 /** TODO WHAT TO DO WITH THIS ? */
-DLLEXPORT uint64_t tv_to_usec(struct timeval *tv);
+DLLEXPORT uint64_t tv_to_usec(const struct timeval *tv);
 
 
@@ -1024 +1024 @@
  * -1 is returned if an error occurs, such as supplied a invalid thread.
  *
- * The packet returned by this function is shared by all threads and remains
- * valid until MESSAGE_PAUSING is received.
+ * The packet and timeval returned by this function is shared by all threads
+ * and remain valid until MESSAGE_PAUSING is received.
  */
 DLLEXPORT int trace_get_first_packet(libtrace_t *libtrace,
                                      libtrace_thread_t *t,
-                                     libtrace_packet_t **packet,
-                                     struct timeval **tv);
+                                     const libtrace_packet_t **packet,
+                                     const struct timeval **tv);
 
 /** Makes a packet safe, a packet will become invalid after a
@@ -1092 +1092 @@
  *
  * @note a environment variable interface is provided by default to users via
- * LIBTRACE_CONFIG, see Parallel Configuration for more information.
+ * LIBTRACE_CONF, see Parallel Configuration for more information.
  *
  * @note this interface is provided to allow a user to configure an application

lib/trace_parallel.c

@@ -944 +944 @@
 DLLEXPORT int trace_get_first_packet(libtrace_t *libtrace,
                                      libtrace_thread_t *t,
-                                     libtrace_packet_t **packet,
-                                     struct timeval **tv)
+                                     const libtrace_packet_t **packet,
+                                     const struct timeval **tv)
 {
         void * tmp;
@@ -957 +957 @@
         /* Throw away these which we don't use */
         if (!packet)
-                packet = (libtrace_packet_t **) &tmp;
+                packet = (const libtrace_packet_t **) &tmp;
         if (!tv)
-                tv = (struct timeval **) &tmp;
+                tv = (const struct timeval **) &tmp;
 
         ASSERT_RET(pthread_spin_lock(&libtrace->first_packets.lock), == 0);
@@ -991 +991 @@
 
 
-DLLEXPORT uint64_t tv_to_usec(struct timeval *tv)
+DLLEXPORT uint64_t tv_to_usec(const struct timeval *tv)
 {
         return (uint64_t) tv->tv_sec*1000000ull + (uint64_t) tv->tv_usec;
@@ -1131 +1131 @@
 
         if (!t->tracetime_offset_usec) {
-                libtrace_packet_t *first_pkt;
-                struct timeval *sys_tv;
+                const libtrace_packet_t *first_pkt;
+                const struct timeval *sys_tv;
                 int64_t initial_offset;
                 int stable = trace_get_first_packet(libtrace, NULL, &first_pkt, &sys_tv);
@@ -2205 +2205 @@
 }
 
-DLLEXPORT int trace_set_tick_interval(libtrace_t *trace, size_t interval) {
+DLLEXPORT int trace_set_tick_interval(libtrace_t *trace, size_t millisec) {
         if (!trace_is_configurable(trace)) return -1;
 
-        trace->config.tick_interval = interval;
+        trace->config.tick_interval = millisec;
         return 0;
 }

tools/tracertstats/tracertstats_parallel.c

@@ -236 +236 @@
                         int64_t offset;
                         struct timeval *tv, tv_real;
-                        libtrace_packet_t *first_packet = NULL;
+                        const libtrace_packet_t *first_packet = NULL;
                         trace_get_first_packet(trace, NULL, &first_packet, &tv);
                         if (first_packet != NULL) {