Fix: syscall event rule: emission sites not compared in is_equal
[lttng-tools.git] / include / lttng / snapshot.h
index 9bdf775a97c8e36dc7fe3846ec01189e6120e95c..4c1049b4d4243fd72de68a008df012207b787713 100644 (file)
@@ -8,6 +8,8 @@
 #ifndef LTTNG_SNAPSHOT_H
 #define LTTNG_SNAPSHOT_H
 
+#include <lttng/lttng-export.h>
+
 #include <limits.h>
 #include <stdint.h>
 #include <sys/types.h>
@@ -26,12 +28,12 @@ struct lttng_snapshot_output_list;
 /*
  * Return an newly allocated snapshot output object or NULL on error.
  */
-struct lttng_snapshot_output *lttng_snapshot_output_create(void);
+LTTNG_EXPORT extern struct lttng_snapshot_output *lttng_snapshot_output_create(void);
 
 /*
  * Free a given snapshot output object.
  */
-void lttng_snapshot_output_destroy(struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern void lttng_snapshot_output_destroy(struct lttng_snapshot_output *output);
 
 /*
  * Snapshot output getter family functions. They all return the value present
@@ -39,15 +41,20 @@ void lttng_snapshot_output_destroy(struct lttng_snapshot_output *output);
  */
 
 /* Return snapshot ID. */
-uint32_t lttng_snapshot_output_get_id(struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern uint32_t
+lttng_snapshot_output_get_id(const struct lttng_snapshot_output *output);
 /* Return maximum size of a snapshot. */
-uint64_t lttng_snapshot_output_get_maxsize(struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern uint64_t
+lttng_snapshot_output_get_maxsize(const struct lttng_snapshot_output *output);
 /* Return snapshot name. */
-const char *lttng_snapshot_output_get_name(struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern const char *
+lttng_snapshot_output_get_name(const struct lttng_snapshot_output *output);
 /* Return snapshot control URL in a text format. */
-const char *lttng_snapshot_output_get_ctrl_url(struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern const char *
+lttng_snapshot_output_get_ctrl_url(const struct lttng_snapshot_output *output);
 /* Return snapshot data URL in a text format. */
-const char *lttng_snapshot_output_get_data_url(struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern const char *
+lttng_snapshot_output_get_data_url(const struct lttng_snapshot_output *output);
 
 /*
  * Snapshot output setter family functions.
@@ -57,36 +64,71 @@ const char *lttng_snapshot_output_get_data_url(struct lttng_snapshot_output *out
  */
 
 /* Set a custom ID. */
-int lttng_snapshot_output_set_id(uint32_t id,
-               struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern int lttng_snapshot_output_set_id(uint32_t id,
+                                                    struct lttng_snapshot_output *output);
 /* Set the maximum size. */
-int lttng_snapshot_output_set_size(uint64_t size,
-               struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern int lttng_snapshot_output_set_size(uint64_t size,
+                                                      struct lttng_snapshot_output *output);
 /* Set the snapshot name. */
-int lttng_snapshot_output_set_name(const char *name,
-               struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern int lttng_snapshot_output_set_name(const char *name,
+                                                      struct lttng_snapshot_output *output);
+
+/*
+ * Set the output destination to be a path on the local filesystem.
+ *
+ * The path must be absolute. It can optionally begin with `file://`.
+ *
+ * Return 0 on success or else a negative LTTNG_ERR code.
+ */
+LTTNG_EXPORT extern int lttng_snapshot_output_set_local_path(const char *path,
+                                                            struct lttng_snapshot_output *output);
+
+/*
+ * Set the output destination to be the network from a combined control/data
+ * URL.
+ *
+ * `url` must start with `net://` or `net6://`.
+ *
+ * Return 0 on success or else a negative LTTNG_ERR code.
+ */
+LTTNG_EXPORT extern int lttng_snapshot_output_set_network_url(const char *url,
+                                                             struct lttng_snapshot_output *output);
+
+/*
+ * Set the output destination to be the network using separate URLs for control
+ * and data.
+ *
+ * Both ctrl_url and data_url must be non-null.
+ *
+ * `ctrl_url` and `data_url` must start with `tcp://` or `tcp6://`.
+ *
+ * Return 0 on success or else a negative LTTNG_ERR code.
+ */
+LTTNG_EXPORT extern int lttng_snapshot_output_set_network_urls(
+       const char *ctrl_url, const char *data_url, struct lttng_snapshot_output *output);
+
 /* Set the control URL. Local and remote URL are supported. */
-int lttng_snapshot_output_set_ctrl_url(const char *url,
-               struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern int lttng_snapshot_output_set_ctrl_url(const char *url,
+                                                          struct lttng_snapshot_output *output);
 /* Set the data URL. Local and remote URL are supported. */
-int lttng_snapshot_output_set_data_url(const char *url,
-               struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern int lttng_snapshot_output_set_data_url(const char *url,
+                                                          struct lttng_snapshot_output *output);
 
 /*
  * Add an output object to a session identified by name.
  *
  * Return 0 on success or else a negative LTTNG_ERR code.
  */
-int lttng_snapshot_add_output(const char *session_name,
-               struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern int lttng_snapshot_add_output(const char *session_name,
+                                                 struct lttng_snapshot_output *output);
 
 /*
  * Delete an output object to a session identified by name.
  *
  * Return 0 on success or else a negative LTTNG_ERR code.
  */
-int lttng_snapshot_del_output(const char *session_name,
-               struct lttng_snapshot_output *output);
+LTTNG_EXPORT extern int lttng_snapshot_del_output(const char *session_name,
+                                                 struct lttng_snapshot_output *output);
 
 /*
  * List all snapshot output(s) of a session identified by name. The output list
@@ -95,8 +137,8 @@ int lttng_snapshot_del_output(const char *session_name,
  * Return 0 on success or else a negative LTTNG_ERR code and the list pointer
  * is untouched.
  */
-int lttng_snapshot_list_output(const char *session_name,
-               struct lttng_snapshot_output_list **list);
+LTTNG_EXPORT extern int lttng_snapshot_list_output(const char *session_name,
+                                                  struct lttng_snapshot_output_list **list);
 
 /*
  * Return the next available snapshot output object in the given list. A list
@@ -105,13 +147,14 @@ int lttng_snapshot_list_output(const char *session_name,
  * Return the next object on success or else NULL indicating the end of the
  * list.
  */
-struct lttng_snapshot_output *lttng_snapshot_output_list_get_next(
-               struct lttng_snapshot_output_list *list);
+LTTNG_EXPORT extern struct lttng_snapshot_output *
+lttng_snapshot_output_list_get_next(struct lttng_snapshot_output_list *list);
 
 /*
  * Free an output list object.
  */
-void lttng_snapshot_output_list_destroy(struct lttng_snapshot_output_list *list);
+LTTNG_EXPORT extern void
+lttng_snapshot_output_list_destroy(struct lttng_snapshot_output_list *list);
 
 /*
  * Snapshot a trace for the given session.
@@ -125,8 +168,8 @@ void lttng_snapshot_output_list_destroy(struct lttng_snapshot_output_list *list)
  *
  * Return 0 on success or else a negative LTTNG_ERR value.
  */
-int lttng_snapshot_record(const char *session_name,
-               struct lttng_snapshot_output *output, int wait);
+LTTNG_EXPORT extern int
+lttng_snapshot_record(const char *session_name, struct lttng_snapshot_output *output, int wait);
 
 #ifdef __cplusplus
 }
This page took 0.026009 seconds and 4 git commands to generate.