zvfs: Move fdtable into ZVFS

The file descriptor table is used in every area that expects to work on
files through descriptor indices. It can only be operated on through
functions whose names indicate a relationship with ZVFS (`zvfs_*fd*`).
The integer file descriptor mechanism shouldn't be separate from ZVFS.
This will make cooperation between different file access APIs much
simpler. This commit also makes preparations for the fdtable becoming
optional.

Signed-off-by: Jakub Klimczak <[email protected]>

Author: Jakub Klimczak

doc/services/portability/posix/kconfig/index.rst

@@ -9,7 +9,6 @@ implementation of the POSIX API.
 * :kconfig:option:`CONFIG_DYNAMIC_THREAD`
 * :kconfig:option:`CONFIG_DYNAMIC_THREAD_POOL_SIZE`
 * :kconfig:option:`CONFIG_EVENTFD`
-* :kconfig:option:`CONFIG_FDTABLE`
 * :kconfig:option:`CONFIG_GETOPT_LONG`
 * :kconfig:option:`CONFIG_MAX_PTHREAD_SPINLOCK_COUNT`
 * :kconfig:option:`CONFIG_MQUEUE_NAMELEN_MAX`
@@ -38,3 +37,4 @@ implementation of the POSIX API.
 * :kconfig:option:`CONFIG_TIMER_CREATE_WAIT`
 * :kconfig:option:`CONFIG_THREAD_STACK_INFO`
 * :kconfig:option:`CONFIG_ZVFS_EVENTFD_MAX`
+* :kconfig:option:`CONFIG_ZVFS_FDTABLE`

drivers/wifi/simplelink/Kconfig.simplelink

@@ -8,7 +8,8 @@ menuconfig WIFI_SIMPLELINK
 	select SIMPLELINK_HOST_DRIVER
 	select WIFI_OFFLOAD
 	select NET_L2_WIFI_MGMT
-	select FDTABLE
+	select ZVFS
+	select ZVFS_FDTABLE
 	select POSIX_SEMAPHORES
 
 if WIFI_SIMPLELINK

lib/os/CMakeLists.txt

@@ -43,11 +43,6 @@ endif()
 
 zephyr_compile_definitions(ZVFS_OPEN_SIZE=${final_fd_size})
 
-zephyr_sources_ifdef(CONFIG_FDTABLE fdtable.c)
-zephyr_syscall_header_ifdef(CONFIG_FDTABLE
-  ${ZEPHYR_BASE}/include/zephyr/sys/fdtable.h
-)
-
 zephyr_sources_ifdef(CONFIG_CBPRINTF_COMPLETE cbprintf_complete.c)
 zephyr_sources_ifdef(CONFIG_CBPRINTF_NANO cbprintf_nano.c)
 add_subdirectory_ifdef(CONFIG_CPU_LOAD_METRIC cpu_load)
@@ -78,3 +73,7 @@ zephyr_library_include_directories(
 )
 
 add_subdirectory_ifdef(CONFIG_ZVFS zvfs)
+
+zephyr_syscall_header_ifdef(CONFIG_ZVFS_FDTABLE
+  ${ZEPHYR_BASE}/include/zephyr/sys/fdtable.h
+)

lib/os/Kconfig

@@ -3,24 +3,6 @@
 
 menu "OS Support Library"
 
-config FDTABLE
-	bool "File descriptor table"
-	help
-	  This file provides generic file descriptor table implementation, suitable
-	  for any I/O object implementing POSIX I/O semantics (i.e. read/write +
-	  aux operations).
-
-if FDTABLE
-
-config ZVFS_DEFAULT_FILE_VMETHODS
-	bool "ZVFS default virtual methods for files"
-	default y
-	help
-	  Provide typical file operations, which can be referenced in a struct fd_op_vtable
-	  and subsequently called by ZVFS functions.
-
-endif
-
 config ZVFS_OPEN_MAX
 	int "Maximum number of open file descriptors"
 	default 0

lib/os/zvfs/CMakeLists.txt

@@ -1,6 +1,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 zephyr_library()
+zephyr_library_sources_ifdef(CONFIG_ZVFS_FDTABLE zvfs_fdtable.c)
 zephyr_library_sources_ifdef(CONFIG_ZVFS_DEFAULT_FILE_VMETHODS zvfs_file_vmethods.c)
 zephyr_library_sources_ifdef(CONFIG_ZVFS_EVENTFD zvfs_eventfd.c)
 zephyr_library_sources_ifdef(CONFIG_ZVFS_POLL zvfs_poll.c)

lib/os/zvfs/Kconfig

@@ -5,7 +5,6 @@
 
 menuconfig ZVFS
 	bool "Zephyr virtual filesystem (ZVFS) support [EXPERIMENTAL]"
