Message pipe services.
[Native Xenomai API.]

---

Detailed Description

Message pipe services.

A message pipe is a two-way communication channel between Xenomai tasks and standard Linux processes using regular file I/O operations on a pseudo-device. Pipes can be operated in a message-oriented fashion so that message boundaries are preserved, and also in byte streaming mode from real-time to standard Linux processes for optimal throughput.

Xenomai tasks open their side of the pipe using the rt_pipe_create() service; standard Linux processes do the same by opening one of the /dev/rtpN special devices, where N is the minor number agreed upon between both ends of each pipe. Additionally, named pipes are available through the registry support, which automatically creates a symbolic link from entries under /proc/xenomai/registry/native/pipes/ to the corresponding special device file.

Files
file	pipe.c
	This file is part of the Xenomai project.
Functions
int	rt_pipe_create (RT_PIPE *pipe, const char *name, int minor, size_t poolsize)
	Create a message pipe.
int	rt_pipe_delete (RT_PIPE *pipe)
	Delete a message pipe.
ssize_t	rt_pipe_receive (RT_PIPE *pipe, RT_PIPE_MSG **msgp, RTIME timeout)
	Receive a message from a pipe.
ssize_t	rt_pipe_read (RT_PIPE *pipe, void *buf, size_t size, RTIME timeout)
	Read a message from a pipe.
ssize_t	rt_pipe_send (RT_PIPE *pipe, RT_PIPE_MSG *msg, size_t size, int mode)
	Send a message through a pipe.
ssize_t	rt_pipe_write (RT_PIPE *pipe, const void *buf, size_t size, int mode)
	Write a message to a pipe.
ssize_t	rt_pipe_stream (RT_PIPE *pipe, const void *buf, size_t size)
	Stream bytes to a pipe.
ssize_t	rt_pipe_flush (RT_PIPE *pipe)
	Flush the pipe.
RT_PIPE_MSG *	rt_pipe_alloc (RT_PIPE *pipe, size_t size)
	Allocate a message pipe buffer.
int	rt_pipe_free (RT_PIPE *pipe, RT_PIPE_MSG *msg)
	Free a message pipe buffer.

---

Function Documentation

RT_PIPE_MSG * rt_pipe_alloc (  RT_PIPE *  pipe, size_t  size )

Allocate a message pipe buffer. This service allocates a message buffer from the pipe's heap which can be subsequently filled by the caller then passed to rt_pipe_send() for sending. The beginning of the available data area of size contiguous bytes is accessible from P_MSGPTR(msg). Parameters: pipe  The descriptor address of the affected pipe. size  The requested size in bytes of the buffer. This value should represent the size of the payload data. Returns: The address of the allocated message buffer upon success, or NULL if the allocation fails. Environments: This service can be called from: Kernel module initialization/cleanup code Interrupt service routine Kernel-based task Rescheduling: never.

int rt_pipe_create (  RT_PIPE *  pipe, const char *  name, int  minor, size_t  poolsize )

Create a message pipe. This service opens a bi-directional communication channel allowing data exchange between Xenomai tasks and standard Linux processes. Pipes natively preserve message boundaries, but can also be used in byte stream mode from Xenomai tasks to standard Linux processes. rt_pipe_create() always returns immediately, even if no Linux process has opened the associated special device file yet. On the contrary, the non real-time side could block upon attempt to open the special device file until rt_pipe_create() is issued on the same pipe from a Xenomai task, unless O_NONBLOCK has been specified to the open(2) system call. Parameters: pipe  The address of a pipe descriptor Xenomai will use to store the pipe-related data. This descriptor must always be valid while the pipe is active therefore it must be allocated in permanent memory. name  An ASCII string standing for the symbolic name of the message pipe. When non-NULL and non-empty, this string is copied to a safe place into the descriptor, and passed to the registry package if enabled for indexing the created pipe. Named pipes are supported through the use of the registry. When the registry support is enabled, passing a valid name parameter when creating a message pipe subsequently allows standard Linux processes to follow a symbolic link from /proc/xenomai/registry/pipes/name in order to reach the associated special device (i.e. /dev/rtp*), so that the specific minor information does not need to be known from those processes for opening the proper device file. In such a case, both sides of the pipe only need to agree upon a symbolic name to refer to the same data path, which is especially useful whenever the minor number is picked up dynamically using an adaptive algorithm, such as passing P_MINOR_AUTO as minor value. Parameters: minor  The minor number of the device associated with the pipe. Passing P_MINOR_AUTO causes the minor number to be auto-allocated. In such a case, the name parameter must be valid so that user-space processes may subsequently follow the symbolic link that will be automatically created from /proc/xenomai/registry/pipes/name to the allocated pipe device entry (i.e. /dev/rtp*). poolsize  Specifies the size of a dedicated buffer pool for the pipe. Passing 0 means that all message allocations for this pipe are performed on the system heap. Returns: 0 is returned upon success. Otherwise: -ENOMEM is returned if the system fails to get enough dynamic memory from the global real-time heap in order to register the pipe, or if not enough memory could be obtained from the selected buffer pool for allocating the internal streaming buffer. -EEXIST is returned if the name is already in use by some registered object. -ENODEV is returned if minor is different from P_MINOR_AUTO and is not a valid minor number for the pipe special device either (i.e. /dev/rtp*). -EBUSY is returned if minor is already open. -EPERM is returned if this service was called from an asynchronous context. Environments: This service can be called from: Kernel module initialization/cleanup code Kernel-based task User-space task Rescheduling: possible.

