src/util/pmix_getcwd.h

0001 /*
0002  * Copyright (c) 2007-2020 Cisco Systems, Inc.  All rights reserved
0003  * Copyright (c) 2019      Intel, Inc.  All rights reserved.
0004  * Copyright (c) 2021-2022 Nanook Consulting.  All rights reserved.
0005  * $COPYRIGHT$
0006  *
0007  * Additional copyrights may follow
0008  *
0009  * $HEADER$
0010  */
0011
0012 /**
0013  * @file
0014  *
0015  * Per https://svn.open-mpi.org/trac/ompi/ticket/933, use a
0016  * combination of $PWD and getcwd() to find the current working
0017  * directory.
0018  */
0019
0020 #ifndef PMIX_GETCWD_H
0021 #define PMIX_GETCWD_H
0022
0023 #include "src/include/pmix_config.h"
0024
0025 BEGIN_C_DECLS
0026
0027 /**
0028  * Per https://svn.open-mpi.org/trac/ompi/ticket/933, use a
0029  * combination of $PWD and getcwd() to find the current working
0030  * directory.
0031  *
0032  * Use $PWD instead of getcwd() a) if $PWD exists and b) is a valid
0033  * synonym for the results from getcwd(). If both of these conditions
0034  * are not met, just fall back and use the results of getcwd().
0035  *
0036  * @param buf Caller-allocated buffer to put the result
0037  * @param size Length of the buf array
0038  *
0039  * @retval PMIX_ERR_OUT_OF_RESOURCE If internal malloc() fails.
0040  * @retval PMIX_ERR_TEMP_OUT_OF_RESOURCE If the supplied buf buffer
0041  * was not long enough to handle the result.
0042  * @retval PMIX_ERR_BAD_PARAM If buf is NULL or size>INT_MAX
0043  * @retval PMIX_ERR_IN_ERRNO If an other error occurred
0044  * @retval PMIX_SUCCESS If all went well and a valid value was placed
0045  * in the buf buffer.
0046  */
0047 PMIX_EXPORT int pmix_getcwd(char *buf, size_t size);
0048
0049 END_C_DECLS
0050
0051 #endif /* PMIX_GETCWD_H */