Google Git
Sign in
plan9port / plan9 / d9c8a7c5366aea63aa45b4afc6a75d133192786d / . / man / man3 / mach.3
blob: 389185232ad404634e4a4ff0cc05e8d457743783 [file] [log] [blame]
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]1.TH MACH 3
2.SH NAME
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]3machbytype, machbyname \- machine-independent access to executables and programs
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]4.SH SYNOPSIS
5.B #include <u.h>
6.br
7.B #include <libc.h>
8.br
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]9.B #include <mach.h>
10.PP
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]11.PP
12.B
13void machbytype(int type)
14.PP
15.B
16int machbyname(char *name)
17.PP
18.B
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]19extern Mach *mach;
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]20.SH DESCRIPTION
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]21.I Libmach
22provides an interface for accessing
23the executable files and executing images of various architectures
24and operating systems.
25The interface is machine-independent, meaning that, for example,
26Mac OS X core dumps may be inspected using an x86 Linux machine
27and vice versa.
28In its current form,
29the library is mainly useful for writing debuggers
30of one sort or another.
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]31.PP
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]32An architecture is described primarily by a
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]33.B Mach
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]34structure, which contains
35data structures and parameters describing the
36particular architecture.
37Most library functions assume that the global variable
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]38.I mach
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]39points at the structure for the architecture being debugged.
40It is set implicitly by
41.I crackhdr
42(see
43.IR mach-file (3))
44and can be set explicitly by calling
45.I machbyname
46or
47.IR machbytype .
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]48.PP
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]49There is no operating system-specific structure akin to
50.IR mach .
51Typically the choice of operating system on a particular
52architecture affects only the executable and core dump formats;
53the various file parsers deduce the operating system from
54information in the binary files themselves and adjust
55accordingly.
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]56.PP
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]57Other manual pages
58describe the library functions in detail.
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]59.PP
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]60.I Mach-file (3)
61describes the manipulation of binary files.
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]62.PP
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]63.I Mach-map (3)
64describes the interface to address spaces and register sets
65in executable files and executing programs.
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]66.PP
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]67.I Mach-stack (3)
68describes support for unwinding the stack.
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]69.PP
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]70.I Mach-swap (3)
71describes helper functions for accessing data
72in a particular byte order.
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]73.PP
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]74.I Mach-symbol (3)
75describes the interface to debugging symbol information.
rsccfa37a72004-04-10 18:53:55 +0000[diff] [blame]76.SH SOURCE
rscb5fdffe2004-04-19 19:22:56 +0000[diff] [blame]77.B /usr/local/plan9/src/libmach
rscbf8a59f2004-04-11 03:42:27 +0000[diff] [blame]78.SH "SEE ALSO
79.IR mach-file (3),
80.IR mach-map (3),
81.IR mach-stack (3),
82.IR mach-swap (3),
83.IR mach-symbol (3)