int rt_pipe_delete (  RT_PIPE *  pipe  )

Delete a message pipe. This service deletes a pipe previously created by rt_pipe_create(). Data pending for transmission to non real-time processes are lost. Parameters: pipe  The descriptor address of the affected pipe. Returns: 0 is returned upon success. Otherwise: -EINVAL is returned if pipe is not a pipe descriptor. -EIDRM is returned if pipe is a closed pipe descriptor. -ENODEV or -EBADF can be returned if pipe is scrambled. -EPERM is returned if this service was called from an asynchronous context. Environments: This service can be called from: Kernel module initialization/cleanup code Kernel-based task User-space task Rescheduling: possible.

ssize_t rt_pipe_flush (  RT_PIPE *  pipe  )

Flush the pipe. This operation makes the data available for reading from the associated special device. Parameters: pipe  The descriptor address of the pipe to flush. Returns: Zero upon success. Otherwise: -EINVAL is returned if pipe is not a pipe descriptor. -EPIPE is returned if the associated special device is not yet open. -EIDRM is returned if pipe is a closed pipe descriptor. -ENODEV or -EBADF are returned if pipe is scrambled. Environments: This service can be called from: Kernel module initialization/cleanup code Interrupt service routine Kernel-based task Rescheduling: possible. Note: This service is deprecated, since the streamed data is now immediately available to the receiving side.

int rt_pipe_free (  RT_PIPE *  pipe, RT_PIPE_MSG *  msg )

Free a message pipe buffer. This service releases a message buffer returned by rt_pipe_receive() to the pipe's heap. Parameters: pipe  The descriptor address of the affected pipe. msg  The address of the message buffer to free. Returns: 0 is returned upon success, or -EINVAL if msg is not a valid message buffer previously allocated by the rt_pipe_alloc() service. Environments: This service can be called from: Kernel module initialization/cleanup code Interrupt service routine Kernel-based task Rescheduling: never.

ssize_t rt_pipe_read (  RT_PIPE *  pipe, void *  buf, size_t  size, RTIME  timeout )

