/*
- * Copyright (C) 2019 - Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
+ * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
*
- * 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_TRACKER_H
#define LTTNG_TRACKER_H
#include <lttng/constant.h>
-#include <common/macros.h>
+#include <lttng/session.h>
#ifdef __cplusplus
extern "C" {
LTTNG_TRACKER_ID_STATUS_UNSET = 1,
};
-struct lttng_handle;
+/*
+ * A tracker id.
+ */
struct lttng_tracker_id;
+/*
+ * A collection of tracker id.
+ */
+struct lttng_tracker_ids;
+
/*
* Create a tracker id for the passed tracker type.
* Users must set the tracker id using the matching API call.
struct lttng_tracker_id *id);
/*
- * Destroys (frees) a tracker id.
+ * Destroy a tracker id.
*/
extern void lttng_tracker_id_destroy(struct lttng_tracker_id *id);
/*
- * Returns the type of the tracker id.
+ * Get the type of a tracker id.
*/
extern enum lttng_tracker_id_type lttng_tracker_id_get_type(
const struct lttng_tracker_id *id);
/*
- * Returns the value of the tracker id.
+ * Get the value of a tracker id.
*
* Returns LTTNG_TRACKER_ID_OK on success,
* LTTNG_TRACKER_ID_STATUS_INVALID when the tracker is not of type
const struct lttng_tracker_id *id, int *value);
/*
- * Returns the string representation of the tracker id.
+ * Get the string representation of the tracker id.
*
* Returns LTTNG_TRACKER_ID_OK on success,
* LTTNG_TRACKER_ID_STATUS_INVALID when the tracker is not of type
extern enum lttng_tracker_id_status lttng_tracker_id_get_string(
const struct lttng_tracker_id *id, const char **value);
-/*
- * Destroys (frees) an array of tracker id.
- */
-extern void lttng_tracker_ids_destroy(
- struct lttng_tracker_id **ids, size_t nr_ids);
-
/*
* Add ID to session tracker.
*
const struct lttng_tracker_id *id);
/*
- * List IDs in the tracker.
+ * List IDs of a tracker.
*
- * tracker_type is the type of tracker.
- * ids is set to an allocated array of IDs currently tracked.
- * On success, ids must be freed using lttng_tracker_id_destroy on each
- * constituent of the returned array or using lttng_tracker_ids_destroy.
- * nr_ids is set to the number of entries contained by the ids array.
+ * On success, ids is allocated.
+ * The ids collection must be freed by the caller with lttng_destroy_ids().
*
* Returns 0 on success, else a negative LTTng error code.
*/
extern int lttng_list_tracker_ids(struct lttng_handle *handle,
enum lttng_tracker_type tracker_type,
- struct lttng_tracker_id ***ids,
- size_t *nr_ids);
+ struct lttng_tracker_ids **ids);
/*
* Backward compatibility.
int32_t **pids,
size_t *nr_pids);
+/*
+ * Get a tracker id from the list at a given index.
+ *
+ * Note that the list maintains the ownership of the returned tracker id.
+ * It must not be destroyed by the user, nor should it be held beyond the
+ * lifetime of the tracker id list.
+ *
+ * Returns a tracker id, or NULL on error.
+ */
+extern const struct lttng_tracker_id *lttng_tracker_ids_get_at_index(
+ const struct lttng_tracker_ids *ids, unsigned int index);
+
+/*
+ * Get the number of tracker id in a tracker id list.
+ *
+ * Return LTTNG_TRACKER_ID_STATUS on sucess,
+ * LTTNG_TRACKER_ID_STATUS_INVALID when passed invalid parameters.
+ */
+extern enum lttng_tracker_id_status lttng_tracker_ids_get_count(
+ const struct lttng_tracker_ids *ids, unsigned int *count);
+
+/*
+ * Destroy a tracker id list.
+ */
+extern void lttng_tracker_ids_destroy(struct lttng_tracker_ids *ids);
+
#ifdef __cplusplus
}
#endif