strace/README-mpers

To use mpers functionality, one should:
* typedef all of the target types which are compound and not typedefed
already;
* for each target type, include DEF_MPERS_TYPE(target_type_t), these can
be included conditionally;
* include MPERS_DEFS once;
* before inclusion of MPERS_DEFS include all important headers
(containing definitions of these types or other behaviour-affecting
defines);
* printers should be defined
as MPERS_PRINTER_DECL(return_type, function_name, args),
inside files that include MPERS_DEFS these printers should be called
as MPERS_FUNC_NAME(function_name)(args), in other files
they should be called just as function_name(args).
Add mpers support Add a subsystem for semi-automatical definition of how parsers should work with personality-dependent (mpers) types of tracee's data. Create auxiliary libraries containing mpers syscall parsers and printer functions, one library for each possible nonnative target personality. Currently some parsers do not handle differences in definitions of data types between personalities, namely LP64 and ILP32. When this is the case, long integers, pointers, and all compound types containing long and pointer members may be printed incorrectly, because of differences in sizes, offsets and alignments. Since in most cases these are the only differences in desired behaviour of parsers and printers for different personalities, a correct way would be to compile one source code into multiple parsers, differing only in definitions of mpers types. To get a definition of a given type for nonnative personality a very basic .c file containing a declaration of a variable of this type is being compiled for this personality (using -m32 or -mx32 compiler flag). Information about the type is then being extracted from this binary's DWARF debug info with an awk script and put into a corresponding header file. Resulting headers are being used to compile mpers variations of syscall parsers and printer functions. In addition to syscall parsers, there can occur a need to create mpers printing functions, which then can be called from many places in the code (for example, printsiginfo_at). Such functions (printers) are marked in a special manner. For each possible nonnative target personality a library is being created, containing mpers variations of syscall parsers and printers. Only syscall parsers from files marked in a special manner and specially marked functions from such files are being recompiled and included in these libraries. generate_mpers_am.sh is called by bootstrap to find the files from strace_SOURCES which include MPERS_DEFS. During compilation, these files are being inspected for inclusions of DEF_MPERS_TYPE, and nonnative variations of each included type are being generated by an awk script. Mpers parser names are being modified during inclusions of syscallent headers for nonnative personalities. Pointers to printers are being stored in structs struct_printers, and a master pointer printers is being updated on every set_personality. * README-mpers: New README explaining how to use mpers support. * empty.h: New empty file. * generate_mpers_am.sh: New file. * mpers.awk: Likewise. * mpers.sh: Likewise. * mpers_test.sh: Likewise. * mpers_type.h: Likewise. * Makefile.am (strace_SOURCES): Add empty.h and mpers_type.h. (strace_CPPFLAGS, strace_LDFLAGS, strace_LDADD): Move to the beginning of the file. (strace_LDADD, noinst_LIBRARIES): Add libmpers-%.a. (EXTRA_DIST): Add mpers.awk, mpers.sh, mpers_test.sh. (BUILT_SOURCES, CLEANFILES): Add new generated files: native_printer_decls.h, native_printer_defs.h, printers.h, [HAVE_M32_MPERS] $(mpers_m32_targets), and [HAVE_MX32_MPERS] $(mpers_mx32_targets). (mpers_NAME, mpers_PREFIX, mpers_DEFS, mpers_INCLUDES, mpers_CPPFLAGS, mpers_sh_opts, libmpers_CPPFLAGS, libmpers_m[x]32_a_SOURCES, libmpers_m[x]32_a_CPPFLAGS, mpers_m[x]32_targets): New variables. (mpers-m[x]32.stamp, m[x]32_defs.h, m[x]32_funcs.h, printers.h, %_printer_decls.h, %_printer_defs.h, clean-local, native_printer_decls.h, native_printer_defs.h, $mpers_m[x]32_targets): New targets. * bootstrap: Add generate_mpers_am.sh. * configure.ac: Add AC_PROG_RANLIB. * m4/mpers.m4: Add HAVE_MPERS variable. Add $st_cv_mpers checks. * defs.h: Include mpers_type.h. Include printers.h, native_printer_decls.h, define MPERS_PRINTER_NAME. Redefine SYS_FUNC_NAME. Define MPERS_PRINTER_DECL. [HAVE_M32_MPERS]: define PERSONALITY1_INCLUDE_FUNCS, PERSONALITY1_INCLUDE_PRINTERS_DECLS, PERSONALITY1_INCLUDE_PRINTERS_DEFS for X86_64, X32. [HAVE_MX32_MPERS]: define PERSONALITY2_INCLUDE_FUNCS, PERSONALITY2_INCLUDE_PRINTERS_DECLS, PERSONALITY2_INCLUDE_PRINTERS_DEFS for X86_64. Add fallback definitions of PERSONALITY1_INCLUDE_FUNCS, PERSONALITY2_INCLUDE_FUNCS, PERSONALITY0_INCLUDE_PRINTERS_DECLS, PERSONALITY0_INCLUDE_PRINTERS_DEFS, PERSONALITY1_INCLUDE_PRINTERS_DECLS, PERSONALITY1_INCLUDE_PRINTERS_DEFS, PERSONALITY2_INCLUDE_PRINTERS_DECLS, PERSONALITY2_INCLUDE_PRINTERS_DEFS. * syscall.c: Include PERSONALITY1_INCLUDE_FUNCS, PERSONALITY2_INCLUDE_FUNCS, PERSONALITY0_INCLUDE_PRINTERS_DECLS, PERSONALITY0_INCLUDE_PRINTERS_DEFS, PERSONALITY1_INCLUDE_PRINTERS_DECLS, PERSONALITY1_INCLUDE_PRINTERS_DEFS, PERSONALITY2_INCLUDE_PRINTERS_DECLS, PERSONALITY2_INCLUDE_PRINTERS_DEFS. (printers): New struct. Update it when needed. * .gitignore: Add libmpers-m32.a, libmpers-mx32.a, m32_defs.h, m32_funcs.h, m32_printer_decls.h, m32_printer_defs.h, mpers-m32, mpers-m32.stamp, mpers-mx32, mpers-mx32.stamp, mpers.am, mx32_defs.h, mx32_funcs.h, mx32_printer_decls.h, mx32_printer_defs.h, native_printer_decls.h, native_printer_defs.h, and printers.h. 2015-08-04 01:47:02 +03:00			`To use mpers functionality, one should:`
			`* typedef all of the target types which are compound and not typedefed`
			`already;`
			`* for each target type, include DEF_MPERS_TYPE(target_type_t), these can`
			`be included conditionally;`
			`* include MPERS_DEFS once;`
			`* before inclusion of MPERS_DEFS include all important headers`
			`(containing definitions of these types or other behaviour-affecting`
			`defines);`
			`* printers should be defined`
