NAME
mkdir mkdirat
— make a directory relative to directory file
descriptor
SYNOPSIS
#include
<sys/stat.h>
int mkdir(const char *path, mode_t mode); int mkdirat(int fd, const char *path, mode_t mode);
DESCRIPTION
The mkdir () function shall create a new
directory with name path. The file permission bits of the
new directory shall be initialized from mode. These file
permission bits of the mode argument shall be modified by
the process' file creation mask.
When bits in mode other than the file permission bits are set, the meaning of these additional bits is implementation-defined.
The directory's user ID shall be set to the process' effective user ID. The directory's group ID shall be set to the group ID of the parent directory or to the effective group ID of the process. Implementations shall provide a way to initialize the directory's group ID to the group ID of the parent directory. Implementations may, but need not, provide an implementation-defined way to initialize the directory's group ID to the effective group ID of the calling process.
The newly created directory shall be an empty directory.
If path names a symbolic link,
mkdir () shall fail and set errno
to [EEXIST].
Upon successful completion, mkdir () shall
mark for update the last data access, last data modification, and last file
status change timestamps of the directory. Also, the last data modification
and last file status change timestamps of the directory that contains the
new entry shall be marked for update.
The mkdirat () function shall be
equivalent to the mkdir () function except in the
case where path specifies a relative path. In this case
the newly created directory is created relative to the directory associated
with the file descriptor fd instead of the current working
directory. If the file descriptor was opened without O_SEARCH, the function
shall check whether directory searches are permitted using the current
permissions of the directory underlying the file descriptor. If the file
descriptor was opened with O_SEARCH, the function shall not perform the
check.
If mkdirat () is passed the special value
AT_FDCWD in the fd parameter, the current working
directory is used and the behavior shall be identical to a call to
mkdir ().
RETURN VALUE
Upon successful completion, these functions shall return 0. Otherwise, these functions shall return -1 and set errno to indicate the error. If -1 is returned, no directory shall be created.
ERRORS
These functions shall fail if:
- [EACCES]
- Search permission is denied on a component of the path prefix, or write permission is denied on the parent directory of the directory to be created.
- [EEXIST]
- The named file exists.
- [ELOOP]
- A loop exists in symbolic links encountered during resolution of the path argument.
- [EMLINK]
- The link count of the parent directory would exceed {LINK_MAX}.
- [ENAMETOOLONG]
- The length of a component of a pathname is longer than {NAME_MAX}.
- [ENOENT]
- A component of the path prefix specified by path does not name an existing directory or path is an empty string.
- [ENOSPC]
- The file system does not contain enough space to hold the contents of the new directory or to extend the parent directory of the new directory.
- [ENOTDIR]
- A component of the path prefix is not a directory.
- [EROFS]
- The parent directory resides on a read-only file system.
In addition, the mkdirat () function shall
fail if:
- [EBADF]
- The path argument does not specify an absolute path and the fd argument is neither AT_FDCWD nor a valid file descriptor open for reading.
These functions may fail if:
- [ELOOP]
- More than {SYMLOOP_MAX} symbolic links were encountered during resolution of the path argument.
- [ENAMETOOLONG]
- The length of a pathname exceeds {PATH_MAX}, or pathname resolution of a symbolic link produced an intermediate result with a length that exceeds {PATH_MAX}.
The mkdirat () function may fail if:
- [ENOTDIR]
- The path argument is not an absolute path and fd is neither AT_FDCWD nor a file descriptor associated with a directory.
EXAMPLES
Creating a Directory
The following example shows how to create a directory named /home/cnd/mod1, with read/write/search permissions for owner and group, and with read/search permissions for others.
#include <sys/types.h>
#include <sys/stat.h>
int status;
...
status = mkdir("/home/cnd/mod1", S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
APPLICATION USAGE
None.
RATIONALE
The mkdir () function originated in 4.2
BSD and was added to System V in Release 3.0.
4.3 BSD detects [ENAMETOOLONG].
The POSIX.1-1990 standard required that the group ID of a newly created directory be set to the group ID of its parent directory or to the effective group ID of the creating process. FIPS 151-2 required that implementations provide a way to have the group ID be set to the group ID of the containing directory, but did not prohibit implementations also supporting a way to set the group ID to the effective group ID of the creating process. Conforming applications should not assume which group ID will be used. If it matters, an application can use chown(3) to set the group ID after the directory is created, or determine under what conditions the implementation will set the desired group ID.
The purpose of the mkdirat () function is
to create a directory in directories other than the current working
directory without exposure to race conditions. Any part of the path of a
file could be changed in parallel to the call to
mkdir (), resulting in unspecified behavior. By
opening a file descriptor for the target directory and using the
mkdirat () function it can be guaranteed that the
newly created directory is located relative to the desired directory.
FUTURE DIRECTIONS
None.
SEE ALSO
chmod(3) , mkdtemp(3) , mknod(3) , umask(3)
XBD <sys/stat.h> , <sys/types.h>
CHANGE HISTORY
First released in Issue 3. Included for alignment with the POSIX.1-1988 standard.
Issue 6
In the SYNOPSIS, the optional include of the <sys/types.h> header is removed.
The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:
- The requirement to include <sys/types.h> has been removed. Although <sys/types.h> was required for conforming implementations of previous POSIX specifications, it was not required for UNIX applications.
- The [ELOOP] mandatory error condition is added.
- A second [ENAMETOOLONG] is added as an optional error condition.
The following changes were made to align with the IEEE P1003.1a draft standard:
- The [ELOOP] optional error condition is added.
Issue 7
Austin Group Interpretation 1003.1-2001 #143 is applied.
The mkdirat () function is added from The
Open Group Technical Standard, 2006, Extended API Set Part 2.
Changes are made related to support for finegrained timestamps.