man-page-rxgen-cmdebug-20051227
[openafs.git] / doc / man-pages / pod1 / rxgen.pod
1 =head1 NAME
2
3 rxgen - Stub generator for the Rx remote procedure call package
4
5 =head1 SYNOPSIS
6
7 B<rxgen> [B<-h> | B<-c> | B<-C> | B<-S> | B<-r>] [B<-dkpR>]
8     [B<-I> I<dir>] [B<-P> I<prefix>] [B<-o> I<outfile>] [I<infile>]
9
10 B<rxgen> B<-s> I<transport> [B<-o> I<outfile>] [I<infile>]
11
12 B<rxgen> B<-l> [B<-o> I<outfile>] [I<infile>]
13
14 B<rxgen> B<-m> [B<-o> I<outfile>] [I<infile>]
15
16 =head1 DESCRIPTION
17
18 B<rxgen> is a tool that generates C code to implement the Rx RPC protocol;
19 it takes as input a description of an application interface similar to C
20 and produces a number of server and/or client stub routines to be linked
21 with RPC-based programs.  These stubs allow programs to invoke remote
22 procedures through local procedure calls.  B<rxgen> is an extension of
23 Sun's B<rpcgen> (version 3.9) and retains full B<rpcgen> functionality (at
24 least as of that version).  Please refer to rpcgen(1) for more details on
25 the Sun's RPC specific flags, and to the RPC programming guide regarding
26 the RPC language along with useful examples.
27
28 =head1 OPTIONS
29
30 B<rxgen> operates in several different modes.  The generated output files
31 can be produced individually (using one of B<-h>, B<-c>, B<-C>, or B<-S>)
32 or collectively.  All output files are created when the default is used
33 (i.e., no options), or the output is limited to the server stubs (B<-C>
34 and B<-S>) when the B<-r> flag is used.  The following describes the types
35 of generated output files (for simplicity, I<filename> refers to the main
36 output filename):
37
38 =over 4
39
40 =item B<-h>
41
42 Generate C data definitions (a header file) from standard RPCL definitions
43 (default extension: I<filename>.h).
44
45 =item B<-c>
46
47 Compile the XDR routines required to serialize the protocol described by
48 RPCL.  Generate XDR routines for all declarations (default extension:
49 I<filename>.xdr.c).
50
51 =item B<-C>
52
53 Generate all the client-side stub routines (default extension:
54 I<filename>.cs.c).  Calling a routine in this file will cause the
55 arguments to be packed up and sent via Rx (or R).
56
57 =item B<-S>
58
59 Generate all the server-side stub routines (default extension:
60 I<filename>.ss.c).  Arguments are unpacked, and the corresponding server
61 routine is called.
62
63 =item B<-r>
64
65 Generate the two default extension files produced by the B<-C> and B<-S>
66 options.
67
68 =back
69
70 The following options can be used on any combination of B<rxgen> calls:
71
72 =over 4
73
74 =item B<-R>
75
76 Generate code for the older \R protocol, as opposed to Rx, which is the
77 default.
78
79 =item B<-k>
80
81 Must be specified when the generated code is intended to be used by the
82 kernel; special "includes" and other specifics are produced when the
83 target output is for the kernel.
84
85 =item B<-p>
86
87 Package combination flag: when multiple packages are included within a
88 single specification file, a single Execute Request routine will be used
89 for all of them as a result of this flag.  The default is to generate
90 individual Execute Request stubs for each package.
91
92 =item B<-I> I<dir>
93
94 Similar to the B<-I> flag in the C compiler (B<cc>). This flag is passed
95 to the pre-processor (B<cpp>) so that directory I<dir> is searched before
96 the standard lookup list for #include files.  As expected, multiple B<-I>
97 flags can be used simultaneously.
98
99 =item B<-P> I<prefix>
100
101 The I<prefix> string following this switch is prepended to all generated
102 output files; useful when multiple runs want to produce different versions
103 of the same interface (say, kernel and non-kernel versions).
104
105 =item B<-d>
106
107 Debugging mode; only needed when B<rxgen> is to be debugged (say, via
108 B<dbx>).
109
110 =item B<-o> I<outfile>
111
112 Specify the name of the output file.  If none is specified, the standard
113 output is used (B<-c>, B<-h>, B<-C>, and B<-S> modes only).  Note that if
114 an output file is specified in a multi-output file option (such as the
115 default, or with option B<-r>), then the I<outfile> replaces the name
116 generated by default (which is based on the configuration's main file
117 name).
118
119 =back
120
121 The B<-s>, B<-l>, and B<-m> options are present only for B<rpcgen>
122 support.  See rpcgen(1) for information on their use.
123
124 =head1 B<rxgen> SYNTAX SUMMARY
125
126     Specification file:
127
128         <Package description option> |
129         <Prefix description option> |
130         <StartingOpcode description option> |
131         <SplitPrefix description option> |
132         <Procedure description option> |
133         <RPCL language description option>
134
135     <Package description option>:
136
137         "package" <Package_ident>
138
139     <Prefix description option>:
140
141         "prefix" <Prefix_ident>
142
143     <StartingOpcode description option>:
144
145         "startingopcode" <constant>
146
147     <SplitPrefix description option>:
148
149         "splitprefix" <split options> ";"
150
151     <Split options>:
152
153         "IN =" <Start_prefix_ident> "|"
154         "OUT =" <End_prefix_ident> "|"
155         <Split options>
156
157     <Procedure description option>:
158
159         ["proc"] [<Procedure_ident>] [<ServerStub_ident>]
160             <Argument list> ["split" | "multi"]
161             ["=" <Opcode_ident>] ";"
162
163     <Argument list>:
164
165         "(" <Argument definition> <Comma_joined argument> ")"
166
167     <Argument definition>:
168
169         <Direction option> <Standard RPCL type decl> <Arg_ident>
170             ["<" <Max_size> ">" | "[" <Max_size> "]"] | NULL
171
172     <Comma_joined argument>:
173
174         "," <Argument definition> | NULL
175
176     <Direction option>:
177
178         "IN" | "OUT" | "INOUT" | NULL
179
180     <Max_size>:
181
182         <constant> | NULL
183
184     <Package_ident>:
185     <Prefix_ident>:
186     <String_ident>:
187     <Start_prefix_ident>:
188     <End_prefix_ident>:
189     <Procedure_ident>:
190     <ServerStub_ident>:
191     <Arg_ident>:
192     <Opcode_ident>:
193
194         <identifier>
195
196     <RPCL language description option>:
197     <Standard RPCL type decl>:
198
199         Sun's RPCL language syntax (see rpcgen(1))
200
201 =head1 B<rxgen> COMMANDS
202
203 =head2 Comments and Preprocessing
204
205 The input interface may contain preprocessor directives which are passed
206 through the C preprocessor (i.e. C<cpp>).  Since the preprocessor runs on
207 all input files before they are actually interpreted by B<rxgen>, all
208 B<cpp> directives (#include, #ifdefs, #defines, etc.) are legal and
209 welcomed within an B<rxgen> input file.  Of course, none of these
210 preprocessor directives will be included in any of the generated files.
211 To facilitate distinctions between the different types of output files,
212 B<rxgen> defines certain special B<cpp> symbols for use by the B<rxgen>
213 programmer.  These are RPC_HDR (defined when compiling into header,
214 I<filename>.h, files), RPC_XDR (defined when compiling into xdr,
215 I<filename>.xdr.c, files), RPC_CLIENT (defined when compiling into client
216 stubs, I<filename>.cs.c, files), and RPC_SERVER (defined when compiling
217 into server stubs, I<filename>.ss.c, files).
218
219 In addition, B<rxgen> does a little preprocessing of its own.  Any line
220 beginning with C<%> is passed directly into the output file, uninterpreted
221 by B<rxgen>.  For a more heavy en masse dumping of uninterpreted code, it
222 would be adviced to include all such code in an C<#include> file and pass
223 it in preceded by C<%>.  The input interface may also contain any C-style
224 comments which are, of course, ignored. Interpretation is token-based,
225 thus special line-orientation of separate statements is not necessary.
226 B<rxgen> also provides a quite rich and helpful set of error reports,
227 identifying them by exact line location and error type.  Also, B<rxgen>
228 will automatically generate #include lines for standard include files,
229 such as F<rx/xdr.h> and F<rx/rx.h>, along with the generated header file
230 from this interface.
231
232 =head2 Prefixing stub procedures
233
234 The I<package> statement tells B<rxgen> the name of the interface package.
235 It is used for prefixing the naming of all generated stub routines and the
236 execute request procedure.  For example:
237
238     package AFS_
239
240 causes the execute request procedure to be named AFS_ExecuteRequest
241 (Warning: in the older version an additional C<_> was appended after the
242 package name to the ExecuteRequest name; thus make sure you don't have an
243 ExecuteRequest interface routine) and a given stub routine, say Fetch, to
244 be actually named AFS_Fetch.  Multiple package statements (current maximum
245 size is 10) per configuration are permitted and are useful when multiple
246 sets of interfaces are implemented (see the example at the end).  Note
247 that in such cases, use of the B<-p> flag results in the generation of
248 just one ExecuteRequest procedure which recognizes the multiple interfaces
249 and whose name is prefixed by the first package statement.  In the default
250 case, independent ExecuteRequest procedures will be created for each
251 packaged group of remote procedure calls.
252
253 The I<prefix> statement supplies a name to prepend to all calls to remote
254 procedure names in the ExecuteRequest stub routine.  It is useful when the
255 server makes RPC calls to other servers (say, for debugging purposes).
256 For example:
257
258     prefix S
259
260 causes the name C<S> to be prepended to the name of all routines called
261 from the server stubs.  The server can then call the original name and get
262 the client stubs.
263
264 =head2 B<rxgen> procedure declaration
265
266 The I<proc> statement is the most common (and meaningful) in the B<rxgen>
267 interface.  Its syntax description is:
268
269         [proc] [<proc_name>] [<server_stub>] (<arg>, ..., <arg>)
270             [split | multi] [= <opcode>] ;
271
272 where:
273
274 =over 2
275
276 =item *
277
278 C<proc> is an optional prefix of the procedure statement. This is just a
279 stylistic item and not a required procedure delimiter.
280
281 =item *
282
283 <proc_name> is the name of the procedure.  Note that even the name of the
284 procedure is optional.  This only makes sense when the name of the given
285 procedure is identical to the name of the last I<package> statement (i.e.,
286 C<package RCallBack> and the declaration of the C<RCallBack> procedure).
287
288 =item *
289
290 <server_stub>, if present, causes the ExecuteRequest procedure to call
291 that stub instead of the automatically generated stub when a call with
292 that opcode is decoded.
293
294 =item *
295
296 <opcode> is a constant or symbol that is the opcode for that procedure.
297 One might use the preprocessor features (i.e., #define), the I<const>
298 RPC-language feature, or the old good constants as opcodes. Some further
299 evaluation/processing of opcodes is done.  Particularly, checks for
300 duplicate and non-existent opcodes are performed, along with checks for
301 "holes" (i.e., gaps in consecutive opcodes) in the opcode sequences.  For
302 example, we use the fact that when "holes" in opcodes exist, the
303 ExecuteRequest procedure uses the I<case> statement rather than the faster
304 (and smaller, codewise) indexed array method.
305
306 Also, B<rxgen> defines (i.e., appends to the header file) three valuable
307 macros for each package group: <package-name>LOWEST_OPCODE,
308 <package-name>HIGHEST_OPCODE, and <package-name>NUMBER_OPCODES.  These may
309 be useful to the B<rxgen> programmer.  Also, notice that the I<opcode>
310 statement is an optional feature, and can be omitted.  In such cases,
311 automatic opcode numbers are generated sequentially, starting from 0.
312
313 One can change the initial opcode number by using the I<startingopcode>
314 (for lack of a better name) B<rxgen> command.  Its syntax is:
315
316     startingopcode <constant>
317
318 where <constant> must be reasonable!  Note that one can not mix
319 procedures, some with opcodes and some without, nor allow opcodes after
320 the specification of the I<startingopcode> statement.  B<rxgen> will
321 complain in all such cases.
322
323 =item *
324
325 The I<argument> entry represents a given parameter of the procedure.  Its
326 syntax is:
327
328     [IN | INOUT | OUT | <null>] <type_decl> <arg_name>
329         [<max>|<>|[max]|[]]
330
331 If the type is an indirect type (i.e., is followed by *), it is assumed
332 that the pointer should be followed one level and the data pointed to is
333 to be transmitted. This should normally be used for all structures/arrays
334 and out parameters.  A noticeable exception is when explicit
335 array/structure maximum size is given; since no array-of-pointer
336 declarations are allowed one should use typedefs to achieve the similar
337 effect.  The parameters could be input parameters (preceded by IN), output
338 parameters (preceded by OUT), or input/output parameters (preceded by
339 INOUT).  If not specified, then the direction of the previous parameter in
340 the procedure is used.  (Note: the first parameter must be preceded by the
341 directional primitive!)
342
343 =item *
344
345 C<split> is a hack to handle stub routines that do things such as file
346 transfers or any other operation that has to exchange information (e.g.,
347 length of a file) before the call returns its output parameters.  Because
348 of the particular handshake that is involved when doing remote file
349 transfer, we currently break all such calls into two client-side stub
350 routines.  The first (with the default prefix of C<Begin>) is used to pass
351 all IN and INOUT parameters to the server side.  The second (with the
352 default prefix of C<End>) is used to get back the INOUT and OUT parameters
353 from the server.  Between the two calls, the user is supposed to do the
354 appropriate calls for the file transfer. For example, the following
355 procedure declaration in package AFS_
356
357     Fetch (IN a, b,INOUT c, OUT d) split = FETCHOPCODE;
358
359 will roughly generate the two independent client stub routines:
360
361     BeginAFS_Fetch (IN a, b, c)
362
363 and
364
365     EndAFS_Fetch(OUT c, d)
366
367 The I<splitprefix> statement is used to change the default prefix names
368 used by the two client-side stub generated routines when dealing with file
369 transfer-related procedure calls.  For example:
370
371     splitprefix IN=Before_ OUT=After_
372
373 will cause the naming of the two client stubs for a file transfer-related
374 routine, say Fetch(), to be Before_AFS_Fetch() and After_AFS_Fetch(),
375 respectively.
376
377 =item *
378
379 The C<multi> option is nearly identical to the C<split> feature described
380 above.  The only significant visible difference is that along with the two
381 client stubs, the standard client stub is also generated.  Since the
382 intention is to handle the multi-Rx calls, we need the whole standard
383 procedure stub in the cases where no multi-Rx call of the procedure is
384 performed.  A side effect of the C<multi> option is the generation of a
385 special macro (i.e., C<< multi_<Procedure-name> >> which passes back as
386 arguments the C<Begin> and C<End> stubs in the header output file. This
387 macro is used directly by the Rx code when a multi-Rx call of this
388 procedure is performed.
389
390 =back
391
392 =head2 OBSOLETE B<rxgen> FEATURES
393
394 Although the following rxgen commands are still in effect, they will soon
395 be removed since there are better alternatives. DO NOT USE THEM!
396
397 The I<special> statement is a temporary hack used to handle certain
398 inefficiencies of standard xdr routines to handle some user-customized
399 declarations.  In particular, this applies to a string pointer specified
400 as part of a declaration.  For example,
401
402     special struct BBS SeqBody;
403
404 tells B<rxgen> that the entry C<SeqBody> in the user-defined BBS xdr
405 routine is a string (note that more than one string can be "special" per
406 structure -- multiple ones are separated by commas); it will thus allocate
407 and de-allocate space properly in the server-generated stubs that contain
408 this structure as an IN or INOUT parameter.
409
410 A better alternative to I<special> is the I<customized> statement, which
411 is simply the C<customized> token followed by the regular declaration of a
412 struct based on the RPCL rules. In this case, the declaration will be
413 included in the generated header file (B<-h> option) but no xdr routine
414 will be generated for this structure -- the user will supply this.  All
415 pointer entries in this structure will be remembered so when the structure
416 is used as an IN or INOUT in the server stub, no core leaks will occur.
417 For example, consider
418
419     customized struct CBS {
420         long Seqlen;
421         char *SeqBody;
422     }
423
424 The C<xdr_CBS> routine would be provided by the user where during the
425 DECODE xdr opcode, appropriate space for the C<SeqBody> string is
426 allocated.  Similarly, that space is freed during the FREE xdr opcode.
427
428 Note: Old style "Array parameter specifications" are not supported any
429 more.
430
431 =head1 EXAMPLES
432
433 In case there are some requirements not available by the current RPC
434 language, one can customize some XDR routines by leaving those data types
435 undefined. For every data type that is undefined, it will be assumed that
436 a routine exists with the name C<xdr_> prepended to it.  A selected set of
437 B<rxgen> features is presented below, but for a more comprehensive one
438 (unions, complex examples, etc) please refer to the I<rpcgen Programming
439 Guide> and I<eXternal Data Representation: Sun Technical Notes>.
440
441 =head2 Typedefs
442
443 The RPC typedef statement is identical to the C typedef (i.e. C<< typedef
444 <declaration> >>).  By default, most user declarations (i.e. structs,
445 unions, etc) are automatically typedef'ed by B<rxgen>.  Since it makes
446 parsing simpler, its usage is recommended by B<rxgen> scripts.
447
448 =head2 Strings
449
450 The C C<char *> string convention is kind of ambiguous, since it is
451 usually intended to mean a null-terminated string of characters, but it
452 could also represent a pointer to a single character, a pointer to an
453 array of characters, etc.  In the RPC language, a null-terminated string
454 is unambiguously called a "string".  Examples,
455
456     string bigname<>;
457     string name<MAXNAMELEN>;
458     typedef string volname<MAXVOLNAME>;
459
460 Notice that the maximum size of string can be arbitrary (like C<bigname>
461 above) or, preferably, or specified in angle brackets (i.e. C<name> and
462 C<volname> above).  In practice, one should always use only bounded
463 strings in interfaces.  A sample calling proc using the declarations above
464 would be:
465
466     GetEntryByName (IN volname name, 
467         OUT struct vldbentry *entry) = VL_GETENTRYBYNAME;
468
469 or, of course,
470
471     GetEntryByName (IN string volname<MAXVOLNAME>,
472         OUT struct vldbentry *entry) = VL_GETENTRYBYNAME;
473
474 It is very important for the user to understand when the string parameters
475 should be allocated and/or freed by the his/her client and/or server
476 programs. A short analysis on string parameters handling follows (note
477 that a similar method is used for the handling of variable length arrays
478 as it will be shown later on):
479
480 =over 2
481
482 =item *
483
484 In the client side: IN and INOUT string parameters are the programmer's
485 responsibility and should be allocated (static or via malloc) before
486 calling the rpc and freed (if malloc was used) after the rpc's return in
487 the user's client program; of course, for INOUT parameters, the returned
488 string can't be bigger than the malloced input string.
489
490 OUT string parameters are automatically malloced (based on the length of
491 the returned string and not the maxsize) by the B<rxgen> client stubs (in
492 I<filename>.cs.c) and must be freed by the client program; admittedly,
493 this could be somewhat confusing since the user needs to free something
494 that he/she didn't allocate.}
495
496 =item *
497
498 In the server side: IN and INOUT string parameters are automatically
499 malloced (based on the size of incoming strings) by the rxgen server stubs
500 (in I<filename>.ss.c) before they are passed to the user's server
501 procedure; that space is automatically freed just before the rxgen server
502 stub returns; therefore the user need not do anything special for IN and
503 INOUT string parameters.
504
505 OUT string parameters must be malloced by the user's server procedure
506 (i.e. null pointer is passed to it by the rxgen server stub) and it is
507 automatically freed at the end of the B<rxgen> server stub.  Like in the
508 client side, the OUT parameters are somewhat unorthodox (i.e. the server
509 routine must malloc a string without ever freeing it itself; this is done
510 by the B<rxgen> server stub).
511
512 Note that for INOUT and OUT string parameters, in both the client and
513 server sides their arguments must be char of pointers (i.e. char **).
514
515 =head2 Pointers
516
517 Pointer declarations in RPC are also exactly as they are in C
518 (i.e. C<struct single_vldbentry *vldblist;>).  Of course, one can't send
519 pointers over the network, but one can use XDR pointers for sending
520 recursive data types such as lists and trees (an example of a linked list
521 will be demonstrated shortly).
522
523 =head2 Arrays
524
525 Fixed arrays are just like standard C array declarations (i.e. C<struct
526 UpdateEntry entries[20]>) without any side effect problems in
527 B<rxgen>. Since variable-length arrays have no explicit syntax in C, the
528 angle-brackets are used for it and the array declarations are actually
529 compiled into "struct"s. For example, declarations such as:
530
531     const   MAXBULKSIZE     = 10000;
532     const   MAXENTRIES      = 100;
533     opaque  bulk<MAXBULKSIZE>;           /* At most 10000 items */
534     int     hosts<>;                     /* any number of items */
535     typedef vldbentry blkentries<100>;   /* Preferable array decl */
536
537 are compiled into the following structs:
538
539     struct {
540         u_int   bulk_len;       /* no of items */
541         char    *bulk_val;      /* pointer to array */
542     } bulk;
543
544 for the C<bulk> array, and similarly for the C<< blkentries<100> >> array,
545
546     struct {
547         u_int      blkentries_len;   /* no of items in array */
548         vldbentry  *blkentries_val;  /* pointer to array */
549     } blkentries;
550
551 Therefore the user should be aware of the "magically" generated structure
552 entries such as the number of items in the array (<array_name>_len) and
553 the pointer to the array (<array_name>_val) since some of the entries will
554 have to be filled in from the client/server programs.  A sample proc would
555 be:
556
557     typedef vldbentry blkentries<MAXENTRIES>;
558     proc GetBlk (OUT blkentries *vlentries) = VL_GETBLK;
559
560 or, more directly,
561
562     GetBlk(OUT vldbentry vlentries<MAXENTRIES>) = VL_GETBLK;
563
564 Note that although the latest method is preferable since one does not have
565 to first use the typedef statement (and admittedly, programmers prefer
566 avoiding typedefs), one should realize that B<rxgen> does the structure
567 expansion and the xdr creation implicitly; therefore the user should be
568 aware of the C<vldbentries_val> and C<vldbentries_len> fields as before
569 (see following examples).
570
571 =head3 Array example I (least desirable)
572
573 Procedure declaration in the interface configuration:
574
575     proc ListAttributes (IN vldblistbyattributes *attributes, 
576                  INOUT blkentries *vldbentries) = VL_LISTATTRIBUTES;
577
578 Sample CLIENT code:
579
580     blkentries entries, *pnt;
581     entries.blkentries_len = 10;   /* max # returned entries */
582     entries.blkentries_val = (vldbentry *)malloc(LEN);
583                                    /* It must be set */
584
585     code = VL_ListAttributes(&attributes, &entries);
586     if (!code) {
587         pnt = entries.blkentries_val;
588         for (i=0; i < entries.blkentries_len; i++, pnt++)
589                 display_vldbentry(pnt);
590         /* Make sure you free the allocated space */
591         free((char *)entries.blkentries_val);   
592     }
593
594 Sample SERVER code:
595
596     VL_ListAttributes(attributes, entries)
597     {
598         vldbentry *singleentry = entries->blkentries_val;
599         entries->blkentries_len = 0;
600
601         while (copy_to_vldbentry(&vlentry, singleentry))
602             singleentry++, vldbentries->entries_len++;
603     }
604
605 Although this method for variable-size arrays works fine, there are some
606 major drawbacks.  The array parameter (i.e. vldbentries above) must be
607 declared as INOUT since we need to pass the max length of the expected
608 returned array; more importantly, a big (depending on the value of
609 C<_len>) chunk of junk code is going to be transferred to the server as
610 result of the IN(out) side-effect of the array.  It's an easy and
611 convenient method if the returned array size can be predicted from the
612 start and when the size is quite high.  This method is included as an
613 example of erroneous use (and abuse) of B<rxgen> and should not be used.
614
615 =head3 Array example II (Desirable method)
616
617 Procedure declaration in the interface configuration (using Example I
618 above):
619
620     proc ListAttributes (IN vldblistbyattributes *attributes, 
621         OUT blkentries *vldbentries) = VL_LISTATTRIBUTES;
622
623 Sample CLIENT code:
624
625     blkentries entries, *pnt;
626
627     code = VL_ListAttributes(&attributes, &entries);
628     if (!code) {
629         pnt = entries.blkentries_val;
630         for (i=0; i < entries.blkentries_len; i++, pnt++)
631                 display_vldbentry(pnt);
632         /* Make sure you free the allocated space (by rxgen) */
633         free((char *)entries.blkentries_val);   
634     }
635
636 Sample SERVER code:
637
638     VL_ListAttributes(attributes, entries)
639     {
640         vldbentry *singleentry;
641         entries->blkentries_len = 0;
642         singleentry = entries->blkentries_val
643             = (vldbentry *)malloc(MAXENTRIES * sizeof(vldbentry));
644
645         while (copy_to_vldbentry(&vlentry, singleentry))
646                 singleentry++, vldbentries->entries_len++;
647     }
648
649 This is the best (and simplest) way of using variable-size arrays as an
650 output parameter.  It is the responsibility of the server-side stub to
651 malloc() the adequate space which is automatically freed by the B<rxgen>
652 stub; the client side should free the space allocated by the
653 B<rxgen>-calling stub.
654
655 =head3 Array example III (Linked Lists)
656
657 Considering the following 3 declarations (could have applied some
658 optimizations) in the configuration file:
659
660     typedef struct single_vldbentry *vldblist;
661     struct single_vldbentry {
662         vldbentry vlentry;
663         vldblist  next_vldb;
664     };
665
666     struct vldb_list {
667         vldblist node;
668     };
669
670 and the rxgen procedure declaration:
671
672     LinkedList (IN vldblistbyattributes *attributes, 
673         OUT vldb_list *linkedentries) = VL_LINKEDLIST;
674
675 Sample CLIENT code:
676
677     vldb_list       linkedvldbs;
678     vldblist        vllist, vllist1;
679
680     bzero(&linkedvldbs, sizeof(vldb_list));
681     code = VL_LinkedList(&attributes, &nentries, &linkedvldbs);
682     if (!code) {
683         printf("We got %d vldb entries\n", nentries);
684         for (vllist = linkedvldbs.node; vllist; vllist = vllist1) {
685             vllist1 = vllist->next_vldb;
686             display_entry(&vllist->vlentry);
687             free((char *)vllist);
688         }
689     }
690
691 Sample SERVER code:
692
693     VL_LinkedList(rxcall, attributes, nentries, linkedvldbs);
694     {
695         vldblist vllist, *vllistptr = &linkedvldbs->node;
696         while (...) {
697             vllist = *vllistptr
698                 = (single_vldbentry *)malloc (sizeof (single_vldbentry));
699             copy_to_vldbentry(&tentry, &vllist->vlentry);
700             nentries++;     
701             vllistptr = &vllist->next_vldb;
702         };
703         *vllistptr = NULL;
704     }
705
706 Using a linked list offers many advantages: Nothing is passed to the
707 server (the parameter is OUT), no additional overhead is involved, and the
708 caller doesn't have to explicitly prepare for an arbitrary return size.  A
709 drawback is that the caller has the responsibility of malloc() (on the
710 server) and free (on the client) of each entry (to avoid unwanted
711 core-leaks).  Another drawback is that since it's a recursive call, the C
712 stack will grow linearly with respect to the number of nodes in the list
713 (so it's wise to increase the Rx LWP stack if huge amounts of data are
714 expected back -- default stack size is 4K).  The advantages should
715 outweight the disadvantages here.
716
717 It's important to pay attention to the comments of the three array
718 examples above particularly when they're references to when the user
719 should allocate/free space for the variable length arrays.  The mechanism
720 is very similar to the handling of strings thus you might need to review
721 the strings section above; note that the linked lists are handled somewhat
722 differently...
723
724 =head2 Miscellaneous examples
725
726 Below is an abbreviated version of a random interface file which shows
727 some of the common cases.
728
729     /* Declaration of all structures used by the R.xg script interface */
730
731     struct AFSFid {
732         unsigned long Volume;
733         unsigned long Vnode;
734         unsigned long Unique;
735     };
736
737     typedef long ViceDataType;
738
739     /* Note that TEST would be equivalent to "HEADER" only during the 
740        processing of the header, *.h, file */
741
742     #ifdef RPC_HDR
743     #define TEST "HEADER"
744     #else
745     #define TEST "REST"
746     #endif
747
748     /* This is the standard *.xg specification file */
749
750     package AFS_
751     splitprefix IN=BEFORE_ OUT=AFTER_;
752     Prefix Test
753
754     proc Remove(IN struct AFSFid *Did, IN string volname<64>,
755         OUT struct AFSStatus *Status) = AFS_REMOVE;
756
757     DisconnectFS AUX_disconnectFS() = AFS_DISCONNECTFS;
758
759     proc GetVolumeInfo(IN string Vid, 
760         OUT struct VolumeInfo *Info) = AFS_GETVOLUMEINFO;
761
762     /* You could have more than an interface per configuration */
763
764     package VOTE_
765
766     /* Using the "multi" feature; thus VOTE_Beacon can be called as an 
767        multi-Rx call or as a regular call */
768
769     Beacon (IN long state, long voteStart, 
770         net_version *version, net_tid *tid) 
771         multi = VOTE_BEACON;
772
773     package DISK_
774
775     /* Using the "split" feature */
776
777     SendFile (IN long file, long offset, 
778         long length, net_version *version) 
779         split = DISK_SENDFILE;
780
781 =head2 Output of an actual interface configuration
782
783 We'll demonstrate some of the actual output generated by B<rxgen> by
784 following an abbreviated actual interface configuration.
785
786 =head3 Configuration file
787
788 Contents of the interface configuration file (F<vldbint.xg>):
789
790     package VL_
791     #include "vl_opcodes.h"   /* The opcodes are included here */
792     %#include "vl_opcodes.h"  /* directly to other places */
793
794     /* Current limitations on parameters that affect other packages
795        (i.e. volume) */
796
797     const   MAXNAMELEN      =       65;
798     const   MAXNSERVERS     =       8;
799     const   MAXTYPES        =       3;
800
801     /* External (visible) representation of an individual vldb entry */
802
803     struct vldbentry {
804         char    name[MAXNAMELEN];       
805         long    volumeType;             
806         long    nServers;               
807         long    serverNumber[MAXNSERVERS];
808         long    serverPartition[MAXNSERVERS];
809         long    serverFlags[MAXNSERVERS];
810         u_long  volumeId[MAXTYPES];     
811         long    flags;                  
812     };
813
814     typedef struct single_vldbentry  *vldblist;
815     struct single_vldbentry {
816         vldbentry VldbEntry;
817         vldblist next_vldb;
818     };
819
820     struct vldb_list {
821         vldblist node;
822     };
823
824     /* vldb interface calls */
825
826     CreateEntry     (IN long Volid, 
827                     vldbentry *newentry) = VLCREATEENTRY;
828
829     GetEntryByName  (IN string volumename<MAXNAMELEN>, 
830                     OUT vldbentry *entry) = VLGETENTRYBYNAME;
831
832     GetNewVolumeId  (IN long bumpcount,
833                     OUT long *newvolumid) = VLGETNEWVOLUMEID;
834
835     ReplaceEntry    (IN long Volid, 
836                     long voltype,
837                     vldbentry *newentry,
838                     long ReleaseType) multi = VLREPLACEENTRY;
839
840     ListAttributes  (IN VldbListByAttributes *attributes, 
841                     OUT long *nentries, 
842                     OUT vldbentry bulkentries<MAXVLDBLEN>) 
843                     = VLLISTATTRIBUTES;
844
845     LinkedList      (IN VldbListByAttributes *attributes, 
846                     OUT long *nentries, 
847                     OUT vldb_list *linkedentries) = VLLINKEDLIST;
848
849 We'll concentrate only on the Rx generated code since the R generated code
850 (B<-R> option) will soon be obsolete.  For a detailed description on the
851 Rx-related calls inside the generated stubs (i.e., rx_NewCall(),
852 rx_EndCall()), along with details on what happens inside certain calls
853 (like xdrrx_create()) please refer to the Rx documentation. Typing C<rxgen
854 vldbint.xg> will result in the creation of four files: F<vldbint.h>,
855 F<vldbint.xdr.c>, F<vldbint.cs.c> and F<vldbint.ss.c>.  A closer look at
856 these files follows.
857
858 =head3 Header file (F<vldbint.h>)
859
860     /* Machine generated file -- Do NOT edit */
861
862     #include "vl_opcodes.h"  /* directly to other places */
863     #define MAXNAMELEN 65
864     #define MAXNSERVERS 8
865     #define MAXTYPES 3
866
867     struct vldbentry {
868         char name[MAXNAMELEN];
869         long volumeType;
870         long nServers;
871         long serverNumber[MAXNSERVERS];
872         long serverPartition[MAXNSERVERS];
873         long serverFlags[MAXNSERVERS];
874         u_long volumeId[MAXTYPES];
875         long flags;
876     };
877     typedef struct vldbentry vldbentry;
878     bool_t xdr_vldbentry();
879
880     typedef struct single_vldbentry *vldblist;
881     bool_t xdr_vldblist();
882
883     struct single_vldbentry {
884         vldbentry VldbEntry;
885         vldblist next_vldb;
886     };
887     typedef struct single_vldbentry single_vldbentry;
888     bool_t xdr_single_vldbentry();
889
890     struct vldb_list {
891         vldblist node;
892     };
893     typedef struct vldb_list vldb_list;
894     bool_t xdr_vldb_list();
895
896     #include <rx/rx_multi.h>
897     #define multi_VL_ReplaceEntry(Volid, voltype, newentry, ReleaseType) \
898         multi_Body(StartVL_ReplaceEntry(multi_call, Volid, voltype,
899                    newentry, ReleaseType), EndVL_ReplaceEntry(multi_call))
900
901     typedef struct bulkentries {
902         u_int bulkentries_len;
903         vldbentry *bulkentries_val;
904     } bulkentries;
905     bool_t xdr_bulkentries();
906
907     /* Opcode-related useful stats for package: VL_ */
908     #define VL_LOWEST_OPCODE        501
909     #define VL_HIGHEST_OPCODE       506
910     #define VL_NUMBER_OPCODES       6
911
912 Notice that all structures are automatically typedef'ed and all C<const>s
913 are converted to C<#define>s. Some data structures, such as bulkentries,
914 are taken from procedure params (from ListAttributes proc). Thus, this
915 should be kept in mind when creating stubs piecemeal with B<rxgen> (i.e.,
916 using the B<-c>, B<-h>, B<-C>, or B<-S> flags).  Also, one of the side
917 effects of the C<multi> option (in C<ReplaceEntry> proc) is the generation
918 of the C<multi_VL_ReplaceEntry> above.
919
920 =head3 XDR routines for structures (vldbint.xdr.c)
921
922     /* Machine generated file -- Do NOT edit */
923
924     #include <rx/xdr.h>
925     #include "vldbint.h"
926
927     #include "vl_opcodes.h"  /* directly to other places */
928
929     bool_t
930     xdr_vldbentry(xdrs, objp)
931         XDR *xdrs;
932         vldbentry *objp;
933     {
934         if (!xdr_vector(xdrs, (char *)objp->name, MAXNAMELEN,
935                         sizeof(char), xdr_char))
936             return (FALSE);
937         if (!xdr_long(xdrs, &objp->volumeType))
938             return (FALSE);
939         if (!xdr_long(xdrs, &objp->nServers))
940             return (FALSE);
941         if (!xdr_vector(xdrs, (char *)objp->serverNumber, MAXNSERVERS,
942                         sizeof(long), xdr_long))
943             return (FALSE);
944         if (!xdr_vector(xdrs, (char *)objp->serverPartition,
945                         MAXNSERVERS, sizeof(long), xdr_long))
946             return (FALSE);
947         if (!xdr_vector(xdrs, (char *)objp->serverFlags, MAXNSERVERS,
948                         sizeof(long), xdr_long))
949             return (FALSE);
950         if (!xdr_vector(xdrs, (char *)objp->volumeId, MAXTYPES,
951                         sizeof(u_long), xdr_u_long))
952             return (FALSE);
953         if (!xdr_long(xdrs, &objp->flags))
954             return (FALSE);
955         return (TRUE);
956     }
957
958     bool_t
959     xdr_vldblist(xdrs, objp)
960         XDR *xdrs;
961         vldblist *objp;
962     {
963         if (!xdr_pointer(xdrs, (char **)objp,
964                          sizeof(struct single_vldbentry), 
965                          xdr_single_vldbentry))
966             return (FALSE);
967         return (TRUE);
968     }
969
970     bool_t
971     xdr_single_vldbentry(xdrs, objp)
972         XDR *xdrs;
973         single_vldbentry *objp;
974     {
975         if (!xdr_vldbentry(xdrs, &objp->VldbEntry))
976             return (FALSE);
977         if (!xdr_vldblist(xdrs, &objp->next_vldb))
978             return (FALSE);
979         return (TRUE);
980     }
981
982     bool_t
983     xdr_vldb_list(xdrs, objp)
984         XDR *xdrs;
985         vldb_list *objp;
986     {
987         if (!xdr_vldblist(xdrs, &objp->node))
988             return (FALSE);
989         return (TRUE);
990     }
991
992     bool_t
993     xdr_bulkentries(xdrs, objp)
994         XDR *xdrs;
995         bulkentries *objp;
996     {
997         if (!xdr_array(xdrs, (char **)&objp->bulkentries_val,
998                        (u_int *)&objp->bulkentries_len, MAXVLDBLEN,
999                        sizeof(vldbentry), xdr_vldbentry))
1000             return (FALSE);
1001         return (TRUE);
1002     }
1003
1004 Note that the xdr_bulkentries() is automatically generated as a side
1005 effect of a procedure parameter declaration.  Thus, if identical multiple
1006 type parameter declarations are used, then multiply-defined xdr_* stubs
1007 will be created!  We felt this was a better alternative to having the
1008 B<rxgen> programmer deal with types such as bulkentries_1,
1009 bulkentries_2...
1010
1011 =head3 Client-Side stub routines (vldbint.cs.c)
1012
1013     /* Machine generated file -- Do NOT edit */
1014
1015     #include <rx/xdr.h>
1016     #include <rx/rx.h>
1017     #include <afs/rxgen_consts.h>
1018     #include "vldbint.h"
1019
1020     #include "vl_opcodes.h"  /* directly to other places */
1021
1022     int VL_CreateEntry(z_conn, Volid, newentry)
1023         register struct rx_connection *z_conn;
1024         long Volid;
1025         vldbentry * newentry;
1026     {
1027         struct rx_call *z_call = rx_NewCall(z_conn);
1028         static int z_op = 501;
1029         int z_result;
1030         XDR z_xdrs;
1031
1032         xdrrx_create(&z_xdrs, z_call, XDR_ENCODE);
1033
1034         /* Marshal the arguments */
1035         if ((!xdr_int(&z_xdrs, &z_op))
1036              || (!xdr_long(&z_xdrs, &Volid))
1037              || (!xdr_vldbentry(&z_xdrs, newentry))) {
1038                 z_result = RXGEN_CC_MARSHAL;
1039                 goto fail;
1040         }
1041
1042         z_result = RXGEN_SUCCESS;
1043     fail:
1044         return rx_EndCall(z_call, z_result);
1045     }
1046
1047     int VL_GetEntryByName(z_conn, volumename, entry)
1048         register struct rx_connection *z_conn;
1049         char * volumename;
1050         vldbentry * entry;
1051     {
1052         struct rx_call *z_call = rx_NewCall(z_conn);
1053         static int z_op = 504;
1054         int z_result;
1055         XDR z_xdrs;
1056
1057         xdrrx_create(&z_xdrs, z_call, XDR_ENCODE);
1058
1059         /* Marshal the arguments */
1060         if ((!xdr_int(&z_xdrs, &z_op))
1061              || (!xdr_string(&z_xdrs, &volumename, 65))) {
1062                 z_result = RXGEN_CC_MARSHAL;
1063                 goto fail;
1064         }
1065
1066         /* Un-marshal the reply arguments */
1067         z_xdrs.x_op = XDR_DECODE;
1068         if ((!xdr_vldbentry(&z_xdrs, entry))) {
1069                 z_result = RXGEN_CC_UNMARSHAL;
1070                 goto fail;
1071         }
1072
1073         z_result = RXGEN_SUCCESS;
1074     fail:
1075         return rx_EndCall(z_call, z_result);
1076     }
1077
1078     int VL_GetNewVolumeId(z_conn, bumpcount, newvolumid)
1079         register struct rx_connection *z_conn;
1080         long bumpcount;
1081         long * newvolumid;
1082     {
1083         struct rx_call *z_call = rx_NewCall(z_conn);
1084         static int z_op = 505;
1085         int z_result;
1086         XDR z_xdrs;
1087
1088         xdrrx_create(&z_xdrs, z_call, XDR_ENCODE);
1089
1090         /* Marshal the arguments */
1091         if ((!xdr_int(&z_xdrs, &z_op))
1092              || (!xdr_long(&z_xdrs, &bumpcount))) {
1093                 z_result = RXGEN_CC_MARSHAL;
1094                 goto fail;
1095         }
1096
1097         /* Un-marshal the reply arguments */
1098         z_xdrs.x_op = XDR_DECODE;
1099         if ((!xdr_long(&z_xdrs, newvolumid))) {
1100                 z_result = RXGEN_CC_UNMARSHAL;
1101                 goto fail;
1102         }
1103
1104         z_result = RXGEN_SUCCESS;
1105     fail:
1106         return rx_EndCall(z_call, z_result);
1107     }
1108
1109     int VL_ReplaceEntry(z_conn, Volid, voltype, newentry, ReleaseType)
1110         register struct rx_connection *z_conn;
1111         long Volid, voltype, ReleaseType;
1112         vldbentry * newentry;
1113     {
1114         struct rx_call *z_call = rx_NewCall(z_conn);
1115         static int z_op = 506;
1116         int z_result;
1117         XDR z_xdrs;
1118
1119         xdrrx_create(&z_xdrs, z_call, XDR_ENCODE);
1120
1121         /* Marshal the arguments */
1122         if ((!xdr_int(&z_xdrs, &z_op))
1123              || (!xdr_long(&z_xdrs, &Volid))
1124              || (!xdr_long(&z_xdrs, &voltype))
1125              || (!xdr_vldbentry(&z_xdrs, newentry))
1126              || (!xdr_long(&z_xdrs, &ReleaseType))) {
1127                 z_result = RXGEN_CC_MARSHAL;
1128                 goto fail;
1129         }
1130
1131         z_result = RXGEN_SUCCESS;
1132     fail:
1133         return rx_EndCall(z_call, z_result);
1134     }
1135
1136     int StartVL_ReplaceEntry(z_call, Volid, voltype, newentry, ReleaseType)
1137         register struct rx_call *z_call;
1138         long Volid, voltype, ReleaseType;
1139         vldbentry * newentry;
1140     {
1141         static int z_op = 506;
1142         int z_result;
1143         XDR z_xdrs;
1144
1145         xdrrx_create(&z_xdrs, z_call, XDR_ENCODE);
1146
1147         /* Marshal the arguments */
1148         if ((!xdr_int(&z_xdrs, &z_op))
1149              || (!xdr_long(&z_xdrs, &Volid))
1150              || (!xdr_long(&z_xdrs, &voltype))
1151              || (!xdr_vldbentry(&z_xdrs, newentry))
1152              || (!xdr_long(&z_xdrs, &ReleaseType))) {
1153                 z_result = RXGEN_CC_MARSHAL;
1154                 goto fail;
1155         }
1156
1157         z_result = RXGEN_SUCCESS;
1158     fail:
1159         return z_result;
1160     }
1161
1162     int EndVL_ReplaceEntry(z_call)
1163         register struct rx_call *z_call;
1164     {
1165         int z_result;
1166         XDR z_xdrs;
1167
1168         z_result = RXGEN_SUCCESS;
1169     fail:
1170         return z_result;
1171     }
1172
1173     int VL_ListAttributes(z_conn, attributes, nentries, bulkentries_1)
1174         register struct rx_connection *z_conn;
1175         VldbListByAttributes * attributes;
1176         long * nentries;
1177         bulkentries * bulkentries_1;
1178     {
1179         struct rx_call *z_call = rx_NewCall(z_conn);
1180         static int z_op = 511;
1181         int z_result;
1182         XDR z_xdrs;
1183
1184         xdrrx_create(&z_xdrs, z_call, XDR_ENCODE);
1185
1186         /* Marshal the arguments */
1187         if ((!xdr_int(&z_xdrs, &z_op))
1188              || (!xdr_VldbListByAttributes(&z_xdrs, attributes))) {
1189                 z_result = RXGEN_CC_MARSHAL;
1190                 goto fail;
1191         }
1192
1193         /* Un-marshal the reply arguments */
1194         z_xdrs.x_op = XDR_DECODE;
1195         if ((!xdr_long(&z_xdrs, nentries))
1196              || (!xdr_bulkentries(&z_xdrs, bulkentries_1))) {
1197                 z_result = RXGEN_CC_UNMARSHAL;
1198                 goto fail;
1199         }
1200
1201         z_result = RXGEN_SUCCESS;
1202     fail:
1203         return rx_EndCall(z_call, z_result);
1204     }
1205
1206     int VL_LinkedList(z_conn, attributes, nentries, linkedentries)
1207         register struct rx_connection *z_conn;
1208         VldbListByAttributes * attributes;
1209         long * nentries;
1210         vldb_list * linkedentries;
1211     {
1212         struct rx_call *z_call = rx_NewCall(z_conn);
1213         static int z_op = 512;
1214         int z_result;
1215         XDR z_xdrs;
1216
1217         xdrrx_create(&z_xdrs, z_call, XDR_ENCODE);
1218
1219         /* Marshal the arguments */
1220         if ((!xdr_int(&z_xdrs, &z_op))
1221              || (!xdr_VldbListByAttributes(&z_xdrs, attributes))) {
1222                 z_result = RXGEN_CC_MARSHAL;
1223                 goto fail;
1224         }
1225
1226         /* Un-marshal the reply arguments */
1227         z_xdrs.x_op = XDR_DECODE;
1228         if ((!xdr_long(&z_xdrs, nentries))
1229              || (!xdr_vldb_list(&z_xdrs, linkedentries))) {
1230                 z_result = RXGEN_CC_UNMARSHAL;
1231                 goto fail;
1232         }
1233
1234         z_result = RXGEN_SUCCESS;
1235     fail:
1236         return rx_EndCall(z_call, z_result);
1237     }
1238
1239 Notice the side effect of the C<multi> feature (three different modules
1240 for C<ReplaceEntry> proc).
1241
1242 =head3 Server-Side stub routines (vldbint.ss.c)
1243
1244     /* Machine generated file -- Do NOT edit */
1245
1246     #include <rx/xdr.h>
1247     #include <rx/rx.h>
1248     #include <afs/rxgen_consts.h>
1249     #include "vldbint.h"
1250
1251     #include "vl_opcodes.h"  /* directly to other places */
1252
1253     long _VL_CreateEntry(z_call, z_xdrs)
1254         struct rx_call *z_call;
1255         XDR *z_xdrs;
1256     {
1257         long z_result;
1258         long Volid;
1259         vldbentry newentry;
1260
1261         if ((!xdr_long(z_xdrs, &Volid))
1262              || (!xdr_vldbentry(z_xdrs, &newentry))) {
1263                 z_result = RXGEN_SS_UNMARSHAL;
1264                 goto fail;
1265         }
1266
1267         z_result = VL_CreateEntry(z_call, Volid, &newentry);
1268     fail:
1269         return z_result;
1270     }
1271
1272     long _VL_GetEntryByName(z_call, z_xdrs)
1273         struct rx_call *z_call;
1274         XDR *z_xdrs;
1275     {
1276         long z_result;
1277         char *volumename = (char *)0;
1278         vldbentry entry;
1279
1280         if ((!xdr_string(z_xdrs, &volumename, 65))) {
1281                 z_result = RXGEN_SS_UNMARSHAL;
1282                 goto fail;
1283         }
1284
1285         z_result = VL_GetEntryByName(z_call, &volumename, &entry);
1286         z_xdrs->x_op = XDR_ENCODE;
1287         if ((!xdr_vldbentry(z_xdrs, &entry)))
1288                 z_result = RXGEN_SS_MARSHAL;
1289     fail:
1290         z_xdrs->x_op = XDR_FREE;
1291         if (!xdr_string(z_xdrs, &volumename, 65)) goto fail1;
1292         return z_result;
1293     fail1:
1294         return RXGEN_SS_XDRFREE;
1295     }
1296
1297     long _VL_GetNewVolumeId(z_call, z_xdrs)
1298         struct rx_call *z_call;
1299         XDR *z_xdrs;
1300     {
1301         long z_result;
1302         long bumpcount;
1303         long newvolumid;
1304
1305         if ((!xdr_long(z_xdrs, &bumpcount))) {
1306                 z_result = RXGEN_SS_UNMARSHAL;
1307                 goto fail;
1308         }
1309
1310         z_result = VL_GetNewVolumeId(z_call, bumpcount, &newvolumid);
1311         z_xdrs->x_op = XDR_ENCODE;
1312         if ((!xdr_long(z_xdrs, &newvolumid)))
1313                 z_result = RXGEN_SS_MARSHAL;
1314     fail:
1315         return z_result;
1316     }
1317
1318     long _VL_ReplaceEntry(z_call, z_xdrs)
1319         struct rx_call *z_call;
1320         XDR *z_xdrs;
1321     {
1322         long z_result;
1323         long Volid, voltype, ReleaseType;
1324         vldbentry newentry;
1325
1326         if ((!xdr_long(z_xdrs, &Volid))
1327              || (!xdr_long(z_xdrs, &voltype))
1328              || (!xdr_vldbentry(z_xdrs, &newentry))
1329              || (!xdr_long(z_xdrs, &ReleaseType))) {
1330                 z_result = RXGEN_SS_UNMARSHAL;
1331                 goto fail;
1332         }
1333
1334         z_result = VL_ReplaceEntry(z_call, Volid, voltype, &newentry,
1335                                    ReleaseType);
1336     fail:
1337         return z_result;
1338     }
1339
1340     long _VL_ListAttributes(z_call, z_xdrs)
1341         struct rx_call *z_call;
1342         XDR *z_xdrs;
1343     {
1344         long z_result;
1345         VldbListByAttributes attributes;
1346         long nentries;
1347         bulkentries bulkentries_1;
1348
1349         if ((!xdr_VldbListByAttributes(z_xdrs, &attributes))) {
1350                 z_result = RXGEN_SS_UNMARSHAL;
1351                 goto fail;
1352         }
1353
1354         z_result = VL_ListAttributes(z_call, &attributes, &nentries,
1355                                      &bulkentries_1);
1356         z_xdrs->x_op = XDR_ENCODE;
1357         if ((!xdr_long(z_xdrs, &nentries))
1358              || (!xdr_bulkentries(z_xdrs, &bulkentries_1)))
1359                 z_result = RXGEN_SS_MARSHAL;
1360     fail:
1361         z_xdrs->x_op = XDR_FREE;
1362         if (!xdr_bulkentries(z_xdrs, &bulkentries_1)) goto fail1;
1363         return z_result;
1364     fail1:
1365         return RXGEN_SS_XDRFREE;
1366     }
1367
1368     long _VL_LinkedList(z_call, z_xdrs)
1369         struct rx_call *z_call;
1370         XDR *z_xdrs;
1371     {
1372         long z_result;
1373         VldbListByAttributes attributes;
1374         long nentries;
1375         vldb_list linkedentries;
1376
1377         if ((!xdr_VldbListByAttributes(z_xdrs, &attributes))) {
1378                 z_result = RXGEN_SS_UNMARSHAL;
1379                 goto fail;
1380         }
1381
1382         z_result = VL_LinkedList(z_call, &attributes, &nentries,
1383                                  &linkedentries);
1384         z_xdrs->x_op = XDR_ENCODE;
1385         if ((!xdr_long(z_xdrs, &nentries))
1386              || (!xdr_vldb_list(z_xdrs, &linkedentries)))
1387                 z_result = RXGEN_SS_MARSHAL;
1388     fail:
1389         return z_result;
1390     }
1391
1392     long _VL_CreateEntry();
1393     long _VL_GetEntryByName();
1394     long _VL_GetNewVolumeId();
1395     long _VL_ReplaceEntry();
1396     long _VL_ListAttributes();
1397     long _VL_LinkedList();
1398
1399     static long (*StubProcsArray0[])() = {_VL_CreateEntry,
1400         _VL_GetEntryByName, _VL_GetNewVolumeId, _VL_ReplaceEntry,
1401         _VL_ListAttributes, _VL_LinkedList};
1402
1403     VL_ExecuteRequest(z_call)
1404         register struct rx_call *z_call;
1405     {
1406         int op;
1407         XDR z_xdrs;
1408         long z_result;
1409
1410         xdrrx_create(&z_xdrs, z_call, XDR_DECODE);
1411         if (!xdr_int(&z_xdrs, &op))
1412             z_result = RXGEN_DECODE;
1413         else if (op < VL_LOWEST_OPCODE || op > VL_HIGHEST_OPCODE)
1414             z_result = RXGEN_OPCODE;
1415         else
1416             z_result = (*StubProcsArray0[op - VL_LOWEST_OPCODE])
1417                 (z_call, &z_xdrs);
1418         return z_result;
1419     }
1420
1421 If there were gaps in the procedures' opcode sequence the code for
1422 VL_ExecuteRequest() routine would be have been drastically different (it
1423 would have been a case statement for each procedure).
1424
1425 =head1 NOTES
1426
1427 B<rxgen> is implemented from Sun's B<rpcgen> utility.  All of the standard
1428 B<rpcgen>'s functionality is fully maintained.  Note that some active
1429 B<rpcgen> options that don't apply to B<rxgen>'s purpose aren't referenced
1430 here (i.e., B<-s>, B<-l>, B<-m> options) and the interested reader should
1431 refer to rpcgen(1) for details.
1432
1433 When the C<%#include <include file>> feature is used make sure that you
1434 don't have any B<rxgen> language features (i.e. %#defines) since you'll
1435 get syntax errors during compilations..
1436
1437 Since this is an ongoing project many of the above may change/disappear
1438 without a major warning.
1439
1440 =head1 SEE ALSO
1441
1442 I<Rxgen Syntax Summary>: Summary description of rxgen's grammar.
1443
1444 I<Rpcgen Programming Guide>: Sun's RPC protocol compiler.  B<rxgen> was
1445 implemented as an extension to that compiler.
1446
1447 I<External Data Representation: Sun Technical Notes>: Detailed examples in
1448 using XDR.
1449
1450 I<RPCL Syntax Summary>: Summary of Sun's Remote Procedure Call Language.
1451
1452 I<Rx>: An extended Remote Procedure Call Protocol.
1453
1454 I<rgen>: An earlier version of a similar stub generator used for the R RPC
1455 protocol.
1456
1457 =head1 COPYRIGHT
1458
1459 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
1460
1461 This documentation is covered by the IBM Public License Version 1.0.  It
1462 was converted from the original TeX B<rxgen> manual to POD by Russ
1463 Allbery.