Add C++ support to API header files
[lttng-tools.git] / include / lttng / lttng.h
index 598abe07777d4b8594219e980ed242795d74b31d..a9aee7233e7307735982c951b937ed5c2012d38e 100644 (file)
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-#ifndef _LTTNG_H
-#define _LTTNG_H
+#ifndef LTTNG_H
+#define LTTNG_H
 
 #include <limits.h>
-#include <netinet/in.h>
 #include <stdint.h>
 #include <sys/types.h>
 
+/* Error codes that can be returned by API calls */
+#include <lttng/lttng-error.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /*
  * Event symbol length. Copied from LTTng kernel ABI.
  */
 #define LTTNG_SYMBOL_NAME_LEN             256
 
-/*
- * Maximum length of a domain name. This is the limit for the total length of a
- * domain name specified by the RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt)
- */
-#define LTTNG_MAX_DNNAME                  255
-
 /*
  * Every lttng_event_* structure both apply to kernel event and user-space
  * event.
@@ -125,67 +125,21 @@ enum lttng_event_context_type {
        LTTNG_EVENT_CONTEXT_PPID              = 8,
        LTTNG_EVENT_CONTEXT_VPPID             = 9,
        LTTNG_EVENT_CONTEXT_PTHREAD_ID        = 10,
+       LTTNG_EVENT_CONTEXT_HOSTNAME          = 11,
 };
 
 enum lttng_calibrate_type {
        LTTNG_CALIBRATE_FUNCTION              = 0,
 };
 
-/* Destination type of lttng URI */
-enum lttng_dst_type {
-       LTTNG_DST_IPV4                        = 1,
-       LTTNG_DST_IPV6                        = 2,
-       LTTNG_DST_PATH                        = 3,
-};
-
-/* Type of lttng URI where it is a final destination or a hop */
-enum lttng_uri_type {
-       LTTNG_URI_DST,  /* The URI is a final destination */
-       /*
-        * Hop are not supported yet but planned for a future release.
-        *
-       LTTNG_URI_HOP,
-       */
-};
-
-/* Communication stream type of a lttng URI */
-enum lttng_stream_type {
-       LTTNG_STREAM_CONTROL,
-       LTTNG_STREAM_DATA,
-};
-
-/*
- * Protocol type of a lttng URI. The value 0 indicate that the proto_type field
- * should be ignored.
- */
-enum lttng_proto_type {
-       LTTNG_TCP                             = 1,
-       /*
-        * UDP protocol is not supported for now.
-        *
-       LTTNG_UDP                             = 2,
-       */
-};
-
-/*
- * Structure representing an URI supported by lttng.
- */
-#define LTTNG_URI_PADDING1_LEN         16
-#define LTTNG_URI_PADDING2_LEN         LTTNG_SYMBOL_NAME_LEN + 32
-struct lttng_uri {
-       enum lttng_dst_type dtype;
-       enum lttng_uri_type utype;
-       enum lttng_stream_type stype;
-       enum lttng_proto_type proto;
-       in_port_t port;
-       char padding[LTTNG_URI_PADDING1_LEN];
-       char subdir[PATH_MAX];
-       union {
-               char ipv4[INET_ADDRSTRLEN];
-               char ipv6[INET6_ADDRSTRLEN];
-               char path[PATH_MAX];
-               char padding[LTTNG_URI_PADDING2_LEN];
-       } dst;
+/* Health component for the health check function. */
+enum lttng_health_component {
+       LTTNG_HEALTH_CMD,
+       LTTNG_HEALTH_APP_MANAGE,
+       LTTNG_HEALTH_APP_REG,
+       LTTNG_HEALTH_KERNEL,
+       LTTNG_HEALTH_CONSUMER,
+       LTTNG_HEALTH_ALL,
 };
 
 /*
@@ -269,7 +223,7 @@ struct lttng_event_function_attr {
  *
  * The structures should be initialized to zero before use.
  */
-#define LTTNG_EVENT_PADDING1               16
+#define LTTNG_EVENT_PADDING1               15
 #define LTTNG_EVENT_PADDING2               LTTNG_SYMBOL_NAME_LEN + 32
 struct lttng_event {
        enum lttng_event_type type;
@@ -280,6 +234,7 @@ struct lttng_event {
 
        int32_t enabled;        /* Does not apply: -1 */
        pid_t pid;
+       unsigned char filter;   /* filter enabled ? */
 
        char padding[LTTNG_EVENT_PADDING1];
 
@@ -410,18 +365,11 @@ extern struct lttng_handle *lttng_create_handle(const char *session_name,
 extern void lttng_destroy_handle(struct lttng_handle *handle);
 
 /*
- * Create a tracing session using a name and a path where the trace will be
- * written.
- */
-extern int lttng_create_session(const char *name, const char *path);
-
-/*
- * Create a tracing sessioin using a name, URIs and a consumer enable flag.
- * The control URI is mandatory for consumer local or network.
+ * Create a tracing session using a name and an optional URL.
+ *
+ * If _url_ is NULL, no consumer is created for the session.
  */
-extern int lttng_create_session_uri(const char *name,
-               struct lttng_uri *ctrl_uri, struct lttng_uri *data_uri,
-               unsigned int enable_consumer);
+extern int lttng_create_session(const char *name, const char *url);
 
 /*
  * Destroy a tracing session.
@@ -599,14 +547,16 @@ extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
                struct lttng_channel_attr *attr);
 
 /*
- * Set URI for a consumer for a session and domain.
+ * Set URL for a consumer for a session and domain.
+ *
+ * Both data and control URL must be defined. If both URLs are the same, only
+ * the control URL is used even for network streaming.
  *
- * For network streaming, both data and control stream type MUST be defined
- * with a specific URIs. Default port are 5342 and 5343 respectively for
- * control and data which uses the TCP protocol.
+ * Default port are 5342 and 5343 respectively for control and data which uses
+ * the TCP protocol.
  */
-extern int lttng_set_consumer_uri(struct lttng_handle *handle,
-               struct lttng_uri *uri);
+extern int lttng_set_consumer_url(struct lttng_handle *handle,
+               const char *control_url, const char *data_url);
 
 /*
  * Enable the consumer for a session and domain.
@@ -618,4 +568,20 @@ extern int lttng_enable_consumer(struct lttng_handle *handle);
  */
 extern int lttng_disable_consumer(struct lttng_handle *handle);
 
-#endif /* _LTTNG_H */
+/*
+ * Check session daemon health for a specific component.
+ *
+ * Return 0 if health is OK or 1 if BAD. A returned value of -1 indicate that
+ * the control library was not able to connect to the session daemon health
+ * socket.
+ *
+ * Any other positive value is an lttcomm error which can be translate with
+ * lttng_strerror().
+ */
+extern int lttng_health_check(enum lttng_health_component c);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* LTTNG_H */
This page took 0.024775 seconds and 4 git commands to generate.