xref: /petsc/src/sys/fileio/grpath.c (revision 55cda6f51c86a483abe5781578f3bbdf986e1625)

#define PETSC_DESIRE_FEATURE_TEST_MACROS /* for realpath() */
#include <petscsys.h>
#if defined(PETSC_HAVE_PWD_H)
  #include <pwd.h>
#endif
#include <ctype.h>
#include <sys/stat.h>
#if defined(PETSC_HAVE_UNISTD_H)
  #include <unistd.h>
#endif
#if defined(PETSC_HAVE_SYS_UTSNAME_H)
  #include <sys/utsname.h>
#endif
#if defined(PETSC_HAVE_SYS_SYSTEMINFO_H)
  #include <sys/systeminfo.h>
#endif
#include <errno.h>

/*@C
  PetscGetRealPath - Get the path without symbolic links etc. in absolute form.

  Not Collective

  Input Parameter:
. path - path to resolve

  Output Parameter:
. rpath - resolved path

  Level: developer

  Notes:
  `rpath` is assumed to be of length `PETSC_MAX_PATH_LEN`.

  Systems that use the automounter often generate absolute paths
  of the form "/tmp_mnt....".  However, the automounter will fail to
  mount this path if it is not already mounted, so we remove this from
  the head of the line.  This may cause problems if, for some reason,
  /tmp_mnt is valid and not the result of the automounter.

.seealso: `PetscGetFullPath()`
@*/
PetscErrorCode PetscGetRealPath(const char path[], char rpath[])
{
#if !defined(PETSC_HAVE_REALPATH) && defined(PETSC_HAVE_READLINK)
  char tmp1[PETSC_MAX_PATH_LEN], char tmp3[PETSC_MAX_PATH_LEN], tmp4[PETSC_MAX_PATH_LEN], *tmp2;
  size_t N, len1, len2;
  int    n, m;
#endif
  size_t len;

  PetscFunctionBegin;
#if defined(PETSC_HAVE_REALPATH)
  PetscCheck(realpath(path, rpath), PETSC_COMM_SELF, PETSC_ERR_LIB, "Error in realpath() due to \"%s\"", strerror(errno));
#else
  #if defined(PETSC_HAVE_READLINK)
  /* Algorithm: we move through the path, replacing links with the real paths.   */
  PetscCall(PetscStrlen(path, &N));
  PetscCall(PetscStrncpy(rpath, path, N + 1)); /* assuming adequate buffer */
  PetscCall(PetscStrlen(rpath, &N));
  while (N) {
    PetscCall(PetscStrncpy(tmp1, rpath, N));
    tmp1[N] = 0;
    n       = readlink(tmp1, tmp3, PETSC_MAX_PATH_LEN);
    PetscCheck(n > -1, PETSC_COMM_SELF, PETSC_ERR_SYS, "Error in readlink() due to \"%\"", strerror(errno));
    if (n > 0) {
      tmp3[n] = 0; /* readlink does not automatically add 0 to string end */
      if (tmp3[0] != '/') {
        PetscCall(PetscStrchr(tmp1, '/', &tmp2));
        PetscCall(PetscStrlen(tmp1, &len1));
        PetscCall(PetscStrlen(tmp2, &len2));
        m = len1 - len2;
        PetscCall(PetscStrncpy(tmp4, tmp1, m));
        tmp4[m] = 0;
        PetscCall(PetscStrlen(tmp4, &len));
        PetscCall(PetscStrlcat(tmp4, "/", PETSC_MAX_PATH_LEN));
        PetscCall(PetscStrlcat(tmp4, tmp3, PETSC_MAX_PATH_LEN));
        PetscCall(PetscGetRealPath(tmp4, rpath));
        PetscCall(PetscStrlcat(rpath, path + N, PETSC_MAX_PATH_LEN));
      } else {
        PetscCall(PetscGetRealPath(tmp3, tmp1));
        PetscCall(PetscStrncpy(rpath, tmp1, PETSC_MAX_PATH_LEN));
        PetscCall(PetscStrlcat(rpath, path + N, PETSC_MAX_PATH_LEN));
      }
      PetscFunctionReturn(PETSC_SUCCESS);
    }
    PetscCall(PetscStrchr(tmp1, '/', &tmp2));
    if (tmp2) {
      PetscCall(PetscStrlen(tmp1, &len1));
      PetscCall(PetscStrlen(tmp2, &len2));
      N = len1 - len2;
    } else {
      PetscCall(PetscStrlen(tmp1, &N));
    }
  }
  #endif
  PetscCall(PetscStrncpy(rpath, path, PETSC_MAX_PATH_LEN)); /* assuming adequate buffer */
#endif

  /* remove garbage some automounters put at the beginning of the path */
  {
    const char   garbage[]   = "/tmp_mnt/";
    const size_t garbage_len = sizeof(garbage) - 1; // 9
    PetscBool    flg;

    PetscCall(PetscStrncmp(garbage, rpath, garbage_len, &flg));
    if (flg) {
      const size_t no_slash_len = garbage_len - 1; // 8

      PetscCall(PetscStrlen(rpath, &len));
      // shift the array left by no_slash_len
      PetscCall(PetscArraymove(rpath, rpath + no_slash_len, len - no_slash_len));
      // zero out the end we just moved from
      PetscCall(PetscArrayzero(rpath + len - no_slash_len, no_slash_len));
    }
  }
  PetscFunctionReturn(PETSC_SUCCESS);
}