C2PH(1) Perl Programmers Reference Guide C2PH(1)
NAME
c2ph, pstruct - Dump C structures as generated from "cc -g -S" stabs
SYNOPSIS
c2ph [-dpnP] [var=val] [files ...]
OPTIONS
Options:
-w wide; short for: typewidth=45 memberwidth=35 offsetwidth=8
-x hex; short for: offsetfmt=x offsetwidth=08 sizefmt=x sizewidth=04
-n do not generate perl code (default when invoked as pstruct)
-p generate perl code (default when invoked as c2ph)
-v generate perl code, with C decls as comments
-i do NOT recompute sizes for intrinsic datatypes
-a dump information on intrinsics also
-t trace execution
-d spew reams of debugging output
-slist give comma-separated list a structures to dump
DESCRIPTION
The following is the old c2ph.doc documentation by Tom Christiansen
Date: 25 Jul 91 08:10:21 GMT
Once upon a time, I wrote a program called pstruct. It was a perl
program that tried to parse out C structures and display their member
offsets for you. This was especially useful for people looking at
binary dumps or poking around the kernel.
Pstruct was not a pretty program. Neither was it particularly robust.
The problem, you see, was that the C compiler was much better at
parsing C than I could ever hope to be.
So I got smart: I decided to be lazy and let the C compiler parse the
C, which would spit out debugger stabs for me to read. These were much
easier to parse. It's still not a pretty program, but at least it's
more robust.
Pstruct takes any .c or .h files, or preferably .s ones, since that's
the format it is going to massage them into anyway, and spits out
listings like this:
struct tty {
int tty.tlocker 000 4
int tty.tmutexindex 004 4
struct tty * tty.ttpvirt 008 4
struct clist tty.trawq 00c 20
int tty.trawq.ccc 00c 4
int tty.trawq.ccmax 010 4
int tty.trawq.ccfx 014 4
int tty.trawq.cclx 018 4
struct tty * tty.trawq.ctpcpu 01c 4
struct tty * tty.trawq.ctpiop 020 4
unsigned char * tty.trawq.cbufcpu 024 4
unsigned char * tty.trawq.cbufiop 028 4
struct clist tty.tcanq 02c 20
int tty.tcanq.ccc 02c 4
int tty.tcanq.ccmax 030 4
int tty.tcanq.ccfx 034 4
int tty.tcanq.cclx 038 4
struct tty * tty.tcanq.ctpcpu 03c 4
struct tty * tty.tcanq.ctpiop 040 4
unsigned char * tty.tcanq.cbufcpu 044 4
unsigned char * tty.tcanq.cbufiop 048 4
struct clist tty.toutq 04c 20
int tty.toutq.ccc 04c 4
int tty.toutq.ccmax 050 4
int tty.toutq.ccfx 054 4
int tty.toutq.cclx 058 4
struct tty * tty.toutq.ctpcpu 05c 4
struct tty * tty.toutq.ctpiop 060 4
unsigned char * tty.toutq.cbufcpu 064 4
unsigned char * tty.toutq.cbufiop 068 4
(*int)() tty.toproccpu 06c 4
(*int)() tty.toprociop 070 4
(*int)() tty.tstopproccpu 074 4
(*int)() tty.tstopprociop 078 4
struct thread * tty.trsel 07c 4
etc.
Actually, this was generated by a particular set of options. You can
control the formatting of each column, whether you prefer wide or fat,
hex or decimal, leading zeroes or whatever.
All you need to be able to use this is a C compiler than generates
BSD/GCC-style stabs. The -g option on native BSD compilers and GCC
should get this for you.
To learn more, just type a bogus option, like -\?, and a long usage
message will be provided. There are a fair number of possibilities.
If you're only a C programmer, than this is the end of the message for
you. You can quit right now, and if you care to, save off the source
and run it when you feel like it. Or not.
But if you're a perl programmer, then for you I have something much
more wondrous than just a structure offset printer.
You see, if you call pstruct by its other incybernation, c2ph, you have
a code generator that translates C code into perl code! Well,
structure and union declarations at least, but that's quite a bit.
Prior to this point, anyone programming in perl who wanted to interact
with C programs, like the kernel, was forced to guess the layouts of
the C structures, and then hardwire these into his program. Of course,
when you took your wonderfully crafted program to a system where the
sgtty structure was laid out differently, your program broke. Which is
a shame.
We've had Larry's h2ph translator, which helped, but that only works on
cpp symbols, not real C, which was also very much needed. What I offer
you is a symbolic way of getting at all the C structures. I've couched
them in terms of packages and functions. Consider the following
program:
#!/usr/local/bin/perl
require 'syscall.ph';
require 'sys/time.ph';
require 'sys/resource.ph';
$ru = "\0" x &rusage'sizeof();
syscall(&SYSgetrusage, &RUSAGESELF, $ru) && die "getrusage: $!";
@ru = unpack($t = &rusage'typedef(), $ru);
$utime = $ru[ &rusage'ruutime + &timeval'tvsec ]
+ ($ru[ &rusage'ruutime + &timeval'tvusec ]) / 1e6;
$stime = $ru[ &rusage'rustime + &timeval'tvsec ]
+ ($ru[ &rusage'rustime + &timeval'tvusec ]) / 1e6;
printf "you have used %8.3fs+%8.3fu seconds.\n", $utime, $stime;
As you see, the name of the package is the name of the structure.
Regular fields are just their own names. Plus the following accessor
functions are provided for your convenience:
struct This takes no arguments, and is merely the number of first-level
elements in the structure. You would use this for indexing
into arrays of structures, perhaps like this
$usec = $u[ &user'uutimer
+ (&ITIMERVIRTUAL * &itimerval'struct)
+ &itimerval'itvalue
+ &timeval'tvusec
];
sizeof Returns the bytes in the structure, or the member if
you pass it an argument, such as
&rusage'sizeof(&rusage'ruutime)
typedef This is the perl format definition for passing to pack and
unpack. If you ask for the typedef of a nothing, you get
the whole structure, otherwise you get that of the member
you ask for. Padding is taken care of, as is the magic to
guarantee that a union is unpacked into all its aliases.
Bitfields are not quite yet supported however.
offsetof This function is the byte offset into the array of that
member. You may wish to use this for indexing directly
into the packed structure with vec() if you're too lazy
to unpack it.
typeof Not to be confused with the typedef accessor function, this
one returns the C type of that field. This would allow
you to print out a nice structured pretty print of some
structure without knoning anything about it beforehand.
No args to this one is a noop. Someday I'll post such
a thing to dump out your u structure for you.
The way I see this being used is like basically this:
% h2ph /usr/lib/perl/tmp.ph
% c2ph someincludefile.h >> /usr/lib/perl/tmp.ph
% install
It's a little tricker with c2ph because you have to get the includes
right. I can't know this for your system, but it's not usually too
terribly difficult.
The code isn't pretty as I mentioned I never thought it would be a
1000- line program when I started, or I might not have begun. :-) But
I would have been less cavalier in how the parts of the program
communicated with each other, etc. It might also have helped if I
didn't have to divine the makeup of the stabs on the fly, and then
account for micro differences between my compiler and gcc.
Anyway, here it is. Should run on perl v4 or greater. Maybe less.
tom
perl v5.16.3 2018-10-30 C2PH(1)