source: rtems/doc/new_chapters/dumpcontrol.t @ d1a859c

4.104.114.84.95
Last change on this file since d1a859c was d1a859c, checked in by Joel Sherrill <joel.sherrill@…>, on 08/25/98 at 20:54:47

Cleaned up formatting.

Added notes on background and operations sections.

Added NOTE to indicate the feature flag defined.

  • Property mode set to 100644
File size: 2.3 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1998.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@chapter Process Dump Control Manager
10
11@section Introduction
12
13The process dump control manager provides a portable
14interface for changing the path to which a process dump
15is written.  The capabilities in this manager were defined in
16the POSIX 1003.1h/D3 proposed standard titled @b{Services for Reliable,
17Available, and Serviceable Systems}.
18
19The directives provided by the process dump control manager are:
20
21@itemize @bullet
22@item @code{dump_setpath} - Dump File Control
23@end itemize
24
25@section Background
26
27@section Operations
28
29@section Directives
30
31This section details the process dump control manager's directives.
32A subsection is dedicated to each of this manager's directives
33and describes the calling sequence, related constants, usage,
34and status codes.
35
36@page
37@subsection dump_setpath - Dump File Control
38
39@subheading CALLING SEQUENCE:
40
41@ifset is-C
42@example
43int dump_setpath(
44  const char      *path
45);
46@end example
47@end ifset
48
49@ifset is-Ada
50@end ifset
51
52@subheading STATUS CODES:
53
54@table @b
55@item EACESS
56Search permission is denied for a component of the path prefix,
57or write permission is denied on the directory containing the
58file.
59
60@item ENAMETOOLONG
61The length of the argument exceeds @code{PATH_MAX} or a pathname
62component is longer than @code{NAME_MAX} while @code{_POSIX_NO_TRUNC}
63is in effect.
64
65@item ENOENT
66The path argument points to an empty string.
67
68@item ENOTDIR
69A component of the path prefix is not a directory.
70
71@item EROFS
72The directory entry specified resides on a read-only file system.
73
74@end table
75
76@subheading DESCRIPTION:
77
78The @code{dump_setpath} function defines the pathname where process
79dumps are written.  The pathname pointed to by @code{path} shall
80define where a process dump file will be written if the calling
81process terminates with a dump file.  The @code{path} argument
82shall not name a directory.
83
84If the @code{path} argument is NULL, the system shall not write a
85process dump file if the calling process terminates with a dump
86file.  If the @code{dump_setpath} function fails, the pathname for
87writing process dumps shall not change.
88
89@subheading NOTES:
90
91The @code{_POSIX_DUMP} feature flag is defined to indicate
92this service is available.
Note: See TracBrowser for help on using the repository browser.