Fix DBG message grammatical error
[lttng-tools.git] / src / common / 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
f6a9efaa 24/* Default size of a hash table */
bec39940 25#define DEFAULT_HT_SIZE 4
f6a9efaa 26
f3ed775e 27/* Default channel attributes */
3817e7df
DG
28#define DEFAULT_CHANNEL_NAME "channel0"
29#define DEFAULT_CHANNEL_OVERWRITE 0 /* usec */
7d452e12 30/* DEFAULT_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
3817e7df 31#define DEFAULT_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
7d452e12 32/* DEFAULT_CHANNEL_SUBBUF_NUM must always be a power of 2 */
3817e7df
DG
33#define DEFAULT_CHANNEL_SUBBUF_NUM 8
34#define DEFAULT_CHANNEL_SWITCH_TIMER 0 /* usec */
b389abbe 35#define DEFAULT_CHANNEL_READ_TIMER 200 /* usec */
3817e7df 36#define DEFAULT_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
b389abbe 37
3817e7df
DG
38#define DEFAULT_METADATA_SUBBUF_SIZE 4096
39#define DEFAULT_METADATA_SUBBUF_NUM 2
e6ddca71 40
b389abbe
MD
41/* Kernel has different defaults */
42
43/* DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE must always be a power of 2 */
3817e7df 44#define DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE 262144 /* bytes */
b389abbe 45/* DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM must always be a power of 2 */
3817e7df 46#define DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM 4
b389abbe 47/* See lttng-kernel.h enum lttng_kernel_output for channel output */
3817e7df 48#define DEFAULT_KERNEL_CHANNEL_OUTPUT LTTNG_EVENT_SPLICE
f3ed775e 49
0b0dd29a
DG
50/* User space defaults */
51
52/* Must be a power of 2 */
53#define DEFAULT_UST_CHANNEL_SUBBUF_SIZE 4096 /* bytes */
54/* Must be a power of 2 */
55#define DEFAULT_UST_CHANNEL_SUBBUF_NUM 4
28ca4a8b 56/* See lttng-ust.h enum lttng_ust_output */
d41f73b7 57#define DEFAULT_UST_CHANNEL_OUTPUT LTTNG_EVENT_MMAP
0b0dd29a 58
ee0b0061
DG
59/*
60 * Default timeout value for the sem_timedwait() call. Blocking forever is not
61 * wanted so a timeout is used to control the data flow and not freeze the
62 * session daemon.
63 */
64#define DEFAULT_SEM_WAIT_TIMEOUT 30 /* in seconds */
65
5eb91c98
DG
66/*
67 * Takes a pointer x and transform it so we can use it to access members
68 * without a function call. Here an example:
69 *
70 * #define GET_SIZE(x) LTTNG_REF(x)->size
71 *
72 * struct { int size; } s;
73 *
74 * printf("size : %d\n", GET_SIZE(&s));
75 *
76 * For this example we can't use something like this for compatibility purpose
77 * since this will fail:
78 *
79 * #define GET_SIZE(x) x->size;
80 *
81 * This is mostly use for the compatibility layer of lttng-tools. See
e848fc76 82 * poll/epoll for a good example. Since x can be on the stack or allocated
5eb91c98 83 * memory using malloc(), we must use generic accessors for compat in order to
e848fc76 84 * *not* use a function to access members and not the variable name.
5eb91c98
DG
85 */
86#define LTTNG_REF(x) ((typeof(*x) *)(x))
87
88/*
89 * Memory allocation zeroed
90 */
91#define zmalloc(x) calloc(1, x)
92
e848fc76
DG
93#ifndef ARRAY_SIZE
94#define ARRAY_SIZE(array) (sizeof(array) / (sizeof((array)[0])))
95#endif
96
97
9bda164d 98#endif /* _LTTNG_SHARE_H */
This page took 0.041304 seconds and 4 git commands to generate.