Read a message from a pipe. This service retrieves the next message written to the associated special device in user-space. rt_pipe_read() always preserves message boundaries, which means that all data sent through the same write(2) operation to the special device will be gathered in a single message by this service. This services differs from rt_pipe_receive() in that it copies back the payload data to a user-defined memory area, instead of returning a pointer to the internal message buffer holding such data. Unless otherwise specified, the caller is blocked for a given amount of time if no data is immediately available on entry. Parameters: pipe  The descriptor address of the pipe to read from. buf  A pointer to a memory location which will be written upon success with the read message contents. size  The count of bytes from the received message to read up into buf. If size is lower than the actual message size, -ENOBUFS is returned since the incompletely received message would be lost. If size is zero, this call returns immediately with no other action. timeout  The number of clock ticks to wait for some message to arrive (see note). Passing TM_INFINITE causes the caller to block indefinitely until some data is eventually available. Passing TM_NONBLOCK causes the service to return immediately without waiting if no data is available on entry. Returns: The number of read bytes copied to the buf is returned upon success. Otherwise: -EINVAL is returned if pipe is not a pipe descriptor. -EIDRM is returned if pipe is a closed pipe descriptor. -ENODEV or -EBADF are returned if pipe is scrambled. -ETIMEDOUT is returned if timeout is different from TM_NONBLOCK and no data is available within the specified amount of time. -EWOULDBLOCK is returned if timeout is equal to TM_NONBLOCK and no data is immediately available on entry. -EINTR is returned if rt_task_unblock() has been called for the waiting task before any data was available. -EPERM is returned if this service should block, but was called from a context which cannot sleep (e.g. interrupt, non-realtime or scheduler locked). -ENOBUFS is returned if size is not large enough to collect the message data. Environments: This service can be called from: Kernel module initialization/cleanup code Interrupt service routine only if timeout is equal to TM_NONBLOCK. Kernel-based task User-space task (switches to primary mode) Rescheduling: always unless the request is immediately satisfied or timeout specifies a non-blocking operation. Note: This service is sensitive to the current operation mode of the system timer, as defined by the CONFIG_XENO_OPT_TIMING_PERIOD parameter. In periodic mode, clock ticks are interpreted as periodic jiffies. In oneshot mode, clock ticks are interpreted as nanoseconds.

ssize_t rt_pipe_receive (  RT_PIPE *  pipe, RT_PIPE_MSG **  msgp, RTIME  timeout )

Receive a message from a pipe. This service retrieves the next message written to the associated special device in user-space. rt_pipe_receive() always preserves message boundaries, which means that all data sent through the same write(2) operation to the special device will be gathered in a single message by this service. This service differs from rt_pipe_read() in that it returns a pointer to the internal buffer holding the message, which improves performances by saving a data copy to a user-provided buffer, especially when large messages are involved. Unless otherwise specified, the caller is blocked for a given amount of time if no data is immediately available on entry. Parameters: pipe  The descriptor address of the pipe to receive from. msgp  A pointer to a memory location which will be written upon success with the address of the received message. Once consumed, the message space should be freed using rt_pipe_free(). The application code can retrieve the actual data and size carried by the message by respectively using the P_MSGPTR() and P_MSGSIZE() macros. timeout  The number of clock ticks to wait for some message to arrive (see note). Passing TM_INFINITE causes the caller to block indefinitely until some data is eventually available. Passing TM_NONBLOCK causes the service to return immediately without waiting if no data is available on entry. Returns: The number of read bytes available from the received message is returned upon success; this value will be equal to P_MSGSIZE(*msgp). Otherwise: -EINVAL is returned if pipe is not a pipe descriptor. -EIDRM is returned if pipe is a closed pipe descriptor. -ENODEV or -EBADF are returned if pipe is scrambled. -ETIMEDOUT is returned if timeout is different from TM_NONBLOCK and no data is available within the specified amount of time. -EWOULDBLOCK is returned if timeout is equal to TM_NONBLOCK and no data is immediately available on entry. -EINTR is returned if rt_task_unblock() has been called for the waiting task before any data was available. -EPERM is returned if this service should block, but was called from a context which cannot sleep (e.g. interrupt, non-realtime or scheduler locked). Environments: This service can be called from: Kernel module initialization/cleanup code Interrupt service routine only if timeout is equal to TM_NONBLOCK. Kernel-based task Rescheduling: always unless the request is immediately satisfied or timeout specifies a non-blocking operation. Note: This service is sensitive to the current operation mode of the system timer, as defined by the CONFIG_XENO_OPT_TIMING_PERIOD parameter. In periodic mode, clock ticks are interpreted as periodic jiffies. In oneshot mode, clock ticks are interpreted as nanoseconds.

ssize_t rt_pipe_send (  RT_PIPE *  pipe, RT_PIPE_MSG *  msg, size_t  size, int  mode )

