shm.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (c) 2016 Gedare Bloom.
 *
 * 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 _RTEMS_POSIX_SHM_H
#define _RTEMS_POSIX_SHM_H
 
#include <rtems/score/objectdata.h>
#include <rtems/score/threadq.h>
 
#include <sys/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct POSIX_Shm_Object_operations POSIX_Shm_Object_operations;
extern const POSIX_Shm_Object_operations _POSIX_Shm_Object_operations;
 
typedef struct {
  void                               *handle;
 
  size_t                              size;
 
  const POSIX_Shm_Object_operations  *ops;
} POSIX_Shm_Object;
 
struct POSIX_Shm_Object_operations {
  int ( *object_create ) ( POSIX_Shm_Object *shm_obj, size_t size );
 
  int ( *object_resize ) ( POSIX_Shm_Object *shm_obj, size_t size );
 
  int ( *object_delete ) ( POSIX_Shm_Object *shm_obj );
 
  int ( *object_read ) ( POSIX_Shm_Object *shm_obj, void *buf, size_t count );
 
  void * ( *object_mmap ) ( POSIX_Shm_Object *shm_obj, size_t len, int prot, off_t off);
};
 
typedef struct {
   Objects_Control      Object;
   Thread_queue_Control Wait_queue;
 
   int                  reference_count;
 
   POSIX_Shm_Object     shm_object;
 
   uid_t                uid;
   gid_t                gid;
   mode_t               mode;
   int                  oflag;
 
   time_t               atime;
   time_t               mtime;
   time_t               ctime;
} POSIX_Shm_Control;
 
extern Objects_Information _POSIX_Shm_Information;
 
#define POSIX_SHM_INFORMATION_DEFINE( max ) \
  OBJECTS_INFORMATION_DEFINE( \
    _POSIX_Shm, \
    OBJECTS_POSIX_API, \
    OBJECTS_POSIX_SHMS, \
    POSIX_Shm_Control, \
    max, \
    _POSIX_PATH_MAX, \
    NULL \
  )
 
extern int _POSIX_Shm_Object_create_from_workspace(
  POSIX_Shm_Object *shm_obj,
  size_t size
);
 
extern int _POSIX_Shm_Object_delete_from_workspace( POSIX_Shm_Object *shm_obj );
 
extern int _POSIX_Shm_Object_resize_from_workspace(
  POSIX_Shm_Object *shm_obj,
  size_t size
);
 
extern int _POSIX_Shm_Object_read_from_workspace(
  POSIX_Shm_Object *shm_obj,
  void *buf,
  size_t count
);
 
extern void * _POSIX_Shm_Object_mmap_from_workspace(
  POSIX_Shm_Object *shm_obj,
  size_t len,
  int prot,
  off_t off
);
 
extern int _POSIX_Shm_Object_create_from_heap(
  POSIX_Shm_Object *shm_obj,
  size_t size
);
 
extern int _POSIX_Shm_Object_delete_from_heap( POSIX_Shm_Object *shm_obj );
 
extern int _POSIX_Shm_Object_resize_from_heap(
  POSIX_Shm_Object *shm_obj,
  size_t size
);
 
extern int _POSIX_Shm_Object_read_from_heap(
  POSIX_Shm_Object *shm_obj,
  void *buf,
  size_t count
);
 
extern void * _POSIX_Shm_Object_mmap_from_heap(
  POSIX_Shm_Object *shm_obj,
  size_t len,
  int prot,
  off_t off
);
 
#ifdef __cplusplus
}
#endif
 
#endif