include: implement REUSE with SPDX identifiers

[lttng-ust.git] / include / lttng / ust-error.h

diff --git a/include/lttng/ust-error.h b/include/lttng/ust-error.h
index 49890a965db426b7488c6577b45e843c5c51ee5e..838c5daa00171c1f302c77ea3fac3162cd79cfab 100644 (file)
--- a/include/lttng/ust-error.h
+++ b/include/lttng/ust-error.h
@@ -1,51 +1,53 @@
+// SPDX-FileCopyrightText: 2011 EfficiOS Inc.
+// SPDX-FileCopyrightText: 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+//
+// SPDX-License-Identifier: LGPL-2.1-only
+
 #ifndef _LTTNG_UST_ERROR_H
 #define _LTTNG_UST_ERROR_H
 
-/*
- * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
- *                      Julien Desfossez <julien.desfossez@polymtl.ca>
- *                      Mathieu Desnoyers <mathieu.desnoyers@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 as published by the Free Software Foundation; only
- * version 2.1 of the License.
- *
- * 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
- */
-
-/*
- * This header is meant for liblttng and libust internal use ONLY.
- * These declarations should NOT be considered stable API.
- */
-
 #include <limits.h>
 #include <unistd.h>
 #include <lttng/ust-abi.h>
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /*
  * ustcomm error code.
  */
 enum lttng_ust_error_code {
        LTTNG_UST_OK = 0,                       /* Ok */
        LTTNG_UST_ERR = 1024,                   /* Unknown Error */
-       LTTNG_UST_ERR_NOENT,                    /* No entry */
+       LTTNG_UST_ERR_NOENT = 1025,             /* No entry */
+       LTTNG_UST_ERR_EXIST = 1026,             /* Object exists */
+       LTTNG_UST_ERR_INVAL = 1027,             /* Invalid argument */
+       LTTNG_UST_ERR_PERM  = 1028,             /* Permission denied */
+       LTTNG_UST_ERR_NOSYS = 1029,             /* Not implemented */
+       LTTNG_UST_ERR_EXITING = 1030,           /* Process is exiting */
+
+       LTTNG_UST_ERR_INVAL_MAGIC = 1031,       /* Invalid magic number */
+       LTTNG_UST_ERR_INVAL_SOCKET_TYPE = 1032, /* Invalid socket type */
+       LTTNG_UST_ERR_UNSUP_MAJOR = 1033,       /* Unsupported major version */
+       LTTNG_UST_ERR_PEERCRED = 1034,          /* Cannot get unix socket peer credentials */
+       LTTNG_UST_ERR_PEERCRED_PID = 1035,      /* Peer credentials PID is invalid. Socket appears to belong to a distinct, non-nested pid namespace. */
 
        /* MUST be last element */
        LTTNG_UST_ERR_NR,                       /* Last element */
 };
 
 /*
- * Return a human-readable error message for an lttng-ust error code.
- * code must be a positive value (or 0).
+ * lttng_ust_strerror
+ * @code: must be a negative value of enum lttng_ust_error_code (or 0).
+ *
+ * Returns a ptr to a string representing a human readable error code from the
+ * ustcomm_return_code enum.
  */
-extern const char *lttng_ust_strerror(int code);
+const char *lttng_ust_strerror(int code);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* _LTTNG_UST_ERROR_H */