pipe.c

Go to the documentation of this file.

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#include <stdio.h>
#include <nks/fsio.h>
#include <nks/errno.h>
 
#include "apr_arch_file_io.h"
#include "apr_strings.h"
#include "apr_portable.h"
#include "apr_arch_inherit.h"
 
static apr_status_t pipeblock(apr_file_t *thepipe)
{
#ifdef USE_FLAGS
    unsigned long   flags;
 
    if (fcntl(thepipe->filedes, F_GETFL, &flags) != -1)
    {
        flags &= ~FNDELAY;
        fcntl(thepipe->filedes, F_SETFL, flags);
    }
#else
        errno = 0;
        fcntl(thepipe->filedes, F_SETFL, 0);
#endif
 
    if (errno)
        return errno;
 
    thepipe->blocking = BLK_ON;
    return APR_SUCCESS;
}
 
static apr_status_t pipenonblock(apr_file_t *thepipe)
{
#ifdef USE_FLAGS
    unsigned long   flags;
 
    errno = 0;
    if (fcntl(thepipe->filedes, F_GETFL, &flags) != -1)
    {
        flags |= FNDELAY;
        fcntl(thepipe->filedes, F_SETFL, flags);
    }
#else
        errno = 0;
        fcntl(thepipe->filedes, F_SETFL, FNDELAY);
#endif
 
    if (errno)
        return errno;
 
    thepipe->blocking = BLK_OFF;
    return APR_SUCCESS;
}
 
APR_DECLARE(apr_status_t) apr_file_pipe_timeout_set(apr_file_t *thepipe, apr_interval_time_t timeout)
{
    if (thepipe->is_pipe == 1) {
        thepipe->timeout = timeout;
        if (timeout >= 0) {
            if (thepipe->blocking != BLK_OFF) { /* blocking or unknown state */
                return pipenonblock(thepipe);
            }
        }
        else {
            if (thepipe->blocking != BLK_ON) { /* non-blocking or unknown state */
                return pipeblock(thepipe);
            }
        }
        return APR_SUCCESS;
    }
    return APR_EINVAL;
}
 
APR_DECLARE(apr_status_t) apr_file_pipe_timeout_get(apr_file_t *thepipe, apr_interval_time_t *timeout)
{
    if (thepipe->is_pipe == 1) {
        *timeout = thepipe->timeout;
        return APR_SUCCESS;
    }
    return APR_EINVAL;
}
 
APR_DECLARE(apr_status_t) apr_os_pipe_put_ex(apr_file_t **file,
                                             apr_os_file_t *thefile,
                                             int register_cleanup,
                                             apr_pool_t *pool)
{
    int *dafile = thefile;
    
    (*file) = apr_pcalloc(pool, sizeof(apr_file_t));
    (*file)->pool = pool;
    (*file)->eof_hit = 0;
    (*file)->is_pipe = 1;
    (*file)->blocking = BLK_UNKNOWN; /* app needs to make a timeout call */
    (*file)->timeout = -1;
    (*file)->ungetchar = -1; /* no char avail */
    (*file)->filedes = *dafile;
    if (!register_cleanup) {
        (*file)->flags = APR_FOPEN_NOCLEANUP;
    }
    (*file)->buffered = 0;
#if APR_HAS_THREADS
    (*file)->thlock = NULL;
#endif
    if (register_cleanup) {
        apr_pool_cleanup_register((*file)->pool, (void *)(*file),
                                  apr_unix_file_cleanup,
                                  apr_pool_cleanup_null);
    }
    return APR_SUCCESS;
}
 
APR_DECLARE(apr_status_t) apr_os_pipe_put(apr_file_t **file,
                                          apr_os_file_t *thefile,
                                          apr_pool_t *pool)
{
    return apr_os_pipe_put_ex(file, thefile, 0, pool);
}
 
static apr_status_t file_pipe_create(apr_file_t **in, apr_file_t **out,
        apr_pool_t *pool_in, apr_pool_t *pool_out)
{
    int         filedes[2];
 
    if (pipe(filedes) == -1) {
        return errno;
    }
 
    (*in) = (apr_file_t *)apr_pcalloc(pool_in, sizeof(apr_file_t));
    (*out) = (apr_file_t *)apr_pcalloc(pool_out, sizeof(apr_file_t));
 
    (*in)->pool     = pool_in;
    (*out)->pool    = pool_out;
    (*in)->filedes   = filedes[0];
    (*out)->filedes  = filedes[1];
    (*in)->flags     = APR_INHERIT;
    (*out)->flags    = APR_INHERIT;
    (*in)->is_pipe      =
    (*out)->is_pipe     = 1;
    (*out)->fname    = 
    (*in)->fname     = NULL;
    (*in)->buffered  =
    (*out)->buffered = 0;
    (*in)->blocking  =
    (*out)->blocking = BLK_ON;
    (*in)->timeout   =
    (*out)->timeout  = -1;
    (*in)->ungetchar = -1;
    (*in)->thlock    =
    (*out)->thlock   = NULL;
    (void) apr_pollset_create(&(*in)->pollset, 1, pool_in, 0);
    (void) apr_pollset_create(&(*out)->pollset, 1, pool_out, 0);
 
    apr_pool_cleanup_register((*in)->pool, (void *)(*in), apr_unix_file_cleanup,
                         apr_pool_cleanup_null);
    apr_pool_cleanup_register((*out)->pool, (void *)(*out), apr_unix_file_cleanup,
                         apr_pool_cleanup_null);
 
    return APR_SUCCESS;
}
 
static void file_pipe_block(apr_file_t **in, apr_file_t **out,
        apr_int32_t blocking)
{
    switch (blocking) {
    case APR_FULL_BLOCK:
        break;
    case APR_READ_BLOCK:
        apr_file_pipe_timeout_set(*out, 0);
        break;
    case APR_WRITE_BLOCK:
        apr_file_pipe_timeout_set(*in, 0);
        break;
    default:
        apr_file_pipe_timeout_set(*out, 0);
        apr_file_pipe_timeout_set(*in, 0);
        break;
    }
}
 
APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in, apr_file_t **out, apr_pool_t *pool)
{
    return file_pipe_create(in, out, pool, pool);
}
 
APR_DECLARE(apr_status_t) apr_file_pipe_create_ex(apr_file_t **in, 
                                                  apr_file_t **out, 
                                                  apr_int32_t blocking,
                                                  apr_pool_t *pool)
{
    apr_status_t status;
 
    if ((status = file_pipe_create(in, out, pool, pool)) != APR_SUCCESS) {
        return status;
    }
 
    file_pipe_block(in, out, blocking);
 
    return APR_SUCCESS;
}
 
APR_DECLARE(apr_status_t) apr_file_pipe_create_pools(apr_file_t **in,
        apr_file_t **out, apr_int32_t blocking, apr_pool_t *pool_in, apr_pool_t *pool_out)
{
    apr_status_t status;
 
    if ((status = file_pipe_create(in, out, pool_in, pool_out)) != APR_SUCCESS) {
        return status;
    }
 
    file_pipe_block(in, out, blocking);
 
    return APR_SUCCESS;
}
 
APR_DECLARE(apr_status_t) apr_file_namedpipe_create(const char *filename, 
                                                    apr_fileperms_t perm, apr_pool_t *pool)
{
    return APR_ENOTIMPL;
}