mpers: add support of conditionally compiled printers We used to declare and define all printers marked with MPERS_PRINTER_DECL, including ifdef'ed ones. That approach left us no way to conditionally compile mpersified printers, which was not a problem until btrfs ioctls appeared on the horizon. With this change, those mpersified printers that are not going to be compiled are also won't be declared and won't be added to struct_printers. This is implemented by filtering all source files containing MPERS_PRINTER_DECL markers through CPP. As a nice side effect, this also lifts an ugly requirement of writing all MPERS_PRINTER_DECL declarations in a single line. * README-mpers: Update description of MPERS_PRINTER_DECL syntax. * defs.h [IN_MPERS_BOOTSTRAP] (MPERS_PRINTER_DECL): Turn into a recursive variadic macro. [!IN_MPERS_BOOTSTRAP] (MPERS_PRINTER_DECL): Turn into a variadic macro. All callers changed. * Makefile.am (mpers_preproc_files, mpers_printer_decl_pattern): New variables. (CLEANFILES): Add $(mpers_preproc_files). (%.c.mpers.i): New rule. (printers.h, %_printer_decls.h, %_printer_defs.h): Use mpers_preproc_files instead of srcdir_mpers_source_files, use mpers_printer_decl_pattern. * .gitignore: Add /*.mpers.i. 2016-05-22 01:53:06 +03:00			`as MPERS_PRINTER_DECL(return_type, function_name, args),`
Simplify use of mpers printers * native_defs.h: New file. * syscall.c: Include it. * mpers_type.h [!IN_MPERS] (MPERS_DEFS): Change to "native_defs.h". * defs.h (MPERS_PRINTER_NAME): Remove. [SUPPORTED_PERSONALITIES > 1] (MPERS_PRINTER_NAME, printers): Move ... * Makefile.am (printers.h): ... here. Add macro definitions for mpers printers. (m%_defs.h): Add redefinition of MPERS_PRINTER_NAME and inclusion of "$(mpers_PREFIX)printer_decls.h". (strace_SOURCES): Add native_defs.h. * README-mpers: Update instructions for using mpers printers. * ipc_msg.c (tprint_msgsnd, tprint_msgrcv): Call tprint_msgbuf directly. * mq.c (sys_mq_open, mq_getsetattr): Call printmqattr directly. * process.c (sys_ptrace): Call printsiginfo_at directly. * signal.c (print_sigqueueinfo, sys_rt_sigtimedwait): Likewise. * resource.c (sys_getrusage): Call printrusage directly. * utimes.c (sys_utimensat): Call print_timespec_utime_pair directly. (sys_utimes, sys_futimesat): Call print_timeval_pair directly. * wait.c (printwaitn): Call printrusage directly. (sys_waitid): Call printrusage and printsiginfo_at directly. 2015-09-16 00:51:15 +03:00			`inside files that include MPERS_DEFS these printers should be called`
			`as MPERS_FUNC_NAME(function_name)(args), in other files`
			`they should be called just as function_name(args).`