Send a message through a pipe. This service writes a complete message to be received from the associated special device. rt_pipe_send() always preserves message boundaries, which means that all data sent through a single call of this service will be gathered in a single read(2) operation from the special device. This service differs from rt_pipe_write() in that it accepts a canned message buffer, instead of a pointer to the raw data to be sent. This call is useful whenever the caller wants to prepare the message contents separately from its sending, which does not require to have all the data to be sent available at once but allows for incremental updates of the message, and also saves a message copy, since rt_pipe_send() deals internally with message buffers. Parameters: pipe  The descriptor address of the pipe to send to. msg  The address of the message to be sent. The message space must have been allocated using the rt_pipe_alloc() service. Once passed to rt_pipe_send(), the memory pointed to by msg is no more under the control of the application code and thus should not be referenced by it anymore; deallocation of this memory will be automatically handled as needed. As a special exception, msg can be NULL and will not be dereferenced if size is zero. size  The size in bytes of the message (payload data only). Zero is a valid value, in which case the service returns immediately without sending any message. This parameter allows you to actually send less data than you reserved using the rt_pipe_alloc() service, which may be the case if you did not know how much space you needed at the time of allocation. In all other cases it may be more convenient to just pass P_MSGSIZE(msg). mode  A set of flags affecting the operation: P_URGENT causes the message to be prepended to the output queue, ensuring a LIFO ordering. P_NORMAL causes the message to be appended to the output queue, ensuring a FIFO ordering. Returns: Upon success, this service returns size. Upon error, one of the following error codes is returned: -EINVAL is returned if pipe is not a pipe descriptor. -EPIPE is returned if the associated special device is not yet open. -EIDRM is returned if pipe is a closed pipe descriptor. -ENODEV or -EBADF are returned if pipe is scrambled. Environments: This service can be called from: Kernel module initialization/cleanup code Interrupt service routine Kernel-based task Rescheduling: possible.

ssize_t rt_pipe_stream (  RT_PIPE *  pipe, const void *  buf, size_t  size )

Stream bytes to a pipe. This service writes a sequence of bytes to be received from the associated special device. Unlike rt_pipe_send(), this service does not preserve message boundaries. Instead, an internal buffer is filled on the fly with the data, which will be consumed as soon as the receiver wakes up. Data buffers sent by the rt_pipe_stream() service are always transmitted in FIFO order (i.e. P_NORMAL mode). Parameters: pipe  The descriptor address of the pipe to write to. buf  The address of the first data byte to send. The data will be copied to an internal buffer before transmission. size  The size in bytes of the buffer. Zero is a valid value, in which case the service returns immediately without buffering any data. Returns: The number of bytes sent upon success; this value may be lower than size, depending on the available space in the internal buffer. Otherwise: -EINVAL is returned if pipe is not a pipe descriptor. -EPIPE is returned if the associated special device is not yet open. -EIDRM is returned if pipe is a closed pipe descriptor. -ENODEV or -EBADF are returned if pipe is scrambled. -ENOSYS is returned if the byte streaming mode has been disabled at configuration time by nullifying the size of the pipe buffer (see CONFIG_XENO_OPT_NATIVE_PIPE_BUFSZ). Environments: This service can be called from: Kernel module initialization/cleanup code Interrupt service routine Kernel-based task User-space task Rescheduling: possible.

ssize_t rt_pipe_write (  RT_PIPE *  pipe, const void *  buf, size_t  size, int  mode )

Write a message to a pipe. This service writes a complete message to be received from the associated special device. rt_pipe_write() always preserves message boundaries, which means that all data sent through a single call of this service will be gathered in a single read(2) operation from the special device. This service differs from rt_pipe_send() in that it accepts a pointer to the raw data to be sent, instead of a canned message buffer. This call is useful whenever the caller does not need to prepare the message contents separately from its sending. Parameters: pipe  The descriptor address of the pipe to write to. buf  The address of the first data byte to send. The data will be copied to an internal buffer before transmission. size  The size in bytes of the message (payload data only). Zero is a valid value, in which case the service returns immediately without sending any message. mode  A set of flags affecting the operation: P_URGENT causes the message to be prepended to the output queue, ensuring a LIFO ordering. P_NORMAL causes the message to be appended to the output queue, ensuring a FIFO ordering. Returns: Upon success, this service returns size. Upon error, one of the following error codes is returned: -EINVAL is returned if pipe is not a pipe descriptor. -EPIPE is returned if the associated special device is not yet open. -ENOMEM is returned if not enough buffer space is available to complete the operation. -EIDRM is returned if pipe is a closed pipe descriptor. -ENODEV or -EBADF are returned if pipe is scrambled. Environments: This service can be called from: Kernel module initialization/cleanup code Interrupt service routine Kernel-based task User-space task Rescheduling: possible.

---