123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656 |
- /****************************************************************************
- * net/local/local_fifo.c
- *
- * Copyright (C) 2015 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <gnutt@nuttx.org>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- * 3. Neither the name NuttX nor the names of its contributors may be
- * used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
- * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- ****************************************************************************/
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #if defined(CONFIG_NET) && defined(CONFIG_NET_LOCAL)
- #include <sys/stat.h>
- #include <sys/ioctl.h>
- #include <stdbool.h>
- #include <stdio.h>
- #include <unistd.h>
- #include <fcntl.h>
- #include <string.h>
- #include <errno.h>
- #include <assert.h>
- #include "local/local.h"
- /****************************************************************************
- * Private Functions
- ****************************************************************************/
- #define LOCAL_CS_SUFFIX "CS" /* Name of the client-to-server FIFO */
- #define LOCAL_SC_SUFFIX "SC" /* Name of the server-to-client FIFO */
- #define LOCAL_HD_SUFFIX "HD" /* Name of the half duplex datagram FIFO */
- #define LOCAL_SUFFIX_LEN 2
- #define LOCAL_FULLPATH_LEN (UNIX_PATH_MAX + LOCAL_SUFFIX_LEN)
- /****************************************************************************
- * Private Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: local_cs_name
- *
- * Description:
- * Create the name of the client-to-server FIFO.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_STREAM
- static inline void local_cs_name(FAR struct local_conn_s *conn,
- FAR char *path)
- {
- if (conn->lc_instance_id < 0)
- {
- (void)snprintf(path, LOCAL_FULLPATH_LEN - 1, "%s" LOCAL_CS_SUFFIX,
- conn->lc_path);
- }
- else
- {
- (void)snprintf(path, LOCAL_FULLPATH_LEN - 1, "%s" LOCAL_CS_SUFFIX "%x",
- conn->lc_path, conn->lc_instance_id);
- }
- path[LOCAL_FULLPATH_LEN - 1] = '\0';
- }
- #endif /* CONFIG_NET_LOCAL_STREAM */
- /****************************************************************************
- * Name: local_sc_name
- *
- * Description:
- * Create the name of the server-to-client FIFO.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_STREAM
- static inline void local_sc_name(FAR struct local_conn_s *conn,
- FAR char *path)
- {
- if (conn->lc_instance_id < 0)
- {
- (void)snprintf(path, LOCAL_FULLPATH_LEN - 1, "%s" LOCAL_SC_SUFFIX,
- conn->lc_path);
- }
- else
- {
- (void)snprintf(path, LOCAL_FULLPATH_LEN - 1, "%s" LOCAL_SC_SUFFIX "%x",
- conn->lc_path, conn->lc_instance_id);
- }
- path[LOCAL_FULLPATH_LEN - 1] = '\0';
- }
- #endif /* CONFIG_NET_LOCAL_STREAM */
- /****************************************************************************
- * Name: local_hd_name
- *
- * Description:
- * Create the name of the half duplex, datagram FIFO.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_DGRAM
- static inline void local_hd_name(FAR const char *inpath, FAR char *outpath)
- {
- (void)snprintf(outpath, LOCAL_FULLPATH_LEN - 1, "%s" LOCAL_HD_SUFFIX,
- inpath);
- outpath[LOCAL_FULLPATH_LEN - 1] = '\0';
- }
- #endif /* CONFIG_NET_LOCAL_DGRAM */
- /****************************************************************************
- * Name: local_fifo_exists
- *
- * Description:
- * Check if a FIFO exists.
- *
- ****************************************************************************/
- static bool local_fifo_exists(FAR const char *path)
- {
- struct stat buf;
- int ret;
- /* Create the client-to-server FIFO */
- ret = stat(path, &buf);
- if (ret < 0)
- {
- return false;
- }
- /* FIFOs are character devices in NuttX. Return true if what we found
- * is a FIFO. What if it is something else? In that case, we will
- * return false and mkfifo() will fail.
- */
- return (bool)S_ISCHR(buf.st_mode);
- }
- /****************************************************************************
- * Name: local_create_fifo
- *
- * Description:
- * Create the one FIFO.
- *
- ****************************************************************************/
- static int local_create_fifo(FAR const char *path)
- {
- int ret;
- /* Create the client-to-server FIFO if it does not already exist. */
- if (!local_fifo_exists(path))
- {
- ret = mkfifo(path, 0644);
- if (ret < 0)
- {
- int errcode = get_errno();
- DEBUGASSERT(errcode > 0);
- nerr("ERROR: Failed to create FIFO %s: %d\n", path, errcode);
- return -errcode;
- }
- }
- /* The FIFO (or some character driver) exists at PATH or we successfully
- * created the FIFO at that location.
- */
- return OK;
- }
- /****************************************************************************
- * Name: local_release_fifo
- *
- * Description:
- * Release a reference from one of the FIFOs used in a connection.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_STREAM /* Currently not used by datagram code */
- static int local_release_fifo(FAR const char *path)
- {
- int ret;
- /* Unlink the client-to-server FIFO if it exists. */
- if (local_fifo_exists(path))
- {
- /* Un-linking the FIFO removes the FIFO from the namespace. It will
- * also mark the FIFO device "unlinked". When all of the open
- * references to the FIFO device are closed, the resources consumed
- * by the device instance will also be freed.
- */
- ret = unlink(path);
- if (ret < 0)
- {
- int errcode = get_errno();
- DEBUGASSERT(errcode > 0);
- nerr("ERROR: Failed to unlink FIFO %s: %d\n", path, errcode);
- return -errcode;
- }
- }
- /* The FIFO does not exist or we successfully unlinked it. */
- return OK;
- }
- #endif
- /****************************************************************************
- * Name: local_rx_open
- *
- * Description:
- * Open a FIFO for read-only access.
- *
- ****************************************************************************/
- static int local_rx_open(FAR struct local_conn_s *conn, FAR const char *path,
- bool nonblock)
- {
- int oflags = nonblock ? O_RDONLY | O_NONBLOCK : O_RDONLY;
- int ret;
- ret = file_open(&conn->lc_infile, path, oflags);
- if (ret < 0)
- {
- nerr("ERROR: Failed on open %s for reading: %d\n",
- path, ret);
- /* Map the error code to something consistent with the return
- * error codes from connect():
- *
- * If error is ENOENT, meaning that the FIFO does exist,
- * return EFAULT meaning that the socket structure address is
- * outside the user's address space.
- */
- return ret == -ENOENT ? -EFAULT : ret;
- }
- return OK;
- }
- /****************************************************************************
- * Name: local_tx_open
- *
- * Description:
- * Open a FIFO for write-only access.
- *
- ****************************************************************************/
- static int local_tx_open(FAR struct local_conn_s *conn, FAR const char *path,
- bool nonblock)
- {
- int oflags = nonblock ? O_WRONLY | O_NONBLOCK : O_WRONLY;
- int ret;
- ret = file_open(&conn->lc_outfile, path, oflags);
- if (ret < 0)
- {
- nerr("ERROR: Failed on open %s for writing: %d\n",
- path, ret);
- /* Map the error code to something consistent with the return
- * error codes from connect():
- *
- * If error is ENOENT, meaning that the FIFO does exist,
- * return EFAULT meaning that the socket structure address is
- * outside the user's address space.
- */
- return ret == -ENOENT ? -EFAULT : ret;
- }
- return OK;
- }
- /****************************************************************************
- * Name: local_set_policy
- *
- * Description:
- * Set the FIFO buffer policy:
- *
- * 0=Free FIFO resources when the last reference is closed
- * 1=Free FIFO resources when the buffer is empty.
- *
- ****************************************************************************/
- static int local_set_policy(FAR struct file *filep, unsigned long policy)
- {
- int ret;
- /* Set the buffer policy */
- ret = file_ioctl(filep, PIPEIOC_POLICY, policy);
- if (ret < 0)
- {
- nerr("ERROR: Failed to set FIFO buffer policty: %d\n", ret);
- }
- return ret;
- }
- /****************************************************************************
- * Public Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: local_create_fifos
- *
- * Description:
- * Create the FIFO pair needed for a SOCK_STREAM connection.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_STREAM
- int local_create_fifos(FAR struct local_conn_s *conn)
- {
- char path[LOCAL_FULLPATH_LEN];
- int ret;
- /* Create the client-to-server FIFO if it does not already exist. */
- local_cs_name(conn, path);
- ret = local_create_fifo(path);
- if (ret >= 0)
- {
- /* Create the server-to-client FIFO if it does not already exist. */
- local_sc_name(conn, path);
- ret = local_create_fifo(path);
- }
- return ret;
- }
- #endif /* CONFIG_NET_LOCAL_STREAM */
- /****************************************************************************
- * Name: local_create_halfduplex
- *
- * Description:
- * Create the half-duplex FIFO needed for SOCK_DGRAM communication.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_DGRAM
- int local_create_halfduplex(FAR struct local_conn_s *conn, FAR const char *path)
- {
- char fullpath[LOCAL_FULLPATH_LEN];
- /* Create the half duplex FIFO if it does not already exist. */
- local_hd_name(path, fullpath);
- return local_create_fifo(fullpath);
- }
- #endif /* CONFIG_NET_LOCAL_DGRAM */
- /****************************************************************************
- * Name: local_release_fifos
- *
- * Description:
- * Release references to the FIFO pair used for a SOCK_STREAM connection.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_STREAM
- int local_release_fifos(FAR struct local_conn_s *conn)
- {
- char path[LOCAL_FULLPATH_LEN];
- int ret1;
- int ret2;
- /* Destroy the client-to-server FIFO if it exists. */
- local_sc_name(conn, path);
- ret1 = local_release_fifo(path);
- /* Destroy the server-to-client FIFO if it exists. */
- local_cs_name(conn, path);
- ret2 = local_release_fifo(path);
- /* Return a failure if one occurred. */
- return ret1 < 0 ? ret1 : ret2;
- }
- #endif /* CONFIG_NET_LOCAL_STREAM */
- /****************************************************************************
- * Name: local_release_halfduplex
- *
- * Description:
- * Release a reference to the FIFO used for SOCK_DGRAM communication
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_DGRAM
- int local_release_halfduplex(FAR struct local_conn_s *conn)
- {
- #if 1
- /* REVIST: We need to think about this carefully. Unlike the connection-
- * oriented Unix domain socket, we don't really know the best time to
- * release the FIFO resource. It would be extremely inefficient to create
- * and destroy the FIFO on each packet. But, on the other hand, failing
- * to destory the FIFO will leave the FIFO resources in place after the
- * communications have completed.
- *
- * I am thinking that there should be something like a timer. The timer
- * would be started at the completion of each transfer and cancelled at
- * the beginning of each transfer. If the timer expires, then the FIFO
- * would be destroyed.
- */
- # warning Missing logic
- return OK;
- #else
- char path[LOCAL_FULLPATH_LEN];
- /* Destroy the half duplex FIFO if it exists. */
- local_hd_name(conn->lc_path, path);
- return local_release_fifo(path);
- #endif
- }
- #endif /* CONFIG_NET_LOCAL_DGRAM */
- /****************************************************************************
- * Name: local_open_client_rx
- *
- * Description:
- * Open the client-side of the server-to-client FIFO.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_STREAM
- int local_open_client_rx(FAR struct local_conn_s *client, bool nonblock)
- {
- char path[LOCAL_FULLPATH_LEN];
- int ret;
- /* Get the server-to-client path name */
- local_sc_name(client, path);
- /* Then open the file for read-only access */
- ret = local_rx_open(client, path, nonblock);
- if (ret == OK)
- {
- /* Policy: Free FIFO resources when the last reference is closed */
- ret = local_set_policy(&client->lc_infile, 0);
- }
- return ret;
- }
- #endif /* CONFIG_NET_LOCAL_STREAM */
- /****************************************************************************
- * Name: local_open_client_tx
- *
- * Description:
- * Open the client-side of the client-to-server FIFO.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_STREAM
- int local_open_client_tx(FAR struct local_conn_s *client, bool nonblock)
- {
- char path[LOCAL_FULLPATH_LEN];
- int ret;
- /* Get the client-to-server path name */
- local_cs_name(client, path);
- /* Then open the file for write-only access */
- ret = local_tx_open(client, path, nonblock);
- if (ret == OK)
- {
- /* Policy: Free FIFO resources when the last reference is closed */
- ret = local_set_policy(&client->lc_outfile, 0);
- }
- return ret;
- }
- #endif /* CONFIG_NET_LOCAL_STREAM */
- /****************************************************************************
- * Name: local_open_server_rx
- *
- * Description:
- * Open the server-side of the client-to-server FIFO.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_STREAM
- int local_open_server_rx(FAR struct local_conn_s *server, bool nonblock)
- {
- char path[LOCAL_FULLPATH_LEN];
- int ret;
- /* Get the client-to-server path name */
- local_cs_name(server, path);
- /* Then open the file for write-only access */
- ret = local_rx_open(server, path, nonblock);
- if (ret == OK)
- {
- /* Policy: Free FIFO resources when the last reference is closed */
- ret = local_set_policy(&server->lc_infile, 0);
- }
- return ret;
- }
- #endif /* CONFIG_NET_LOCAL_STREAM */
- /****************************************************************************
- * Name: local_open_server_tx
- *
- * Description:
- * Only the server-side of the server-to-client FIFO.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_STREAM
- int local_open_server_tx(FAR struct local_conn_s *server, bool nonblock)
- {
- char path[LOCAL_FULLPATH_LEN];
- int ret;
- /* Get the server-to-client path name */
- local_sc_name(server, path);
- /* Then open the file for read-only access */
- ret = local_tx_open(server, path, nonblock);
- if (ret == OK)
- {
- /* Policy: Free FIFO resources when the last reference is closed */
- ret = local_set_policy(&server->lc_outfile, 0);
- }
- return ret;
- }
- #endif /* CONFIG_NET_LOCAL_STREAM */
- /****************************************************************************
- * Name: local_open_receiver
- *
- * Description:
- * Only the receiving side of the half duplex FIFO.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_DGRAM
- int local_open_receiver(FAR struct local_conn_s *conn, bool nonblock)
- {
- char path[LOCAL_FULLPATH_LEN];
- int ret;
- /* Get the server-to-client path name */
- local_hd_name(conn->lc_path, path);
- /* Then open the file for read-only access */
- ret = local_rx_open(conn, path, nonblock);
- if (ret == OK)
- {
- /* Policy: Free FIFO resources when the buffer is empty. */
- ret = local_set_policy(&conn->lc_infile, 1);
- }
- return ret;
- }
- #endif /* CONFIG_NET_LOCAL_DGRAM */
- /****************************************************************************
- * Name: local_open_sender
- *
- * Description:
- * Only the sending side of the half duplex FIFO.
- *
- ****************************************************************************/
- #ifdef CONFIG_NET_LOCAL_DGRAM
- int local_open_sender(FAR struct local_conn_s *conn, FAR const char *path,
- bool nonblock)
- {
- char fullpath[LOCAL_FULLPATH_LEN];
- int ret;
- /* Get the server-to-client path name */
- local_hd_name(path, fullpath);
- /* Then open the file for read-only access */
- ret = local_tx_open(conn, fullpath, nonblock);
- if (ret == OK)
- {
- /* Policy: Free FIFO resources when the buffer is empty. */
- ret = local_set_policy(&conn->lc_outfile, 1);
- }
- return ret;
- }
- #endif /* CONFIG_NET_LOCAL_DGRAM */
- #endif /* CONFIG_NET && CONFIG_NET_LOCAL */
|