gusimplewhiteboard.h

Go to the documentation of this file.

/*
 *  gusimplewhiteboard.h
 *  
 *  Created by René Hexel on 20/12/11.
 *  Copyright (c) 2011, 2012, 2013, 2014, 2015, 2020 Rene Hexel.
 *  All rights reserved.
 *
 * 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. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgement:
 *
 *        This product includes software developed by Rene Hexel.
 *
 * 4. Neither the name of the author nor the names of 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.
 *
 * -----------------------------------------------------------------------
 * This program is free software; you can redistribute it and/or
 * modify it under the above terms or under the terms of the GNU
 * General Public License as published by the Free Software Foundation;
 * either version 2 of the License, or (at your option) any later version.
 *
 * 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, see http://www.gnu.org/licenses/
 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */
#ifndef gusimplewhiteboard_gusimplewhiteboard_h
#define gusimplewhiteboard_gusimplewhiteboard_h
 
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wpadded"
#pragma clang diagnostic ignored "-Wc++98-compat-pedantic"
#pragma clang diagnostic ignored "-Wunused-macros"
#pragma clang diagnostic ignored "-Wreserved-id-macro"
#pragma clang diagnostic ignored "-Wdeprecated"
#pragma clang diagnostic ignored "-Wold-style-cast"
 
#ifdef __APPLE__
# ifndef TARGET_OS_IPHONE
#  include <AvailabilityMacros.h>
# endif
#endif
#ifndef WITHOUT_LIBDISPATCH
#include <dispatch/dispatch.h>
#endif
#include <sys/types.h>
 
#ifndef __cplusplus
#include <stdbool.h>
#include <stdint.h>
#else
#if __cplusplus < 201103L
#include <stdbool.h>
#else
#include <cstdbool>
#endif
 
