xref: /titanic_44/usr/src/cmd/sgs/prof/common/symint.h (revision 8eea8e29cc4374d1ee24c25a07f45af132db3499)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*	Copyright (c) 1988 AT&T	*/
23 /*	  All Rights Reserved  	*/
24 
25 
26 #pragma ident	"%Z%%M%	%I%	%E% SMI"
27 
28 #include "symintHdr.h"
29 
30 	/* protect against multiple inclusion */
31 #ifndef SYMINT_FCNS
32 #define SYMINT_FCNS
33 
34 /* * * * * *
35  * symint.c -- symbol information interface routines,
36  * 	       interface definition.
37  *
38  * these routines form a symbol information access
39  * interface, for the profilers to get at object file
40  * information.  this interface was designed to aid
41  * in the COFF to ELF conversion of prof, lprof and friends.
42  *
43  * this file includes all declarative information required
44  * by a user of this interface.
45  *
46  * ASSUMPTIONS
47  * ===========
48  *
49  * 1.	that there exists a routine _Malloc, with the following
50  * 	(effective) prototype:
51  * 		char * _Malloc (int item_count, int item_size);
52  * 	which does NOT (necessarily) initialize the allocated storage,
53  * 	and which issues an error message and calls exit() if
54  * 	the storage could not be allocated.
55  *
56  */
57 
58 
59 /* * * * * *
60  * the interface routines:
61  *
62  * 	1. open an object file, set up PROF_FILE et al. (_symintOpen).
63  * 	1. close an object file, clean up PROF_FILE et al. (_symintClose).
64  *
65  * the data:
66  *
67  * 	(none yet.)
68  *
69  */
70 
71 					/* Returns!! */
72 					/* FAILURE or SUCCESS */
73 
74 extern	  PROF_FILE *	_symintOpen();	/* NULL or ptr */
75 
76 extern           void	_symintClose();	/* nuttin */
77 
78 
79 
80 /* * * * * *
81  * required to be provided by the user of the interface...
82  */
83 
84 extern         char *	_Malloc();	/* Safe alloc given ct & itemsize */
85 
86 #endif
87