aio_misc.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

 
/*
 *  Copyright 2010, Alin Rus <alin.codejunkie@gmail.com>
 * 
 *  COPYRIGHT (c) 1989-2011.
 *  On-Line Applications Research Corporation (OAR).
 *
 * 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.
 *
 * 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 _AIO_MISC_H
#define _AIO_MISC_H
 
#include <string.h>
#include <signal.h> 
#include <aio.h>
#include <pthread.h>
#include <stdatomic.h>
#include <rtems.h>
#include <rtems/chain.h>
#include <rtems/seterr.h>
 
#ifdef RTEMS_DEBUG
#include <stdio.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif


#define AIO_OP_READ        0

#define AIO_OP_WRITE       1

#define AIO_OP_SYNC        2

#define AIO_OP_DSYNC       3
 
/*
 * Constants to track return status
 */

#define AIO_RETURNED    0

#define AIO_NOTRETURNED 1


#define AIO_LIO_NO_NOTIFY  0

#define AIO_LIO_SIGEV      1

#define AIO_LIO_EVENT      2

typedef union
{
  struct sigevent *sigp;

  int task_id;
 
} lio_notification_union;

typedef struct
{
  pthread_mutex_t mutex;

  int requests_left;

  int notification_type;

  lio_notification_union lio_notification;
 
} listcb;

typedef struct
{
  rtems_chain_node next_prio;
 
  int policy;

  int priority;

  pthread_t caller_thread;

  listcb *listcbp;

  struct aiocb *aiocbp;

  int op_type;
 
} rtems_aio_request;

typedef struct
{
  rtems_chain_node next_fd;

  rtems_chain_control perfd;

  int fildes;

  int new_fd;
 
  pthread_mutex_t mutex;
  pthread_cond_t cond;
 
} rtems_aio_request_chain;

typedef struct
{
  pthread_mutex_t mutex;
  pthread_cond_t new_req;
  pthread_attr_t attr;

  rtems_chain_control work_req;

  rtems_chain_control idle_req;
  
  unsigned int initialized;

  int active_threads;

  int idle_threads;

  atomic_int queued_requests;
 
} rtems_aio_queue;
 
extern rtems_aio_queue aio_request_queue;
 
#define AIO_QUEUE_INITIALIZED 0xB00B
 
#ifndef AIO_MAX_THREADS
#define AIO_MAX_THREADS 5
#endif
 
/* Override AIO_LISTIO_MAX from newlib */
#undef AIO_LISTIO_MAX
#define AIO_LISTIO_MAX 20
 
#ifndef RTEMS_AIO_MAX
#define RTEMS_AIO_MAX 100
#endif

int rtems_aio_init( void );

int rtems_aio_enqueue( rtems_aio_request *req );

rtems_aio_request_chain *rtems_aio_search_fd(
  rtems_chain_control *chain,
  int fildes,
  int create
);

void rtems_aio_remove_fd( rtems_aio_request_chain *r_chain );

int rtems_aio_remove_req(
  rtems_chain_control *chain,
    struct aiocb *aiocbp
);

int rtems_aio_check_sigevent( struct sigevent *sigp );

rtems_aio_request *init_write_req( struct aiocb* aiocbp );

rtems_aio_request *init_read_req( struct aiocb* aiocbp );

void rtems_aio_completed_list_op( listcb *listcbp );
 
#ifdef RTEMS_DEBUG
#include <assert.h>
 
#define AIO_assert(_x) assert(_x)
#define AIO_printf(_x) printf(_x)
#else
#define AIO_assert(_x)
#define AIO_printf(_x)
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif