Standard C Library Support

RTEMS Specific Support for the Standard C Library. More...

Topics
	Error And Panic Support
	Defines and externs for rtems error reporting.
	Malloc Support
	This group contains interfaces to support dynamic memory allocation.
	RTEMS Termios Device Support
	This group contains the Termios Device Support provided by RTEMS.

Files
file	cpukit/include/rtems/libcsupport.h
	Standard C Library Support.
file	cpukit/libcsupport/src/__assert.c
	Evaluate Assertion.
file	cpukit/libcsupport/src/__getpid.c
	Get Process Id.
file	cpukit/libcsupport/src/__gettod.c
	Get the Date and Time.
file	cpukit/libcsupport/src/__times.c
	Get Process Times.
file	cpukit/libcsupport/src/_calloc_r.c
	Allocate Space for Array in Memory.
file	cpukit/libcsupport/src/_free_r.c
	Allocate and Free Dynamic Memory.
file	cpukit/libcsupport/src/_realloc_r.c
	_realloc_r Implementation
file	cpukit/libcsupport/src/_rename_r.c
	Rename a File.
file	cpukit/libcsupport/src/access.c
	access() - POSIX 1003.1b 5.6.3 - File Accessibility
file	cpukit/libcsupport/src/calloc.c
	Allocate Space for Array in Memory.
file	cpukit/libcsupport/src/chmod.c
	Change File Modes.
file	cpukit/libcsupport/src/chown.c
	Change Owner and Group of a File.
file	cpukit/libcsupport/src/chroot.c
	Change Root Directory.
file	cpukit/libcsupport/src/close.c
	POSIX 1003.1b 6.3.1 - Close a File.
file	cpukit/libcsupport/src/ctermid.c
	Generate Terminal Pathname.
file	cpukit/libcsupport/src/dup.c
	POSIX 1003.1b 6.2.1 Duplicate an Open File Descriptor.
file	cpukit/libcsupport/src/dup2.c
	Duplicate an Open File Descriptor.
file	cpukit/libcsupport/src/fchdir.c
	Change Directory.
file	cpukit/libcsupport/src/fchmod.c
	Change File Modes.
file	cpukit/libcsupport/src/fchown.c
	Change Owner and Group of a File.
file	cpukit/libcsupport/src/fcntl.c
	POSIX 1003.1b 6.5.2 - File Control.
file	cpukit/libcsupport/src/fdatasync.c
	POSIX 1003.1b 6.6.2 - Synchronize the Data of a File.
file	cpukit/libcsupport/src/fpathconf.c
	Configurable Pathname Varables.
file	cpukit/libcsupport/src/free.c
	calloc()
file	cpukit/libcsupport/src/fsync.c
	Synchronize the State of a File.
file	cpukit/libcsupport/src/ftruncate.c
	Truncate a File to the Specified Length.
file	cpukit/libcsupport/src/funlockfile.c
	Unlock File for Stdio.
file	cpukit/libcsupport/src/futimens.c
	Set file access and modification times based on file descriptor in nanoseconds.
file	cpukit/libcsupport/src/gcovfork.c
	This source file contains functions required by GCC if code and branch coverage instrumentation (gcov) is enabled.
file	cpukit/libcsupport/src/getdents.c
	Get Directory Entries.
file	cpukit/libcsupport/src/getegid.c
	Get Real User, Effective User, Ral Group, and Effective Group IDs.
file	cpukit/libcsupport/src/geteuid.c
	Get Real User, Effective User, Ral Group, and Effective Group IDs.
file	cpukit/libcsupport/src/getgid.c
	Get Real User, Effective User, Ral Group, and Effective Group IDs.
file	cpukit/libcsupport/src/getgrent.c
	User Database Access Routines.
file	cpukit/libcsupport/src/getgrnam.c
	User Database Access Routines.
file	cpukit/libcsupport/src/getgroups.c
	Get Supplementary IDs.
file	cpukit/libcsupport/src/getlogin.c
	Get User Name.
file	cpukit/libcsupport/src/getpagesize.c
	Get System Page Size.
file	cpukit/libcsupport/src/getpgrp.c
	Get process group IDs.
file	cpukit/libcsupport/src/getpid.c
	Process and Parent Process IDs.
file	cpukit/libcsupport/src/getppid.c
	Get Process and Parent Process IDs.
