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