X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Fload.h;h=0395bb4145acfea3923abeca700eaf3c062aa527;hp=9f4c7ab8ee81f3f47c5de4a96f3d9cd56d53bb9c;hb=HEAD;hpb=a2a75fa4301617ab0d2b97614a989e3ad6efa4bb diff --git a/include/lttng/load.h b/include/lttng/load.h index 9f4c7ab8e..5f7b4ec44 100644 --- a/include/lttng/load.h +++ b/include/lttng/load.h @@ -1,24 +1,16 @@ /* - * Copyright (C) 2014 - Jérémie Galarneau - * David Goulet + * Copyright (C) 2014 Jérémie Galarneau + * Copyright (C) 2014 David Goulet * - * This library is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License, version 2.1 only, - * as published by the Free Software Foundation. + * SPDX-License-Identifier: LGPL-2.1-only * - * 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 */ #ifndef LTTNG_LOAD_H #define LTTNG_LOAD_H +#include + #ifdef __cplusplus extern "C" { #endif @@ -32,28 +24,27 @@ struct lttng_load_session_attr; /* * Return a newly allocated load session attribute object or NULL on error. */ -struct lttng_load_session_attr *lttng_load_session_attr_create(void); +LTTNG_EXPORT extern struct lttng_load_session_attr *lttng_load_session_attr_create(void); /* * Free a given load session attribute object. */ -void lttng_load_session_attr_destroy(struct lttng_load_session_attr *attr); - +LTTNG_EXPORT extern void lttng_load_session_attr_destroy(struct lttng_load_session_attr *attr); /* * Load session attribute getter family of functions. */ /* Return session name. NULL indicates all sessions must be loaded. */ -const char *lttng_load_session_attr_get_session_name( - struct lttng_load_session_attr *attr); +LTTNG_EXPORT extern const char * +lttng_load_session_attr_get_session_name(struct lttng_load_session_attr *attr); /* * Return input URL. A NULL value indicates the default session * configuration location. The URL format used is documented in lttng-create(1). * NULL indicates that the default session configuration path is used. */ -const char *lttng_load_session_attr_get_input_url( - struct lttng_load_session_attr *attr); +LTTNG_EXPORT extern const char * +lttng_load_session_attr_get_input_url(struct lttng_load_session_attr *attr); /* * Return the configuration overwrite attribute. This attribute indicates @@ -61,8 +52,7 @@ const char *lttng_load_session_attr_get_input_url( * same name already exists. If such a session exists, it is destroyed before * the replacement is loaded. */ -int lttng_load_session_attr_get_overwrite( - struct lttng_load_session_attr *attr); +LTTNG_EXPORT extern int lttng_load_session_attr_get_overwrite(struct lttng_load_session_attr *attr); /* * Return the destination URL configuration override attribute. This attribute @@ -70,11 +60,9 @@ int lttng_load_session_attr_get_overwrite( * configuration. * * NULL indicates no override will be applied on configuration load. - * - * Caller is responsible for freeing the return value. */ -const char *lttng_load_session_attr_get_override_url( - struct lttng_load_session_attr *attr); +LTTNG_EXPORT extern const char * +lttng_load_session_attr_get_override_url(struct lttng_load_session_attr *attr); /* * Return the configuration override control URL attribute. This attribute @@ -82,23 +70,30 @@ const char *lttng_load_session_attr_get_override_url( * configuration(s). * * NULL indicates no control URL override will be applied on configuration load. - * - * Caller is responsible for freeing the return value. */ -const char *lttng_load_session_attr_get_override_ctrl_url( - struct lttng_load_session_attr *attr); +LTTNG_EXPORT extern const char * +lttng_load_session_attr_get_override_ctrl_url(struct lttng_load_session_attr *attr); /* * Return the configuration override data URL attribute. This attribute - * indicate a data URL override to be applied during the loading of the + * indicates a data URL override to be applied during the loading of the * configuration(s). * * NULL indicates no data URL override will be applied on configuration load. + */ +LTTNG_EXPORT extern const char * +lttng_load_session_attr_get_override_data_url(struct lttng_load_session_attr *attr); + +/* + * Return the configuration override session name attribute. + * This attribute indicates a session name override to be applied during + * the loading of the configuration(s). * - * Caller is responsible for freeing the return value. + * NULL indicates no session name override will be applied on configuration + * load. */ -const char *lttng_load_session_attr_get_override_data_url( - struct lttng_load_session_attr *attr); +LTTNG_EXPORT extern const char * +lttng_load_session_attr_get_override_session_name(struct lttng_load_session_attr *attr); /* * Load session attribute setter family of functions. @@ -111,8 +106,9 @@ const char *lttng_load_session_attr_get_override_data_url( * Set the name of the session to load. A NULL name means all sessions * found at the input URL will be loaded. */ -int lttng_load_session_attr_set_session_name( - struct lttng_load_session_attr *attr, const char *session_name); +LTTNG_EXPORT extern int +lttng_load_session_attr_set_session_name(struct lttng_load_session_attr *attr, + const char *session_name); /* * Set the URL of the session configuration to load. A NULL value indicates the @@ -120,16 +116,16 @@ int lttng_load_session_attr_set_session_name( * * Note that file:// is the only supported URL format. */ -int lttng_load_session_attr_set_input_url( - struct lttng_load_session_attr *attr, const char *url); +LTTNG_EXPORT extern int lttng_load_session_attr_set_input_url(struct lttng_load_session_attr *attr, + const char *url); /* * Set the overwrite attribute. If set to true, current sessions matching the * loaded sessions will be destroyed and be replaced by the session(s) being * loaded. */ -int lttng_load_session_attr_set_overwrite( - struct lttng_load_session_attr *attr, int overwrite); +LTTNG_EXPORT extern int lttng_load_session_attr_set_overwrite(struct lttng_load_session_attr *attr, + int overwrite); /* * The following setter are for overriding sessions attributes during the @@ -138,20 +134,21 @@ int lttng_load_session_attr_set_overwrite( * */ /* - * Set the control url override attribute. + * Set the url override attribute. * * Supported format: - * NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH] + * file://TRACEPATH + * NETPROTO://(HOST | IPADDR)[:CTRLPORT[:DATAPORT]][/TRACEPATH] * * Where NETPROTO is one of {tcp, tcp6} * * See lttng-create(1) for more detail. */ -int lttng_load_session_attr_set_override_ctrl_url( - struct lttng_load_session_attr *attr, const char *url); +LTTNG_EXPORT extern int +lttng_load_session_attr_set_override_url(struct lttng_load_session_attr *attr, const char *url); /* - * Set the data url override attribute. + * Set the control url override attribute. * * Supported format: * NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH] @@ -160,22 +157,33 @@ int lttng_load_session_attr_set_override_ctrl_url( * * See lttng-create(1) for more detail. */ -int lttng_load_session_attr_set_override_data_url( - struct lttng_load_session_attr *attr, const char *url); +LTTNG_EXPORT extern int +lttng_load_session_attr_set_override_ctrl_url(struct lttng_load_session_attr *attr, + const char *url); /* - * Set the url override attribute. + * Set the data url override attribute. * * Supported format: - * file://TRACEPATH - * NETPROTO://(HOST | IPADDR)[:CTRLPORT[:DATAPORT]][/TRACEPATH] + * NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH] * * Where NETPROTO is one of {tcp, tcp6} * * See lttng-create(1) for more detail. */ -int lttng_load_session_attr_set_override_url( - struct lttng_load_session_attr *attr, const char *url); +LTTNG_EXPORT extern int +lttng_load_session_attr_set_override_data_url(struct lttng_load_session_attr *attr, + const char *url); + +/* + * Set the session name override attribute. + * + * Loading a configuration file defining multiple sessions will fail if a + * session name is provided. + */ +LTTNG_EXPORT extern int +lttng_load_session_attr_set_override_session_name(struct lttng_load_session_attr *attr, + const char *session_name); /* * Load session configuration(s). @@ -185,7 +193,7 @@ int lttng_load_session_attr_set_override_url( * * Returns 0 on success or a negative LTTNG_ERR value on error. */ -int lttng_load_session(struct lttng_load_session_attr *attr); +LTTNG_EXPORT extern int lttng_load_session(struct lttng_load_session_attr *attr); #ifdef __cplusplus }