file	cpukit/libcsupport/src/getpwent.c
	User Database Access Routines.
file	cpukit/libcsupport/src/getuid.c
	Get Real User, Effective User, Ral Group, and Effective Group IDs.
file	cpukit/libcsupport/src/ioctl.c
	ioctl() system call
file	cpukit/libcsupport/src/isatty_r.c
	Test for a Terminal Device.
file	cpukit/libcsupport/src/issetugid.c
	Dummy Version of BSD Routine.
file	cpukit/libcsupport/src/kill_noposix.c
	Kill No POSIX.
file	cpukit/libcsupport/src/link.c
	Create a new link.
file	cpukit/libcsupport/src/lstat.c
	Get File Status.
file	cpukit/libcsupport/src/malloc.c
	RTEMS Malloc Family Implementation.
file	cpukit/libcsupport/src/malloc_deferred.c
	Malloc Deferred Support.
file	cpukit/libcsupport/src/malloc_p.h
	This header file provides interfaces used by the memory allocator implementation.
file	cpukit/libcsupport/src/malloc_walk.c
	Malloc Walk.
file	cpukit/libcsupport/src/mallocfreespace.c
	RTEMS Malloc Get Free Information.
file	cpukit/libcsupport/src/mallocgetheapptr.c
	RTEMS Malloc Get Heap Pointer.
file	cpukit/libcsupport/src/mallocinfo.c
	RTEMS Malloc Get Status Information.
file	cpukit/libcsupport/src/mallocsetheapptr.c
	RTEMS Malloc Set Heap Pointer.
file	cpukit/libcsupport/src/mkdir.c
	Make a Directory.
file	cpukit/libcsupport/src/mkfifo.c
	Make a FIFO Special File.
file	cpukit/libcsupport/src/mknod.c
	Create a Special or Ordinary File.
file	cpukit/libcsupport/src/newlibc_reent.c
	Newlib Support.
file	cpukit/libcsupport/src/open.c
	Open a File.
file	cpukit/libcsupport/src/pathconf.c
	Configurable Pathname Varables.
file	cpukit/libcsupport/src/posix_memalign.c
file	cpukit/libcsupport/src/print_fprintf.c
	RTEMS Print Support.
file	cpukit/libcsupport/src/print_printf.c
	RTEMS Print Support.
file	cpukit/libcsupport/src/printf_plugin.c
	RTEMS Plugin Printf.
file	cpukit/libcsupport/src/pwdgrp.c
	User Database Access Routines.
file	cpukit/libcsupport/src/read.c
	Read From a File.
file	cpukit/libcsupport/src/readlink.c
	Read Value of a Symbolic Link.
file	cpukit/libcsupport/src/readv.c
	Read a Vector.
file	cpukit/libcsupport/src/realloc.c
	Reallocate Memory Block.
file	cpukit/libcsupport/src/rmdir.c
	Remove a Directory.
file	cpukit/libcsupport/src/rtems_heap_extend.c
	rtems_heap_extend() implementation.
file	cpukit/libcsupport/src/rtemscalloc.c
	This source file contains the implementation of rtems_calloc().
file	cpukit/libcsupport/src/setegid.c
	Get Real User, Effective User, Ral Group, and Effective Group IDs.
file	cpukit/libcsupport/src/seteuid.c
	Set Effective User Id.
file	cpukit/libcsupport/src/setpgid.c
	Set Process Group ID for Job Control.
file	cpukit/libcsupport/src/setsid.c
	Create Session and Set Process Group ID.
file	cpukit/libcsupport/src/stat.c
	Get File Status.
file	cpukit/libcsupport/src/symlink.c
	Make a Symbolic Link to a File.
file	cpukit/libcsupport/src/sync.c
	This source file contains the implementation of sync().
file	cpukit/libcsupport/src/tcgetpgrp.c
	Get Foreground Process Group ID.
file	cpukit/libcsupport/src/tcsetattr.c
	Get and Set State.
file	cpukit/libcsupport/src/tcsetpgrp.c
	Set Foreground Process Group ID.
file	cpukit/libcsupport/src/truncate.c
	Truncate a File to the Specified Length.
file	cpukit/libcsupport/src/umask.c
	Set File Creation Mask.
file	cpukit/libcsupport/src/unlink.c
	Remove an Existing Link.
file	cpukit/libcsupport/src/unmount.c
	Unmount a File System.
