[Serdev] CVS:commitlog: ser_objdump - Imported sources

[Jan Janak]

Hello,

This is a small tool that can be used to list all symbols (functions,
module parameters, and rpc functions) from a SER module. The tool will
be mainly used to auto-generate reference documentation for SER.

janakj at localhost:~/ser/ser_objdump$ ./ser_objdump -h
Usage: ./ser_objdump [option(s)] <module>
 List SER symbols in <module>.
 The options are:
  -f, --functions      List module function symbols (on by default)
  -p, --parameters     List module parameter symbols (on by default)
  -r, --rpc            List module RPC functions (on by default)
  -c, --csv            Display output in CSV format (default)
  -s, --sql            Display output in SQL format
  -t, --table <str>    Table name to be used in SQL format
  -m, --module <str>   Set module name to <str>
  -h, --help           Display this information
  -v, --version <str>  Set version string to <str>

Report bugs to serdev at lists.iptel.org.

The tool can either generate CVS-style output:
janakj at localhost:~/ser/ser_objdump$ ./ser_objdump
/usr/local/lib/ser/modules/ctl.so
ctl,ser 0.10.99-dev64-tls (i386/linux),ctl.who,1,0,0x0,list..
ctl,ser 0.10.99-dev64-tls (i386/linux),ctl.connections,1,0,0x0,return..
ctl,ser 0.10.99-dev64-tls (i386/linux),ctl.listen,1,0,0x0,list..
ctl,ser 0.10.99-dev64-tls (i386/linux),fifo,2,0,0x80000001,(null)
ctl,ser 0.10.99-dev64-tls (i386/linux),binrpc,2,0,0x80000001,(null)
ctl,ser 0.10.99-dev64-tls (i386/linux),mode,2,0,0x2,(null)
ctl,ser 0.10.99-dev64-tls (i386/linux),user,2,0,0x80000001,(null)
ctl,ser 0.10.99-dev64-tls (i386/linux),group,2,0,0x80000001,(null)

The meaning of the fields is as follow:
  * module  - Module name
  * version - SER version
  * name - Name of the function/parameter/rpc
  * type - Type of the symbol (0 - function, 1 - rpc, 2 - parameter)
  * parameters - Number of parameters
  * flags - Symbol specific flags (see SER module API)
  * doc - Documentation string (only for RPC functions)

or SQL-style output that can be inserted into a mysql table (try -s cmd
line option).

ser_objdump_all.sh is a script that will list symbols from all modules
in a given directory tree.

The tool does not try to link SER modules so no dependency libraries are
required to extract the information from SER modules. To build the tool
you need to have binutils-dev (debian package name) installed, it
requires libbfl.so to open ELF files.

   Jan.

Jan Janak wrote:
> janakj      2007/01/19 02:20:09 CET
> 
>   SER CVS Repository
> 
>   ser_objdump - Imported sources
>   Update of /cvsroot/ser/ser_objdump
>   In directory sheep:/tmp/cvs-serv32212
>   
>   Log Message:
>   initial import
>   
>   Status:
>   
>   Vendor Tag:	janakj
>   Release Tags:	start
>   		
>   N ser_objdump/Makefile
>   N ser_objdump/ser_objdump_all.sh
>   N ser_objdump/ser_objdump.c
>   
>   No conflicts created by this import
>   
> _______________________________________________
> Serdev mailing list
> Serdev at lists.iptel.org
> http://lists.iptel.org/mailman/listinfo/serdev
>