src/util/pmix_error.h

0001 /*
0002  * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
0003  *                         University Research and Technology
0004  *                         Corporation.  All rights reserved.
0005  * Copyright (c) 2004-2006 The University of Tennessee and The University
0006  *                         of Tennessee Research Foundation.  All rights
0007  *                         reserved.
0008  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
0009  *                         University of Stuttgart.  All rights reserved.
0010  * Copyright (c) 2004-2005 The Regents of the University of California.
0011  *                         All rights reserved.
0012  * Copyright (c) 2015-2020 Intel, Inc.  All rights reserved.
0013  * Copyright (c) 2021-2023 Nanook Consulting.  All rights reserved.
0014  * $COPYRIGHT$
0015  *
0016  * Additional copyrights may follow
0017  *
0018  * $HEADER$
0019  */
0020
0021 #ifndef PMIX_UTIL_ERROR_H
0022 #define PMIX_UTIL_ERROR_H
0023
0024 #include "src/include/pmix_config.h"
0025
0026 #include "pmix.h"
0027 #include "src/util/pmix_output.h"
0028
0029 BEGIN_C_DECLS
0030
0031 /* define a starting point for PMIx internal error codes
0032  * that are never exposed outside the library */
0033 #define PMIX_INTERNAL_ERR_BASE -1330
0034
0035 /****    PMIX ERROR CONSTANTS    ****/
0036
0037 /* internal error codes - never exposed outside of the library */
0038 #define PMIX_ERR_FABRIC_NOT_PARSEABLE -1363
0039 #define PMIX_ERR_TAKE_NEXT_OPTION     -1366
0040 #define PMIX_ERR_TEMP_UNAVAILABLE     -1367
0041
0042 #define PMIX_INTERNAL_ERR_DONE   -2000
0043
0044 #define PMIX_ERROR_LOG(r)                                                                  \
0045     do {                                                                                   \
0046         if (PMIX_ERR_SILENT != (r)) {                                                      \
0047             pmix_output(0, "PMIX ERROR: %s in file %s at line %d", PMIx_Error_string((r)), \
0048                         __FILE__, __LINE__);                                               \
0049         }                                                                                  \
0050     } while (0)
0051
0052 END_C_DECLS
0053
0054 #endif /* PMIX_UTIL_ERROR_H */