Implement ust-tracepoint-events under MIT license
[lttng-ust.git] / libringbuffer / backend_types.h
CommitLineData
852c2936
MD
1#ifndef _LINUX_RING_BUFFER_BACKEND_TYPES_H
2#define _LINUX_RING_BUFFER_BACKEND_TYPES_H
3
4/*
5 * linux/ringbuffer/backend_types.h
6 *
7 * Copyright (C) 2008-2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 *
9 * Ring buffer backend (types).
10 *
11 * Dual LGPL v2.1/GPL v2 license.
12 */
13
2fed87ae 14#include <limits.h>
1d498196 15#include "shm_internal.h"
852c2936 16
4cfec15c 17struct lttng_ust_lib_ring_buffer_backend_pages {
852c2936
MD
18 unsigned long mmap_offset; /* offset of the subbuffer in mmap */
19 union v_atomic records_commit; /* current records committed count */
20 union v_atomic records_unread; /* records to read */
21 unsigned long data_size; /* Amount of data to read from subbuf */
a6352fd4 22 DECLARE_SHMP(char, p); /* Backing memory map */
852c2936
MD
23};
24
4cfec15c 25struct lttng_ust_lib_ring_buffer_backend_subbuffer {
852c2936
MD
26 /* Identifier for subbuf backend pages. Exchanged atomically. */
27 unsigned long id; /* backend subbuffer identifier */
28};
29
30/*
31 * Forward declaration of frontend-specific channel and ring_buffer.
32 */
33struct channel;
4cfec15c 34struct lttng_ust_lib_ring_buffer;
852c2936 35
4cfec15c
MD
36struct lttng_ust_lib_ring_buffer_backend_pages_shmp {
37 DECLARE_SHMP(struct lttng_ust_lib_ring_buffer_backend_pages, shmp);
1d498196
MD
38};
39
4cfec15c 40struct lttng_ust_lib_ring_buffer_backend {
852c2936 41 /* Array of ring_buffer_backend_subbuffer for writer */
4cfec15c 42 DECLARE_SHMP(struct lttng_ust_lib_ring_buffer_backend_subbuffer, buf_wsb);
852c2936 43 /* ring_buffer_backend_subbuffer for reader */
4cfec15c 44 struct lttng_ust_lib_ring_buffer_backend_subbuffer buf_rsb;
852c2936
MD
45 /*
46 * Pointer array of backend pages, for whole buffer.
47 * Indexed by ring_buffer_backend_subbuffer identifier (id) index.
48 */
4cfec15c 49 DECLARE_SHMP(struct lttng_ust_lib_ring_buffer_backend_pages_shmp, array);
a6352fd4 50 DECLARE_SHMP(char, memory_map); /* memory mapping */
852c2936 51
a6352fd4 52 DECLARE_SHMP(struct channel, chan); /* Associated channel */
852c2936
MD
53 int cpu; /* This buffer's cpu. -1 if global. */
54 union v_atomic records_read; /* Number of records read */
55 unsigned int allocated:1; /* Bool: is buffer allocated ? */
56};
57
4cfec15c
MD
58struct lttng_ust_lib_ring_buffer_shmp {
59 DECLARE_SHMP(struct lttng_ust_lib_ring_buffer, shmp); /* Channel per-cpu buffers */
1d498196
MD
60};
61
852c2936
MD
62struct channel_backend {
63 unsigned long buf_size; /* Size of the buffer */
64 unsigned long subbuf_size; /* Sub-buffer size */
65 unsigned int subbuf_size_order; /* Order of sub-buffer size */
66 unsigned int num_subbuf_order; /*
67 * Order of number of sub-buffers/buffer
68 * for writer.
69 */
70 unsigned int buf_size_order; /* Order of buffer size */
71 int extra_reader_sb:1; /* Bool: has extra reader subbuffer */
852c2936 72 unsigned long num_subbuf; /* Number of sub-buffers for writer */
2fed87ae 73 uint64_t start_tsc; /* Channel creation TSC value */
a3f61e7f 74 DECLARE_SHMP(void *, priv_data);/* Client-specific information */
4cfec15c 75 struct lttng_ust_lib_ring_buffer_config config; /* Ring buffer configuration */
852c2936 76 char name[NAME_MAX]; /* Channel name */
4cfec15c 77 struct lttng_ust_lib_ring_buffer_shmp buf[];
852c2936
MD
78};
79
80#endif /* _LINUX_RING_BUFFER_BACKEND_TYPES_H */
This page took 0.027281 seconds and 4 git commands to generate.