xref: /titanic_50/usr/src/cmd/sgs/librtld_db/demo/00README (revision 6a634c9dca3093f3922e4b7ab826d7bdf17bf78e)
1*20c1c355SRod Evans#
2*20c1c355SRod Evans# CDDL HEADER START
3*20c1c355SRod Evans#
4*20c1c355SRod Evans# The contents of this file are subject to the terms of the
5*20c1c355SRod Evans# Common Development and Distribution License (the "License").
6*20c1c355SRod Evans# You may not use this file except in compliance with the License.
7*20c1c355SRod Evans#
8*20c1c355SRod Evans# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*20c1c355SRod Evans# or http://www.opensolaris.org/os/licensing.
10*20c1c355SRod Evans# See the License for the specific language governing permissions
11*20c1c355SRod Evans# and limitations under the License.
12*20c1c355SRod Evans#
13*20c1c355SRod Evans# When distributing Covered Code, include this CDDL HEADER in each
14*20c1c355SRod Evans# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*20c1c355SRod Evans# If applicable, add the following below this CDDL HEADER, with the
16*20c1c355SRod Evans# fields enclosed by brackets "[]" replaced with your own identifying
17*20c1c355SRod Evans# information: Portions Copyright [yyyy] [name of copyright owner]
18*20c1c355SRod Evans#
19*20c1c355SRod Evans# CDDL HEADER END
20*20c1c355SRod Evans#
21*20c1c355SRod Evans
22*20c1c355SRod Evans#
23*20c1c355SRod Evans# Copyright (c) 1995, 2010, Oracle and/or its affiliates. All rights reserved.
24*20c1c355SRod Evans#
25*20c1c355SRod Evans
26*20c1c355SRod EvansThis directory contains source code to the rdb debugger.  This debugger
27*20c1c355SRod Evansis distributed as an example client of the librtld_db.so.1 interface.
28*20c1c355SRod EvansAs well as offering examples of the proper calling sequence for the
29*20c1c355SRod Evanslibrtld_db.so.1 interface rdb also offers a sample implementation of the
30*20c1c355SRod Evansproc_services (/usr/include/proc_service.h) that rdb is dependent upon.
31*20c1c355SRod Evans
32*20c1c355SRod EvansThe following is an overview of the directory structure and highlight
33*20c1c355SRod Evansof some of the important files contained within:
34*20c1c355SRod Evans
35*20c1c355SRod Evansrdb.man		- man page for the rdb debugger
36*20c1c355SRod EvansMakefile.com
37*20c1c355SRod EvansMakefile.targ	- common Makefiles included by ${MACH)/Makefile
38*20c1c355SRod Evanscommon/*	- common source code used for all architectures
39*20c1c355SRod Evansamd64/		- build directory contains architecture specific source files
40*20c1c355SRod Evansi386/		 	"	"	"	"
41*20c1c355SRod Evanssparc/			"	"	"	"
42*20c1c355SRod Evanssparcv9/		"	"	"	"
43*20c1c355SRod Evansamd64/Makefile	- makefiles to build rdb for each architecture
44*20c1c355SRod Evansi386/Makefile		"	"	"	"
45*20c1c355SRod Evanssparc/Makefil		"	"	"	"
46*20c1c355SRod Evanssparcv9/Makefil		"	"	"	"
47*20c1c355SRod Evanstest/*		- sample command files which can be used to test rdb
48*20c1c355SRod Evans
49*20c1c355SRod Evans
50*20c1c355SRod EvansBuilding rdb
51*20c1c355SRod Evans------------
52*20c1c355SRod Evans
53*20c1c355SRod EvansTo build rdb:
54*20c1c355SRod Evans
55*20c1c355SRod Evans % cd {amd64,i386,sparc,sparcv9}	- depending on which architecture
56*20c1c355SRod Evans					  you are building for
57*20c1c355SRod Evans % make all
58*20c1c355SRod Evans
59*20c1c355SRod EvansTo test the demo:
60*20c1c355SRod Evans
61*20c1c355SRod Evans % make test
62