d082a63734
After seeing the uglyness that is removing directories in the
codebase I decided to push down this to the OPAL by extending the
opal/os_create_dirpath.(c|h) to contain some more functionality.
In this process I renamed 'os_create_dirpath' to 'os_dirpath' since it
is a bit more general now.
Added a few functions to:
- check if an directory is empty
- check to see if the access permissions are set correctly
- destroy the directory at the end of the dirpath
- By using a caller callback function (a la Perl, I believe)
for every file, the caller can have fine grained control over
whether a specific file is deleted or not.
This simplifies things a bit for orte_session_dir_(finalize|cleanup)
as it should no longer contain any of this functionality, but uses
these functions to do the work.
From the external perspective nothing has changed, from the
developer point of view we have some cleaner, more generic code.
This commit was SVN r10640.
119 строки
4.8 KiB
C
119 строки
4.8 KiB
C
/*
|
|
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
|
|
* University Research and Technology
|
|
* Corporation. All rights reserved.
|
|
* Copyright (c) 2004-2005 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:
|
|
* Creates a directory tree set to the specified permissions.
|
|
*
|
|
* The opal_os_dirpath_create() function creates a directory
|
|
* tree, with each directory that is created in the tree having the specified
|
|
* access permissions. Existing directories within the tree are left
|
|
* untouched - however, if they do not permit the user to create a directory
|
|
* within them, the function will return an error condition.
|
|
*
|
|
* If the specified full path name already exists, the
|
|
* opal_os_dirpath_create() function will check to ensure that
|
|
* the final directory in the tree has at least the specified access permission. In other
|
|
* words, if the directory has read-write-execute for all, and the user
|
|
* has requested read-write access for just the user, then the function
|
|
* will consider the directory acceptable. If the minimal permissions are
|
|
* not currently provided, the function will attempt to change the
|
|
* access permissions of the directory to add the specified
|
|
* permissions. The function will return OPAL_ERROR if this cannot
|
|
* be done.
|
|
**/
|
|
|
|
#ifndef OPAL_OS_DIRPATH_CREATE_H
|
|
#define OPAL_OS_DIRPATH_CREATE_H
|
|
|
|
#include "opal_config.h"
|
|
#include <stdio.h>
|
|
#ifdef HAVE_SYS_TYPES_H
|
|
#include <sys/types.h>
|
|
#endif
|
|
#ifdef HAVE_SYS_STAT_H
|
|
#include <sys/stat.h>
|
|
#endif
|
|
|
|
/**
|
|
* @param path A pointer to a string that contains the path name to be built.
|
|
* @param mode A mode_t bit mask that specifies the access permissions for the
|
|
* directories being constructed.
|
|
* @retval OPAL_SUCCESS If the directory tree has been successfully created with
|
|
* the specified access permissions.
|
|
* @retval OPAL_ERROR If the directory tree could not be created with the
|
|
* specified access permissions.
|
|
*/
|
|
|
|
OMPI_DECLSPEC int opal_os_dirpath_create(const char *path, const mode_t mode);
|
|
|
|
/**
|
|
* Check to see if a directory is empty
|
|
*
|
|
* @param path A pointer to a string that contains the path name to be checked.
|
|
*
|
|
* @retval true If the directory is empty
|
|
* @retval false If the directory is not empty
|
|
*/
|
|
OMPI_DECLSPEC bool opal_os_dirpath_is_empty(const char *path);
|
|
|
|
/**
|
|
* Check access to the directory
|
|
*
|
|
* @param path A pointer to a string that contains the path name to be checked.
|
|
* @param mode A mode_t bit mask that specifies the access permissions for the
|
|
* directory to be accessed.
|
|
*
|
|
* @retval OPAL_SUCCESS If directory exists, and permissions match
|
|
* @retval OPAL_ERR_NOT_FOUND If directory does not exist
|
|
* @retval OPAL_ERROR If directory exists, and permissions do not match
|
|
*/
|
|
OMPI_DECLSPEC int opal_os_dirpath_access(const char *path, const mode_t mode );
|
|
|
|
/**
|
|
* Callback for opal_os_dirpath_destroy(). Call for every file/directory before
|
|
* taking action to remove/unlink it.
|
|
*
|
|
* @param root A pointer to a string that contains the base path name (e.g., /tmp/foo from /tmp/foo/bar)
|
|
* @param path A pointer to a string that contains the file or directory (e.g., bar from /tmp/foo/bar)
|
|
*
|
|
* @retval true Allow the program to remove the file/directory
|
|
* @retval false Do not allow the program to remove the file/directory
|
|
*/
|
|
typedef bool (*opal_os_dirpath_destroy_callback_fn_t)(const char *root, const char *path);
|
|
|
|
/**
|
|
* Destroy a directory
|
|
*
|
|
* @param path A pointer to a string that contains the path name to be destroyed
|
|
* @param recursive Recursively desend the directory removing all files and directories.
|
|
* if set to 'false' then the directory must be empty to succeed.
|
|
* @param cbfunc A function that will be called before removing a file or directory.
|
|
* If NULL, then assume all remove.
|
|
*
|
|
* @retval OPAL_SUCCESS If the directory was successfully removed or removed to the
|
|
* specification of the user (i.e., obeyed the callback function).
|
|
* @retval OPAL_ERR_NOT_FOUND If directory does not exist.
|
|
* @retval OPAL_ERROR If the directory cannnot be removed, accessed properly, or contains
|
|
* directories that could not be removed..
|
|
*/
|
|
OMPI_DECLSPEC int opal_os_dirpath_destroy(const char *path,
|
|
bool recursive,
|
|
opal_os_dirpath_destroy_callback_fn_t cbfunc);
|
|
|
|
#endif
|