extern "C"
{
#endif // __cplusplus
#undef __block
#define __block _xblock
#include <unistd.h>
#undef __block
#define __block __attribute__((__blocks__(byref)))
 
#ifndef __has_feature           // Optional of course.
#define __has_feature(x) 0      // Compatibility with non-clang compilers.
#endif
 
#ifdef __cplusplus
 
#pragma clang diagnostic ignored "-Wc++11-long-long"
 
#ifdef bool
#undef bool
#endif
 
#ifdef true
#undef true
#undef false
#endif
#endif // __cplusplus
 
#ifndef u_int64_t
# define u_int64_t uint64_t
#endif
#ifndef u_int32_t
# define u_int32_t uint32_t
#endif
#ifndef u_int16_t
# define u_int16_t uint16_t
#endif
#ifndef u_int8_t
# define u_int8_t uint8_t
#endif
 
#if defined(TARGET_IPHONE_SIMULATOR) && TARGET_IPHONE_SIMULATOR
#define GSW_IOS_SIMULATOR                               
#endif
 
#if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE && !defined (GSW_IOS_SIMULATOR)
#define GSW_IOS_DEVICE                                  
#endif
 
#if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE || defined(TARGET_IPHONE_SIMULATOR) && TARGET_IPHONE_SIMULATOR
#define GSW_IOS                                         
#endif
 
#define GU_SIMPLE_WHITEBOARD_VERSION            6       
#ifndef GU_SIMPLE_WHITEBOARD_GENERATIONS
#define GU_SIMPLE_WHITEBOARD_GENERATIONS        4       
#endif
#ifndef GU_SIMPLE_WHITEBOARD_BUFSIZE
#define GU_SIMPLE_WHITEBOARD_BUFSIZE            128     
#endif
#ifndef GSW_TOTAL_MESSAGE_TYPES
#define GSW_TOTAL_MESSAGE_TYPES                 512     
#endif
#ifndef GSW_NUM_RESERVED
#define GSW_NUM_RESERVED                        (GSW_TOTAL_MESSAGE_TYPES/2)    // message types (max)
#endif
#define GSW_TOTAL_PROCESSES                     256     
#define GSW_NON_RESERVED_MESSAGE_TYPES  (GSW_TOTAL_MESSAGE_TYPES-GSW_NUM_RESERVED)
 
#ifndef GSW_DEFAULT_ENV
#define GSW_DEFAULT_ENV     "WHITEBOARD_NAME"
#endif
#ifndef GSW_DEFAULT_NAME
#define GSW_DEFAULT_NAME    "guWhiteboard"              
#endif
#ifndef GSWR_BASE_NAME
#define GSWR_BASE_NAME      "guudpwhiteboard"           
#endif
#ifndef WHITEBOARD_SIGNAL
#define WHITEBOARD_SIGNAL       SIGUSR2
#endif
#ifndef WHITEBOARD_POLL_PERIOD
#define WHITEBOARD_POLL_PERIOD  10000
#endif
 
enum gsw_semaphores
{
        GSW_SEM_PUTMSG,                 
        GSW_SEM_CALLBACK,               
        GSW_SEM_MSGTYPE,                
        GSW_SEM_PROC,                   
        GSW_NUM_SEM                     
};
 
struct gsw_whiteboard_s;
 
typedef void (*gsw_subscription_f)(struct gsw_whiteboard_s *wbd);
 
typedef union gsw_simple_message
{
        /*
         * standard types
         */
        unsigned long long      ulonglong;      
        long long               slonglong;      
        unsigned long           ulong;          
        long                    slong;          
        unsigned                uint;           
        int                     sint;           
        unsigned short          ushort;         
        short                   sshort;         
        unsigned char           uchar;          
        signed char             schar;          
        char                    xchar;          
 
        long double             slongdouble;    
        double                  sdouble;        
        float                   sfloat;         
 
        /*
         * POSIX defined length types
         */
        u_int64_t               u64;            
        u_int32_t               u32;            
        u_int16_t               u16;            
        u_int8_t                u8;             
        
        int64_t                 s64;            
        int32_t                 s32;            
        int16_t                 s16;            
        int8_t                  s8;             
 
        unsigned long long      ullvec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(unsigned long long)];
        unsigned long           ulvec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(unsigned long)];  
        unsigned                uivec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(unsigned)];       
        unsigned short          usvec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(unsigned short)]; 
        unsigned char           ucvec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(unsigned char)];  
 
        long long               llvec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(long long)];  
        long                    lvec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(long)];    
        int                     ivec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(int)];     
        short                   svec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(short)];   
        signed char             cvec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(signed char)]; 
        bool                    bvec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(bool)];    
 
        u_int64_t               u64vec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(u_int64_t)]; 
        u_int32_t               u32vec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(u_int32_t)]; 
        u_int16_t               u16vec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(u_int16_t)]; 
        u_int8_t                u8vec[GU_SIMPLE_WHITEBOARD_BUFSIZE];            
 
        int64_t                 s64vec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(int64_t)];   
        int32_t                 s32vec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(int32_t)];   
        int16_t                 s16vec[GU_SIMPLE_WHITEBOARD_BUFSIZE/sizeof(int16_t)];   
        int8_t                  s8vec[GU_SIMPLE_WHITEBOARD_BUFSIZE];            
 
        /*
         * simple compound types
         */
        struct {int16_t x,y,z,a,b,c,d,e; } coord;  
        struct {double x,y,z,a,b,c,d,e;} dcoord;
        struct {float x,y,z,a,b,c,d,e;} fcoord; 
 
        char                    string[GU_SIMPLE_WHITEBOARD_BUFSIZE];
 
        struct { u_int16_t value; char string[GU_SIMPLE_WHITEBOARD_BUFSIZE-sizeof(u_int16_t)]; } hash;
 
        struct { char data[GU_SIMPLE_WHITEBOARD_BUFSIZE-2]; unsigned char len; unsigned char type; } wbmsg;
} gu_simple_message;
 
