1
1
openmpi/opal/util/path.h
Rainer Keller ea4de16561 - Check whether file is opened on network file-system.
If file does not exist, check the directory it lives in...
   Maybe used by caller, trying to open mmap() on NFS, Lustre or
   Panasas (thanks Sam).
   For now, this is used to warn about the usage of mmap on such FS.

   Please note, that Ralph mentioned the orte_no_session_dir parameter.
   The help message includes a reference to this.

   Tested on NFS and Lustre on Linux on
     smoky: mpirun --mca orte_tmpdir_base $HOME/tmp -np 2 ./mpi_stub
     jaguar: mpirun ... --mca orte_tmpdir_base /tmp/work/$USER ...

   Fixes trac:1354

   This should   cmr:v1.5   once it has soaked and is shown to work on
   Solaris

This commit was SVN r22604.

The following Trac tickets were found above:
  Ticket 1354 --> https://svn.open-mpi.org/trac/ompi/ticket/1354
2010-02-10 23:18:29 +00:00

142 строки
4.7 KiB
C

/*
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2007 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*
* @file
*/
#ifndef OPAL_PATH_H
#define OPAL_PATH_H
#include "opal_config.h"
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
BEGIN_C_DECLS
/**
* Locates a file with certain permissions
*
* @param fname File name
* @param pathv Array of search directories
* @param mode Permissions which must be satisfied (see access(2))
* @param envv Pointer to string containing environment
*
* @retval Full pathname of located file Success
* @retval NULL Failure
*
* Environment variables can appear in the form $variable at the
* start of a prefix path and will be replaced by the environment
* value if it is defined; otherwise the whole prefix is ignored.
* Environment variables must be followed by a path delimiter or
* end-of-string.
*
* The caller is responsible for freeing the returned string.
*/
OPAL_DECLSPEC char *opal_path_find(char *fname, char **pathv, int mode,
char **envv) __opal_attribute_malloc__ __opal_attribute_warn_unused_result__;
/**
* Locates a file with certain permissions from a list of search
* paths
*
* @param fname File name
* @param mode Target permissions which must be satisfied (see access(2))
* @param envv Pointer to environment list
* @param wrkdir Working directory
*
* @retval Full pathname of located file Success
* @retval NULL Failure
*
* Locates a file with certain permissions from the list of paths
* given by the $PATH environment variable. Replaces "." in the
* path with the working dir.
*
* The caller is responsible for freeing the returned string.
*/
OPAL_DECLSPEC char *opal_path_findv(char *fname, int mode,
char **envv, char *wrkdir) __opal_attribute_malloc__ __opal_attribute_warn_unused_result__;
/**
* Detect if the requested path is absolute or relative.
*
* @param path File name
*
* @retval true if the path is absolute
* @retval false otherwise
*
* Detect if a path is absolute or relative. Handle Windows
* with special care as an absolute path on Windows starts
* with [A-Za-z]: or \\ instead of the usual / on UNIX.
*/
OPAL_DECLSPEC bool opal_path_is_absolute( const char *path );
/**
* Find the absolute path for an executable and return it.
*
* @param app_name Executable name
*
* @retval The absolute path if the application can be reached,
* @retval NULL otherwise.
*
* Try to figure out the absolute path based on the application name
* (usually argv[0]). If the path is already absolute return a copy, if
* it start with . look into the current directory, if not dig into
* the $PATH.
* In case of error or if executable was not found (as an example if
* the application did a cwd between the start and this call), the
* function will return NULL. Otherwise, an newly allocated string
* will be returned.
*/
OPAL_DECLSPEC char* opal_find_absolute_path( char* app_name ) __opal_attribute_warn_unused_result__;
/**
* Forms a complete pathname and checks it for existance and
* permissions
*
* @param fname File name
* @param path Path prefix, if NULL then fname is an absolute path
* @param mode Target permissions which must be satisfied (see access(2))
*
* @retval NULL Failure
* @retval Full pathname of the located file on Success
*
* The caller is responsible for freeing the returned string.
*/
OPAL_DECLSPEC char *opal_path_access(char *fname, char *path, int mode) __opal_attribute_malloc__ __opal_attribute_warn_unused_result__;
/**
* @brief Figure out, whether fname is on network file system
*
* Try to figure out, whether the file name specified through fname is
* on any network file system (currently NFS, Lustre and Panasas).
*
* If the file is not created, the parent directory is checked.
* This allows checking for NFS prior to opening the file.
*
* @param[in] fname File name to check
*
* @retval true If fname is on NFS, Lustre or Panasas
* @retval false otherwise
*/
OPAL_DECLSPEC bool opal_path_nfs(char *fname) __opal_attribute_warn_unused_result__;
END_C_DECLS
#endif /* OPAL_PATH_H */