xref: /onnv-gate/usr/src/cmd/sgs/prof/common/symint.h (revision 211:37c8180b1ace)
10Sstevel@tonic-gate /*
20Sstevel@tonic-gate  * CDDL HEADER START
30Sstevel@tonic-gate  *
40Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
50Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
60Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
70Sstevel@tonic-gate  * with the License.
80Sstevel@tonic-gate  *
90Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
100Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
110Sstevel@tonic-gate  * See the License for the specific language governing permissions
120Sstevel@tonic-gate  * and limitations under the License.
130Sstevel@tonic-gate  *
140Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
150Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
160Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
170Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
180Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
190Sstevel@tonic-gate  *
200Sstevel@tonic-gate  * CDDL HEADER END
210Sstevel@tonic-gate  */
22*211Smike_s 
23*211Smike_s /*
24*211Smike_s  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
25*211Smike_s  * Use is subject to license terms.
26*211Smike_s  */
27*211Smike_s 
280Sstevel@tonic-gate /*	Copyright (c) 1988 AT&T	*/
290Sstevel@tonic-gate /*	  All Rights Reserved  	*/
300Sstevel@tonic-gate 
310Sstevel@tonic-gate 
32*211Smike_s 	/* protect against multiple inclusion */
33*211Smike_s #ifndef _SYMINT_H
34*211Smike_s #define	_SYMINT_H
35*211Smike_s 
360Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
370Sstevel@tonic-gate 
380Sstevel@tonic-gate #include "symintHdr.h"
390Sstevel@tonic-gate 
40*211Smike_s #ifdef  __cplusplus
41*211Smike_s extern "C" {
42*211Smike_s #endif
430Sstevel@tonic-gate 
44*211Smike_s /*
450Sstevel@tonic-gate  * symint.c -- symbol information interface routines,
46*211Smike_s  *		interface definition.
47*211Smike_s  *
480Sstevel@tonic-gate  * these routines form a symbol information access
490Sstevel@tonic-gate  * interface, for the profilers to get at object file
500Sstevel@tonic-gate  * information.  this interface was designed to aid
510Sstevel@tonic-gate  * in the COFF to ELF conversion of prof, lprof and friends.
52*211Smike_s  *
530Sstevel@tonic-gate  * this file includes all declarative information required
540Sstevel@tonic-gate  * by a user of this interface.
55*211Smike_s  *
560Sstevel@tonic-gate  * ASSUMPTIONS
570Sstevel@tonic-gate  * ===========
58*211Smike_s  *
590Sstevel@tonic-gate  * 1.	that there exists a routine _Malloc, with the following
600Sstevel@tonic-gate  * 	(effective) prototype:
610Sstevel@tonic-gate  * 		char * _Malloc (int item_count, int item_size);
620Sstevel@tonic-gate  * 	which does NOT (necessarily) initialize the allocated storage,
630Sstevel@tonic-gate  * 	and which issues an error message and calls exit() if
640Sstevel@tonic-gate  * 	the storage could not be allocated.
65*211Smike_s  *
660Sstevel@tonic-gate  */
670Sstevel@tonic-gate 
680Sstevel@tonic-gate 
69*211Smike_s /*
700Sstevel@tonic-gate  * the interface routines:
71*211Smike_s  *
720Sstevel@tonic-gate  * 	1. open an object file, set up PROF_FILE et al. (_symintOpen).
730Sstevel@tonic-gate  * 	1. close an object file, clean up PROF_FILE et al. (_symintClose).
74*211Smike_s  *
750Sstevel@tonic-gate  * the data:
76*211Smike_s  *
770Sstevel@tonic-gate  * 	(none yet.)
78*211Smike_s  *
790Sstevel@tonic-gate  */
800Sstevel@tonic-gate 
81*211Smike_s PROF_FILE *_symintOpen(char *aout_name);	/* NULL or ptr */
82*211Smike_s void _symintClose(PROF_FILE *profPtr);		/* nuttin */
83*211Smike_s PROF_SYMBOL *_symintLoad(PROF_FILE *proffilePtr);
840Sstevel@tonic-gate 
85*211Smike_s /*
860Sstevel@tonic-gate  * required to be provided by the user of the interface...
870Sstevel@tonic-gate  */
880Sstevel@tonic-gate 
89*211Smike_s void *_Malloc(uint_t item_count, uint_t item_size);
90*211Smike_s void _err_exit(char *format_s, ...);
910Sstevel@tonic-gate 
92*211Smike_s #ifdef  __cplusplus
93*211Smike_s }
940Sstevel@tonic-gate #endif
95*211Smike_s 
96*211Smike_s #endif	/* _SYMINT_H */
97