kernel: drop deprecated pipe API

This API was deprecated in 4.1, so drop it for the 4.3 release. Use new
PIPE API instead.

Signed-off-by: Anas Nashif <[email protected]>

Author: nashif

doc/releases/release-notes-4.3.rst

@@ -60,6 +60,7 @@ Removed APIs and options
 
 * The TinyCrypt library was removed as the upstream version is no longer maintained.
   PSA Crypto API is now the recommended cryptographic library for Zephyr.
+* The legacy pipe object API was removed. Use the new pipe API instead.
 
 Deprecated APIs and options
 ===========================

include/zephyr/kernel.h

@@ -5211,206 +5211,6 @@ void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer);
  */
 __syscall void k_pipe_init(struct k_pipe *pipe, uint8_t *buffer, size_t buffer_size);
 
-#ifdef CONFIG_PIPES
-/** Pipe Structure */
-struct k_pipe {
-	unsigned char *buffer;          /**< Pipe buffer: may be NULL */
-	size_t         size;            /**< Buffer size */
-	size_t         bytes_used;      /**< Number of bytes used in buffer */
-	size_t         read_index;      /**< Where in buffer to read from */
-	size_t         write_index;     /**< Where in buffer to write */
-	struct k_spinlock lock;		/**< Synchronization lock */
-
-	struct {
-		_wait_q_t      readers; /**< Reader wait queue */
-		_wait_q_t      writers; /**< Writer wait queue */
-	} wait_q;			/** Wait queue */
-
-	Z_DECL_POLL_EVENT
-
-	uint8_t	       flags;		/**< Flags */
-
-	SYS_PORT_TRACING_TRACKING_FIELD(k_pipe)
-
-#ifdef CONFIG_OBJ_CORE_PIPE
-	struct k_obj_core  obj_core;
-#endif
-};
-
-/**
- * @cond INTERNAL_HIDDEN
- */
-#define K_PIPE_FLAG_ALLOC	BIT(0)	/** Buffer was allocated */
-
-#define Z_PIPE_INITIALIZER(obj, pipe_buffer, pipe_buffer_size)     \
-	{                                                           \
-	.buffer = pipe_buffer,                                      \
-	.size = pipe_buffer_size,                                   \
-	.bytes_used = 0,                                            \
-	.read_index = 0,                                            \
-	.write_index = 0,                                           \
-	.lock = {},                                                 \
-	.wait_q = {                                                 \
-		.readers = Z_WAIT_Q_INIT(&obj.wait_q.readers),       \
-		.writers = Z_WAIT_Q_INIT(&obj.wait_q.writers)        \
-	},                                                          \
-	Z_POLL_EVENT_OBJ_INIT(obj)                                   \
-	.flags = 0,                                                 \
-	}
-
-/**
- * INTERNAL_HIDDEN @endcond
- */
-
-/**
- * @brief Statically define and initialize a pipe.
- *
- * The pipe can be accessed outside the module where it is defined using:
- *
- * @code extern struct k_pipe <name>; @endcode
- *
- * @param name Name of the pipe.
- * @param pipe_buffer_size Size of the pipe's ring buffer (in bytes),
- *                         or zero if no ring buffer is used.
- * @param pipe_align Alignment of the pipe's ring buffer (power of 2).
- *
- */
-#define K_PIPE_DEFINE(name, pipe_buffer_size, pipe_align)		\
-	static unsigned char __noinit __aligned(pipe_align)		\
-		_k_pipe_buf_##name[pipe_buffer_size];			\
-	STRUCT_SECTION_ITERABLE(k_pipe, name) =				\
-		Z_PIPE_INITIALIZER(name, _k_pipe_buf_##name, pipe_buffer_size)
-
-/**
- * @deprecated Dynamic allocation of pipe buffers will be removed in the new k_pipe API.
- * @brief Release a pipe's allocated buffer
- *
- * If a pipe object was given a dynamically allocated buffer via
- * k_pipe_alloc_init(), this will free it. This function does nothing
- * if the buffer wasn't dynamically allocated.
- *
- * @param pipe Address of the pipe.
- * @retval 0 on success
- * @retval -EAGAIN nothing to cleanup
- */
-__deprecated int k_pipe_cleanup(struct k_pipe *pipe);
-
-/**
- * @deprecated Dynamic allocation of pipe buffers will be removed in the new k_pipe API.
- * @brief Initialize a pipe and allocate a buffer for it
- *
- * Storage for the buffer region will be allocated from the calling thread's
- * resource pool. This memory will be released if k_pipe_cleanup() is called,
- * or userspace is enabled and the pipe object loses all references to it.
- *
- * This function should only be called on uninitialized pipe objects.
- *
- * @param pipe Address of the pipe.
- * @param size Size of the pipe's ring buffer (in bytes), or zero if no ring
- *             buffer is used.
- * @retval 0 on success
- * @retval -ENOMEM if memory couldn't be allocated
- */
-__deprecated __syscall int k_pipe_alloc_init(struct k_pipe *pipe, size_t size);
-
-/**
- * @deprecated k_pipe_put() is replaced by k_pipe_write(...) in the new k_pipe API.
- * @brief Write data to a pipe.
- *
- * This routine writes up to @a bytes_to_write bytes of data to @a pipe.
- *
- * @param pipe Address of the pipe.
- * @param data Address of data to write.
- * @param bytes_to_write Size of data (in bytes).
- * @param bytes_written Address of area to hold the number of bytes written.
- * @param min_xfer Minimum number of bytes to write.
- * @param timeout Waiting period to wait for the data to be written,
- *                or one of the special values K_NO_WAIT and K_FOREVER.
- *
- * @retval 0 At least @a min_xfer bytes of data were written.
- * @retval -EIO Returned without waiting; zero data bytes were written.
- * @retval -EAGAIN Waiting period timed out; between zero and @a min_xfer
- *                 minus one data bytes were written.
- */
-__deprecated __syscall int k_pipe_put(struct k_pipe *pipe, const void *data,
-			 size_t bytes_to_write, size_t *bytes_written,
-			 size_t min_xfer, k_timeout_t timeout);
-
-/**
- * @deprecated k_pipe_get() is replaced by k_pipe_read(...) in the new k_pipe API.
- * @brief Read data from a pipe.
- *
- * This routine reads up to @a bytes_to_read bytes of data from @a pipe.
- *
- * @param pipe Address of the pipe.
- * @param data Address to place the data read from pipe.
- * @param bytes_to_read Maximum number of data bytes to read.
- * @param bytes_read Address of area to hold the number of bytes read.
- * @param min_xfer Minimum number of data bytes to read.
- * @param timeout Waiting period to wait for the data to be read,
- *                or one of the special values K_NO_WAIT and K_FOREVER.
- *
- * @retval 0 At least @a min_xfer bytes of data were read.
- * @retval -EINVAL invalid parameters supplied
- * @retval -EIO Returned without waiting; zero data bytes were read.
- * @retval -EAGAIN Waiting period timed out; between zero and @a min_xfer
- *                 minus one data bytes were read.
- */
-__deprecated  __syscall int k_pipe_get(struct k_pipe *pipe, void *data,
-			 size_t bytes_to_read, size_t *bytes_read,
-			 size_t min_xfer, k_timeout_t timeout);
-
-/**
- * @deprecated k_pipe_read_avail() will be removed in the new k_pipe API.
- * @brief Query the number of bytes that may be read from @a pipe.
- *
- * @param pipe Address of the pipe.
- *
- * @retval a number n such that 0 <= n <= @ref k_pipe.size; the
- *         result is zero for unbuffered pipes.
- */
-__deprecated  __syscall size_t k_pipe_read_avail(struct k_pipe *pipe);
-
-/**
- * @deprecated k_pipe_write_avail() will be removed in the new k_pipe API.
- * @brief Query the number of bytes that may be written to @a pipe
- *
- * @param pipe Address of the pipe.
- *
- * @retval a number n such that 0 <= n <= @ref k_pipe.size; the
- *         result is zero for unbuffered pipes.
- */
-__deprecated __syscall size_t k_pipe_write_avail(struct k_pipe *pipe);
-
-/**
- * @deprecated k_pipe_flush() will be removed in the new k_pipe API.
- * @brief Flush the pipe of write data
- *
- * This routine flushes the pipe. Flushing the pipe is equivalent to reading
- * both all the data in the pipe's buffer and all the data waiting to go into
- * that pipe into a large temporary buffer and discarding the buffer. Any
- * writers that were previously pended become unpended.
- *
- * @param pipe Address of the pipe.
- */
-__deprecated __syscall void k_pipe_flush(struct k_pipe *pipe);
-
-/**
- * @deprecated k_pipe_buffer_flush will be removed in the new k_pipe API.
- * @brief Flush the pipe's internal buffer
- *
- * This routine flushes the pipe's internal buffer. This is equivalent to
- * reading up to N bytes from the pipe (where N is the size of the pipe's
- * buffer) into a temporary buffer and then discarding that buffer. If there
- * were writers previously pending, then some may unpend as they try to fill
- * up the pipe's emptied buffer.
- *
- * @param pipe Address of the pipe.
- */
-__deprecated __syscall void k_pipe_buffer_flush(struct k_pipe *pipe);
-
-#else /* CONFIG_PIPES */
-
 enum pipe_flags {
 	PIPE_FLAG_OPEN = BIT(0),
 	PIPE_FLAG_RESET = BIT(1),
@@ -5524,7 +5324,6 @@ __syscall void k_pipe_reset(struct k_pipe *pipe);
  * @param pipe Address of the pipe.
  */
 __syscall void k_pipe_close(struct k_pipe *pipe);
-#endif /* CONFIG_PIPES */
 /** @} */
 
 /**

include/zephyr/kernel/thread.h

@@ -42,18 +42,6 @@ struct __thread_entry {
 
 struct k_thread;
 
-/*
- * This _pipe_desc structure is used by the pipes kernel module when
- * CONFIG_PIPES has been selected.
- */
-
-struct _pipe_desc {
-	sys_dnode_t      node;
-	unsigned char   *buffer;         /* Position in src/dest buffer */
-	size_t           bytes_to_xfer;  /* # bytes left to transfer */
-	struct k_thread *thread;         /* Back pointer to pended thread */
-};
-
 /* can be used for creating 'dummy' threads, e.g. for pending on objects */
 struct _thread_base {
 
@@ -361,11 +349,6 @@ struct k_thread {
 	struct k_mem_paging_stats_t paging_stats;
 #endif /* CONFIG_DEMAND_PAGING_THREAD_STATS */
 
-#ifdef CONFIG_PIPES
-	/** Pipe descriptor used with blocking k_pipe operations */
-	struct _pipe_desc pipe_desc;
-#endif /* CONFIG_PIPES */
-
 #ifdef CONFIG_OBJ_CORE_THREAD
 	struct k_obj_core  obj_core;
 #endif /* CONFIG_OBJ_CORE_THREAD */

kernel/CMakeLists.txt

@@ -81,16 +81,13 @@ list(APPEND kernel_files
   condvar.c
   thread.c
   sched.c
+  pipe.c
   )
 
 if (CONFIG_SCHED_SCALABLE OR CONFIG_WAITQ_SCALABLE)
 list(APPEND kernel_files priority_queues.c)
 endif()
 
-# FIXME: Once the prior pipe implementation is removed, this should be included in the above list
-if(NOT CONFIG_PIPES)
-list(APPEND kernel_files pipe.c)
-endif() # NOT CONFIG_PIPES
 if(CONFIG_SMP)
 list(APPEND kernel_files
      smp.c
@@ -153,7 +150,6 @@ target_sources_ifdef(CONFIG_ATOMIC_OPERATIONS_C   kernel PRIVATE atomic_c.c)
 target_sources_ifdef(CONFIG_MMU                   kernel PRIVATE mmu.c)
 target_sources_ifdef(CONFIG_POLL                  kernel PRIVATE poll.c)
 target_sources_ifdef(CONFIG_EVENTS                kernel PRIVATE events.c)
-target_sources_ifdef(CONFIG_PIPES                 kernel PRIVATE pipes.c)
 target_sources_ifdef(CONFIG_SCHED_THREAD_USAGE    kernel PRIVATE usage.c)
 target_sources_ifdef(CONFIG_OBJ_CORE              kernel PRIVATE obj_core.c)
 

kernel/Kconfig

@@ -742,20 +742,6 @@ config EVENTS
 	  Note that setting this option slightly increases the size of the
 	  thread structure.
 
-config PIPES
-	bool "Pipe objects"
-	select DEPRECATED
-	help
-	  This option enables kernel pipes. A pipe is a kernel object that
-	  allows a thread to send a byte stream to another thread. Pipes can
-	  be used to synchronously transfer chunks of data in whole or in part.
-
-	  Note that setting this option slightly increases the size of the
-	  thread structure.
-	  This Kconfig is deprecated and will be removed, by disabling this
-	  kconfig another implementation of k_pipe will be available when
-	  CONFIG_MULTITHREADING is enabled.
-
 config KERNEL_MEM_POOL
 	bool "Use Kernel Memory Pool"
 	default y