shm.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Gedare Bloom.
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://www.rtems.org/license/LICENSE.
 */

#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