file	cpukit/libcsupport/src/utime.c
	Set file access and modification times in seconds.
file	cpukit/libcsupport/src/utimensat.c
	Set file access and modification times in nanoseconds.
file	cpukit/libcsupport/src/utimes.c
	Set file access and modification times in milliseconds.
file	cpukit/libcsupport/src/write.c
	Write to a File.
file	cpukit/libcsupport/src/write_r.c
	POSIX 1003.1b 6.4.2 - Write to a File.

Data Structures
struct	rtems_resource_rtems_api
struct	rtems_resource_posix_api
struct	rtems_resource_snapshot

Macros
#define	_NEWLIB_CREATE_HOOK   newlib_create_hook
#define	RTEMS_NEWLIB_EXTENSION

Functions
void	malloc_dump (void)
bool	malloc_walk (int source, bool printf_enabled)
	Malloc walk.
void	malloc_set_heap_pointer (Heap_Control *new_heap)
	Set malloc heap pointer.
Heap_Control *	malloc_get_heap_pointer (void)
	Get malloc heap pointer.
size_t	malloc_free_space (void)
	Get free malloc information.
int	malloc_info (Heap_Information_block *the_info)
	Get malloc status information.
bool	newlib_create_hook (rtems_tcb *current_task, rtems_tcb *creating_task)
void	newlib_terminate_hook (rtems_tcb *current_task)
void	rtems_resource_snapshot_take (rtems_resource_snapshot *snapshot)
	Tasks a snapshot of the resource usage of the system.
bool	rtems_resource_snapshot_equal (const rtems_resource_snapshot *a, const rtems_resource_snapshot *b)
	Compares two resource snapshots for equality.
bool	rtems_resource_snapshot_check (const rtems_resource_snapshot *snapshot)
	Takes a new resource snapshot and checks that it is equal to the given resource snapshot.

Detailed Description

RTEMS Specific Support for the Standard C Library.

Macro Definition Documentation

RTEMS_NEWLIB_EXTENSION

#define RTEMS_NEWLIB_EXTENSION

Value:

{ \
  _NEWLIB_CREATE_HOOK,    \
  NULL,                   \
  NULL,                   \
  NULL,                   \
  NULL,                   \
  NULL,                   \
  NULL,                   \
  NULL,                   \
  newlib_terminate_hook   \
}

Function Documentation

malloc_free_space()

size_t malloc_free_space ( void )

extern

Get free malloc information.

Find amount of free heap remaining

malloc_get_heap_pointer()

Heap_Control * malloc_get_heap_pointer

(

void

)

Get malloc heap pointer.

This routine is primarily used for debugging.

malloc_info()

int malloc_info ( Heap_Information_block * the_info )

extern

Get malloc status information.

Find amount of free heap remaining.

malloc_set_heap_pointer()

void malloc_set_heap_pointer

(

Heap_Control *

new_heap

)

Set malloc heap pointer.

This routine is primarily used for debugging.

rtems_resource_snapshot_check()

bool rtems_resource_snapshot_check

(

const rtems_resource_snapshot *

snapshot

)

Takes a new resource snapshot and checks that it is equal to the given resource snapshot.

Parameters

[in]

snapshot

The resource snapshot used for comparison with the new resource snapshot.

Return values

true	The resource snapshots are equal.
false	Otherwise.

See also

rtems_resource_snapshot_take().

rtems_resource_snapshot_equal()

bool rtems_resource_snapshot_equal	(	const rtems_resource_snapshot *	a,
		const rtems_resource_snapshot *	b )

Compares two resource snapshots for equality.

Parameters

[in]	a	One resource snapshot.
[in]	b	Another resource snapshot.

Return values

true	The resource snapshots are equal.
false	Otherwise.

See also

rtems_resource_snapshot_take().

rtems_resource_snapshot_take()

void rtems_resource_snapshot_take

(

rtems_resource_snapshot *

snapshot

)

Tasks a snapshot of the resource usage of the system.

Parameters

[out]

snapshot

The snapshot of used resources.

See also

rtems_resource_snapshot_equal() and rtems_resource_snapshot_check().

#include <assert.h>
 
#include <rtems/libcsupport.h>
 
void example(void)
{
  rtems_resource_snapshot before;
 
  test_setup();
  rtems_resource_snapshot_take(&before);
  test();
  assert(rtems_resource_snapshot_check(&before));
  test_cleanup();
}