Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-08-01 20:28:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
nuttx/include/fcntl.h
Xiang Xiao 9e141acab3 !include/fcntl.h: align open flags with Linux values 
Align the NuttX open(2) flag constants with the Linux asm-generic
values so that the FUSE wire protocol and other cross-platform
interfaces work without conversion.

All code that used '(flags & O_RDONLY)' as a bitmask check (always 0
now that O_RDONLY=0) has been updated to use '(flags & O_ACCMODE)'
comparisons.

The NUTTX_O_* constants in include/nuttx/fs/hostfs.h are updated to
match, and the sim hostfs open flag mapping is fixed.

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2026-06-30 13:43:44 +08:00

224 lines
9.8 KiB
C
Raw Permalink Blame History

/****************************************************************************
* include/fcntl.h
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __INCLUDE_FCNTL_H
#define __INCLUDE_FCNTL_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <stdint.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Open flag settings for open() (and related APIs) */
/* The access mode flags (O_RDONLY/O_WRONLY/O_RDWR) use the same values
* as Linux (0/1/2) so that the FUSE wire protocol and other cross-
* platform interfaces work without conversion. The remaining flags
* are also aligned with Linux where possible.
*/
#define O_RDONLY (0U << 0) /* Open for read access (only) */
#define O_WRONLY (1U << 0) /* Open for write access (only) */
#define O_RDWR (2U << 0) /* Open for both read & write access */
#define O_ACCMODE (3U << 0) /* Mask for access mode */
#define O_TEXT (1U << 5) /* Open the file in text (translated) mode. */
#define O_CREAT (1U << 6) /* Create file/sem/mq object */
#define O_EXCL (1U << 7) /* Name must not exist when opened */
#define O_NOCTTY (1U << 8) /* Don't assign a controlling terminal */
#define O_TRUNC (1U << 9) /* Delete contents */
#define O_APPEND (1U << 10) /* Keep contents, append to end */
#define O_NONBLOCK (1U << 11) /* Don't wait for data */
#define O_DSYNC (1U << 12) /* Synchronize data on write */
#define O_ASYNC (1U << 13) /* Enable signal-driven I/O */
#define O_DIRECT (1U << 14) /* Avoid caching, write directly to hardware */
#define O_LARGEFILE (1U << 15) /* Large File */
#define O_DIRECTORY (1U << 16) /* Must be a directory */
#define O_NOFOLLOW (1U << 17) /* Don't follow links */
#define O_NOATIME (1U << 18) /* Don't update the file last access time */
#define O_CLOEXEC (1U << 19) /* Close on execute */
#define __O_SYNC (1U << 20) /* Synchronize file (data+metadata) */
#define O_PATH (1U << 21) /* Obtain a path-only fd (no I/O) */
#define __O_TMPFILE (1U << 22) /* Create an unnamed temporary file */
#define O_NDELAY O_NONBLOCK /* Synonym for O_NONBLOCK */
#define O_SYNC (__O_SYNC | O_DSYNC) /* Synchronize output on write */
#define O_RSYNC O_SYNC /* Synchronize input on read */
#define O_TMPFILE (__O_TMPFILE | O_DIRECTORY) /* Create a temporary file */
#define O_BINARY 0 /* Open the file in binary mode */
/* This is the highest bit number used in the open flags bitset. Bits above
* this bit number may be used within NuttX for other, internal purposes.
*/
#define _O_MAXBIT 22
/* Synonyms historically used as F_SETFL flags (BSD). */
#define FNDELAY O_NONBLOCK /* Don't wait for data */
#define FNONBLOCK O_NONBLOCK /* Don't wait for data */
#define FAPPEND O_APPEND /* Keep contents, append to end */
#define FSYNC O_SYNC /* Synchronize output on write */
#define FASYNC O_ASYNC /* No counterpart in NuttX */
/* FFCNTL is all the bits that may be set via fcntl. */
#define FFCNTL (FNONBLOCK | FNDELAY | FAPPEND | FSYNC | FASYNC)
/* fcntl() commands */
#define F_DUPFD 0 /* Duplicate a file descriptor */
#define F_GETFD 1 /* Read the file descriptor flags */
#define F_GETFL 2 /* Read the file status flags */
#define F_GETLEASE 3 /* Indicates what type of lease is held on fd (linux) */
#define F_GETLK 4 /* Check if we could place a lock */
#define F_GETOWN 5 /* Get the pid receiving SIGIO and SIGURG signals for fd */
#define F_GETSIG 6 /* Get the signal sent */
#define F_NOTIFY 7 /* Provide notification when directory referred to by fd changes (linux) */
#define F_SETFD 8 /* Set the file descriptor flags to value */
#define F_SETFL 9 /* Set the file status flags to the value */
#define F_SETLEASE 10 /* Set or remove file lease (linux) */
#define F_SETLK 11 /* Acquire or release a lock on range of bytes */
#define F_SETLKW 12 /* Like F_SETLK, but wait for lock to become available */
#define F_SETOWN 13 /* Set pid that will receive SIGIO and SIGURG signals for fd */
#define F_SETSIG 14 /* Set the signal to be sent */
#define F_GETPATH 15 /* Get the path of the file descriptor(BSD/macOS) */
#define F_ADD_SEALS 16 /* Add the bit-mask argument arg to the set of seals of the inode */
#define F_GET_SEALS 17 /* Get (as the function result) the current set of seals of the inode */
#define F_DUPFD_CLOEXEC 18 /* Duplicate file descriptor with close-on-exit set. */
#define F_SETPIPE_SZ 19 /* Modify the capacity of the pipe to arg bytes, but not larger than CONFIG_DEV_PIPE_MAXSIZE */
#define F_GETPIPE_SZ 20 /* Return the capacity of the pipe */
/* For posix fcntl() and lockf() */
#define F_RDLCK 0 /* Take out a read lease */
#define F_WRLCK 1 /* Take out a write lease */
#define F_UNLCK 2 /* Remove a lease */
/* Operations for bsd flock(), also used by the kernel implementation */
#define LOCK_SH 1 /* Shared lock */
#define LOCK_EX 2 /* Exclusive lock */
#define LOCK_NB 4 /* Or'd with one of the above to prevent blocking */
#define LOCK_UN 8 /* Remove lock */
/* close-on-exec flag for F_GETFD and F_SETFD */
#define FD_CLOEXEC 1
/* The flag for openat, faccessat, ... */
#define AT_FDCWD -100 /* Special value used to indicate openat should use the current
* working directory.
*/
#define AT_SYMLINK_NOFOLLOW 0x0100 /* Do not follow symbolic links. */
#define AT_EACCESS 0x0200 /* Test access permitted for effective IDs, not real IDs. */
#define AT_REMOVEDIR 0x0200 /* Remove directory instead of unlinking file. */
#define AT_SYMLINK_FOLLOW 0x0400 /* Follow symbolic links. */
#define AT_NO_AUTOMOUNT 0x0800 /* Suppress terminal automount traversal */
#define AT_EMPTY_PATH 0x1000 /* Allow empty relative pathname */
/* These are the notifications that can be received from F_NOTIFY (linux) */
#define DN_ACCESS 0 /* A file was accessed */
#define DN_MODIFY 1 /* A file was modified */
#define DN_CREATE 2 /* A file was created */
#define DN_DELETE 3 /* A file was unlinked */
#define DN_RENAME 4 /* A file was renamed */
#define DN_ATTRIB 5 /* Attributes of a file were changed */
/* Types of seals */
#define F_SEAL_SEAL 0x0001 /* Prevent further seals from being set */
#define F_SEAL_SHRINK 0x0002 /* Prevent file from shrinking */
#define F_SEAL_GROW 0x0004 /* Prevent file from growing */
#define F_SEAL_WRITE 0x0008 /* Prevent writes */
#define F_SEAL_FUTURE_WRITE 0x0010 /* Prevent future writes while mapped */
#if defined(CONFIG_FS_LARGEFILE)
# define F_GETLK64 F_GETLK
# define F_SETLK64 F_SETLK
# define F_SETLKW64 F_SETLKW
# define flock64 flock
# define open64 open
# define openat64 openat
# define creat64 creat
# define fallocate64 fallocate
# define posix_fadvise64 posix_fadvise
# define posix_fallocate64 posix_fallocate
#endif
/****************************************************************************
* Public Type Definitions
****************************************************************************/
/* struct flock is the third argument for F_GETLK, F_SETLK and F_SETLKW */
struct flock
{
int16_t l_type; /* Type of lock: F_RDLCK, F_WRLCK, F_UNLCK */
int16_t l_whence; /* How to interpret l_start: SEEK_SET, SEEK_CUR, SEEK_END */
off_t l_start; /* Starting offset for lock */
off_t l_len; /* Number of bytes to lock */
pid_t l_pid; /* PID of process blocking our lock (F_GETLK only) */
};
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Public Data
****************************************************************************/
/* POSIX-like File System Interfaces */
int creat(FAR const char *pathname, mode_t mode);
int open(FAR const char *path, int oflag, ...);
int openat(int dirfd, FAR const char *path, int oflag, ...);
int fcntl(int fd, int cmd, ...);
int posix_fallocate(int fd, off_t offset, off_t len);
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* __INCLUDE_FCNTL_H */
Reference in a new issue View git blame Copy permalink