← Back to branch summary

~lttng/lttng-ust/lttng-ust

« back to all changes in this revision

Viewing changes to src/common/ringbuffer/ringbuffer-config.h

  • Committer: Mathieu Desnoyers
  • Date: 2024-05-03 19:32:50 UTC
  • Revision ID: git-v1:373ea80ac0db5072e995140f1dbdbf4f0b1bdaad
Rename "tsc" to "timestamp"

Naming timestamps "TSC" or "tsc" is an historical artefact dating from
the implementation of libringbuffer, where the initial intent was to use
the x86 "rdtsc" instruction directly, which ended up not being what was
done in reality.

Rename uses of "TSC" and "tsc" to "timestamp" to clarify things and
don't require reviewers to be fluent in x86 instruction set.

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Change-Id: I8e7e2ad9cd2d2427485fc6adbc340fccde14ca2f

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/common/ringbuffer/ringbuffer-config.h
46
46
 
47
47
        /* Slow path only, at subbuffer switch */
48
48
        size_t (*subbuffer_header_size) (void);
49
 
        void (*buffer_begin) (struct lttng_ust_ring_buffer *buf, uint64_t tsc,
 
49
        void (*buffer_begin) (struct lttng_ust_ring_buffer *buf, uint64_t timestamp,
50
50
                              unsigned int subbuf_idx,
51
51
                              struct lttng_ust_shm_handle *handle);
52
 
        void (*buffer_end) (struct lttng_ust_ring_buffer *buf, uint64_t tsc,
 
52
        void (*buffer_end) (struct lttng_ust_ring_buffer *buf, uint64_t timestamp,
53
53
                            unsigned int subbuf_idx, unsigned long data_size,
54
54
                            struct lttng_ust_shm_handle *handle,
55
55
                            const struct lttng_ust_ring_buffer_ctx *ctx);
185
185
        enum lttng_ust_ring_buffer_ipi_types ipi;
186
186
        enum lttng_ust_ring_buffer_wakeup_types wakeup;
187
187
        /*
188
 
         * tsc_bits: timestamp bits saved at each record.
 
188
         * timestamp_bits: timestamp bits saved at each record.
189
189
         *   0 and 64 disable the timestamp compression scheme.
190
190
         */
191
 
        unsigned int tsc_bits;
 
191
        unsigned int timestamp_bits;
192
192
        struct lttng_ust_ring_buffer_client_cb cb;
193
193
        /*
194
194
         * client_type is used by the consumer process (which is in a
204
204
/*
205
205
 * Reservation flags.
206
206
 *
207
 
 * RING_BUFFER_RFLAG_FULL_TSC
 
207
 * RING_BUFFER_RFLAG_FULL_TIMESTAMP
208
208
 *
209
209
 * This flag is passed to record_header_size() and to the primitive used to
210
210
 * write the record header. It indicates that the full 64-bit time value is
211
211
 * needed in the record header. If this flag is not set, the record header needs
212
 
 * only to contain "tsc_bits" bit of time value.
 
212
 * only to contain "timestamp_bits" bit of time value.
213
213
 *
214
214
 * Reservation flags can be added by the client, starting from
215
215
 * "(RING_BUFFER_FLAGS_END << 0)". It can be used to pass information from
216
216
 * record_header_size() to lib_ring_buffer_write_record_header().
217
217
 */
218
 
#define RING_BUFFER_RFLAG_FULL_TSC              (1U << 0)
 
218
#define RING_BUFFER_RFLAG_FULL_TIMESTAMP        (1U << 0)
219
219
#define RING_BUFFER_RFLAG_END                   (1U << 1)
220
220
 
221
221
/*