summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpatacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679>2012-09-04 23:59:24 +0000
committerpatacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679>2012-09-04 23:59:24 +0000
commit5fbe1af41245ce6eaf18590bd9ef62c9e55e452a (patch)
tree45cda2f05310caf3ffeed2919271876a0051f898
parented8b171fbeb8063c38114868baa913738d3372ab (diff)
Add sendfile()
git-svn-id: https://nuttx.svn.sourceforge.net/svnroot/nuttx/trunk@5090 7fd9a85b-ad96-42d3-883c-3090e2eb8679
-rw-r--r--nuttx/ChangeLog2
-rw-r--r--nuttx/include/sys/sendfile.h123
-rw-r--r--nuttx/lib/Kconfig8
-rw-r--r--nuttx/lib/lib.csv1
-rw-r--r--nuttx/lib/misc/Make.defs14
-rw-r--r--nuttx/lib/misc/lib_dbg.c2
-rw-r--r--nuttx/lib/misc/lib_dumpbuffer.c2
-rw-r--r--nuttx/lib/misc/lib_filesem.c2
-rw-r--r--nuttx/lib/misc/lib_init.c2
-rw-r--r--nuttx/lib/misc/lib_sendfile.c277
-rw-r--r--nuttx/lib/misc/lib_streamsem.c2
11 files changed, 429 insertions, 6 deletions
diff --git a/nuttx/ChangeLog b/nuttx/ChangeLog
index 47bb4c3712..a48619140d 100644
--- a/nuttx/ChangeLog
+++ b/nuttx/ChangeLog
@@ -3258,4 +3258,6 @@
is incorrect.
* configs/: Make use of UART4/5 vs USART4/5 consistent in all places.
* Kconfig: Serial 2STOP setting must be integer 0/1, not a boolean.
+ * lib/misc/sendfile.c and include/sys/sendfile.h: Add a Linux style
+ sendfile() (non-standard!)
diff --git a/nuttx/include/sys/sendfile.h b/nuttx/include/sys/sendfile.h
new file mode 100644
index 0000000000..0f3c05444a
--- /dev/null
+++ b/nuttx/include/sys/sendfile.h
@@ -0,0 +1,123 @@
+/****************************************************************************
+ * include/sys/sendfile.h
+ *
+ * Copyright (C) 2012 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.
+ *
+ ****************************************************************************/
+
+#ifndef __INCLUDE_SYS_SENDFILE_H
+#define __INCLUDE_SYS_SENDFILE_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+
+#include <sys/types.h>
+
+/****************************************************************************
+ * Pre-Processor Definitions
+ ****************************************************************************/
+/* Configuration ************************************************************/
+
+#ifndef CONFIG_LIB_SENDFILE_BUFSIZE
+# define CONFIG_LIB_SENDFILE_BUFSIZE 512
+#endif
+
+/****************************************************************************
+ * Public Type Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+#undef EXTERN
+#if defined(__cplusplus)
+#define EXTERN extern "C"
+extern "C" {
+#else
+#define EXTERN extern
+#endif
+
+/************************************************************************
+ * Name: sendfile
+ *
+ * Description:
+ * sendfile() copies data between one file descriptor and another.
+ * sendfile() basically just wraps a sequence of reads() and writes()
+ * to perform a copy. It serves a purpose in systems where there is
+ * a penalty for copies to between user and kernal space, but really
+ * nothing in NuttX but provide some Linux compatible (and adding
+ * another 'almost standard' interface).
+ *
+ * NOTE: This interface is *not* specified in POSIX.1-2001, or other
+ * standards. The implementation here is very similar to the Linux
+ * sendfile interface. Other UNIX systems implement sendfile() with
+ * different semantics and prototypes. sendfile() should not be used
+ * in portable programs.
+ *
+ * Input Parmeters:
+ * infd - A file (or socket) descriptor opened for reading
+ * outfd - A descriptor opened for writing.
+ * offset - If 'offset' is not NULL, then it points to a variable
+ * holding the file offset from which sendfile() will start
+ * reading data from 'infd'. When sendfile() returns, this
+ * variable will be set to the offset of the byte following
+ * the last byte that was read. If 'offset' is not NULL,
+ * then sendfile() does not modify the current file offset of
+ * 'infd'; otherwise the current file offset is adjusted to
+ * reflect the number of bytes read from 'infd.'
+ *
+ * If 'offset' is NULL, then data will be read from 'infd'
+ * starting at the current file offset, and the file offset
+ * will be updated by the call.
+ * count - The number of bytes to copy between the file descriptors.
+ *
+ * Returned Value:
+ * If the transfer was successful, the number of bytes written to outfd is
+ * returned. On error, -1 is returned, and errno is set appropriately.
+ * There error values are those returned by read() or write() plus:
+ *
+ * EINVAL - Bad input parameters.
+ * ENOMEM - Could not allocated an I/O buffer
+ *
+ ************************************************************************/
+
+EXTERN ssize_t sendfile (int outfd, int infd, FAR off_t *offset, size_t count);
+
+#undef EXTERN
+#if defined(__cplusplus)
+}
+#endif
+
+#endif /* __INCLUDE_SYS_SENDFILE_H */
diff --git a/nuttx/lib/Kconfig b/nuttx/lib/Kconfig
index d94a274f9b..1f9bc07df3 100644
--- a/nuttx/lib/Kconfig
+++ b/nuttx/lib/Kconfig
@@ -96,7 +96,13 @@ config ARCH_LOWPUTC
default "y"
---help---
architecture supports low-level, boot time console output
-
+
+config LIB_SENDFILE_BUFSIZE
+ int "sendfile() buffer size"
+ default 512
+ ---help---
+ Size of the I/O buffer to allocate in sendfile(). Default: 512b
+
config ENABLE_ARCH_OPTIMIZED_FUN
bool "Enable arch optimized functions"
default n
diff --git a/nuttx/lib/lib.csv b/nuttx/lib/lib.csv
index aa63653f5c..171f64e9b7 100644
--- a/nuttx/lib/lib.csv
+++ b/nuttx/lib/lib.csv
@@ -109,6 +109,7 @@
"sched_get_priority_min","sched.h","","int","int"
"sem_getvalue","semaphore.h","","int","FAR sem_t *","FAR int *"
"sem_init","semaphore.h","","int","FAR sem_t *","int","unsigned int"
+"sendfile","sys/sendfile.h","CONFIG_NSOCKET_DESCRIPTORS > 0 || CONFIG_NFILE_DESCRIPTORS > 0","ssize_t","int","int","off_t","size_t"
"sigaddset","signal.h","!defined(CONFIG_DISABLE_SIGNALS)","int","FAR sigset_t *","int"
"sigdelset","signal.h","!defined(CONFIG_DISABLE_SIGNALS)","int","FAR sigset_t *","int"
"sigemptyset","signal.h","!defined(CONFIG_DISABLE_SIGNALS)","int","FAR sigset_t *"
diff --git a/nuttx/lib/misc/Make.defs b/nuttx/lib/misc/Make.defs
index 484f822d0f..c12533f754 100644
--- a/nuttx/lib/misc/Make.defs
+++ b/nuttx/lib/misc/Make.defs
@@ -37,10 +37,24 @@
CSRCS += lib_init.c lib_filesem.c
+# Add C files that depend on file OR socket descriptors
+
ifneq ($(CONFIG_NFILE_DESCRIPTORS),0)
+
+CSRCS += lib_sendfile.c
ifneq ($(CONFIG_NFILE_STREAMS),0)
CSRCS += lib_streamsem.c
endif
+
+else
+ifneq ($(CONFIG_NSOCKET_DESCRIPTORS),0)
+
+CSRCS += lib_sendfile.c
+ifneq ($(CONFIG_NFILE_STREAMS),0)
+CSRCS += lib_streamsem.c
+endif
+
+endif
endif
# Add the miscellaneous C files to the build
diff --git a/nuttx/lib/misc/lib_dbg.c b/nuttx/lib/misc/lib_dbg.c
index 6f326bf4fc..aacdaa30a9 100644
--- a/nuttx/lib/misc/lib_dbg.c
+++ b/nuttx/lib/misc/lib_dbg.c
@@ -2,7 +2,7 @@
* lib/misc/lib_dbg.c
*
* Copyright (C) 2007-2009, 2011-2012 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ * 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
diff --git a/nuttx/lib/misc/lib_dumpbuffer.c b/nuttx/lib/misc/lib_dumpbuffer.c
index 1f1f54e8db..155468ca12 100644
--- a/nuttx/lib/misc/lib_dumpbuffer.c
+++ b/nuttx/lib/misc/lib_dumpbuffer.c
@@ -2,7 +2,7 @@
* lib/misc/lib_dumpbuffer.c
*
* Copyright (C) 2009, 2011 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ * 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
diff --git a/nuttx/lib/misc/lib_filesem.c b/nuttx/lib/misc/lib_filesem.c
index e6a3fdb671..1d1f25c2fd 100644
--- a/nuttx/lib/misc/lib_filesem.c
+++ b/nuttx/lib/misc/lib_filesem.c
@@ -2,7 +2,7 @@
* lib/misc/lib_filesem.c
*
* Copyright (C) 2007, 2009, 2011 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ * 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
diff --git a/nuttx/lib/misc/lib_init.c b/nuttx/lib/misc/lib_init.c
index fb246b1ad3..3403a837b9 100644
--- a/nuttx/lib/misc/lib_init.c
+++ b/nuttx/lib/misc/lib_init.c
@@ -2,7 +2,7 @@
* lib/misc/lib_init.c
*
* Copyright (C) 2007, 2011 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ * 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
diff --git a/nuttx/lib/misc/lib_sendfile.c b/nuttx/lib/misc/lib_sendfile.c
new file mode 100644
index 0000000000..7d7a781f58
--- /dev/null
+++ b/nuttx/lib/misc/lib_sendfile.c
@@ -0,0 +1,277 @@
+/************************************************************************
+ * lib/misc/lib_streamsem.c
+ *
+ * Copyright (C) 2007, 2009, 2011 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>
+
+#include <sys/sendfile.h>
+#include <stdbool.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <errno.h>
+
+#if CONFIG_NSOCKET_DESCRIPTORS > 0 || CONFIG_NFILE_DESCRIPTORS > 0
+
+/************************************************************************
+ * Private types
+ ************************************************************************/
+
+/************************************************************************
+ * Private Variables
+ ************************************************************************/
+
+/************************************************************************
+ * Public Variables
+ ************************************************************************/
+
+/************************************************************************
+ * Private Functions
+ ************************************************************************/
+
+/************************************************************************
+ * Public Functions
+ ************************************************************************/
+
+/************************************************************************
+ * Name: sendfile
+ *
+ * Description:
+ * sendfile() copies data between one file descriptor and another.
+ * sendfile() basically just wraps a sequence of reads() and writes()
+ * to perform a copy. It serves a purpose in systems where there is
+ * a penalty for copies to between user and kernal space, but really
+ * nothing in NuttX but provide some Linux compatible (and adding
+ * another 'almost standard' interface).
+ *
+ * NOTE: This interface is *not* specified in POSIX.1-2001, or other
+ * standards. The implementation here is very similar to the Linux
+ * sendfile interface. Other UNIX systems implement sendfile() with
+ * different semantics and prototypes. sendfile() should not be used
+ * in portable programs.
+ *
+ * Input Parmeters:
+ * infd - A file (or socket) descriptor opened for reading
+ * outfd - A descriptor opened for writing.
+ * offset - If 'offset' is not NULL, then it points to a variable
+ * holding the file offset from which sendfile() will start
+ * reading data from 'infd'. When sendfile() returns, this
+ * variable will be set to the offset of the byte following
+ * the last byte that was read. If 'offset' is not NULL,
+ * then sendfile() does not modify the current file offset of
+ * 'infd'; otherwise the current file offset is adjusted to
+ * reflect the number of bytes read from 'infd.'
+ *
+ * If 'offset' is NULL, then data will be read from 'infd'
+ * starting at the current file offset, and the file offset
+ * will be updated by the call.
+ * count - The number of bytes to copy between the file descriptors.
+ *
+ * Returned Value:
+ * If the transfer was successful, the number of bytes written to outfd is
+ * returned. On error, -1 is returned, and errno is set appropriately.
+ * There error values are those returned by read() or write() plus:
+ *
+ * EINVAL - Bad input parameters.
+ * ENOMEM - Could not allocated an I/O buffer
+ *
+ ************************************************************************/
+
+ssize_t sendfile(int outfd, int infd, off_t *offset, size_t count)
+{
+ FAR uint8_t *iobuffer;
+ off_t startpos = 0;
+ ssize_t nbytesread;
+ ssize_t nbyteswritten;
+ size_t ntransferred;
+ bool endxfr;
+
+ /* Get the current file position. */
+
+ if (offset)
+ {
+ /* Use lseek to get the current position */
+
+ startpos = lseek(infd, 0, SEEK_CUR);
+ if (startpos == (off_t)-1)
+ {
+ return ERROR;
+ }
+
+ /* Use lseek again to set the new position */
+
+ if (lseek(infd, *offset, SEEK_SET) == (off_t)-1)
+ {
+ return ERROR;
+ }
+ }
+
+ /* Allocate an I/O buffer */
+
+ iobuffer = (FAR void *)malloc(CONFIG_LIB_SENDFILE_BUFSIZE);
+ if (!iobuffer)
+ {
+ set_errno(ENOMEM);
+ return ERROR;
+ }
+
+ /* Now transfer 'count' bytes from the infd to the outfd */
+
+ for (ntransferred = 0, endxfr = false; ntransferred < count && !endxfr; )
+ {
+ /* Loop until the read side of the transfer comes to some conclusion */
+
+ do
+ {
+ /* Read a buffer of data from the infd */
+
+ nbytesread = read(infd, iobuffer, CONFIG_LIB_SENDFILE_BUFSIZE);
+
+ /* Check for end of file */
+
+ if (nbytesread == 0)
+ {
+ /* End of file. Break out and return current number of bytes
+ * transferred.
+ */
+
+ endxfr = true;
+ break;
+ }
+
+ /* Check for a read ERROR. EINTR is a special case. This function
+ * should break out and return an error if EINTR is returned and
+ * no data has been transferred. But what should it do if some
+ * data has been transferred? I suppose just continue?
+ */
+
+ else if (nbytesread < 0)
+ {
+ /* EINTR is not an error (but will still stop the copy) */
+
+#ifndef CONFIG_DISABLE_SIGNALS
+ if (errno != EINTR || ntransferred == 0)
+#endif
+ {
+ /* Read error. Break out and return the error condition. */
+
+ ntransferred = ERROR;
+ endxfr = true;
+ break;
+ }
+ }
+ }
+ while (nbytesread < 0);
+
+ /* Was anything read? */
+
+ if (!endxfr)
+ {
+ /* Yes.. Loop until the read side of the transfer comes to some
+ * conclusion.
+ */
+
+ do
+ {
+ nbyteswritten = write(outfd, iobuffer, nbytesread);
+
+ /* Check for a complete (or parial write) */
+
+ if (nbyteswritten >= 0)
+ {
+ nbytesread -= nbyteswritten;
+ }
+
+ /* Otherwise an error occurred (write should not return zero) */
+
+ else
+ {
+ /* Check for a read ERROR. EINTR is a special case. This
+ * function should break out and return an error if EINTR
+ * is returned and no data has been transferred. But what
+ * should it do if some data has been transferred? I
+ * suppose just continue?
+ */
+
+#ifndef CONFIG_DISABLE_SIGNALS
+ if (errno != EINTR || ntransferred == 0)
+#endif
+ {
+ /* Write error. Break out and return the error condition */
+
+ ntransferred = ERROR;
+ endxfr = true;
+ break;
+ }
+ }
+ }
+ while (nbytesread > 0);
+ }
+ }
+
+ /* Release the I/O buffer */
+
+ free(iobuffer);
+
+ /* Get the current file position */
+
+ if (offset)
+ {
+ /* Use lseek to get the current position */
+
+ off_t curpos = lseek(infd, 0, SEEK_CUR);
+ if (curpos == (off_t)-1)
+ {
+ return ERROR;
+ }
+
+ /* Return the current file position */
+
+ *offset = curpos;
+
+ /* Use lseek again to restore the original position */
+
+ if (lseek(infd, startpos, SEEK_SET) == (off_t)-1)
+ {
+ return ERROR;
+ }
+ }
+
+ return ntransferred;
+}
+
+#endif /* CONFIG_NSOCKET_DESCRIPTORS > 0 || CONFIG_NFILE_DESCRIPTORS > 0 */ \ No newline at end of file
diff --git a/nuttx/lib/misc/lib_streamsem.c b/nuttx/lib/misc/lib_streamsem.c
index 3d86ab280e..fdf494e751 100644
--- a/nuttx/lib/misc/lib_streamsem.c
+++ b/nuttx/lib/misc/lib_streamsem.c
@@ -2,7 +2,7 @@
* lib/misc/lib_streamsem.c
*
* Copyright (C) 2007, 2009, 2011 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ * 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