X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fexamples%2Feasy-ust%2Fsample_component_provider.h;h=d6eb19dd950a6a6adce0d0a061e21357ad88ba96;hb=5b393d6424d959e2efbb800b0c8a61b81bf9968e;hp=16c1ee3c0bbf3b2ddf9264a797556c314b79264d;hpb=a60af3a5ee5d990c867ef190acfa81c180301ea2;p=lttng-ust.git diff --git a/doc/examples/easy-ust/sample_component_provider.h b/doc/examples/easy-ust/sample_component_provider.h index 16c1ee3c..d6eb19dd 100644 --- a/doc/examples/easy-ust/sample_component_provider.h +++ b/doc/examples/easy-ust/sample_component_provider.h @@ -1,24 +1,8 @@ /* - * Copyright (C) 2011-2012 Mathieu Desnoyers - * Copyright (C) 2011-2012 Matthew Khouzam + * SPDX-License-Identifier: MIT * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. + * Copyright (C) 2011-2012 Mathieu Desnoyers + * Copyright (C) 2011-2012 Matthew Khouzam */ /* @@ -41,20 +25,20 @@ * In this example, "sample" is the project, and "component" is the * component. */ -#undef TRACEPOINT_PROVIDER -#define TRACEPOINT_PROVIDER sample_component +#undef LTTNG_UST_TRACEPOINT_PROVIDER +#define LTTNG_UST_TRACEPOINT_PROVIDER sample_component /* * include file (this files's name) */ -#undef TRACEPOINT_INCLUDE -#define TRACEPOINT_INCLUDE "./sample_component_provider.h" +#undef LTTNG_UST_TRACEPOINT_INCLUDE +#define LTTNG_UST_TRACEPOINT_INCLUDE "./sample_component_provider.h" /* * 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) +#if !defined(_SAMPLE_COMPONENT_PROVIDER_H) || defined(LTTNG_UST_TRACEPOINT_HEADER_MULTI_READ) #define _SAMPLE_COMPONENT_PROVIDER_H /* * Add this to allow programs to call "tracepoint(...): @@ -68,11 +52,11 @@ * * sample_component:message:message = text. */ -TRACEPOINT_EVENT( +LTTNG_UST_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 + * Needs to be the same as LTTNG_UST_TRACEPOINT_PROVIDER */ sample_component, /* @@ -81,21 +65,21 @@ TRACEPOINT_EVENT( */ message, /* - * TP_ARGS macro contains the arguments passed for the tracepoint + * LTTNG_UST_TP_ARGS macro contains the arguments passed for the tracepoint * it is in the following format - * TP_ARGS( type1, name1, type2, name2, ... type10, name10) + * LTTNG_UST_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 + * LTTNG_UST_TP_ARGS() is valid to mean no arguments + * LTTNG_UST_TP_ARGS( void ) is valid too */ - TP_ARGS(char *, text), + LTTNG_UST_TP_ARGS(const char *, text), /* - * TP_FIELDS describes how to write the fields of the trace event. + * LTTNG_UST_TP_FIELDS describes how to write the fields of the trace event. * You can use the args here */ - TP_FIELDS( + LTTNG_UST_TP_FIELDS( /* * The ctf_string macro takes a c string and writes it into a field * named "message" @@ -104,28 +88,30 @@ TRACEPOINT_EVENT( ) ) /* - * 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 line 347 + * Trace loglevel, shows the level of the trace event. It can be + * LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG, LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT, + * LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT, LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR, + * LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING, LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO or + * others. If this is not set, LTTNG_UST_TRACEPOINT_LOGLEVEL_DEFAULT is + * assumed. The first two arguments identify the tracepoint See details in + * line 347 */ -TRACEPOINT_LOGLEVEL( +LTTNG_UST_TRACEPOINT_LOGLEVEL( /* * The provider name, must be the same as the provider name in the - * TRACEPOINT_EVENT and as TRACEPOINT_PROVIDER above. + * LTTNG_UST_TRACEPOINT_EVENT and as LTTNG_UST_TRACEPOINT_PROVIDER above. */ sample_component, /* * The tracepoint name, must be the same as the tracepoint name in the - * TRACEPOINT_EVENT + * LTTNG_UST_TRACEPOINT_EVENT */ message, /* * The tracepoint loglevel. Warning, some levels are abbreviated and * others are not, please see */ - TRACE_WARNING) + LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING) #endif /* _SAMPLE_COMPONENT_PROVIDER_H */