# rtai_shm.h File Reference

## Detailed Description

Interface of the RTAI SHM module.

Author:
  Paolo Mantegazza

Note:
  Copyright © 1999-2004 Paolo Mantegazza <mantegazza@aero.polimi.it>

This program is free software; you can redistribute it and/or modify it 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, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Include dependency graph for rtai_shm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Defines

#define | rtai_kmalloc(name, size) rt_shm_alloc(name, size, USE_VMALLOC)
| Allocate a chunk of memory to be shared inter-intra kernel modules and Linux processes.
#define | rtai_kfree(name) rt_shm_free(name)
| Free a chunk of shared memory being shared inter-intra kernel modules and Linux processes.
#define | rtai_malloc(name, size) _rt_shm_alloc(0, name, size, USE_VMALLOC, 0)
| Allocate a chunk of memory to be shared inter-intra kernel modules and Linux processes.
#define | rt_shm_alloc_adr(start_address, name, size, suprt) _rt_shm_alloc(start_address, name, size, suprt, 0)
| Allocate a chunk of memory to be shared inter-intra kernel modules and Linux processes.
#define | rtai_malloc_adr(start_address, name, size) _rt_shm_alloc(start_address, name, size, USE_VMALLOC, 0)
| Allocate a chunk of memory to be shared inter-intra kernel modules and Linux processes.
#define | rtai_free(name, adr) rt_shm_free(name)
| Free a chunk of shared memory being shared inter-intra kernel modules and Linux processes.
#define | rt_heap_close(name, adr) rt_shm_free(name)
| Close a real time group heap being shared inter-intra kernel modules and Linux processes.
#define | rt_global_heap_open() rt_heap_open(GLOBAL_HEAP_ID, 0, 0)
| Open the global real time heap to be shared inter-intra kernel modules and Linux processes.
#define | rt_global_heap_close() rt_heap_close(GLOBAL_HEAP_ID, 0)
| Close the global real time heap being shared inter-intra kernel modules and Linux processes.

## Functions

int | rt_shm_free (unsigned long name)
| Free a chunk of shared memory being shared inter-intra kernel modules and Linux processes.
void * | rt_halloc (int size)
| Allocate a chunk of a group real time heap in kernel/user space.
void | rt_hfree (void *addr)
| Free a chunk of a group real time heap.
void * | rt_named_halloc (unsigned long name, int size)
| Allocate a chunk of a group real time heap in kernel/user space.
void | rt_named_hfree (void *addr)
| Free a chunk of a group real time heap.
void * | rt_named_malloc (unsigned long name, int size)
| Allocate a chunk of the global real time heap in kernel/user space.
void | rt_named_free (void *addr)
| Free a named chunk of the global real time heap.