freebsd-dev/usr.bin/rpcgen/rpcgen.1

533 lines
11 KiB
Groff
Raw Normal View History

.\" @(#)rpcgen.1 1.35 93/06/02 SMI
1999-08-28 01:08:13 +00:00
.\" $FreeBSD$
.\" Copyright 1985-1993 Sun Microsystems, Inc.
2002-04-20 12:18:28 +00:00
.\"
.Dd September 2, 2005
1997-11-03 07:48:26 +00:00
.Dt RPCGEN 1
.Os
.Sh NAME
.Nm rpcgen
.Nd an RPC protocol compiler
.Sh SYNOPSIS
.Nm
1997-11-03 07:48:26 +00:00
.Ar infile
.Nm
1997-11-03 07:48:26 +00:00
.Op Fl a
.Op Fl b
.Op Fl C
.Oo
.Fl D Ns Ar name Ns Op Ar =value
.Oc
.Op Fl i Ar size
.Op Fl I Fl P Op Fl K Ar seconds
1997-11-03 07:48:26 +00:00
.Op Fl L
.Op Fl M
.Op Fl N
.Op Fl T
.Op Fl Y Ar pathname
.Ar infile
.Nm
1997-11-03 07:48:26 +00:00
.Oo
.Fl c |
.Fl h |
.Fl l |
.Fl m |
.Fl t |
.Fl \&Sc |
.Fl \&Ss |
.Fl \&Sm
.Oc
.Op Fl o Ar outfile
.Op Ar infile
.Nm
1997-11-03 07:48:26 +00:00
.Op Fl s Ar nettype
.Op Fl o Ar outfile
.Op Ar infile
.Nm
1997-11-03 07:48:26 +00:00
.Op Fl n Ar netid
.Op Fl o Ar outfile
.Op Ar infile
.\" .SH AVAILABILITY
.\" .LP
.\" SUNWcsu
1997-11-03 07:48:26 +00:00
.Sh DESCRIPTION
2002-04-20 12:18:28 +00:00
The
.Nm
utility is a tool that generates C code to implement an
1997-11-03 07:48:26 +00:00
.Tn RPC
protocol.
The input to
1997-11-03 07:48:26 +00:00
.Nm
is a language similar to C known as
1997-11-03 07:48:26 +00:00
.Tn RPC
Language (Remote Procedure Call Language).
.Pp
2002-04-20 12:18:28 +00:00
The
.Nm
utility is normally used as in the first synopsis where
it takes an input file and generates three output files.
If the
1997-11-03 07:48:26 +00:00
.Ar infile
is named
1997-11-03 07:48:26 +00:00
.Pa proto.x ,
then
1997-11-03 07:48:26 +00:00
.Nm
generates a header in
1997-11-03 07:48:26 +00:00
.Pa proto.h ,
XDR routines in
1997-11-03 07:48:26 +00:00
.Pa proto_xdr.c ,
server-side stubs in
1997-11-03 07:48:26 +00:00
.Pa proto_svc.c ,
and client-side stubs in
1997-11-03 07:48:26 +00:00
.Pa proto_clnt.c .
With the
1997-11-03 07:48:26 +00:00
.Fl T
option,
1997-11-03 07:48:26 +00:00
it also generates the
.Tn RPC
dispatch table in
.Pa proto_tbl.i .
.Pp
2002-04-20 12:18:28 +00:00
The
.Nm
utility can also generate sample client and server files
that can be customized to suit a particular application.
The
1997-11-03 07:48:26 +00:00
.Fl \&Sc ,
.Fl \&Ss
and
1997-11-03 07:48:26 +00:00
.Fl \&Sm
2001-07-15 08:06:20 +00:00
options generate sample client, server and makefile, respectively.
The
1997-11-03 07:48:26 +00:00
.Fl a
option generates all files, including sample files.
If the
1997-11-03 07:48:26 +00:00
.Ar infile
is
.Pa proto.x ,
then the client side sample file is written to
.Pa proto_client.c ,
the server side sample file to
.Pa proto_server.c
and the sample makefile to
2001-07-15 08:06:20 +00:00
.Pa makefile.proto .
1997-11-03 07:48:26 +00:00
.Pp
If option
.Fl I
is set,
the server created can be started both by the port monitors
1997-11-03 07:48:26 +00:00
(for example,
.Xr inetd 8 )
or by itself.
When it is started by a port monitor,
2001-07-15 08:06:20 +00:00
it creates servers only for the transport for which
1997-11-03 07:48:26 +00:00
the file descriptor
.Em 0
was passed.
The name of the transport may be specified
by setting up the environment variable
.Ev NLSPROVIDER .
When the server generated by
1997-11-03 07:48:26 +00:00
.Nm
is executed,
it creates server handles for all the transports
specified in
1997-11-03 07:48:26 +00:00
.Ev NETPATH
environment variable,
or if it is unset,
it creates server handles for all the visible transports from
1997-11-03 07:48:26 +00:00
.Pa /etc/netconfig
file.
Note:
the transports are chosen at run time and not at compile time.
When the server is self-started,
it backgrounds itself by default.
A special define symbol
1997-11-03 07:48:26 +00:00
.Em RPC_SVC_FG
can be used to run the server process in foreground.
1997-11-03 07:48:26 +00:00
.Pp
The second synopsis provides special features which allow
1997-11-03 07:48:26 +00:00
for the creation of more sophisticated
.Tn RPC
servers.
These features include support for user provided
1997-11-03 07:48:26 +00:00
.Em #defines
and
.Tn RPC
dispatch tables.
The entries in the
.Tn RPC
dispatch table contain:
.Bl -bullet -offset indent -compact
.It
pointers to the service routine corresponding to that procedure,
1997-11-03 07:48:26 +00:00
.It
a pointer to the input and output arguments,
.It
the size of these routines.
.El
2001-07-15 08:06:20 +00:00
A server can use the dispatch table to check authorization
and then to execute the service routine;
a client library may use it to deal with the details of storage
management and XDR data conversion.
1997-11-03 07:48:26 +00:00
.Pp
2001-07-15 08:06:20 +00:00
The other three synopses shown above are used when
one does not want to generate all the output files,
but only a particular one.
See the
1997-11-03 07:48:26 +00:00
.Sx EXAMPLES
2001-07-15 08:06:20 +00:00
section below for examples of
1997-11-03 07:48:26 +00:00
.Nm
usage.
2001-07-15 08:06:20 +00:00
When
1997-11-03 07:48:26 +00:00
.Nm
is executed with the
1997-11-03 07:48:26 +00:00
.Fl s
option,
it creates servers for that particular class of transports.
When
executed with the
1997-11-03 07:48:26 +00:00
.Fl n
option,
it creates a server for the transport specified by
1997-11-03 07:48:26 +00:00
.Ar netid .
If
1997-11-03 07:48:26 +00:00
.Ar infile
is not specified,
1997-11-03 07:48:26 +00:00
.Nm
accepts the standard input.
1997-11-03 07:48:26 +00:00
.Pp
The C preprocessor,
1997-11-03 07:48:26 +00:00
.Em cc -E
is run on the input file before it is actually interpreted by
.Nm .
For each type of output file,
1997-11-03 07:48:26 +00:00
.Nm
defines a special preprocessor symbol for use by the
1997-11-03 07:48:26 +00:00
.Nm
programmer:
1997-11-03 07:48:26 +00:00
.Bl -tag -width indent
.It RPC_HDR
defined when compiling into headers
1997-11-03 07:48:26 +00:00
.It RPC_XDR
defined when compiling into XDR routines
1997-11-03 07:48:26 +00:00
.It RPC_SVC
defined when compiling into server-side stubs
1997-11-03 07:48:26 +00:00
.It RPC_CLNT
defined when compiling into client-side stubs
1997-11-03 07:48:26 +00:00
.It RPC_TBL
defined when compiling into RPC dispatch tables
1997-11-03 07:48:26 +00:00
.El
.Pp
Any line beginning with
1997-11-03 07:48:26 +00:00
.Dq %
is passed directly into the output file,
uninterpreted by
.Nm .
1997-11-03 07:48:26 +00:00
To specify the path name of the C preprocessor use
.Fl Y
flag.
.Pp
For every data type referred to in
1997-11-03 07:48:26 +00:00
.Ar infile ,
.Nm
assumes that there exists a
routine with the string
1997-11-03 07:48:26 +00:00
.Em xdr_
prepended to the name of the data type.
1997-11-03 07:48:26 +00:00
If this routine does not exist in the
.Tn RPC/XDR
library, it must be provided.
Providing an undefined data type
1997-11-03 07:48:26 +00:00
allows customization of
Bring in a hybrid of SunSoft's transport-independent RPC (TI-RPC) and associated changes that had to happen to make this possible as well as bugs fixed along the way. Bring in required TLI library routines to support this. Since we don't support TLI we've essentially copied what NetBSD has done, adding a thin layer to emulate direct the TLI calls into BSD socket calls. This is mostly from Sun's tirpc release that was made in 1994, however some fixes were backported from the 1999 release (supposedly only made available after this porting effort was underway). The submitter has agreed to continue on and bring us up to the 1999 release. Several key features are introduced with this update: Client calls are thread safe. (1999 code has server side thread safe) Updated, a more modern interface. Many userland updates were done to bring the code up to par with the recent RPC API. There is an update to the pthreads library, a function pthread_main_np() was added to emulate a function of Sun's threads library. While we're at it, bring in NetBSD's lockd, it's been far too long of a wait. New rpcbind(8) replaces portmap(8) (supporting communication over an authenticated Unix-domain socket, and by default only allowing set and unset requests over that channel). It's much more secure than the old portmapper. Umount(8), mountd(8), mount_nfs(8), nfsd(8) have also been upgraded to support TI-RPC and to support IPV6. Umount(8) is also fixed to unmount pathnames longer than 80 chars, which are currently truncated by the Kernel statfs structure. Submitted by: Martin Blapp <mb@imp.ch> Manpage review: ru Secure RPC implemented by: wpaul
2001-03-19 12:50:13 +00:00
.Xr xdr 3
1997-11-03 07:48:26 +00:00
routines.
.Sh OPTIONS
The following options are available:
.Bl -tag -width indent
.It Fl a
Generate all files, including sample files.
1997-11-03 07:48:26 +00:00
.It Fl b
Backward compatibility mode.
1997-11-03 07:48:26 +00:00
Generate transport specific
.Tn RPC
code for older versions
of the operating system.
1997-11-03 07:48:26 +00:00
.It Fl c
Compile into
.Tn XDR
routines.
.It Fl C
Generate ANSI C code.
This is always done, the flag is only provided for backwards compatibility.
1997-11-03 07:48:26 +00:00
.It Fl D Ns Ar name
.It Fl D Ns Ar name=value
.\".It Fl D Ns Ar name Ns Op Ar =value
Define a symbol
1997-11-03 07:48:26 +00:00
.Ar name .
Equivalent to the
1997-11-03 07:48:26 +00:00
.Em #define
directive in the source.
If no
1997-11-03 07:48:26 +00:00
.Ar value
is given,
1997-11-03 07:48:26 +00:00
.Ar value
is defined as
.Em 1 .
This option may be specified more than once.
1997-11-03 07:48:26 +00:00
.It Fl h
Compile into C data-definitions (a header).
.Fl T
2001-07-15 08:06:20 +00:00
option can be used in conjunction to produce a
1997-11-03 07:48:26 +00:00
header which supports
.Tn RPC
dispatch tables.
.It Fl i Ar size
Size at which to start generating inline code.
This option is useful for optimization.
The default size is 5.
1997-11-03 07:48:26 +00:00
.Pp
Note: in order to provide backwards compatibility with the older
1997-11-03 07:48:26 +00:00
.Nm
on the
.Fx
1997-11-03 07:48:26 +00:00
platform, the default is actually 0 (which means
that inline code generation is disabled by default).
You must specify
a non-zero value explicitly to override this default.
1997-11-03 07:48:26 +00:00
.It Fl I
Compile support for
1997-11-03 07:48:26 +00:00
.Xr inetd 8
in the server side stubs.
1997-11-03 07:48:26 +00:00
Such servers can be self-started or can be started by
.Xr inetd 8 .
When the server is self-started, it backgrounds itself by default.
1997-11-03 07:48:26 +00:00
A special define symbol
.Em RPC_SVC_FG
2001-07-15 08:06:20 +00:00
can be used to run the
server process in foreground, or the user may simply compile without
1997-11-03 07:48:26 +00:00
the
.Fl I
option.
.Pp
If there are no pending client requests, the
.Xr inetd 8
1997-11-03 07:48:26 +00:00
servers exit after 120 seconds (default).
2001-07-15 08:06:20 +00:00
The default can be changed with the
1997-11-03 07:48:26 +00:00
.Fl K
option.
1997-11-03 07:48:26 +00:00
All the error messages for
.Xr inetd 8
2001-07-15 08:06:20 +00:00
servers
are always logged with
1997-11-03 07:48:26 +00:00
.Xr syslog 3 .
.Pp
Note:
Contrary to some systems, in
.Fx
this option is needed to generate
servers that can be invoked through portmonitors and
.Xr inetd 8 .
1997-11-03 07:48:26 +00:00
.Pp
.It Fl K Ar seconds
By default, services created using
.Nm
and invoked through
port monitors wait 120 seconds
after servicing a request before exiting.
1997-11-03 07:48:26 +00:00
That interval can be changed using the
.Fl K
flag.
2001-07-15 08:06:20 +00:00
To create a server that exits immediately upon servicing a request,
use
1997-11-03 07:48:26 +00:00
.Fl K Ar 0 .
To create a server that never exits, the appropriate argument is
.Fl K Ar -1 .
1997-11-03 07:48:26 +00:00
.Pp
When monitoring for a server,
some portmonitors
1997-11-03 07:48:26 +00:00
.Em always
spawn a new process in response to a service request.
If it is known that a server will be used with such a monitor, the
server should exit immediately on completion.
1997-11-03 07:48:26 +00:00
For such servers,
.Nm
should be used with
.Fl K Ar 0 .
.It Fl l
Compile into client-side stubs.
1997-11-03 07:48:26 +00:00
.It Fl L
When the servers are started in foreground, use
1997-11-03 07:48:26 +00:00
.Xr syslog 3
to log the server errors instead of printing them on the standard
error.
1997-11-03 07:48:26 +00:00
.It Fl m
Compile into server-side stubs,
1997-11-03 07:48:26 +00:00
but do not generate a
.Qq main
routine.
2001-07-15 08:06:20 +00:00
This option is useful for doing callback-routines
and for users who need to write their own
1997-11-03 07:48:26 +00:00
.Qq main
routine to do initialization.
.It Fl M
Generate multithread-safe stubs for passing arguments and results between
rpcgen generated code and user written code.
2001-07-15 08:06:20 +00:00
This option is useful
for users who want to use threads in their code.
However, the
1997-11-03 07:48:26 +00:00
.Xr rpc_svc_calls 3
functions are not yet MT-safe, which means that rpcgen generated server-side
code will not be MT-safe.
1997-11-03 07:48:26 +00:00
.It Fl N
2002-04-20 12:18:28 +00:00
Allow procedures to have multiple arguments.
It also uses the style of parameter passing that closely resembles C.
So, when passing an argument to a remote procedure, you do not have to
pass a pointer to the argument, but can pass the argument itself.
This behavior is different from the old style of
1997-11-03 07:48:26 +00:00
.Nm
generated code.
To maintain backward compatibility,
this option is not the default.
1997-11-03 07:48:26 +00:00
.It Fl n Ar netid
Compile into server-side stubs for the transport
specified by
1997-11-03 07:48:26 +00:00
.Ar netid .
There should be an entry for
1997-11-03 07:48:26 +00:00
.Ar netid
in the
netconfig database.
This option may be specified more than once,
so as to compile a server that serves multiple transports.
1997-11-03 07:48:26 +00:00
.It Fl o Ar outfile
Specify the name of the output file.
If none is specified,
standard output is used
2005-01-15 11:20:51 +00:00
.Fl ( c ,
1997-11-03 07:48:26 +00:00
.Fl h ,
.Fl l ,
.Fl m ,
.Fl n ,
.Fl s ,
.Fl \&Sc ,
.Fl \&Sm ,
.Fl \&Ss ,
and
2001-07-15 08:06:20 +00:00
.Fl t
modes only).
.It Fl P
Compile support for
port monitors
in the server side stubs.
.Pp
Note:
Contrary to some systems, in
.Fx
this option is needed to generate
servers that can be monitored.
.Pp
If the
.Fl I
option has been specified,
.Fl P
is turned off automatically.
1997-11-03 07:48:26 +00:00
.It Fl s Ar nettype
2001-07-15 08:06:20 +00:00
Compile into server-side stubs for all the
transports belonging to the class
1997-11-03 07:48:26 +00:00
.Ar nettype .
The supported classes are
1997-11-03 07:48:26 +00:00
.Em netpath ,
.Em visible ,
.Em circuit_n ,
.Em circuit_v ,
.Em datagram_n ,
.Em datagram_v ,
.Em tcp ,
and
2001-07-15 08:06:20 +00:00
.Em udp
(see
1997-11-03 07:48:26 +00:00
.Xr rpc 3
for the meanings associated with these classes).
This option may be specified more than once.
Note:
the transports are chosen at run time and not at compile time.
1997-11-03 07:48:26 +00:00
.It Fl \&Sc
Generate sample client code that uses remote procedure calls.
1997-11-03 07:48:26 +00:00
.It Fl \&Sm
Generate a sample
.Pa Makefile
which can be used for compiling the application.
.It Fl \&Ss
Generate sample server code that uses remote procedure calls.
1997-11-03 07:48:26 +00:00
.It Fl t
Compile into
.Tn RPC
dispatch table.
.It Fl T
Generate the code to support
.Tn RPC
dispatch tables.
.Pp
2001-07-15 08:06:20 +00:00
The options
1997-11-03 07:48:26 +00:00
.Fl c ,
.Fl h ,
.Fl l ,
.Fl m ,
.Fl s ,
.Fl \&Sc ,
.Fl \&Sm ,
.Fl \&Ss ,
and
2001-07-15 08:06:20 +00:00
.Fl t
are used exclusively to generate a particular type of file,
while the options
1997-11-03 07:48:26 +00:00
.Fl D
and
1997-11-03 07:48:26 +00:00
.Fl T
are global and can be used with the other options.
1997-11-03 07:48:26 +00:00
.It Fl Y Ar pathname
2001-07-15 08:06:20 +00:00
Give the name of the directory where
1997-11-03 07:48:26 +00:00
.Nm
will start looking for the C-preprocessor.
1997-11-03 07:48:26 +00:00
.El
.Sh EXAMPLES
The following example:
1997-11-03 07:48:26 +00:00
.Dl example% rpcgen -T prot.x
.Pp
generates all the five files:
1997-11-03 07:48:26 +00:00
.Pa prot.h ,
.Pa prot_clnt.c ,
.Pa prot_svc.c ,
.Pa prot_xdr.c
and
1997-11-03 07:48:26 +00:00
.Pa prot_tbl.i .
.Pp
The following example sends the C data-definitions (header)
to the standard output.
1997-11-03 07:48:26 +00:00
.Dl example% rpcgen -h prot.x
.Pp
To send the test version of the
1997-11-03 07:48:26 +00:00
.Fl D Ns Ar TEST ,
2001-07-15 08:06:20 +00:00
server side stubs for
all the transport belonging to the class
1997-11-03 07:48:26 +00:00
.Ar datagram_n
to standard output, use:
1997-11-03 07:48:26 +00:00
.Dl example% rpcgen -s datagram_n -DTEST prot.x
.Pp
To create the server side stubs for the transport indicated
by
1997-11-03 07:48:26 +00:00
.Ar netid
tcp,
use:
1997-11-03 07:48:26 +00:00
.Dl example% rpcgen -n tcp -o prot_svc.c prot.x
1999-10-30 15:12:25 +00:00
.Sh SEE ALSO
1997-11-03 07:48:26 +00:00
.Xr cc 1 ,
.Xr rpc 3 ,
Bring in a hybrid of SunSoft's transport-independent RPC (TI-RPC) and associated changes that had to happen to make this possible as well as bugs fixed along the way. Bring in required TLI library routines to support this. Since we don't support TLI we've essentially copied what NetBSD has done, adding a thin layer to emulate direct the TLI calls into BSD socket calls. This is mostly from Sun's tirpc release that was made in 1994, however some fixes were backported from the 1999 release (supposedly only made available after this porting effort was underway). The submitter has agreed to continue on and bring us up to the 1999 release. Several key features are introduced with this update: Client calls are thread safe. (1999 code has server side thread safe) Updated, a more modern interface. Many userland updates were done to bring the code up to par with the recent RPC API. There is an update to the pthreads library, a function pthread_main_np() was added to emulate a function of Sun's threads library. While we're at it, bring in NetBSD's lockd, it's been far too long of a wait. New rpcbind(8) replaces portmap(8) (supporting communication over an authenticated Unix-domain socket, and by default only allowing set and unset requests over that channel). It's much more secure than the old portmapper. Umount(8), mountd(8), mount_nfs(8), nfsd(8) have also been upgraded to support TI-RPC and to support IPV6. Umount(8) is also fixed to unmount pathnames longer than 80 chars, which are currently truncated by the Kernel statfs structure. Submitted by: Martin Blapp <mb@imp.ch> Manpage review: ru Secure RPC implemented by: wpaul
2001-03-19 12:50:13 +00:00
.Xr rpc_svc_calls 3 ,
1997-11-03 07:48:26 +00:00
.Xr syslog 3 ,
Bring in a hybrid of SunSoft's transport-independent RPC (TI-RPC) and associated changes that had to happen to make this possible as well as bugs fixed along the way. Bring in required TLI library routines to support this. Since we don't support TLI we've essentially copied what NetBSD has done, adding a thin layer to emulate direct the TLI calls into BSD socket calls. This is mostly from Sun's tirpc release that was made in 1994, however some fixes were backported from the 1999 release (supposedly only made available after this porting effort was underway). The submitter has agreed to continue on and bring us up to the 1999 release. Several key features are introduced with this update: Client calls are thread safe. (1999 code has server side thread safe) Updated, a more modern interface. Many userland updates were done to bring the code up to par with the recent RPC API. There is an update to the pthreads library, a function pthread_main_np() was added to emulate a function of Sun's threads library. While we're at it, bring in NetBSD's lockd, it's been far too long of a wait. New rpcbind(8) replaces portmap(8) (supporting communication over an authenticated Unix-domain socket, and by default only allowing set and unset requests over that channel). It's much more secure than the old portmapper. Umount(8), mountd(8), mount_nfs(8), nfsd(8) have also been upgraded to support TI-RPC and to support IPV6. Umount(8) is also fixed to unmount pathnames longer than 80 chars, which are currently truncated by the Kernel statfs structure. Submitted by: Martin Blapp <mb@imp.ch> Manpage review: ru Secure RPC implemented by: wpaul
2001-03-19 12:50:13 +00:00
.Xr xdr 3 ,
1997-11-03 07:48:26 +00:00
.Xr inetd 8
1999-10-30 15:12:25 +00:00
.Rs
.%T The rpcgen chapter in the NETP manual
1999-10-30 15:12:25 +00:00
.Re