--- /dev/null
+# Copyright (C) 2011-2012 Matthew Khouzam <matthew.khouzam@ericsson.com>
+# Copyright (C) 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+#
+# THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
+# OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
+#
+# Permission is hereby granted to use or copy this program for any
+# purpose, provided the above notices are retained on all copies.
+# Permission to modify the code and to distribute modified code is
+# granted, provided the above notices are retained, and a notice that
+# the code was modified is included with the above copyright notice.
+
+# This makefile is not using automake so that people can see how to make
+# simply. It builds a program with a statically embedded tracepoint
+# provider probe.
+# the "html" target helps for documentation (req. code2html)
+
+CC = gcc
+LIBS = -ldl -llttng-ust
+CFLAGS = -I.
+
+all: sample
+
+sample: sample.o tp.o
+ $(CC) $(LIBS) -o $@ $^
+
+sample.o: sample.c sample_component_provider.h
+ $(CC) $(CFLAGS) -c -o $@ $<
+
+tp.o: tp.c sample_component_provider.h
+ $(CC) $(CFLAGS) -c -o $@ $<
+
+html: sample_component_provider.html sample.html tp.html
+
+%.html: %.c
+ code2html -lc $< $@
+
+%.html : %.h
+ code2html -lc $< $@
+
+.PHONY: clean
+clean:
+ rm -f *.html
+ rm -f *.o sample
--- /dev/null
+/*
+ * Copyright (C) 2011-2012 Matthew Khouzam <matthew.khouzam@ericsson.com>
+ * Copyright (C) 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *
+ * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
+ * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
+ *
+ * Permission is hereby granted to use or copy this program for any
+ * purpose, provided the above notices are retained on all copies.
+ * Permission to modify the code and to distribute modified code is
+ * granted, provided the above notices are retained, and a notice that
+ * the code was modified is included with the above copyright notice.
+ */
+
+#include <unistd.h>
+
+/*
+ * We need to define TRACEPOINT_DEFINE in one C file in the program
+ * before including provider headers.
+ */
+#define TRACEPOINT_DEFINE
+#include "sample_component_provider.h"
+
+int main(int argc, char **argv)
+{
+ int i = 0;
+
+ for (i = 0; i < 100000; i++) {
+ tracepoint(sample_component, message, "Hello World\n");
+ usleep(1);
+ }
+ return 0;
+}
--- /dev/null
+/*
+ * Copyright (C) 2011-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (C) 2011-2012 Matthew Khouzam <matthew.khouzam@ericsson.com>
+ *
+ * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
+ * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
+ *
+ * Permission is hereby granted to use or copy this program for any
+ * purpose, provided the above notices are retained on all copies.
+ * Permission to modify the code and to distribute modified code is
+ * granted, provided the above notices are retained, and a notice that
+ * the code was modified is included with the above copyright notice.
+ */
+
+/*
+ * Sample lttng-ust tracepoint provider.
+ */
+
+/*
+ * First part: defines
+ * We undef a macro before defining it as it can be used in several files.
+ */
+
+/*
+ * Must be included before include tracepoint provider
+ * ex.: project_event
+ * ex.: project_component_event
+ *
+ * Optional company name goes here
+ * ex.: com_efficios_project_component_event
+ *
+ * In this example, "sample" is the project, and "component" is the
+ * component.
+ */
+#undef TRACEPOINT_PROVIDER
+#define TRACEPOINT_PROVIDER sample_component
+
+/*
+ * include file (this files's name)
+ */
+#undef TRACEPOINT_INCLUDE_FILE
+#define TRACEPOINT_INCLUDE_FILE ./sample_component_provider.h
+
+/*
+ * Add this macro and its matching element to make sure the program
+ * works in c++.
+ */
+#ifdef __cplusplus
+#extern "C"{
+#endif /*__cplusplus */
+
+/*
+ * Add this precompiler conditionals to ensure the tracepoint event generation
+ * can include this file more than once.
+ */
+#if !defined(_SAMPLE_COMPONENT_PROVIDER_H) || defined(TRACEPOINT_HEADER_MULTI_READ)
+#define _SAMPLE_COMPONENT_PROVIDER_H
+/*
+ * Add this to allow programs to call "tracepoint(...):
+ */
+#include <lttng/tracepoint.h>
+
+/*
+ * The following tracepoint event writes a message (c string) into the
+ * field message of the trace event message in the provider
+ * sample_component in other words:
+ *
+ * sample_component:message:message = text.
+ */
+TRACEPOINT_EVENT(
+ /*
+ * provider name, not a variable but a string starting with a letter
+ * and containing either letters, numbers or underscores.
+ * Needs to be the same as TRACEPOINT_PROVIDER
+ */
+ sample_component,
+ /*
+ * tracepoint name, same format as sample provider. Does not need to be
+ * declared before. in this case the name is "message"
+ */
+ message,
+ /*
+ * TP_ARGS macro contains the arguments passed for the tracepoint
+ * it is in the following format
+ * TP_ARGS( type1, name1, type2, name2, ... type10, name10)
+ * where there can be from zero to ten elements.
+ * typeN is the datatype, such as int, struct or double **.
+ * name is the variable name (in "int myInt" the name would be myint)
+ * TP_ARGS() is valid to mean no arguments
+ * TP_ARGS( void ) is valid too
+ */
+ TP_ARGS(char *, text),
+ /*
+ * TP_FIELDS describes how to write the fields of the trace event.
+ * You can use the args here
+ */
+ TP_FIELDS(
+ /*
+ * The ctf_string macro takes a c string and writes it into a field
+ * named "message"
+ */
+ ctf_string(message, text)
+ )
+)
+/*
+ * Trace loglevel, shows the level of the trace event. It can be TRACE_EMERG,
+ * TRACE_ALERT, TRACE_CRIT, TRACE_ERR, TRACE_WARNING, TRACE_INFO or others.
+ * If this is not set, TRACE_DEFAULT is assumed.
+ * The first two arguments identify the tracepoint
+ * See details in <lttng/tracepoint.h> line 347
+ */
+TRACEPOINT_LOGLEVEL(
+ /*
+ * The provider name, must be the same as the provider name in the
+ * TRACEPOINT_EVENT and as TRACEPOINT_PROVIDER above.
+ */
+ sample_component,
+ /*
+ * The tracepoint name, must be the same as the tracepoint name in the
+ * TRACEPOINT_EVENT
+ */
+ message,
+ /*
+ * The tracepoint loglevel. Warning, some levels are abbreviated and
+ * others are not, please see <lttng/tracepoint.h>
+ */
+ TRACE_WARNING)
+
+#endif /* _SAMPLE_COMPONENT_PROVIDER_H */
+
+/*
+ * Add this after defining the tracepoint events to expand the macros.
+ */
+#include <lttng/tracepoint-event.h>
+
+/*
+ * Add this macro and its matching element to make sure the program
+ * works in c++.
+ */
+#ifdef __cplusplus
+}
+#endif /*__cplusplus */
--- /dev/null
+/*
+ * tp.c
+ *
+ * Copyright (c) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *
+ * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
+ * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
+ *
+ * Permission is hereby granted to use or copy this program for any
+ * purpose, provided the above notices are retained on all copies.
+ * Permission to modify the code and to distribute modified code is
+ * granted, provided the above notices are retained, and a notice that
+ * the code was modified is included with the above copyright notice.
+ */
+
+/*
+ * Defining macro creates the code objects of the traceprobes, only do
+ * it once per file
+ */
+#define TRACEPOINT_CREATE_PROBES
+/*
+ * The header containing our TRACEPOINT_EVENTs.
+ */
+#include "sample_component_provider.h"
projects / lttng-ust.git / commitdiff
