generic.h

Go to the documentation of this file.

/* -*- mode: C; c-basic-offset: 4 -*- */
/* ex: set shiftwidth=4 tabstop=4 expandtab: */
/*
 * Copyright (c) 2008-2014, Georgia Tech Research Corporation
 * Copyright (c) 2015, Rice University
 * All rights reserved.
 *
 * Author(s): Neil T. Dantam <ntd@rice.edu>
 * Georgia Tech Humanoid Robotics Lab
 * Under Direction of Prof. Mike Stilman <mstilman@cc.gatech.edu>
 *
 *
 * This file is provided under the following "BSD-style" License:
 *
 *
 *   Redistribution and use in source and binary forms, with or
 *   without modification, are permitted provided that the following
 *   conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * 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.
 *
 *   * Neither the name of the copyright holder 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 HOLDER 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 ACH_GENERIC_H
#define ACH_GENERIC_H


#ifdef __cplusplus
extern "C" {
#endif

#ifdef __GNUC__

#define ACH_WARN_UNUSED __attribute__((warn_unused_result))
#else

#define ACH_WARN_UNUSED
#endif /* __GNUC__ */

typedef enum ach_status {
    ACH_OK = 0,             
    ACH_OVERFLOW = 1,       
    ACH_INVALID_NAME = 2,   
    ACH_BAD_SHM_FILE = 3,   
    ACH_FAILED_SYSCALL = 4, 
    ACH_STALE_FRAMES = 5,   
    ACH_MISSED_FRAME = 6,   
    ACH_TIMEOUT = 7,        
    ACH_EEXIST = 8,         
    ACH_ENOENT = 9,         
    ACH_CLOSED = 10,        
    ACH_BUG = 11,           
    ACH_EINVAL = 12,        
    ACH_CORRUPT = 13,       
    ACH_BAD_HEADER = 14,    
    ACH_EACCES = 15,        
    ACH_CANCELED = 16,      
    ACH_EFAULT = 17,        
    ACH_EINTR = 18,          
    ACH_ENOTSUP = 19        
} ach_status_t;


#define ACH_STATUS_MASK(r) (1<<(r))

enum ach_mask {
    ACH_MASK_OK             = ACH_STATUS_MASK(ACH_OK),
    ACH_MASK_OVERFLOW       = ACH_STATUS_MASK(ACH_OVERFLOW),
    ACH_MASK_INVALID_NAME   = ACH_STATUS_MASK(ACH_INVALID_NAME),
    ACH_MASK_BAD_SHM_FILE   = ACH_STATUS_MASK(ACH_BAD_SHM_FILE),
    ACH_MASK_FAILED_SYSCALL = ACH_STATUS_MASK(ACH_FAILED_SYSCALL),
    ACH_MASK_STALE_FRAMES   = ACH_STATUS_MASK(ACH_STALE_FRAMES),
    ACH_MASK_MISSED_FRAME   = ACH_STATUS_MASK(ACH_MISSED_FRAME),
    ACH_MASK_TIMEOUT        = ACH_STATUS_MASK(ACH_TIMEOUT),
    ACH_MASK_EEXIST         = ACH_STATUS_MASK(ACH_EEXIST),
    ACH_MASK_ENOENT         = ACH_STATUS_MASK(ACH_ENOENT),
    ACH_MASK_CLOSED         = ACH_STATUS_MASK(ACH_CLOSED),
    ACH_MASK_BUG            = ACH_STATUS_MASK(ACH_BUG),
    ACH_MASK_EINVAL         = ACH_STATUS_MASK(ACH_EINVAL),
    ACH_MASK_CORRUPT        = ACH_STATUS_MASK(ACH_CORRUPT),
    ACH_MASK_BAD_HEADER     = ACH_STATUS_MASK(ACH_BAD_HEADER),
    ACH_MASK_EACCES         = ACH_STATUS_MASK(ACH_EACCES),
    ACH_MASK_CANCELED       = ACH_STATUS_MASK(ACH_CANCELED),
    ACH_MASK_EFAULT         = ACH_STATUS_MASK(ACH_EFAULT),
    ACH_MASK_EINTR          = ACH_STATUS_MASK(ACH_EINTR),
    ACH_MASK_ENOTSUP        = ACH_STATUS_MASK(ACH_ENOTSUP),

    ACH_MASK_NONE           = 0,
    ACH_MASK_ALL            = 0xffffffff
};

typedef enum ach_mask ach_mask_t;

static inline int
ach_status_mask( enum ach_status status )
{
    return (enum ach_mask)ACH_STATUS_MASK(status);
}

static inline int
ach_status_match( enum ach_status status, int mask )
{
    return (ACH_STATUS_MASK(status) & mask) ? 1 : 0;
}

typedef enum {
    /* default options are zero */

    ACH_O_NONBLOCK = 0x00,

    ACH_O_FIRST = 0x00,

    ACH_O_ABSTIME = 0x00,

    ACH_O_WAIT = 0x01,

    ACH_O_LAST = 0x02,

    ACH_O_COPY = 0x04,

    ACH_O_RELTIME = 0x08
} ach_get_opts_t;

#define ACH_CHAN_NAME_MAX 64ul


typedef enum ach_status
ach_get_fun(void *cx, void **obj_dst, const void *chan_src, size_t frame_size );


typedef enum ach_status
ach_put_fun(void *cx, void *chan_dst, const void *obj_src);

typedef struct achk_opt {
    int options;               
    struct timespec reltime;   
} achk_opt_t;


#ifdef __cplusplus
}
#endif

#endif