Build fix: Missing message in LTTNG_DEPRECATED invocation
[lttng-tools.git] / src / common / pipe.c
index c8f00141574c3a6f11ce278a4c4a07d9cad1fa46..45be43fa3833fe21966b8377a9831e6c185b7540 100644 (file)
@@ -1,22 +1,11 @@
 /*
- * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
  *
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License, version 2 only, as
- * published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
  *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
- * more details.
- *
- * You should have received a copy of the GNU General Public License along with
- * this program; if not, write to the Free Software Foundation, Inc., 51
- * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #define _LGPL_SOURCE
-#include <assert.h>
 #include <fcntl.h>
 #include <unistd.h>
 #include <sys/types.h>
@@ -67,7 +56,7 @@ static int _pipe_read_close(struct lttng_pipe *pipe)
 {
        int ret, ret_val = 0;
 
-       assert(pipe);
+       LTTNG_ASSERT(pipe);
 
        if (!lttng_pipe_is_read_open(pipe)) {
                goto end;
@@ -95,7 +84,7 @@ static int _pipe_write_close(struct lttng_pipe *pipe)
 {
        int ret, ret_val = 0;
 
-       assert(pipe);
+       LTTNG_ASSERT(pipe);
 
        if (!lttng_pipe_is_write_open(pipe)) {
                goto end;
@@ -154,9 +143,28 @@ static int _pipe_set_flags(struct lttng_pipe *pipe, int flags)
        }
 
        for (i = 0; i < 2; i++) {
-               ret = fcntl(pipe->fd[i], F_SETFD, flags);
-               if (ret < 0) {
-                       PERROR("fcntl lttng pipe %d", flags);
+               if (flags & O_NONBLOCK) {
+                       ret = fcntl(pipe->fd[i], F_SETFL, O_NONBLOCK);
+                       if (ret < 0) {
+                               PERROR("fcntl lttng pipe %d", flags);
+                               goto end;
+                       }
+               }
+               if (flags & FD_CLOEXEC) {
+                       ret = fcntl(pipe->fd[i], F_SETFD, FD_CLOEXEC);
+                       if (ret < 0) {
+                               PERROR("fcntl lttng pipe %d", flags);
+                               goto end;
+                       }
+               }
+               /*
+                * We only check for O_NONBLOCK or FD_CLOEXEC, if another flag is
+                * needed, we can add it, but for now just make sure we don't make
+                * mistakes with the parameters we pass.
+                */
+               if (!(flags & O_NONBLOCK) && !(flags & FD_CLOEXEC)) {
+                       fprintf(stderr, "Unsupported flag\n");
+                       ret = -1;
                        goto end;
                }
        }
@@ -169,7 +177,6 @@ end:
  *
  * Return a newly allocated lttng pipe on success or else NULL.
  */
-LTTNG_HIDDEN
 struct lttng_pipe *lttng_pipe_open(int flags)
 {
        int ret;
@@ -206,7 +213,6 @@ error:
  *
  * Return a newly allocated lttng pipe on success or else NULL.
  */
-LTTNG_HIDDEN
 struct lttng_pipe *lttng_pipe_named_open(const char *path, mode_t mode,
                int flags)
 {
@@ -227,7 +233,6 @@ struct lttng_pipe *lttng_pipe_named_open(const char *path, mode_t mode,
        fd_r = open(path, O_RDONLY | O_NONBLOCK);
        if (fd_r < 0) {
                PERROR("open fifo");
-               ret = fd_r;
                goto error;
        }
        pipe->fd[0] = fd_r;
@@ -236,7 +241,6 @@ struct lttng_pipe *lttng_pipe_named_open(const char *path, mode_t mode,
        fd_w = open(path, O_WRONLY | O_NONBLOCK);
        if (fd_w < 0) {
                PERROR("open fifo");
-               ret = fd_w;
                goto error;
        }
        pipe->fd[1] = fd_w;
@@ -259,12 +263,11 @@ error:
  *
  * Return 0 on success else a negative value.
  */
-LTTNG_HIDDEN
 int lttng_pipe_read_close(struct lttng_pipe *pipe)
 {
        int ret;
 
-       assert(pipe);
+       LTTNG_ASSERT(pipe);
 
        /* Handle read side first. */
        lock_read_side(pipe);
@@ -279,12 +282,11 @@ int lttng_pipe_read_close(struct lttng_pipe *pipe)
  *
  * Return 0 on success else a negative value.
  */
-LTTNG_HIDDEN
 int lttng_pipe_write_close(struct lttng_pipe *pipe)
 {
        int ret;
 
-       assert(pipe);
+       LTTNG_ASSERT(pipe);
 
        lock_write_side(pipe);
        ret = _pipe_write_close(pipe);
@@ -298,12 +300,11 @@ int lttng_pipe_write_close(struct lttng_pipe *pipe)
  *
  * Return 0 on success else a negative value.
  */
-LTTNG_HIDDEN
 int lttng_pipe_close(struct lttng_pipe *pipe)
 {
        int ret, ret_val = 0;
 
-       assert(pipe);
+       LTTNG_ASSERT(pipe);
 
        ret = lttng_pipe_read_close(pipe);
        if (ret < 0) {
@@ -321,7 +322,6 @@ int lttng_pipe_close(struct lttng_pipe *pipe)
 /*
  * Close and destroy a lttng pipe object. Finally, pipe is freed.
  */
-LTTNG_HIDDEN
 void lttng_pipe_destroy(struct lttng_pipe *pipe)
 {
        int ret;
@@ -335,9 +335,9 @@ void lttng_pipe_destroy(struct lttng_pipe *pipe)
         * succeed so we unlock them after the close pipe below.
         */
        ret = pthread_mutex_trylock(&pipe->read_mutex);
-       assert(!ret);
+       LTTNG_ASSERT(!ret);
        ret = pthread_mutex_trylock(&pipe->write_mutex);
-       assert(!ret);
+       LTTNG_ASSERT(!ret);
 
        /* Close pipes WITHOUT trying to lock the pipes. */
        (void) _pipe_read_close(pipe);
@@ -358,13 +358,12 @@ void lttng_pipe_destroy(struct lttng_pipe *pipe)
  * Return "count" on success. Return < count on error. errno can be used
  * to check the actual error.
  */
-LTTNG_HIDDEN
 ssize_t lttng_pipe_read(struct lttng_pipe *pipe, void *buf, size_t count)
 {
        ssize_t ret;
 
-       assert(pipe);
-       assert(buf);
+       LTTNG_ASSERT(pipe);
+       LTTNG_ASSERT(buf);
 
        lock_read_side(pipe);
        if (!lttng_pipe_is_read_open(pipe)) {
@@ -384,14 +383,13 @@ error:
  * Return "count" on success. Return < count on error. errno can be used
  * to check the actual error.
  */
-LTTNG_HIDDEN
 ssize_t lttng_pipe_write(struct lttng_pipe *pipe, const void *buf,
                size_t count)
 {
        ssize_t ret;
 
-       assert(pipe);
-       assert(buf);
+       LTTNG_ASSERT(pipe);
+       LTTNG_ASSERT(buf);
 
        lock_write_side(pipe);
        if (!lttng_pipe_is_write_open(pipe)) {
@@ -404,3 +402,67 @@ error:
        unlock_write_side(pipe);
        return ret;
 }
+
+/*
+ * Return and release the read end of the pipe.
+ *
+ * This call transfers the ownership of the read fd of the underlying pipe
+ * to the caller if it is still open.
+ *
+ * Returns the fd of the read end of the pipe, or -1 if it was already closed or
+ * released.
+ */
+int lttng_pipe_release_readfd(struct lttng_pipe *pipe)
+{
+       int ret;
+
+       if (!pipe) {
+               ret = -1;
+               goto end;
+       }
+
+       lock_read_side(pipe);
+       if (!lttng_pipe_is_read_open(pipe)) {
+               ret = -1;
+               goto end_unlock;
+       }
+       ret = pipe->fd[0];
+       pipe->fd[0] = -1;
+       pipe->r_state = LTTNG_PIPE_STATE_CLOSED;
+end_unlock:
+       unlock_read_side(pipe);
+end:
+       return ret;
+}
+
+/*
+ * Return and release the write end of the pipe.
+ *
+ * This call transfers the ownership of the write fd of the underlying pipe
+ * to the caller if it is still open.
+ *
+ * Returns the fd of the write end of the pipe, or -1 if it was alwritey closed
+ * or released.
+ */
+int lttng_pipe_release_writefd(struct lttng_pipe *pipe)
+{
+       int ret;
+
+       if (!pipe) {
+               ret = -1;
+               goto end;
+       }
+
+       lock_write_side(pipe);
+       if (!lttng_pipe_is_write_open(pipe)) {
+               ret = -1;
+               goto end_unlock;
+       }
+       ret = pipe->fd[1];
+       pipe->fd[1] = -1;
+       pipe->w_state = LTTNG_PIPE_STATE_CLOSED;
+end_unlock:
+       unlock_write_side(pipe);
+end:
+       return ret;
+}
This page took 0.026406 seconds and 4 git commands to generate.