More removal

[lttng-ust.git] / deprecated / libust / channels.h

diff --git a/deprecated/libust/channels.h b/deprecated/libust/channels.h
new file mode 100644 (file)
index 0000000..eb9a11c
--- /dev/null
+++ b/deprecated/libust/channels.h
@@ -0,0 +1,97 @@
+#ifndef UST_CHANNELS_H
+#define UST_CHANNELS_H
+
+/*
+ * Copyright (C) 2008 Mathieu Desnoyers (mathieu.desnoyers@polymtl.ca)
+ *
+ * Dynamic tracer channel allocation.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+#define _LGPL_SOURCE
+#include <linux/limits.h>
+#include <errno.h>
+#include <ust/kcompat/kcompat.h>
+#include <ust/core.h>
+#include <urcu/list.h>
+#include <urcu/ref.h>
+
+#define EVENTS_PER_CHANNEL     65536
+#define MAX_CPUS               32
+
+struct ust_trace;
+
+struct ust_buffer;
+
+struct ust_channel {
+       /* First 32 bytes cache-hot cacheline */
+       struct ust_trace *trace;
+       int *buf_struct_shmids;
+       struct ust_buffer **buf;
+       int overwrite:1;
+       /* whether collection is requested upon trace start */
+       int request_collection:1;
+       int active:1;
+       unsigned int n_subbufs_order;
+       unsigned long commit_count_mask;        /*
+                                                * Commit count mask, removing
+                                                * the MSBs corresponding to
+                                                * bits used to represent the
+                                                * subbuffer index.
+                                                */
+       /* End of first 32 bytes cacheline */
+
+       struct urcu_ref urcu_ref;       /* Channel transport reference count */
+       size_t subbuf_size;
+       int subbuf_size_order;
+       unsigned int subbuf_cnt;
+       const char *channel_name;
+       int n_cpus;
+
+       u32 version;
+       size_t alloc_size;
+       struct cds_list_head list;
+} ____cacheline_aligned;
+
+struct ltt_channel_setting {
+       unsigned int subbuf_size;
+       unsigned int subbuf_cnt;
+       struct urcu_ref urcu_ref;       /* Number of references to structure content */
+       struct cds_list_head list;
+       unsigned int index;     /* index of channel in trace channel array */
+       u16 free_event_id;      /* Next event ID to allocate */
+       char name[PATH_MAX];
+};
+
+extern int ltt_channels_register(const char *name);
+extern int ltt_channels_unregister(const char *name);
+extern int ltt_channels_set_default(const char *name,
+                            unsigned int subbuf_size,
+                            unsigned int subbuf_cnt);
+extern const char *ltt_channels_get_name_from_index(unsigned int index);
+extern int ltt_channels_get_index_from_name(const char *name);
+extern struct ust_channel *ltt_channels_trace_alloc(unsigned int *nr_channels,
+                                                   int overwrite,
+                                                   int request_collection,
+                                                   int active);
+extern void ltt_channels_trace_free(struct ust_channel *channels);
+extern int _ltt_channels_get_event_id(const char *channel, const char *name);
+extern int ltt_channels_get_event_id(const char *channel, const char *name);
+
+extern int ust_channels_overwrite_by_default;
+extern int ust_channels_request_collection_by_default;
+
+#endif /* UST_CHANNELS_H */