typedef struct gsw_simple_whiteboard_s
{
        u_int16_t               version;        
        u_int16_t               eventcount;     
        u_int16_t               subscribed;     
        u_int16_t               num_types;      
 
        u_int8_t                indexes[GSW_TOTAL_MESSAGE_TYPES];       
        u_int16_t               event_counters[GSW_TOTAL_MESSAGE_TYPES];       
 
        gu_simple_message       messages[GSW_TOTAL_MESSAGE_TYPES][GU_SIMPLE_WHITEBOARD_GENERATIONS];
 
        gu_simple_message       hashes[GSW_TOTAL_MESSAGE_TYPES];
 
        gu_simple_message       typenames[GSW_TOTAL_MESSAGE_TYPES];
 
        pid_t                   processes[GSW_TOTAL_PROCESSES];
 
        u_int64_t               magic;
} gu_simple_whiteboard;
 
#ifdef GSW_IOS_DEVICE
typedef dispatch_semaphore_t __strong *gsw_sema_t;
#else
typedef int gsw_sema_t;
#endif
 
typedef struct gsw_whiteboard_s
{
        gu_simple_whiteboard    *wb;            
        gsw_sema_t               sem;           
        int                      fd;            
#if __has_feature(objc_arc) || defined(WITHOUT_LIBDISPATCH)
        void                    *callback_queue;
#else
        dispatch_queue_t         callback_queue;
#endif
        gsw_subscription_f       callback;      
        void                    *context;       
        bool                     got_monitor;   
        bool                     exit_monitor;  
} gu_simple_whiteboard_descriptor;
 
extern const char *gsw_global_whiteboard_name;
 
//backwards compat for GU whiteboard defaults
//---------------
#define GSW_NUM_TYPES_DEFINED num_types_defined
 
extern int num_types_defined;
 
extern const char **WBTypes_stringValues;
//---------------
 
 
 
extern gu_simple_whiteboard_descriptor *gsw_new_whiteboard(const char *name);
 
extern gu_simple_whiteboard_descriptor *gsw_new_custom_whiteboard(const char *name, const char *message_names[], int num_messages, int semaphore_magic_key);
 
extern gu_simple_whiteboard_descriptor *gswr_new_whiteboard(int i);
 
extern gu_simple_whiteboard_descriptor *gsw_new_numbered_whiteboard(const char *name, int num);
 
extern void gsw_free_whiteboard(gu_simple_whiteboard_descriptor *wbd);
 
extern int gsw_register_message_type(gu_simple_whiteboard_descriptor *wbd, const char *name);
 
extern int gsw_offset_for_message_type(gu_simple_whiteboard_descriptor *wbd, const char *name);
 
extern gu_simple_whiteboard *gsw_create(const char *name, int *fdp, bool *ini);
    
extern gu_simple_whiteboard_descriptor *get_local_singleton_whiteboard(void);
    
extern void gsw_free(gu_simple_whiteboard *wb, int fd);
 
extern gsw_sema_t gsw_setup_semaphores(int key);
 
extern int gsw_procure(gsw_sema_t sem, enum gsw_semaphores s);
 
extern int gsw_vacate(gsw_sema_t sem, enum gsw_semaphores s);
 
extern void gsw_init_semaphores(gsw_sema_t sem);
 
gu_simple_message *gsw_current_message(gu_simple_whiteboard *wb, int i);
 
gu_simple_message *gsw_next_message(gu_simple_whiteboard *wb, int i);
 
void gsw_increment(gu_simple_whiteboard *wb, int i);
 
void gsw_increment_event_counter(gu_simple_whiteboard *wb, int i);
        
 
#pragma mark - subscription and callbacks
 
extern void gsw_add_process(gu_simple_whiteboard_descriptor *wbd, const pid_t proc);
 
extern void gsw_add_wbd_signal_handler(gu_simple_whiteboard_descriptor *wbd);
 
extern void gsw_remove_wbd_signal_handler(gu_simple_whiteboard_descriptor *wbd);
 
void gsw_add_process(gu_simple_whiteboard_descriptor *wbd, const pid_t proc);
 
void gsw_remove_process(gu_simple_whiteboard_descriptor *wbd, const pid_t proc);
 
void gsw_signal_subscribers(gu_simple_whiteboard *wb);
 
#ifdef __cplusplus
}
#endif
 
#pragma clang diagnostic pop
 
#endif