Minor fixes to header files
[lttng-tools.git] / include / lttng-share.h
CommitLineData
9bda164d 1/*
e848fc76
DG
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9bda164d 4 *
e848fc76
DG
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
9bda164d 8 *
e848fc76
DG
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
9bda164d 13 *
e848fc76
DG
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
9bda164d
DG
17 */
18
19#ifndef _LTTNG_SHARE_H
20#define _LTTNG_SHARE_H
21
e848fc76
DG
22#include <stdlib.h>
23
f3ed775e 24/* Default channel attributes */
3817e7df
DG
25#define DEFAULT_CHANNEL_NAME "channel0"
26#define DEFAULT_CHANNEL_OVERWRITE 0 /* usec */
7d452e12 27/* DEFAULT_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
3817e7df 28#define DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
7d452e12 29/* DEFAULT_CHANNEL_SUBBUF_NUM must always be a power of 2 */
3817e7df
DG
30#define DEFAULT_CHANNEL_SUBBUF_NUM 8
31#define DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
b389abbe 32#define DEFAULT_CHANNEL_READ_TIMER 200 /* usec */
3817e7df 33#define DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
b389abbe 34
3817e7df
DG
35#define DEFAULT_METADATA_SUBBUF_SIZE 4096
36#define DEFAULT_METADATA_SUBBUF_NUM 2
e6ddca71 37
b389abbe
MD
38/* Kernel has different defaults */
39
40/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
3817e7df 41#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
b389abbe 42/* DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2 */
3817e7df 43#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM 4
b389abbe 44/* See lttng-kernel.h enum lttng_kernel_output for channel output */
3817e7df 45#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
f3ed775e 46
5eb91c98
DG
47/*
48 * Takes a pointer x and transform it so we can use it to access members
49 * without a function call. Here an example:
50 *
51 * #define GET_SIZE(x) LTTNG_REF(x)->size
52 *
53 * struct { int size; } s;
54 *
55 * printf("size : %d\n", GET_SIZE(&s));
56 *
57 * For this example we can't use something like this for compatibility purpose
58 * since this will fail:
59 *
60 * #define GET_SIZE(x) x->size;
61 *
62 * This is mostly use for the compatibility layer of lttng-tools. See
e848fc76 63 * poll/epoll for a good example. Since x can be on the stack or allocated
5eb91c98 64 * memory using malloc(), we must use generic accessors for compat in order to
e848fc76 65 * *not* use a function to access members and not the variable name.
5eb91c98
DG
66 */
67#define LTTNG_REF(x) ((typeof(*x) *)(x))
68
69/*
70 * Memory allocation zeroed
71 */
72#define zmalloc(x) calloc(1, x)
73
e848fc76
DG
74#ifndef ARRAY_SIZE
75#define ARRAY_SIZE(array) (sizeof(array) / (sizeof((array)[0])))
76#endif
77
78
9bda164d 79#endif /* _LTTNG_SHARE_H */
This page took 0.037793 seconds and 4 git commands to generate.