-	select FDTABLE
 	select EXPERIMENTAL
 	help
 	  ZVFS is a central, Zephyr-native library that provides a common interoperable API for all
@@ -14,9 +13,28 @@ menuconfig ZVFS
 
 if ZVFS
 
+config ZVFS_FDTABLE
+	bool "ZVFS file descriptor table"
+	default y
+	help
+	  This file provides generic file descriptor table implementation, suitable
+	  for any I/O object implementing POSIX I/O semantics (i.e. read/write +
+	  aux operations).
+
+if ZVFS_FDTABLE
+
+config ZVFS_DEFAULT_FILE_VMETHODS
+	bool "ZVFS default virtual methods for files"
+	help
+	  Provide typical file operations, which can be referenced in a struct fd_op_vtable
+	  and subsequently called by ZVFS functions.
+
+endif
+
 config ZVFS_EVENTFD
 	bool "ZVFS event file descriptor support"
 	imply ZVFS_POLL
+	select ZVFS_FDTABLE
 	help
 	  Enable support for ZVFS event file descriptors. An eventfd can
 	  be used as an event wait/notify mechanism together with POSIX calls
@@ -37,6 +55,7 @@ endif # ZVFS_EVENTFD
 config ZVFS_POLL
 	bool "ZVFS poll"
 	select POLL
+	select ZVFS_FDTABLE
 	help
 	  Enable support for zvfs_poll().
 

lib/os/fdtable.c lib/os/zvfs/zvfs_fdtable.clib/os/fdtable.c renamed to lib/os/zvfs/zvfs_fdtable.c

@@ -236,7 +236,7 @@ static int z_get_fd_by_obj_and_vtable(void *obj, const struct fd_op_vtable *vtab
 }
 
 bool zvfs_get_obj_lock_and_cond(void *obj, const struct fd_op_vtable *vtable, struct k_mutex **lock,
-			     struct k_condvar **cond)
+				struct k_condvar **cond)
 {
 	int fd;
 	struct fd_entry *entry;
@@ -259,8 +259,7 @@ bool zvfs_get_obj_lock_and_cond(void *obj, const struct fd_op_vtable *vtable, st
 	return true;
 }
 
-void *zvfs_get_fd_obj_and_vtable(int fd, const struct fd_op_vtable **vtable,
-			      struct k_mutex **lock)
+void *zvfs_get_fd_obj_and_vtable(int fd, const struct fd_op_vtable **vtable, struct k_mutex **lock)
 {
 	struct fd_entry *entry;
 
@@ -324,8 +323,7 @@ void zvfs_finalize_typed_fd(int fd, void *obj, const struct fd_op_vtable *vtable
 	if (vtable && vtable->ioctl) {
 		int prev_errno = errno;
 
-		(void)zvfs_fdtable_call_ioctl(vtable, obj, ZFD_IOCTL_SET_LOCK,
-					   &fdtable[fd].lock);
+		(void)zvfs_fdtable_call_ioctl(vtable, obj, ZFD_IOCTL_SET_LOCK, &fdtable[fd].lock);
 		if ((prev_errno != EOPNOTSUPP) && (errno == EOPNOTSUPP)) {
 			/* restore backed-up errno value if the backend does not support locking */
 			errno = prev_errno;
@@ -626,7 +624,6 @@ static int stdinout_ioctl_vmeth(void *obj, unsigned int request, va_list args)
 	return -1;
 }
 
-
 static const struct fd_op_vtable stdinout_fd_op_vtable = {
 	.read = stdinout_read_vmeth,
 	.write = stdinout_write_vmeth,

lib/posix/options/Kconfig.device_io

@@ -8,6 +8,7 @@ config POSIX_DEVICE_IO
 	bool "POSIX device I/O"
 	select REQUIRES_FULL_LIBC
 	select ZVFS
+	select ZVFS_DEFAULT_FILE_VMETHODS
 	select ZVFS_POLL
 	select ZVFS_SELECT
 	help

lib/posix/options/Kconfig.fs

@@ -6,7 +6,8 @@ menuconfig POSIX_FILE_SYSTEM
 	bool "POSIX file system API support"
 	default y if POSIX_API
 	select FILE_SYSTEM
-	select FDTABLE
+	select ZVFS
+	select ZVFS_FDTABLE
 	help
 	  This enables POSIX style file system related APIs.
 

lib/posix/options/Kconfig.mem

@@ -16,7 +16,8 @@ config POSIX_SHARED_MEMORY_OBJECTS
 	bool "POSIX shared memory objects"
 	select SYS_HASH_FUNC32
 	select SYS_HASH_FUNC32_DJB2
-	select FDTABLE
+	select ZVFS
+	select ZVFS_FDTABLE
 	select POSIX_MAPPED_FILES
 	help
 	  Select 'y' here and Zephyr will provide implementations of shm_open() and shm_unlink().