Renesas stub generator User's Manual

Below you will find brief information for stub generator. The stub generator is a tool that can be used to create the source code of the client and server stubs that are required whenever the remote procedure call (RPC) facility of the HI7200/MP realtime operating system is to be used. The tool takes a configuration file as input and generates the source code for the client and server stubs. The user can then compile and link these stubs into their applications.
PDF Download
Document
To our customers,
Old Company Name in Catalogs and Other Documents
On April 1st, 2010, NEC Electronics Corporation merged with Renesas Technology
Corporation, and Renesas Electronics Corporation took over all the business of both
companies. Therefore, although the old company name remains in this document, it is a valid
Renesas Electronics document. We appreciate your understanding.
Renesas Electronics website: http://www.renesas.com
April 1st, 2010
Renesas Electronics Corporation
Issued by: Renesas Electronics Corporation (http://www.renesas.com)
Send any inquiries to http://www.renesas.com/inquiry.
Notice
1.
2.
3.
4.
5.
6.
7.
All information included in this document is current as of the date this document is issued. Such information, however, is
subject to change without any prior notice. Before purchasing or using any Renesas Electronics products listed herein, please
confirm the latest product information with a Renesas Electronics sales office. Also, please pay regular and careful attention to
additional and different information to be disclosed by Renesas Electronics such as that disclosed through our website.
Renesas Electronics does not assume any liability for infringement of patents, copyrights, or other intellectual property rights
of third parties by or arising from the use of Renesas Electronics products or technical information described in this document.
No license, express, implied or otherwise, is granted hereby under any patents, copyrights or other intellectual property rights
of Renesas Electronics or others.
You should not alter, modify, copy, or otherwise misappropriate any Renesas Electronics product, whether in whole or in part.
Descriptions of circuits, software and other related information in this document are provided only to illustrate the operation of
semiconductor products and application examples. You are fully responsible for the incorporation of these circuits, software,
and information in the design of your equipment. Renesas Electronics assumes no responsibility for any losses incurred by
you or third parties arising from the use of these circuits, software, or information.
When exporting the products or technology described in this document, you should comply with the applicable export control
laws and regulations and follow the procedures required by such laws and regulations. You should not use Renesas
Electronics products or the technology described in this document for any purpose relating to military applications or use by
the military, including but not limited to the development of weapons of mass destruction. Renesas Electronics products and
technology may not be used for or incorporated into any products or systems whose manufacture, use, or sale is prohibited
under any applicable domestic or foreign laws or regulations.
Renesas Electronics has used reasonable care in preparing the information included in this document, but Renesas Electronics
does not warrant that such information is error free. Renesas Electronics assumes no liability whatsoever for any damages
incurred by you resulting from errors in or omissions from the information included herein.
Renesas Electronics products are classified according to the following three quality grades: “Standard”, “High Quality”, and
“Specific”. The recommended applications for each Renesas Electronics product depends on the product’s quality grade, as
indicated below. You must check the quality grade of each Renesas Electronics product before using it in a particular
application. You may not use any Renesas Electronics product for any application categorized as “Specific” without the prior
written consent of Renesas Electronics. Further, you may not use any Renesas Electronics product for any application for
which it is not intended without the prior written consent of Renesas Electronics. Renesas Electronics shall not be in any way
liable for any damages or losses incurred by you or third parties arising from the use of any Renesas Electronics product for an
application categorized as “Specific” or for which the product is not intended where you have failed to obtain the prior written
consent of Renesas Electronics. The quality grade of each Renesas Electronics product is “Standard” unless otherwise
expressly specified in a Renesas Electronics data sheets or data books, etc.
“Standard”:
8.
9.
10.
11.
12.
Computers; office equipment; communications equipment; test and measurement equipment; audio and visual
equipment; home electronic appliances; machine tools; personal electronic equipment; and industrial robots.
“High Quality”: Transportation equipment (automobiles, trains, ships, etc.); traffic control systems; anti-disaster systems; anticrime systems; safety equipment; and medical equipment not specifically designed for life support.
“Specific”:
Aircraft; aerospace equipment; submersible repeaters; nuclear reactor control systems; medical equipment or
systems for life support (e.g. artificial life support devices or systems), surgical implantations, or healthcare
intervention (e.g. excision, etc.), and any other applications or purposes that pose a direct threat to human life.
You should use the Renesas Electronics products described in this document within the range specified by Renesas Electronics,
especially with respect to the maximum rating, operating supply voltage range, movement power voltage range, heat radiation
characteristics, installation and other product characteristics. Renesas Electronics shall have no liability for malfunctions or
damages arising out of the use of Renesas Electronics products beyond such specified ranges.
Although Renesas Electronics endeavors to improve the quality and reliability of its products, semiconductor products have
specific characteristics such as the occurrence of failure at a certain rate and malfunctions under certain use conditions. Further,
Renesas Electronics products are not subject to radiation resistance design. Please be sure to implement safety measures to
guard them against the possibility of physical injury, and injury or damage caused by fire in the event of the failure of a
Renesas Electronics product, such as safety design for hardware and software including but not limited to redundancy, fire
control and malfunction prevention, appropriate treatment for aging degradation or any other appropriate measures. Because
the evaluation of microcomputer software alone is very difficult, please evaluate the safety of the final products or system
manufactured by you.
Please contact a Renesas Electronics sales office for details as to environmental matters such as the environmental
compatibility of each Renesas Electronics product. Please use Renesas Electronics products in compliance with all applicable
laws and regulations that regulate the inclusion or use of controlled substances, including without limitation, the EU RoHS
Directive. Renesas Electronics assumes no liability for damages or losses occurring as a result of your noncompliance with
applicable laws and regulations.
This document may not be reproduced or duplicated, in any form, in whole or in part, without prior written consent of Renesas
Electronics.
Please contact a Renesas Electronics sales office if you have any questions regarding the information contained in this
document or Renesas Electronics products, or if you have any other inquiries.
(Note 1) “Renesas Electronics” as used in this document means Renesas Electronics Corporation and also includes its majorityowned subsidiaries.
(Note 2) “Renesas Electronics product(s)” means any product developed or manufactured by or for Renesas Electronics.
User’s Manual
Stub Generator
V.1.00
User’s Manual
Renesas Microcomputer
Development Environment
System
Rev.1.01 2008.03
Notes regarding these materials
1. This document is provided for reference purposes only so that Renesas customers may select the appropriate
Renesas products for their use. Renesas neither makes warranties or representations with respect to the
accuracy or completeness of the information contained in this document nor grants any license to any
intellectual property rights or any other rights of Renesas or any third party with respect to the information in
this document.
2. Renesas shall have no liability for damages or infringement of any intellectual property or other rights arising
out of the use of any information in this document, including, but not limited to, product data, diagrams, charts,
programs, algorithms, and application circuit examples.
3. You should not use the products or the technology described in this document for the purpose of military
applications such as the development of weapons of mass destruction or for the purpose of any other military
use. When exporting the products or technology described herein, you should follow the applicable export
control laws and regulations, and procedures required by such laws and regulations.
4. All information included in this document such as product data, diagrams, charts, programs, algorithms, and
application circuit examples, is current as of the date this document is issued. Such information, however, is
subject to change without any prior notice. Before purchasing or using any Renesas products listed in this
document, please confirm the latest product information with a Renesas sales office. Also, please pay regular
and careful attention to additional and different information to be disclosed by Renesas such as that disclosed
through our website. (http://www.renesas.com )
5. Renesas has used reasonable care in compiling the information included in this document, but Renesas
assumes no liability whatsoever for any damages incurred as a result of errors or omissions in the information
included in this document.
6. When using or otherwise relying on the information in this document, you should evaluate the information in
light of the total system before deciding about the applicability of such information to the intended application.
Renesas makes no representations, warranties or guaranties regarding the suitability of its products for any
particular application and specifically disclaims any liability arising out of the application and use of the
information in this document or Renesas products.
7. With the exception of products specified by Renesas as suitable for automobile applications, Renesas
products are not designed, manufactured or tested for applications or otherwise in systems the failure or
malfunction of which may cause a direct threat to human life or create a risk of human injury or which require
especially high quality and reliability such as safety systems, or equipment or systems for transportation and
traffic, healthcare, combustion control, aerospace and aeronautics, nuclear power, or undersea communication
transmission. If you are considering the use of our products for such purposes, please contact a Renesas
sales office beforehand. Renesas shall have no liability for damages arising out of the uses set forth above.
8. Notwithstanding the preceding paragraph, you should not use Renesas products for the purposes listed below:
(1) artificial life support devices or systems
(2) surgical implantations
(3) healthcare intervention (e.g., excision, administration of medication, etc.)
(4) any other purposes that pose a direct threat to human life
Renesas shall have no liability for damages arising out of the uses set forth in the above and purchasers who
elect to use Renesas products in any of the foregoing applications shall indemnify and hold harmless Renesas
Technology Corp., its affiliated companies and their officers, directors, and employees against any and all
damages arising out of such applications.
9. You should use the products described herein within the range specified by Renesas, especially with respect
to the maximum rating, operating supply voltage range, movement power voltage range, heat radiation
characteristics, installation and other product characteristics. Renesas shall have no liability for malfunctions or
damages arising out of the use of Renesas products beyond such specified ranges.
10. Although Renesas endeavors to improve the quality and reliability of its products, IC products have specific
characteristics such as the occurrence of failure at a certain rate and malfunctions under certain use
conditions. Please be sure to implement safety measures to guard against the possibility of physical injury, and
injury or damage caused by fire in the event of the failure of a Renesas product, such as safety design for
hardware and software including but not limited to redundancy, fire control and malfunction prevention,
appropriate treatment for aging degradation or any other applicable measures. Among others, since the
evaluation of microcomputer software alone is very difficult, please evaluate the safety of the final products or
system manufactured by you.
11. In case Renesas products listed in this document are detached from the products to which the Renesas
products are attached or affixed, the risk of accident such as swallowing by infants and small children is very
high. You should implement safety measures so that Renesas products may not be easily detached from your
products. Renesas shall have no liability for damages arising out of such detachment.
12. This document may not be reproduced or duplicated, in any form, in whole or in part, without prior written
approval from Renesas.
13. Please contact a Renesas sales office if you have any questions regarding the information contained in this
document, Renesas semiconductor products, or if you have any other inquiries.
Preface
This manual describes how to use the stub generator. Read this manual and understand it well
before using the stub generator.
Notes on Descriptions
RPCGEN
Abbreviation for the stub generator
Prefix
Prefix 0x indicates a hexadecimal number. Numbers with no prefix are
decimal.
\
‘\’ is the directory delimiter.
[Menu -&gt; Menu item]
‘-&gt;’ leads to the menu item (e.g. File -&gt; Save).
$(xxxx)
Custom placeholder in the High-performance Embedded Workshop
i
Trademarks
All trademarks and registered trademarks belong to their respective owners.
1. TRON is an acronym formed from &quot;The Real Time Operating system Nucleus&quot;. ITRON is
short for &quot;Industrial TRON&quot; and &micro;ITRON is short for &quot;Micro Industrial TRON&quot;.
TRON, ITRON, and &micro;ITRON are the names of computer specifications and do not indicate
specific products or groups of products.
The &micro;ITRON4.0 specification is an open realtime-kernel specification defined by the TRON
Association. The &micro;ITRON4.0 specification can be downloaded from the TRON Association
homepage (http://www.assoc.tron.org).
The copyright of the &micro;ITRON specification belongs to the TRON Association.
2. Microsoft&reg; and Windows&reg; are registered trademarks of Microsoft Corporation in the United
States and/or other countries. The formal name of Windows&reg; is Microsoft Windows Operating
System.
3. All other product names are trademarks or registered trademarks of the respective holders.
Renesas Technology Homepage
Various support information are available on the following Renesas Technology homepage:
http://www.renesas.com/en/tools/
ii
Contents
Section 1 Overview..................................................................................................1
1.1
1.2
Overview............................................................................................................................... 1
Operating Environment......................................................................................................... 2
Section 2 Installation................................................................................................3
2.1
2.2
Downloading......................................................................................................................... 3
Installing RPCGEN............................................................................................................... 3
Section 3 Functions and Files Generated by RPCGEN ...........................................5
3.1
3.2
Functions Generated by RPCGEN........................................................................................ 5
3.1.1
Client..................................................................................................................... 6
3.1.2
Server .................................................................................................................... 6
Files Generated by RPCGEN................................................................................................ 7
Section 4 Executing RPCGEN ................................................................................9
4.1
4.2
4.3
Executing RPCGEN ............................................................................................................. 9
Options................................................................................................................................ 10
4.2.1
PUBI ................................................................................................................... 10
4.2.2
CLNTS................................................................................................................ 10
4.2.3
CLNTI................................................................................................................. 10
4.2.4
SVRS .................................................................................................................. 11
4.2.5
SVRI ................................................................................................................... 11
Executing RPCGEN as a Build Phase in the High-performance Embedded Workshop..... 12
Section 5 Specifications of a Config File ..............................................................23
5.1
5.2
5.3
5.4
Definition ............................................................................................................................ 23
Comments ........................................................................................................................... 24
File Locations ..................................................................................................................... 25
5.3.1
PUB_INCPATH ................................................................................................. 25
5.3.2
CLNT_SOURCEPATH ...................................................................................... 26
5.3.3
CLNT_INCPATH............................................................................................... 26
5.3.4
SVR_SOURCEPATH......................................................................................... 27
5.3.5
SVR_INCPATH ................................................................................................. 27
Controlling the Output of #include Directives.................................................................... 28
5.4.1
Order of #Include Directives............................................................................... 29
5.4.2
GLOBAL_INCFILE ........................................................................................... 30
iii
5.5
5.6
5.7
5.4.3
CLNT_INCFILE................................................................................................. 30
5.4.4
SVR_INCFILE ................................................................................................... 31
Server Information.............................................................................................................. 32
5.5.1
SVR_NAME....................................................................................................... 32
5.5.2
SVR_ID .............................................................................................................. 33
5.5.3
SVR_VERSION ................................................................................................. 34
5.5.4
SVR_NOINIT..................................................................................................... 34
5.5.5
SVR_NOSTUBTBL ........................................................................................... 35
5.5.6
SVR_NOSHUTDOWN ...................................................................................... 36
5.5.7
SVR_STATIC..................................................................................................... 37
5.5.8
SVR_AUTH ....................................................................................................... 38
5.5.9
SVR_SECTION.................................................................................................. 42
Client Information .............................................................................................................. 43
5.6.1
CLNT_NOINIT .................................................................................................. 43
5.6.2
CLNT_NOSHUTDOWN ................................................................................... 44
5.6.3
CLNT_CALLCHK ............................................................................................. 45
5.6.4
CLNT_SECTION ............................................................................................... 46
Server Functions ................................................................................................................. 47
5.7.1
RPC_FUNC ........................................................................................................ 47
Section 6 Definitions of Server Functions.............................................................49
6.1
6.2
6.3
6.4
6.5
6.6
iv
Format................................................................................................................................. 49
Function-Type Directives ................................................................................................... 52
6.2.1
Function with a Return Value ............................................................................. 52
6.2.2
Function without a Return Value........................................................................ 53
6.2.3
When the Return Value is not Representable as a 4-Byte Integer ...................... 54
Function Names .................................................................................................................. 55
Parameters........................................................................................................................... 56
Keywords for Input/Output................................................................................................. 57
6.5.1
IN (Input) ............................................................................................................ 57
6.5.2
OUT (Output) ..................................................................................................... 58
6.5.3
INOUT (Input and Output) ................................................................................. 59
6.5.4
REF (Passing by Reference) ............................................................................... 60
6.5.5
DESC (Specified Parameter is not Passed from the Client to the Server) .......... 62
Keywords for Data Types ................................................................................................... 63
6.6.1
DFLT (Default)................................................................................................... 63
6.6.2
STR (String)........................................................................................................ 64
6.6.3
PTR (Pointer)...................................................................................................... 65
6.6.4
ARY (Array) ....................................................................................................... 66
6.6.5
COUNT (Number of Elements in an Array)....................................................... 67
6.7
Optional Keywords ............................................................................................................. 83
6.7.1
SVRSTUB (Server Stub) .................................................................................... 84
6.7.2
SVRFUNC (Server Function Name) .................................................................. 85
6.7.3
CLNTSTUB (Client Stub) .................................................................................. 86
6.7.4
UNACK (Asynchronous Call) ............................................................................ 87
6.7.5
CLNTCOPYCBK (RPC Call by rpc_call_copycbk())........................................ 88
Section 7 Server Functions Not Supported by RPCGEN ......................................89
7.1
7.2
Parameter ............................................................................................................................ 89
Return Value ....................................................................................................................... 91
Section 8 Application Interface .............................................................................93
8.1
8.2
8.3
8.4
8.5
8.6
8.7
8.8
8.9
8.10
Client-Stub Functions Generated by RPCGEN .................................................................. 93
Server-Stub Functions Generated by RPCGEN.................................................................. 95
Server-Initialization Function ............................................................................................. 96
Server-Stub Function Table ................................................................................................ 97
Server-Shutdown Function ................................................................................................. 99
Client-Initialization Function............................................................................................ 100
Client-Shutdown Function ................................................................................................ 101
rpc_retval_adr() ................................................................................................................ 102
&lt;Config file&gt;_public.h...................................................................................................... 104
Local Variables Used in the Source Code Created by RPCGEN...................................... 104
Section 9 Notes ....................................................................................................105
Section 10 Error Messages...................................................................................107
10.1
10.2
10.3
10.4
Format............................................................................................................................... 107
General.............................................................................................................................. 108
Definition Errors (other than RPC_FUNC) ...................................................................... 108
Definition Errors (RPC_FUNC) ....................................................................................... 108
Section 11 Samples ..............................................................................................109
11.1
11.2
11.3
11.4
11.5
11.6
11.7
Config File (sample.x) ...................................................................................................... 110
sample_clnt.h .................................................................................................................... 112
sample_private.h ............................................................................................................... 113
sample_clnt.c .................................................................................................................... 114
sample_svr.h ..................................................................................................................... 120
sample_svr.c ..................................................................................................................... 122
sample_public.h ................................................................................................................ 127
v
vi
Section 1 Overview
Section 1 Overview
1.1
Overview
The stub generator (hereafter referred to as RPCGEN) is a tool used to generate the source code of
the client and server stubs that are required whenever the remote procedure call (RPC) facility of
the HI7200/MP realtime operating system is to be used. A config file is created by using a text
editor and then input to RPCGEN, which creates the source code of the client and server stubs.
Config file
RPCGEN
Source code of the client
and server stubs
Figure 1.1 Overview of RPCGEN
Rev. 1.01 Mar. 17, 2008 Page 1 of 128
REJ10J1822-0101
Section 1 Overview
1.2
Operating Environment
RPCGEN is provided as a Perl script file. Table 1.1 shows the operating environment.
Table 1.1
Operating Environment
Item
Operating Environment
Realtime OS
HI7200/MP V.1.00 Release 00 or later
Perl environment
We have confirmed correct execution of RPCGEN by ActivePerl
5.8.8.820 (for Windows&reg; (x86)) produced by ActiveState Software Inc.
ActivePerl is available for free download from the following Web site:
http://www.activestate.com/Products/activeperl/
Host machine
Any machine with Windows&reg; XP (32 bits) or Windows&reg; 2000 as the
operating system
Rev. 1.01 Mar. 17, 2008 Page 2 of 128
REJ10J1822-0101
Section 2 Installation
Section 2 Installation
2.1
Downloading
RPCGEN can be downloaded for free from the Renesas Web site at the following URL.
http://www.renesas.com
2.2
Installing RPCGEN
The file for downloading has been compressed in the zip format. Expanding the zip file generates
the files listed in table 2.1. These files must be stored in a suitable folder.
Table 2.1
Files Provided as RPCGEN
Filename
Description
rpcgen.pl
Main body of RPCGEN
rpcgen_clnt.pm
Package modules for use by the main body of RPCGEN
rpcgen_svr.pm
rpcgen_info.pm
rpcgen_misc.pm
Rev. 1.01 Mar. 17, 2008 Page 3 of 128
REJ10J1822-0101
Section 2 Installation
Rev. 1.01 Mar. 17, 2008 Page 4 of 128
REJ10J1822-0101
Section 3 Functions and Files Generated by RPCGEN
Section 3 Functions and Files Generated by RPCGEN
3.1
Functions Generated by RPCGEN
Figure 3.1 shows the functions generated by RPCGEN.
Client
Server
Clientinitialization
function
Serverinitialization
function
Client-stub
functions
Server-stub
functions
Clientshutdown
function
Servershutdown
function
Figure 3.1 Functions Generated by RPCGEN
Rev. 1.01 Mar. 17, 2008 Page 5 of 128
REJ10J1822-0101
Section 3 Functions and Files Generated by RPCGEN
3.1.1
Client
(1) Client-initialization function
This function initiates the connection with the server. Specifying CLNT_NOINIT prevents the
creation of the client-initialization function.
(2) Client-shutdown function
This function ends the connection with the server. Specifying CLNT_NOSHUTDOWN prevents
the creation of the client-shutdown function.
(3) Client-stub functions
Each of these functions makes an RPC call and has the same API as or an API similar to the server
function. If SVRAUTH has not been specified, the API will be the same as that of the server
function. Specifying CLNTSTUB prevents the creation of a specific client-stub function.
3.1.2
Server
(1) Server-initialization function
This function starts up the server. Specifying SVR_NOINIT prevents the creation of the serverinitialization function.
(2) Server-shutdown function
This function shuts the server down. Specifying SVR_NOSHUTDOWN prevents the creation of
the server-shutdown function.
(3) Server-stub functions
Each of these functions is called back from the RPC library and then calls a server function.
Specifying SVRSTUB prevents the creation of a specific server-stub function, while specifying
SVRFUNC allows the name of the called server function to be replaced.
Rev. 1.01 Mar. 17, 2008 Page 6 of 128
REJ10J1822-0101
Section 3 Functions and Files Generated by RPCGEN
3.2
Files Generated by RPCGEN
RPCGEN generates the files listed in table 3.1 in accord with the name of the config file.
Table 3.1
Files Generated by RPCGEN
Filename
Description
Definition of the File Location
&lt;config file&gt;_clnt.c
Client-stub source file
CLNTS option or
CLNT_SOURCEPATH in the config file
&lt;config file&gt;_clnt.h
Client-stub header file
&lt;config file&gt;_private.h
Internal header file for the
client stub
CLNTI option or CLNT_INCPATH in
the config file
&lt;config file&gt;_svr.c
Server-stub source file
SVRS option or SVR_SOURCEPATH
in the config file
&lt;config file&gt;_svr.h
Server-stub header file
SVRI option or SVR_INCPATH in the
config file
&lt;config file&gt;_public.h
Header file for the client and
server stubs
PUBI option or PUB_INCPATH in the
config file
When the config file is “sample.x,” for example, RPCGEN will generate the following files:
sample_clnt.c, sample_clnt.h, sample_svr.c, sample_svr.h, sample_private.h, and sample_public.h.
To temporarily save information during the process of file generation, RPCGEN also generates
intermediate files in the current directory. The names of these intermediate files consist of two
underscores (“__”) appended before the filenames given in the table above.
(1) &lt;config file&gt;_clnt.c (client-stub source file)
This file contains the client-stub functions, client-initialization function, and client-shutdown
function.
(2) &lt;config file&gt;_clnt.h (client-stub header file)
This file contains definitions required for use of the client-stub functions, client-initialization
function, and client-shutdown function. The definitions include prototype declarations of the
client-stub functions, client-initialization function, and client-shutdown function.
Rev. 1.01 Mar. 17, 2008 Page 7 of 128
REJ10J1822-0101
Section 3 Functions and Files Generated by RPCGEN
(3) &lt;config file&gt;_private.h (internal header file for the client stub)
This is a header file included by &lt;config file&gt;_clnt.c only.
(4) &lt;config file&gt;_svr.c (server-stub source file)
This file contains the server-stub functions, server-initialization function, server-shutdown
function, and server-stub function table.
(5) &lt;config file&gt;_svr.h (server-stub header file)
This file contains definitions required for use of the server-initialization function and servershutdown function. The definitions include prototype declarations of the server-stub functions,
server-initialization function, and server-shutdown function.
(6) &lt;config file&gt;_public.h (header file for the client and server stubs)
This is a header file for the client and server applications. For details, refer to section 8.9, &lt;config
file&gt;_public.h.
Rev. 1.01 Mar. 17, 2008 Page 8 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
Section 4 Executing RPCGEN
4.1
Executing RPCGEN
RPCGEN must be executed from the command prompt as follows.
perlΔ-I&lt;rpcgen path&gt;Δ&lt;rpcgen path&gt;\rpcgen.plΔ
&lt;config file&gt;[Δ&lt;option&gt;...](RET)
&lt;rpcgen path&gt; is a path to the directory where RPCGEN has been installed.
&lt;config file&gt; refers to a file describing the specifications of the client and server stubs to be
generated. This file must be created by the user. The standard filename extension for the config
file is “.x”, which must not be omitted when the name is entered in a command line.
After execution of the above command, RPCGEN will generate the C-language source files and
header files for the client and server stubs in accord with the information contained in the config
file.
If &lt;config file&gt; and &lt;option&gt; are omitted, the command syntax will be shown.
Rev. 1.01 Mar. 17, 2008 Page 9 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
4.2
Options
4.2.1
PUBI
Format:
PUBI=&quot;&lt;path&gt;&quot;
Description:
This option is used to specify the path for output of &lt;config file&gt;_public.h. If this option is used, a
definition of PUB_INCPATH in the config file is ignored.
4.2.2
CLNTS
Format:
CLNTS=&quot;&lt;path&gt;&quot;
Description:
This option is used to specify the path for output of &lt;config file&gt;_clnt.c. If this option is used, a
definition of CLNT_SOURCEPATH in the config file is ignored.
4.2.3
CLNTI
Format:
CLNTI=&quot;&lt;path&gt;&quot;
Description:
This option is used to specify the path for output of &lt;config file&gt;_clnt.h and
&lt;config file&gt;_private.h. If this option is used, a definition of CLNT_INCPATH in the config file
is ignored.
Rev. 1.01 Mar. 17, 2008 Page 10 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
4.2.4
SVRS
Format:
SVRS=&quot;&lt;path&gt;&quot;
Description:
This option is used to specify the path for output of &lt;config file&gt;_svr.c. If this option is used, a
definition of SVR_SOURCEPATH in the config file is ignored.
4.2.5
SVRI
Format:
SVRI=&quot;&lt;path&gt;&quot;
Description:
This option is used to specify the path for output of &lt;config file&gt;_svr.h. If this option is used, a
definition of SVR_INCPATH in the config file is ignored.
Rev. 1.01 Mar. 17, 2008 Page 11 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
4.3
Executing RPCGEN as a Build Phase in the High-performance
Embedded Workshop
After RPCGEN has been registered as a custom build phase in the workspace, it will be
automatically executed at the time of building.
(1) Defining Custom Placeholders
The following two custom placeholders must be defined.
• Path to RPCGEN
[Placeholder]: RPCGEN_INST
[Description]: RPCGEN Base directory
[Directory]: Directory under which RPCGEN is stored
• Path to Perl.exe
[Placeholder]: PERL_INST
[Description]: Perl Base directory
[Directory]: Directory under which perl.exe is stored
To define a custom placeholder, follow the procedure below.
Select [Setup-&gt;Customize] from the menu bar of the High-performance Embedded Workshop.
Then select the [Placeholders] tab of the [Customize] dialog box. Choose either [Application wide
custom placeholders] or [Workspace wide custom placeholders] and click on the [Add] button.
This opens the [New Custom Placeholder] dialog box shown in figure 4.1. Define the two custom
placeholders in this dialog box by filling in the information given above.
Figure 4.1 [New Custom Placeholder] Dialog Box
Rev. 1.01 Mar. 17, 2008 Page 12 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
(2) Adding a File Extension
To make execution as a custom build phase work, the filename extension “.x” for config files must
be added as a filename extension to be used in custom build phases. Select [Project-&gt;File
Extensions] from the menu bar of the High-performance Embedded Workshop. This opens the
[File Extensions] dialog box shown in figure 4.2.
Figure 4.2 [File Extensions] Dialog Box
Clicking the [Add] button opens the [Add File Extension] dialog box shown in figure 4.3. Add the
extension “.x” as shown in the figure.
Rev. 1.01 Mar. 17, 2008 Page 13 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
Figure 4.3 [Add File Extension] Dialog Box
Rev. 1.01 Mar. 17, 2008 Page 14 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
(3) Creating the RPCGEN Custom Build Phase
Select [Build-&gt;Build Phases] from the menu bar of the High-performance Embedded Workshop.
This opens the [Build Phases] dialog box shown in figure 4.4.
Figure 4.4 [Build Phases] Dialog Box
Clicking on the [Add] button invokes the [New Build Phase] wizard (figure 4.5).
Rev. 1.01 Mar. 17, 2008 Page 15 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
Figure 4.5 [New Build Phase - Step 1 of 4] Dialog Box
Click on [Next] to go to step 2.
Figure 4.6 [New Build Phase - Step 2 of 4] Dialog Box
Rev. 1.01 Mar. 17, 2008 Page 16 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
At step 2, select [Multiple phase]. Then select [RPCGEN config file] for [Select input file group].
Click on [Next] to go to step 3.
Figure 4.7 [New Build Phase - Step 3 of 4] Dialog Box
[Phase name]: Any name defined by the user (“rpcgen” in this example)
[Command]: $(PERL_INST)\perl.exe
[Default options]: -I $(RPCGEN_INST) $(RPCGEN_INST)\rpcgen.pl $(FULLFILE)
[Initial directory]: $(FILEDIR)
Click on [Next] to go to step 4.
Rev. 1.01 Mar. 17, 2008 Page 17 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
Figure 4.8 [New Build Phase - Step 4 of 4] Dialog Box
Although no environment variables need to be added for RPCGEN, you can add environment
variables for the Perl environment as required.
Creation of the RPCGEN custom build phase is now complete.
Next, the syntax for messages about RPCGEN must be defined. After the syntax has been defined,
the corresponding config file (*.x) will be opened in response to double-clicking on an RPCGEN
error message output in the [Build] window of the High-performance Embedded Workshop.
In the [Build Phases] dialog box shown in figure 4.4, select “rpcgen” and click on the [Modify]
button. The [Modify rpcgen] dialog box opens. Select the [Output Syntax] tab and type in the
syntax for errors shown in figure 4.9.
Figure 4.9 [Add Output Syntax] Dialog Box
Rev. 1.01 Mar. 17, 2008 Page 18 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
Now settings must be made so that the files output by RPCGEN will be deleted by
[Build-&gt;Clean Current Project] or [Build-&gt;Clean All Projects] from the High-performance
Embedded Workshop.
Select [Build-&gt;rpcgen] to open the [rpcgen Options] dialog box (figure 4.10). Select the [Output
Files] tab, check that the “RPCGEN config file” folder icon is active, and click on the [Add]
button. This opens the [Add Output File] dialog box, in which the names of the files output by
RPCGEN should be entered. For the filenames, refer to section 3.2, Files Generated by RPCGEN.
Figure 4.10 [rpcgen Options] Dialog Box
Figure 4.11 [Add Output File] Dialog Box
Rev. 1.01 Mar. 17, 2008 Page 19 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
(4) Settings in the [Build Phases] Dialog Box
The created RPCGEN custom build phase is shown at the bottom of the [Build Phases] dialog box.
Use the [Move Up] button to move “rpcgen” so that it is above “SH C/C++ Library Generator.”
Figure 4.12 [Build Phases] Dialog Box - [Build Order] Tab
Open the [Build File Order] tab. Select “RPCGEN config file” under [File group] and check the
box for [rpcgen] under [Phase order].
Rev. 1.01 Mar. 17, 2008 Page 20 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
Figure 4.13 [Build Phases] Dialog Box - [Build File Order] Tab
Setting of the RPCGEN build phase is now complete.
Rev. 1.01 Mar. 17, 2008 Page 21 of 128
REJ10J1822-0101
Section 4 Executing RPCGEN
Rev. 1.01 Mar. 17, 2008 Page 22 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
Section 5 Specifications of a Config File
A config file contains definitions used for creation of the client and server stubs. Specifically, such
definitions are made by appending keywords for passing to RPCGEN to the API of the server
functions (as described in section 6, Definitions of Server Functions). Read this section carefully
before creating your own config file. The extension for config files is “.x.”
One config file corresponds to the definition of one server. Do not attempt to define multiple
servers within a single config file.
5.1
Definition
Definitions must be written in either of the following formats.
&lt;keyword&gt;{...};
&lt;keyword&gt;;
For certain definitions, two or more items can be entered between the braces {...}.
Example:
GLOBAL_INCFILE { “types.h” “rpc_public.h” };
A config file can include the following definitions.
(1) Locations where the files created by RPCGEN will be stored
• PUB_INCPATH{…};
Path to &lt;config file&gt;_public.h
• CLNT_SOURCEPATH{…};
Path to &lt;config file&gt;_clnt.c
• CLNT_INCPATH{…};
Path to &lt;config file&gt;_clnt.h and &lt;config file&gt;_private.h
• SVR_SOURCEPATH{…};
Path to &lt;config file&gt;_svr.c
• SVR_INCPATH{…};
Path to &lt;config file&gt;_svr.h
(2) Controlling output of the #include directive to the files created by RPCGEN
• GLOBAL_INCFILE{…};
Include file common to the client and server stubs
• CLNT_INCFILE{…};
Include file for the client stub
• SVR_INCFILE{…};
Include file for the server stub
Rev. 1.01 Mar. 17, 2008 Page 23 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
(3) Server information
• SVR_NAME{…};
Server name
• SVR_ID{…};
Server ID
• SVR_VERSION{…};
Server version
• SVR_NOINIT;
The server-initialization function is not to be created.
• SVR_NOSHUTDOWN;
The server-shutdown function is not to be created.
• SVR_NOSTUBTBL;
The server-stub function table is not to be created.
• SVR_STATIC{…};
Use of a static server
• SVR_SECTION{…};
Section name to be given to the server stub
• SVR_AUTH;
How the server ID and server version will be assigned
(4) Client information
• CLNT_NOINIT;
The client-initialization function is not to be created.
• CLNT_NOSHUTDOWN;
The client-shutdown function is not to be created.
• CLNT_CALLCHK;
Facilitates saving the return values of RPC calls
• CLNT_SECTION{…};
Section name to be given to the client stub
(5) Server functions
• RPC_FUNC{…};
Server functions
Server functions are only defined within the braces of RPC_FUNC; multiple server functions can
be defined.
5.2
Comments
Comments in config files should be written in the same way as in the C and C++ languages. The
comments that are written before the first valid definition of a keyword will be output to the
beginning of all source and header files generated by RPCGEN.
Rev. 1.01 Mar. 17, 2008 Page 24 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.3
File Locations
Use the statements listed below to define paths to the files generated by RPCGEN. If these
definitions are omitted, RPCGEN will generate the source or header files in the current directory.
If a definition is otherwise correct but the defined path does not exist or the directory already
contains read-only files, RPCGEN displays an error message and terminates the processing.
The following definitions of file locations are available.
• PUB_INCPATH{…};
Path to &lt;config file&gt;_public.h
• CLNT_SOURCEPATH{…};
Path to &lt;config file&gt;_clnt.c
• CLNT_INCPATH{…};
Path to &lt;config file&gt;_clnt.h and &lt;config file&gt;_private.h
• SVR_SOURCEPATH{…};
Path to &lt;config file&gt;_svr.c
• SVR_INCPATH{…};
Path to &lt;config file&gt;_svr.h
5.3.1
PUB_INCPATH
Format:
PUB_INCPATH{&quot;&lt;path&gt;&quot;};
Description:
This statement defines the path under which &lt;config file&gt;_public.h will be generated. When the
PUBI option is used, a definition of PUB_INCPATH is ignored.
Example:
PUB_INCPATH{&quot;public_include&quot;};
&lt;config file&gt;_public.h will be generated in the public_include directory under the current
directory.
Rev. 1.01 Mar. 17, 2008 Page 25 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.3.2
CLNT_SOURCEPATH
Format:
CLNT_SOURCEPATH{&quot;&lt;path&gt;&quot;};
Description:
This statement defines the path under which &lt;config file&gt;_clnt.c will be generated. When the
CLNTS option is used, a definition of CLNT_SOURCEPATH is ignored.
Example:
CLNT_SOURCEPATH{&quot;clnt\source&quot;};
&lt;config file&gt;_clnt.c will be generated in the clnt\source directory under the current directory.
5.3.3
CLNT_INCPATH
Format:
CLNT_INCPATH{&quot;&lt;path&gt;&quot;};
Description:
This statement defines the path under which &lt;config file&gt;_clnt.h and &lt;config file&gt;_private.h will
be generated. When the CLNTI option is used, a definition of CLNT_INCPATH is ignored.
Example:
CLNT_INCPATH{&quot;C:\clnt\include&quot;};
&lt;config file&gt;_clnt.h and &lt;config file&gt;_private.h will be generated in the C:\clnt\include directory.
Rev. 1.01 Mar. 17, 2008 Page 26 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.3.4
SVR_SOURCEPATH
Format:
SVR_SOURCEPATH{&quot;&lt;path&gt;&quot;};
Description:
This statement defines the path under which &lt;config file&gt;_svr.c will be generated. When the
SVRS option is used, a definition of SVR_SOURCEPATH is ignored.
Example:
SVR_SOURCEPATH{&quot;svr\source&quot;};
&lt;config file&gt;_svr.c will be generated in the svr\source directory under the current directory.
5.3.5
SVR_INCPATH
Format:
SVR_INCPATH{&quot;&lt;path&gt;&quot;};
Description:
This statement defines the path under which &lt;config file&gt;_svr.h will be generated. When the
SVRI option is used, a definition of SVR_INCPATH is ignored.
Example:
SVR_INCPATH{&quot;svr\include&quot;};
&lt;config file&gt;_svr.h will be generated in the svr\include directory under the current directory.
Rev. 1.01 Mar. 17, 2008 Page 27 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.4
Controlling the Output of #include Directives
Use the statements listed below to output #include directives for user files to the files generated by
RPCGEN.
Note, however, that #include directives for the following include files will always be output.
Table 5.1 Default Include Files
Filename
Description
string.h
Standard include file for the compiler
types.h
Header file of data-type definitions; comes with Renesas
operating systems (such as the HI7200/MP)
rpc_public.h
RPC header file that comes with Renesas operating systems
(such as the HI7200/MP)
The following definitions are available for controlling the output of #include directives.
• GLOBAL_INCFILE{…};
Include file common to the client and server stubs
• CLNT_INCFILE{…};
Include file for the client stub
• SVR_INCFILE{…};
Include file for the server stub
Rev. 1.01 Mar. 17, 2008 Page 28 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.4.1
Order of #Include Directives
RPCGEN outputs #include directives to files in the following order.
(1) &lt;config file&gt;_clnt.c
1. Default include files (in the order given in table 5.1)
2. File(s) defined with GLOBAL_INCFILE (in the order of file definition)
3. File(s) defined with CLNT_INCFILE (in the order of file definition)
4. &lt;config file&gt;_public.h generated by RPCGEN (only if SVR_AUTH has not been defined)
5. &lt;config file&gt;_clnt.h generated by RPCGEN
6. &lt;config file&gt;_private.h generated by RPCGEN
(2) &lt;config file&gt;_svr.c
1. Default include files (in the order given in table 5.1)
2. File(s) defined with GLOBAL_INCFILE (in the order of file definition)
3. File(s) defined with SVR_INCFILE (in the order of file definition)
4. &lt;config file&gt;_public.h generated by RPCGEN (only if SVR_AUTH has not been defined)
5. &lt;config file&gt;_svr.h generated by RPCGEN
Rev. 1.01 Mar. 17, 2008 Page 29 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.4.2
GLOBAL_INCFILE
Format:
GLOBAL_INCFILE{&lt;file&gt;[Δ&lt;file&gt;...]};
Description:
This statement is for the output of #include directives for the specified files to &lt;config file&gt;_clnt.c
and &lt;config file&gt;_svr.c. File(s) must be specified in the form &quot;filename&quot; or &lt;filename&gt;. The
difference between these two formats is as defined in the specification of the #include directive.
When two or more files are to be specified, they must be separated by a space.
Example:
GLOBAL_INCFILE{&lt;math.h&gt; &quot;import\include\user_public.h&quot;};
5.4.3
CLNT_INCFILE
Format:
CLNT_INCFILE{&lt;file&gt;[Δ&lt;file&gt;...]};
Description:
This statement is for the output of #include directives for the specified files to &lt;config file&gt;_clnt.c.
File(s) must be specified in the form &quot;filename&quot; or &lt;filename&gt;. The difference between these two
formats is as defined in the specification of the #include directive.
When two or more files are to be specified, they must be separated by a space.
Example:
CLNT_INCFILE{&lt;math.h&gt; &quot;import\include\user_clnt.h&quot;};
Rev. 1.01 Mar. 17, 2008 Page 30 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.4.4
SVR_INCFILE
Format:
SVR_INCFILE{&lt;file&gt;[Δ&lt;file&gt;...]};
Description:
This statement is for the output of #include directives for the specified files to &lt;config file&gt;_svr.c.
File(s) must be specified in the form &quot;filename&quot; or &lt;filename&gt;. The difference between these two
formats is as defined in the specification of the #include directive.
When two or more files are to be specified, they must be separated by a space.
Example:
SVR_INCFILE{&lt;math.h&gt; &quot;import\include\user_svr.h&quot;};
Rev. 1.01 Mar. 17, 2008 Page 31 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.5
Server Information
The following types of definitions are available for defining server information.
• SVR_NAME{…};
Server name
• SVR_ID{…};
Server ID
• SVR_VERSION{…};
Server version
• SVR_NOINIT;
The server-initialization function is not to be created.
• SVR_NOSHUTDOWN;
The server-shutdown function is not to be created.
• SVR_NOSTUBTBL;
The server-stub function table is not to be created.
• SVR_STATIC{…};
Use of a static server
• SVR_SECTION{…};
Section name to be given to the server stub
• SVR_AUTH;
How the server ID and server version will be assigned
5.5.1
SVR_NAME
Format:
SVR_NAME {&lt;server name&gt;};
Description:
This statement defines the server name. The defined server name will be applied to the names of
stub functions, etc. generated by RPCGEN. This definition cannot be omitted; if it is omitted,
RPCGEN reports the error and terminates processing.
Example:
SVR_NAME{EXAMPLE};
Rev. 1.01 Mar. 17, 2008 Page 32 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.5.2
SVR_ID
Format:
SVR_ID {&lt;ID number&gt;};
Description:
This statement defines the server ID. The ID number can only be specified as a 4-byte integer
constant that can be represented as UINT32 or a C-language macro name to be replaced by such a
4-byte integer constant. If a C-language macro is used, this macro must have been defined in a file
specified by GLOBAL_INCFILE.
The server ID must, of course, be consistent across the entire system due to the specifications of
the HI7200/MP. RPCGEN does not detect duplication of server IDs.
The ID number is output to &lt;config file&gt;_public.h in the following format.
#define
RPCSVR_ID_&lt;server name&gt;
&lt;ID number&gt;
&lt;Server name&gt; refers to the server name defined with SVR_NAME.
SVR_ID cannot be omitted if a definition of SVR_AUTH has been omitted. Also refer to section
5.5.8, SVR_AUTH.
Example:
SVR_ID{1UL};
Rev. 1.01 Mar. 17, 2008 Page 33 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.5.3
SVR_VERSION
Format:
SVR_VERSION {&lt;server version&gt;};
Description:
This statement defines the server version. The server version can only be specified as a 4-byte
integer constant that can be represented as UINT32 or a C-language macro name to be replaced by
such a 4-byte integer constant. If a C-language macro is used, this macro must have been defined
in a file specified by GLOBAL_INCFILE.
The server version is output to &lt;config file&gt;_public.h in the following format.
#define
RPCSVR_VERS_&lt;server name&gt;
&lt;server version&gt;
SVR_VERSION cannot be omitted if SVR_AUTH has been omitted. Also refer to section 5.5.8,
SVR_AUTH.
Example:
SVR_VERSION{1UL};
5.5.4
SVR_NOINIT
Format:
SVR_NOINIT;
Description:
If this statement is present, RPCGEN will not create the server-initialization function. Use
SVR_NOINIT when the server-initialization function is provided as part of the application. Also
refer to sections 8.3, Server-Initialization Function, and 8.4, Server-Stub Function Table.
Example:
SVR_NOINIT;
Rev. 1.01 Mar. 17, 2008 Page 34 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.5.5
SVR_NOSTUBTBL
Format:
SVR_NOSTUBTBL;
Description:
The server-stub function table is rpc_server_info.ServerStubList, the table defined by
rpc_start_server() or rpc_start_server_with_paramarea() called by the server-initialization
function.
If this statement is present, RPCGEN will not create the server-stub function table. Use
SVR_NOSTUBTBL when the server-initialization function is provided as part of the application.
Also refer to section 8.4, Server-Stub Function Table.
Example:
SVR_NOSTUBTBL;
Rev. 1.01 Mar. 17, 2008 Page 35 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.5.6
SVR_NOSHUTDOWN
Format:
SVR_NOSHUTDOWN;
Description:
If this statement is present, RPCGEN will not create the server-shutdown function. Use
SVR_NOSHUTDOWN when the server-shutdown function is provided as part of the application.
The server-shutdown function generated by RPCGEN calls rpc_stop_server() to stop the server.
Although rpc_stop_server() generally allows specification of a callback function to be executed at
the time the server is stopped, no callback function is specifiable for the server-shutdown function
generated by RPCGEN. If you wish to use a callback function, specify SVR_NOSHUTDOWN
and implement the server-shutdown function on the user side.
Also refer to section 8.5, Server-Shutdown Function.
Example:
SVR_NOSHUTDOWN;
Rev. 1.01 Mar. 17, 2008 Page 36 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.5.7
SVR_STATIC
Format:
SVR_STATIC{&lt;size&gt;Δ&lt;section name&gt;};
Description:
This statement defines the server as static. If this definition is omitted, the server will be dynamic.
Note that SVR_STATIC cannot be used in conjunction with SVR_NOINIT.
&lt;Size&gt; indicates the size of the server parameter area. Specify an integer constant that can be
represented as UINT32. The specified value is rounded up to the nearest multiple of four.
&lt;Section name&gt; indicates the section name to be given to the server parameter area. Note,
however, that the actual section name will be ‘B’ followed by the section name given here. This
&lt;section name&gt; is not affected by definition of SVR_SECTION.
The server-parameter area information is output to &lt;config file&gt;_svr.c in the following format.
#pragma section &lt;section name&gt;
#pragma pack 4
static UINT8 ucServerArea_&lt;server name&gt;[ ALIGNUP4(&lt;size&gt;) ];
#pragma unpack
#pragma section
Note:
Since the SH2A-DUAL does not have a facility for the CPU cores to snoop on each other’s
caches, the server parameter area must be allocated in a non-cacheable area. Specify a section
name that can be distinguished from those of sections to be allocated in cacheable areas.
Example:
SVR_STATIC{ 512
D_SVRAREA};
Rev. 1.01 Mar. 17, 2008 Page 37 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.5.8
SVR_AUTH
Format:
SVR_AUTH;
Description:
There are two ways to assign the server ID and server version.
(1) Model 1
Model 1 applies when SVR_AUTH has not been specified.
In this model, the application does not recognize the server ID or server version. The server ID
and server version are determined within the client and server stubs generated by RPCGEN.
Each of the client-stub functions has the same API as the original server function. Server IDs and
server version information passed to the following functions will be ignored.
• Server-initialization function
• Server-shutdown function
• Client-initialization function
• Client-shutdown function
RPCGEN outputs the definitions of the server ID and server version to &lt;config file&gt;_public.h.
Since the client-stub functions and server- and client- initialization and shutdown functions
generated by RPCGEN have include statements for &lt;config file&gt;_public.h, the server ID and
server version information is passed to the RPC library.
If RPCGEN-generated files for the client and server are from different generations, the RPC
library treats any RPC call as an error.
Rev. 1.01 Mar. 17, 2008 Page 38 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
Server application
Client application
Any server IDs and
server versions in
parameters are ignored
func(...) (same API
as the original
server function)
Any server IDs and
server versions in
parameters are ignored
&lt;config file&gt;_public.h
Clientinitialization
function
Clientshutdown
function
???
Client???
stub
Server ID
Server version
Server ID and server version
Serverinitialization
function
Serverinitialization
function
Server ID and server version
RPC library
RPC library
Check that the server ID and
server version specifications
on the client match the server
Figure 5.1 Model 1
Rev. 1.01 Mar. 17, 2008 Page 39 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
(2) Model 2
Model 2 applies when SVR_AUTH has been specified.
In this model, the application assigns the server ID and server version. RPCGEN outputs
definitions of the server ID and server version in &lt;config file&gt;_public.h so that the application is
able to acquire this information.
Each of the client-stub functions is in the form of rpcclnt_&lt;server name&gt;_&lt;server function name&gt;
and its first and second parameters are the server ID and server version, respectively. The third and
subsequent parameters are the parameters of the actual server function. In other words, all of the
client-stub functions have APIs that differ from the server functions. To make the client-stub
functions have the same APIs as the original server functions, the user must implement wrapper
functions for the client-stub functions.
RPCGEN outputs definitions of the server ID and server version to &lt;config file&gt;_public.h.
Applications that call client-stub functions and the server-initialization function must thus include
&lt;config file&gt;_public.h so that the server ID and version are specified.
If &lt;config file&gt;_public.h for the client and server are from different generations, the RPC library
treats any RPC call as an error.
Rev. 1.01 Mar. 17, 2008 Page 40 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
&lt;config file&gt;_public.h
Server ID
Server version
Client application
Server ID and server version
Clientinitialization
function
Clientshutdown
function
rpcclnt_&lt;server name&gt;_func
(server ID, server version, ...)
???
Client???
stub
Server application
Server ID and server version
Serverinitialization
function
Serverinitialization
function
Server ID and server version
Server ID and server version
RPC library
RPC library
Check that the server ID and
server version specifications
on the client match the server
Figure 5.2 Model 2
Example:
SVR_AUTH;
Rev. 1.01 Mar. 17, 2008 Page 41 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.5.9
SVR_SECTION
Format:
SVR_SECTION{&lt;section name&gt;};
Description:
This statement specifies the section to which the server stubs will be assigned. When this
definition is omitted, one of the section names (alphabetical characters) listed below will
automatically be assigned. If SVR_SECTION has been defined, the actual section name will be
one of the letters listed below followed by &lt;section name&gt;.
• Program section:
‘P’
• Constant section:
‘C’
• Non-initialized data section:
‘B’
• Initialized data section:
‘D’
Example:
SVR_SECTION{ C_EXAMPLE };
Rev. 1.01 Mar. 17, 2008 Page 42 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.6
Client Information
The following definitions of client information are available.
• CLNT_NOINIT;
The client-initialization function is not to be created.
• CLNT_NOSHUTDOWN;
The client-shutdown function is not to be created.
• CLNT_CALLCHK;
Facilitates saving the return value in RPC calls
• CLNT_SECTION{…};
Section name to be given to the client stub
5.6.1
CLNT_NOINIT
Format:
CLNT_NOINIT;
Description:
RPCGEN creates the following client-initialization function in &lt;config file&gt;_clnt.c as the
standard:
INT32 rpcclnt_&lt;server name&gt;_init(UINT32 __ulRPCServerID, UINT32
__ulRPCServerVersion );
If the CLNT_NOINIT statement is present, RPCGEN will not create the client-initialization
function. Use CLNT_NOINIT when the client-initialization function is provided as part of the
application. Also refer to section 8.6, Client-Initialization Function.
Example:
CLNT_NOINIT;
Rev. 1.01 Mar. 17, 2008 Page 43 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.6.2
CLNT_NOSHUTDOWN
Format:
CLNT_NOSHUTDOWN;
Description:
RPCGEN creates the following client-shutdown function in &lt;config file&gt;_clnt.c as the standard:
INT32 rpcclnt_&lt;server name&gt;_shutdown(UINT32 __ulRPCServerID, UINT32
__ulRPCServerVersion );
If the CLNT_NOSHUTDOWN statement is present, RPCGEN will not create the client-shutdown
function. Use CLNT_NOSHUTDOWN when the client-shutdown function is provided as part of
the application.
The client-shutdown function generated by RPCGEN calls rpc_disconnect() to disconnect the
client from the server. Although rpc_disconnect() generally allows specification of a callback
function to be executed at the time the client is disconnected from the server, no callback function
is specifiable for the client-shutdown function generated by RPCGEN. If you wish to use a
callback function, specify CLNT_NOSHUTDOWN and implement the client-shutdown function
on the user side.
In the current HI7200/MP specification, a callback function is ignored even if one has been
specified for rpc_disconnect().
Also refer to section 8.7, Client-Shutdown Function.
Example:
CLNT_NOSHUTDOWN;
Rev. 1.01 Mar. 17, 2008 Page 44 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.6.3
CLNT_CALLCHK
Format:
CLNT_CALLCHK;
Description:
RPCGEN creates the following code in &lt;config file&gt;_clnt.c to facilitate saving of the return values
of RPC calls (rpc_call() or rpc_call_copycbk()) and outputs the API of *rpc_retval_adr() in
&lt;config file&gt;_clnt.h.
*rpc_retval_adr() = rpc_call(...);
rpc_retval_adr() must be implemented by the user. If this definition is omitted, the following code,
which discards the return value of an RPC call, will be created.
rpc_call(...);
For how to implement rpc_retval_adr(), refer to section 8.8, rpc_retval_adr().
Example:
CLNT_CALLCHK;
Rev. 1.01 Mar. 17, 2008 Page 45 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.6.4
CLNT_SECTION
Format:
CLNT_SECTION{&lt;section name&gt;};
Description:
This statement specifies the section to which the client stubs will be assigned. When this definition
is omitted, one of the section names (alphabetical characters) listed below will automatically be
assigned. If CLNT_SECTION has been defined, the actual section name will be one of the letters
listed below followed by the &lt;section name&gt;.
• Program section:
‘P’
• Constant section:
‘C’
• Non-initialized data section:
‘B’
• Initialized data section:
‘D’
Example:
CLNT_SECTION{ C_EXAMPLE };
Rev. 1.01 Mar. 17, 2008 Page 46 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
5.7
Server Functions
The following definition statement is available for defining server functions.
• RPC_FUNC{…};
5.7.1
Server functions
RPC_FUNC
Format:
RPC_FUNC
{
&lt;definitions of server functions&gt;;
...
};
Description:
Enter definitions of server functions between the braces {} of RPC_FUNC. For information on
definition statements for server functions, refer to section 6, Definitions of Server Functions.
Example:
RPC_FUNC
{
int ret = func1([IN DFLT]int par);
func2([OUT PTR]struct ST *ptr);
};
Rev. 1.01 Mar. 17, 2008 Page 47 of 128
REJ10J1822-0101
Section 5 Specifications of a Config File
Rev. 1.01 Mar. 17, 2008 Page 48 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Section 6 Definitions of Server Functions
6.1
Format
Server functions must be defined in one of the following formats.
(1) &lt;specification of the return value&gt; &lt;variable to be returned&gt; =
&lt;function name&gt;(&lt;parameter&gt;, ...)[&lt;option&gt;Δ...];
(2) &lt;function name&gt; (&lt;parameter&gt;, ...)[&lt;option&gt;Δ...];
(3) &lt;directive to extend the return value&gt;&lt;specification of the return
value&gt; &lt;variable to be returned&gt; = &lt;function name&gt;(&lt;parameter&gt;, ...)
[&lt;option&gt;Δ...];
RPCGEN keywords enclosed by [] are specified in &lt;parameter&gt;, &lt;option&gt;, and &lt;directive to
extend the return value&gt;.
Example 1:
Specification of a server function
int func(int par);
The function takes par as an input and returns a value of type int.
Definition of the server function
int ret = func([IN DFLT]int par);
Description
• Directive to extend the return value:
None
• Specification of the return value:
int ret =
• Function name:
func
• Parameter directive:
[IN DFLT]
• Parameter specification:
int par
• Option:
None
Rev. 1.01 Mar. 17, 2008 Page 49 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Example 2:
Specification of a server function
void func(struct ST *ptr);
The function takes ptr, a pointer to a structure of type ST, as an input and does not return a
value.
Definition of the server function
func([IN PTR]struct ST *ptr)[UNACK];
Description
• Directive to extend the return value:
None
• Specification of the return value:
None
• Function name:
func
• Parameter directive:
[IN PTR]
• Parameter specification:
struct ST *ptr
• Option:
[UNACK]
Rev. 1.01 Mar. 17, 2008 Page 50 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Example 3:
Specification of a server function
double func(double inf);
The input is inf and a value of type double will be returned.
Definition of the server function
[RETEXT]double dret = func([IN DFLT]double inf);
Description
• Directive to extend the return value:
[RETEXT]
• Specification of the return value:
double dret =
• Function name:
func
• Parameter directive:
[IN DFLT]
• Parameter specification:
double inf
• Option:
None
For details on each of the descriptions, refer to the following sections.
• Function-type directives:
6.2, Function-Type Directives
• Specifying the return value:
6.2, Function-Type Directives
• Function name:
6.3, Function Names
• Parameter:
6.4, Parameters
• Option:
6.7, Optional Keywords
Rev. 1.01 Mar. 17, 2008 Page 51 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.2
Function-Type Directives
6.2.1
Function with a Return Value
Format:
&lt;type of the return value&gt;Δ&lt;variable to hold the return value&gt;=
Description:
&lt;Variable to hold the return value&gt; refers to a local variable used to store the return value in both
client and server stubs. A parameter of the function may be specified as this variable.
Example:
Specification of a server function
int func(int par);
The function takes par as an input and returns a value of type int.
Definition of the server function
int ret = func([IN DFLT]int par);
Rev. 1.01 Mar. 17, 2008 Page 52 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.2.2
Function without a Return Value
Description:
For a function that doesn’t have a return value, a return-value specification must not be made.
Example:
Specification of a server function
void func(struct ST *ptr);
The function has no input and returns a value in the ST structure indicated by *ptr.
Definition of the server function
func([OUT PTR]struct ST *ptr);
Rev. 1.01 Mar. 17, 2008 Page 53 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.2.3
When the Return Value is not Representable as a 4-Byte Integer
Format:
[RETEXT]Δ&lt;type of the return value&gt;Δ
&lt;variable to hold the return value&gt;=
Description:
By default, the return value is cast into UINT32 in the server stub and then transferred to the
client. This value is cast back into the original type in the client stub and is then returned.
When the return value is of the following types, however, the definition must have an RETEXT
directive because the default behavior above is not applicable in these cases.
• 64-bit integer
• Floating point
• Structure-type object
• Union-type object
When a definition has an RETEXT directive, code will be generated such that a value is returned
from the server to the client by using the structure IOVEC.
Example:
Specification of a server function
double func(int par);
The function takes par as an input and returns a value of type double.
Definition of the server function
[RETEXT]double ret = func([IN DFLT]int par);
Rev. 1.01 Mar. 17, 2008 Page 54 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.3
Function Names
Description:
Type the name of the function you wish to use.
Example:
Specification of a server function
int func(int par);
The function takes par as an input and returns a value of type int.
Definition of the server function
int ret = func([IN DFLT]int par);
Rev. 1.01 Mar. 17, 2008 Page 55 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.4
Parameters
Parameters must be defined in the following format.
[parameter directive]&lt;parameter specification&gt;
The parameter directive is a declaration of the following parameter specification and has the form
given below.
[&lt;type of input/output&gt;Δ&lt;data type&gt;]
&lt;type of input/output&gt;: Specify one of the keywords given in section 6.5, Keywords for
Input/Output.
&lt;data type&gt;: Specify one of the keywords given in section 6.6, Keywords for Data Types.
&lt;parameter specification&gt;: Define the specification of the original function.
Table 6.1 lists the available combinations of keywords although details on input/output and data
types will be described in later sections. Note, however, that REF and DESC cannot be used at the
same time.
Table 6.1 Input/Output and Data Types
Input/Output
IN
OUT
INOUT
Data Type
Option
DFLT
STR
PTR
ARY
None
9
9
9
9
REF
⎯
9
9
9
DESC
9
9
9
9
None
⎯
⎯
9
9
REF
⎯
⎯
⎯
⎯
DESC
⎯
⎯
⎯
⎯
None
⎯
⎯
9
9
REF
⎯
⎯
⎯
⎯
DESC
⎯
⎯
⎯
⎯
9: Available
⎯: Not available (RPCGEN reports an error and terminates the processing)
Rev. 1.01 Mar. 17, 2008 Page 56 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.5
Keywords for Input/Output
The following three keywords are available for setting the input/output attributes of parameters.
• IN:
Input
• OUT:
Output
• INOUT:
Input and output
The following optional keywords can also be attached to the keywords listed above (note,
however, that REF and DESC cannot be used at the same time).
• REF:
Passing by reference
• DESC:
The parameter is not passed from the client to the server
Each of these keywords, specified with one of the data-type keywords listed in section 6.6, works
as a declaration of the subsequent parameter specification.
6.5.1
IN (Input)
Description:
This keyword defines a parameter as an input to the server function. The parameter is transferred
from the client to the server and is then passed to the server function.
Example:
Specification of a server function
int func(int par);
The function takes par as an input and returns a value of type int.
Definition of the server function
int ret = func([IN DFLT]int par);
Rev. 1.01 Mar. 17, 2008 Page 57 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.5.2
OUT (Output)
Description:
This keyword defines a parameter as an output from the server function. The data output by the
server function to the area specified by the parameter are returned to the client. This keyword can
only be used with the data-type keywords PTR and ARY.
Example:
Specification of a server function
void func(struct ST *ptr);
The function has no input and returns a value in the ST structure indicated by *ptr.
Definition of the server function
func([OUT PTR]struct ST *ptr);
Rev. 1.01 Mar. 17, 2008 Page 58 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.5.3
INOUT (Input and Output)
Description:
This keyword defines a parameter as an input to and output from the server function. The data in
the area specified by the parameter are transferred from the client to the server and then passed to
the server function. After that, the data output by the server function to the area specified by the
parameter are returned to the client. This keyword can only be used with the data-type keywords
PTR and ARY.
Example:
Specification of a server function
int func(struct ST *ptr);
The function takes *ptr, a pointer to a structure of type ST, as an input and returns a value in the
same area.
Definition of the server function
int ret = func([INOUT PTR]struct ST *ptr);
Rev. 1.01 Mar. 17, 2008 Page 59 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.5.4
REF (Passing by Reference)
Description:
This keyword specifies that only the address of the parameter will be passed between the client
and the server. REF is useful when the size of the parameter to be passed is large.
This keyword can be used in conjunction with IN and with the data-type keywords PTR, STR, and
ARY.
Figure 6.1 illustrates the difference between cases with and without REF.
[IN PTR] struct ST *ptr
Server parameter area
(in a non-cacheable area)
Parameter specified in the client
ptr
ptr
Copying
struct ST
struct ST
Parameter to be
passed to the
server function
Client area
[IN REF PTR] struct ST *ptr
Server parameter area
(in a non-cacheable area)
Parameter specified in the client
ptr
Copying
ptr
Parameter to be
passed to the
server function
struct ST
Client area*
*Note: When the device in use does not provide a facility for cache-snooping
between the CPU cores (as is the case for the SH2A-DUAL etc.), the server
parameter area must be allocated in a non-cacheable area.
Figure 6.1 REF
Rev. 1.01 Mar. 17, 2008 Page 60 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Without the REF specification, the data indicated by the pointer variable specified with PTR, STR,
or ARY are transferred. The transferred pointer points to a different area from that before the
transfer.
With the REF specification, the pointer variable is transferred. In this case, the pointer points to
the same area even after the transfer.
Note:
When the device in use does not provide a facility for cache-snooping between the CPU cores (as
is the case for the SH2A-DUAL etc.), the server parameter area must be allocated in a noncacheable area.
Example:
Specification of a server function
int func(struct ST *ptr);
*ptr is passed to func as the input. ptr is sure to keep pointing to a non-cacheable area.
Definition of the server function
int ret = func([IN REF PTR]struct ST *ptr);
Rev. 1.01 Mar. 17, 2008 Page 61 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.5.5
DESC (Specified Parameter is not Passed from the Client to the Server)
Description:
This keyword specifies that the parameter will not be passed from the client to the server. This
keyword can also be used with IN.
Example:
Specification of a server function
int func(void);
While the actual server function has no parameter, the client application calls an old API
function, func, which does have a parameter (int par).
Definition of the server function
int ret = func([IN DESC PTR]int par);
Rev. 1.01 Mar. 17, 2008 Page 62 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.6
Keywords for Data Types
Select one of the following four available keywords.
• DFLT:
Default
• PTR:
Pointer
• STR:
String
• ARY:
Array
When ARY is selected, the parameter for COUNT must also be specified.
6.6.1
DFLT (Default)
Input/Output Keywords Available for Use in Combination with DFLT:
IN
Description:
The parameter itself is transferred between the client and server. DFLT is only specifiable when
the parameter has any of the following types.
• Integer (signed short, unsigned short, signed long, unsigned long, signed int, or unsigned int)
• Character (signed char or unsigned char)
• Real number (float or double)
• Structure-type or union-type object that is not an array
Example:
Specification of a server function
int func(int par);
The function takes par as an input and returns a value of type int.
Definition of the server function
int ret = func([IN DFLT]int par);
Rev. 1.01 Mar. 17, 2008 Page 63 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.6.2
STR (String)
Input/Output Keywords Available in Combination with STR:
IN
Description:
The string specified as the parameter is transferred from the client to the server. STR is only
specifiable when the parameter is of the character type.
When STR is used with REF, the pointer to the string is transferred instead of the string itself. For
details, refer to section 6.5.4, REF (Passing by Reference).
Example:
Specification of a server function
int func(const char *s);
The function takes string s as an input and returns a value of type int.
Definition of the server function
int ret = func([IN STR]const char *s);
Rev. 1.01 Mar. 17, 2008 Page 64 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.6.3
PTR (Pointer)
Input/Output Keywords Available in Combination with PTR:
All
Description:
The data pointed to by a specified pointer are transferred between the client and the server. PTR is
only specifiable when the parameter is of the pointer type.
When IN has been selected and REF is used with PTR, the pointer value is transferred instead of
the data it indicates. For details, refer to section 6.5.4, REF (Passing by Reference).
Example:
Specification of a server function
void func(struct ST *ptr);
The function has no input and returns the structure of type ST that is indicated by *ptr.
Definition of the server function
func([OUT PTR]struct ST *ptr);
Rev. 1.01 Mar. 17, 2008 Page 65 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.6.4
ARY (Array)
Input/Output Keywords Available in Combination with ARY:
All
Description:
The data of a specified array are transferred between the client and the server. ARY is only
specifiable when the parameter is of the array type. As the parameter specification that follows this
keyword, define a parameter that expresses the first address of the array.
When ARY is used, it must be followed by a definition of COUNT, which indicates the number of
elements in the array to be passed between the client and the server. For details, refer to section
6.6.5, COUNT (Number of Elements in an Array).
When IN has been selected and REF is used with ARY, the pointer to the array is transferred
instead of the array it indicates. For details, refer to section 6.5.4, REF (Passing by Reference).
Example:
Refer to section 6.6.5, COUNT (Number of Elements in an Array).
Rev. 1.01 Mar. 17, 2008 Page 66 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.6.5
COUNT (Number of Elements in an Array)
Description:
When ARY is used, it must be followed by a definition of COUNT, which indicates the number of
elements in the array to be passed between the client and the server.
When the input/output keyword selected for ARY is IN
(1)
In this case, a parameter specification that includes ARY must be followed by a single definition
of COUNT to indicate the number of elements in the array.
&lt;parameter including ARY&gt;,&lt;definition of COUNT&gt;
COUNT is an expression that specifies the number of elements in the array to be passed from the
client to the server.
RPCGEN creates client-stub code that makes an RPC call after setting the size of an input IOVEC
structure by using an expression of the kind specified in figure 6.2. This must be taken into
account when COUNT is defined. For example, the expression for COUNT must not contain any
variables that hold the return value of a function. Figures 6.2 and 6.3 show the code for example 5
(without SVR_AUTH) of the examples introduced following the figures.
int func (struct INF * inf, struct ST * ptr )
{
IOVEC __input[2];
...
__input[ __ulInputParamCount ].pBaseAddress = (UINT8 *)(inf);
__input[ __ulInputParamCount++ ].ulSize
= sizeof(*inf);
...
if (((UINT32)(inf-&gt;count)) &gt; 0UL)
{
__input[ __ulInputParamCount ].pBaseAddress = (UINT8 *)(ptr);
__input[ __ulInputParamCount++ ].ulSize
= sizeof(*ptr) * ((UINT32)(inf-&gt;count));
}
...
rpc_call(...);
}
Figure 6.2 Code Output to the Client Stub (IN) for COUNT
Rev. 1.01 Mar. 17, 2008 Page 67 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
UINT32 rpcsvr_SMPL_func( rpc_server_stub_info * __pInfo )
{
...
inf = (struct INF *)( __pInfo-&gt;pucParamArea + __ulInputParamOffset);
__ulInputParamOffset += ALIGNUP4(sizeof(*inf));
if (((UINT32)(inf-&gt;count)) &gt; 0UL)
{
ptr = (struct ST *)( __pInfo-&gt;pucParamArea + __ulInputParamOffset);
}
...
ret = func( inf, ptr );
...
return ((UINT32)ret);
}
Figure 6.3 Code Output to the Server Stub (IN) for COUNT
Examples:
Example 1
Specification of a server function
int func(struct ST *ptr);
Pointer ptr to an array of 10 elements of the structure type (ST) will be passed.
Definition of the server function
int ret = func([IN ARY]struct ST *ptr, [COUNT]10);
Rev. 1.01 Mar. 17, 2008 Page 68 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Example 2
Specification of a server function
int func(struct ST *ptr, int count);
Pointer ptr to an array of count elements of the structure type (ST) will be passed.
Definition of the server function
int ret = func([IN ARY]struct ST *ptr, [COUNT]count,[IN DFLT]int
count);
Example 3
Specification of a server function
int func(int count , struct ST *ptr);
Pointer ptr to an array of count elements of the structure type (ST) will be passed.
Definition of the server function
int ret = func([IN DFLT]int count, [IN ARY]struct ST *ptr,
[COUNT]count);
Example 4
Specification of a server function
int func(struct ST *ptr, int *p_count);
Pointer ptr to an array of *p_count elements of the structure type (ST) will be passed.
Definition of the server function
int ret = func([IN ARY]struct ST *ptr, [COUNT]*p_count, [IN PTR]int
*p_count);
Rev. 1.01 Mar. 17, 2008 Page 69 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Example 5
Specification of a server function
int func(struct INF *inf, struct ST *ptr);
ptr points to an array to be given to the server function and inf indicates other input information.
It has a type-int member count, which indicates the number of elements in the array pointed to
by ptr.
Definition of the server function
int ret = func([IN PTR]struct INF *inf, [IN ARY]struct ST *ptr,
[COUNT]inf-&gt;count);
Rev. 1.01 Mar. 17, 2008 Page 70 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
(2)
When the input/output keyword selected for ARY is OUT
In this case, a parameter specification that includes ARY must be followed by two definitions of
COUNT to indicate the number of elements in the array.
&lt;parameter including ARY&gt;,&lt;definition of first COUNT&gt;,
&lt;definition of second COUNT&gt;
The first COUNT is the COUNT keyword followed by an expression that specifies the number of
elements in the array for storage of output by the client.
The second COUNT is the COUNT keyword followed by an expression that specifies the number
of elements in the array to be actually output by the server. This value must be less than or equal
to that specified for the first COUNT.
RPCGEN creates client-stub code that makes an RPC call after setting the size of an input IOVEC
structure by using an expression of the kind specified in figure 6.4. RPCGEN also creates serverstub code that makes a server-function call before setting the size of an output IOVEC structure by
using an expression of the kind specified in figure 6.5. This must be taken into account in defining
the first and second COUNT. For example, an expression for the first COUNT must not contain
any variables that hold the return value of a function. Figures 6.4 and 6.5 show the code for
example 8 (without SVR_AUTH) of the examples introduced following the figures.
Rev. 1.01 Mar. 17, 2008 Page 71 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
int func (struct INF * inf, struct ST * ptr )
{
IOVEC __input[1];
IOVEC __output[1];
...
__input[ __ulInputParamCount ].pBaseAddress = (UINT8 *)(inf);
__input[ __ulInputParamCount++ ].ulSize
= sizeof(*inf);
if (((UINT32)(inf-&gt;count)) &gt; 0UL)
{
__output[ __ulOutputParamCount ].pBaseAddress
__output[ __ulOutputParamCount++ ].ulSize
= (UINT8 *)(ptr);
= sizeof(*ptr) * ((UINT32)(inf-&gt;count));
}
...
rpc_call(...);
}
Figure 6.4 Code Output to the Client Stub (OUT) for First COUNT
Rev. 1.01 Mar. 17, 2008 Page 72 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
UINT32 rpcsvr_SMPL_func( rpc_server_stub_info * __pInfo )
{
...
inf = (struct INF *)( __pInfo-&gt;pucParamArea + __ulInputParamOffset);
__ulInputParamOffset += ALIGNUP4(sizeof(*inf));
if (((UINT32)(inf-&gt;count)) &gt; 0UL)
{
ptr = (struct ST *)( __pInfo-&gt;pucParamArea + __ulInputParamOffset);
}
ret = func( inf, ptr );
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount
].pBaseAddress = ptr;
if (((UINT32)(ret )) &gt; 0UL)
{
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount++ ].ulSize = sizeof(*ptr) *
((UINT32)(ret ));
}
else
{
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount++ ].ulSize = 0UL;
}
__pInfo-&gt;ulOutputIOVectorTableSize = 1UL;
return ((UINT32)ret);
}
Figure 6.5 Code Output to the Server Stub (OUT) for Second COUNT
Rev. 1.01 Mar. 17, 2008 Page 73 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Examples:
Example 1
Specification of a server function
int func(struct ST *ptr);
ptr points to an array for output that has 10 elements. func outputs all 10 elements.
Definition of the server function
int ret = func([OUT ARY]struct ST *ptr,[COUNT]10, [COUNT]10));
Example 2
Specification of a server function
int func(struct ST *ptr, int *p_count);
ptr points to an array for output that has 10 elements. *p_count, which is the return parameter of
func, indicates the number of elements to be output.
Definition of the server function
int ret = func([OUT ARY]struct ST *ptr,
[COUNT]10,[COUNT]*p_count,[OUT PTR]int *p_count);
Example 3
Specification of a server function
int func(struct ST *ptr);
ptr points to an array for output that has 10 elements. The return value from func indicates the
number of elements to be output.
Definition of the server function
int ret = func([OUT ARY]struct ST *ptr,[COUNT]10, [COUNT]ret);
Rev. 1.01 Mar. 17, 2008 Page 74 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Example 4
Specification of a server function
int func(struct ST *ptr, int *p_count);
ptr points to an array for output that has *p_count elements. func outputs the return parameter
*p_count as the number of elements.
Definition of the server function
int ret = func([OUT ARY]struct ST *ptr,
[COUNT]*p_count, [COUNT]*p_count,[INOUT PTR]int *p_count);
Example 5
Specification of a server function
int func(struct ST *ptr, int count);
ptr points to an array for output that has count elements. func outputs all count elements.
Definition of the server function
int ret = func([OUT ARY]struct ST *ptr,
[COUNT]count, [COUNT]count,[IN DFLT]int count);
Rev. 1.01 Mar. 17, 2008 Page 75 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Example 6
Specification of a server function
int func(struct INF *inf, struct ST *ptr, int *p_count);
ptr points to an array for output and inf indicates other input information. It has a type-int
member count, which indicates the number of elements in the array pointed to by ptr. func
outputs the return parameter *p_count as the number of elements.
Definition of the server function
int ret = func([IN PTR]struct INF *inf, [OUT ARY]struct ST *ptr,
[COUNT]inf-&gt;count, [COUNT]*p_count, [OUT PTR]int *p_count);
Example 7
Specification of a server function
int func(struct INF *inf, struct ST *ptr);
ptr points to an array for output and inf indicates other input information. It has a type-int
member count, which indicates the number of elements in the array pointed to by ptr. func
outputs all inf -&gt; count elements.
Definition of the server function
int ret = func([IN PTR]struct INF *inf, [OUT ARY]struct ST *ptr,
[COUNT]inf-&gt;count, [COUNT]inf-&gt;count );
Rev. 1.01 Mar. 17, 2008 Page 76 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Example 8
Specification of a server function
int func(struct INF *inf, struct ST *ptr);
ptr points to an array for output and inf indicates other input information, including a type-int
member count, which indicates the number of elements in the array pointed to by ptr. The return
value indicates the number of elements to be output.
Definition of the server function
int ret = func([IN PTR]struct INF *inf, [OUT ARY]struct ST *ptr,
[COUNT]inf-&gt;count, [COUNT]ret );
(3)
When the input/output keyword selected for ARY is INOUT
In this case, a parameter specification that includes ARY must be followed by two definitions of
COUNT to indicate the number of elements in the array.
&lt;parameter including ARY&gt;,&lt;definition of first COUNT&gt;,
&lt;definition of second COUNT&gt;
The first COUNT is the COUNT keyword followed by an expression that specifies the number of
elements in the array to be passed from the client to the server.
The second COUNT is the COUNT keyword followed by an expression that specifies the number
of elements in the array to be actually output by the server. This value must be less than or equal
to that specified for the first COUNT.
RPCGEN creates client-stub code that makes an RPC call after setting the size of an input IOVEC
structure by using an expression of the kind specified in figure 6.6. RPCGEN also creates serverstub code that makes a server-function call before setting the size of an output IOVEC structure by
using an expression of the kind specified in figure 6.7. This must be taken into account in defining
the first and second COUNT. For example, an expression for the first COUNT must not contain
any variables that hold the return value of a function. Figures 6.6 and 6.7 show the code for
example 8 (without SVR_AUTH) of the examples introduced following the figures.
Rev. 1.01 Mar. 17, 2008 Page 77 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
int func (struct INF * inf, struct ST * ptr )
{
IOVEC __input[2];
IOVEC __output[1];
...
__input[ __ulInputParamCount ].pBaseAddress = (UINT8 *)(inf);
__input[ __ulInputParamCount++ ].ulSize
= sizeof(*inf);
if (((UINT32)(inf-&gt;count)) &gt; 0UL)
{
__input[ __ulInputParamCount ].pBaseAddress = (UINT8 *)(ptr);
__input[ __ulInputParamCount++ ].ulSize
= sizeof(*ptr) * ((UINT32)(inf-&gt;count));
}
if (((UINT32)(inf-&gt;count)) &gt; 0UL)
{
__output[ __ulOutputParamCount ].pBaseAddress
__output[ __ulOutputParamCount++ ].ulSize
= (UINT8 *)(ptr);
= sizeof(*ptr) * ((UINT32)(inf-&gt;count));
}
...
rpc_call(...);
}
Figure 6.6 Code Output to the Client Stub (INOUT) for First COUNT
Rev. 1.01 Mar. 17, 2008 Page 78 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
UINT32 rpcsvr_SMPL_func( rpc_server_stub_info * __pInfo )
{
...
inf = (struct INF *)( __pInfo-&gt;pucParamArea + __ulInputParamOffset);
__ulInputParamOffset += ALIGNUP4(sizeof(*inf));
if (((UINT32)(inf-&gt;count)) &gt; 0UL)
{
ptr = (struct ST *)( __pInfo-&gt;pucParamArea + __ulInputParamOffset);
__ulInputParamOffset += ALIGNUP4(sizeof(*ptr) * ((UINT32)(inf-&gt;count)));
}
...
ret = func( inf, ptr );
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount
].pBaseAddress = ptr;
if (((UINT32)(ret )) &gt; 0UL)
{
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount++ ].ulSize = sizeof(*ptr) *
((UINT32)(ret ));
}
else
{
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount++ ].ulSize = 0UL;
}
__pInfo-&gt;ulOutputIOVectorTableSize = 1UL;
return ((UINT32)ret);
}
Figure 6.7 Code Output to the Server Stub (INOUT) for Second COUNT
Rev. 1.01 Mar. 17, 2008 Page 79 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Examples:
Example 1
Specification of a server function
int func(struct ST *ptr);
ptr points to an array for input and output that has 10 elements. func outputs all 10 elements.
Definition of the server function
int ret = func([INOUT ARY]struct ST *ptr,[COUNT]10, [COUNT]10);
Example 2
Specification of a server function
int func(struct ST *ptr, int *p_count);
ptr points to an array for input and output that has 10 elements. *p_count, which is the return
parameter of func, indicates the number of elements to be output.
Definition of the server function
int ret = func([INOUT ARY]struct ST *ptr,
[COUNT]10,[COUNT]*p_count,[OUT PTR]int *p_count);
Example 3
Specification of a server function
int func(struct ST *ptr);
ptr points to an array for input and output that has 10 elements. The return value from func
indicates the number of elements to be output.
Definition of the server function
int ret = func([INOUT ARY]struct ST *ptr,[COUNT]10, [COUNT]ret);
Rev. 1.01 Mar. 17, 2008 Page 80 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Example 4
Specification of a server function
int func(struct ST *ptr, int *p_count);
ptr points to an array for input and output that has *p_count elements. func outputs the return
parameter *p_count as the number of elements.
Definition of the server function
int ret = func([INOUT ARY]struct ST *ptr,
[COUNT]*p_count,[COUNT]*p_count,[INOUT PTR]int *p_count);
Example 5
Specification of a server function
int func(struct ST *ptr, int count);
ptr points to an array for input and output that has count elements. func outputs all count
elements.
Definition of the server function
int ret = func([INOUT ARY]struct ST *ptr,
[COUNT]count, [COUNT]count, [IN DFLT]int count);
Rev. 1.01 Mar. 17, 2008 Page 81 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Example 6
Specification of a server function
int func(struct INF *inf, struct ST *ptr, int *p_count);
ptr points to an array for input and output and inf indicates other input information, including a
type-int member count, which indicates the number of elements in the array pointed to by ptr.
func outputs the return parameter *p_count as the number of elements.
Definition of the server function
int ret = func([IN PTR]struct INF *inf, [INOUT ARY]struct ST *ptr,
[COUNT]inf-&gt;count, [COUNT]*p_count, [OUT PTR]int *p_count);
Example 7
Specification of a server function
int func(struct INF *inf, struct ST *ptr);
ptr points to an array for input and output and inf indicates other input information, including a
type-int member count, which indicates the number of elements in the array pointed to by ptr.
func outputs all inf -&gt; count elements.
Definition of the server function
int ret = func([IN PTR]struct INF *inf, [INOUT ARY]struct ST *ptr,
[COUNT]inf-&gt;count, [COUNT]inf-&gt;count );
Rev. 1.01 Mar. 17, 2008 Page 82 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Example 8
Specification of a server function
int func(struct INF *inf, struct ST *ptr);
ptr points to an array for input and output and inf indicates other input information, including a
type-int member count, which indicates the number of elements in the array pointed to by ptr.
The return value indicates the number of elements to be output.
Definition of the server function
int ret = func([IN PTR]struct INF *inf, [INOUT ARY]struct ST *ptr,
[COUNT]inf-&gt;count, [COUNT]ret );
6.7
Optional Keywords
The following optional keywords are available to control output to the client or server stub for the
individual server functions.
• SVRSTUB:
Server stub
• SVRFUNC:
Server function name
• CLNTSTUB:
Client stub
• UNACK:
Asynchronous call
• CLNTCOPYCBK:
RPC call by rpc_call_copycbk()
Two or more optional keywords may be specifiable. Note, however, that the same keyword must
not be used more than once. When a combination of keywords specified by the user is not valid,
RPCGEN shows an error message and terminates processing.
Multiple keywords must be delimited by commas.
Rev. 1.01 Mar. 17, 2008 Page 83 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
Table 6.2 shows the available combinations of optional keywords.
Table 6.2 Combinations of Optional Keywords
SVRSTUB
SVRSTUB
SVRFUNC
SVRFUNC
CLNTSTUB
UNACK
CLNTCOPYCBK
⎯
9
9
9
9
9
9
⎯
⎯
CLNTSTUB
9
UNACK
CLNTCOPYCBK
9: Available
⎯: Not available (RPCGEN reports an error and terminates processing)
6.7.1
SVRSTUB (Server Stub)
Format:
[SVRSTUB] &lt;server-stub function name&gt;
Description:
A server stub provided by the user is to be used, so RPCGEN does not create a server stub.
Example:
Specification of a server function
int func(int par);
The function takes par as an input and returns a value of type int. RPCGEN will not create a
server stub for func (i.e. will not create func_svrstub) because the user will provide this server
stub.
Definition of the server function
int ret = func([IN DFLT]int par)[SVRSTUB]func_svrstub;
Rev. 1.01 Mar. 17, 2008 Page 84 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.7.2
SVRFUNC (Server Function Name)
Format:
[SVRFUNC]&lt;replacement server function name&gt;
Description:
RPCGEN replaces the name of the server function to be called by the server stub with a specific
name. Use SVRFUNC when the name of a function as called by the client does not match the
name of the function as called by the server.
SVRFUNC cannot be used with SVRSTUB.
Example:
Specification of a server function
int func(int par);
The function takes par as an input and returns a value of type int. func on the server, however, is
named func_main.
Definition of the server function
int ret = func([IN DFLT]int par)[SVRFUNC]func_main;
Rev. 1.01 Mar. 17, 2008 Page 85 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.7.3
CLNTSTUB (Client Stub)
Format:
[CLNTSTUB]
Description:
A client stub provided by the user is to be used, so RPCGEN does not create a client stub.
Example:
Specification of a server function
int func(int par);
The function takes par as an input and returns a value of type int. RPCGEN will not create a
client stub for func because the user will provide this client stub.
Definition of the server function
int ret = func([IN DFLT]int par)[CLNTSTUB];
Rev. 1.01 Mar. 17, 2008 Page 86 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.7.4
UNACK (Asynchronous Call)
Format:
[UNACK]
Description:
The client makes RPC calls in asynchronous mode. When UNACK is not used, RPC calls are
made in synchronous mode.
UNACK cannot be used with CLNTSTUB.
Note:
When UNACK is used, the return value of the server function must be of type void and the
input/output keyword for parameters must be IN.
Example:
Specification of a server function
void func(int par);
The function takes par as an input. The client makes RPC calls in asynchronous mode.
Definition of the server function
func([IN DFLT]int par)[UNACK];
Rev. 1.01 Mar. 17, 2008 Page 87 of 128
REJ10J1822-0101
Section 6 Definitions of Server Functions
6.7.5
CLNTCOPYCBK (RPC Call by rpc_call_copycbk())
Format:
[CLNTCOPYCBK]&lt;function 1&gt; &lt;function 2&gt;
Description:
RPC calls are started by rpc_call_copycbk(). &lt;function 1&gt; and &lt;function 2&gt; are copy callback
functions specified in rpc_call_copycbk(). Specification of the two callback functions is
mandatory.
The prototype for the callback functions must conform with the RPC specifications and has to be
declared in a file included by the client stub.
Example:
Specification of a server function
int func(struct ST *ptr);
ptr is an array for output and has 10 elements, all of which are output by func. copy1() is used
for transfer from the client to the server while copy2() is used for transfer from the server to the
client.
Definition of the server function
int ret = func([OUT ARY]struct ST *ptr,[COUNT]10,
[COUNT]10)[CLNTCOPYCBK] copy1 copy2;
Rev. 1.01 Mar. 17, 2008 Page 88 of 128
REJ10J1822-0101
Section 7 Server Functions Not Supported by RPCGEN
Section 7 Server Functions Not Supported by RPCGEN
This section gives the types of functions not supported by RPCGEN. If a server function you are
using falls under the definitions in this section, use SVRSTUB or CLNTSTUB so that RPCGEN
will not create a server or client stub for the server function. A substitute server or client stub must
be implemented by the user.
7.1
Parameter
RPCGEN is not capable of correctly creating a client or server stub for server functions that have
parameters of the following types.
(1) Parameters with data types of undefined size
RPCGEN cannot handle parameters with data types that have undefined size. When such a
parameter is a pointer, however, using REF allows the creation of stub code for passing of the
pointer itself.
Example:
Specification of a server function
int func(void *par);
The function takes ptr, a pointer to data of undefined size, as an input and returns an int-type
value.
Definition of the server function
int ret = func([IN PTR]void *par);
In this case, an error will occur in compilation of the client stub.
int ret = func([IN REF PTR]void *par);
In this case, code to pass the value of par to the server will be created.
Rev. 1.01 Mar. 17, 2008 Page 89 of 128
REJ10J1822-0101
Section 7 Server Functions Not Supported by RPCGEN
(2) Multiple-level pointers
RPCGEN only recognizes the first level of multiple-level pointers.
Example:
Specification of a server function
int func(int **ptr);
The function takes ptr, a pointer to a pointer to int-type data, as an input.
Definition of the server function
int ret = func([IN PTR] int **ptr);
In this case, RPCGEN creates code to transfer *ptr from the client to the server. *ptr is a pointer
to the target int-type data, but this data (**ptr) will not be transferred.
(3) Function pointer
RPCGEN does not support server functions whose parameters are pointers to functions.
Rev. 1.01 Mar. 17, 2008 Page 90 of 128
REJ10J1822-0101
Section 7 Server Functions Not Supported by RPCGEN
7.2
Return Value
(1) Pointer
If a function returns a pointer-type value, this return value indicates an address in the server.
RPCGEN does not create any code to transfer the data indicated by the pointer from the server to
the client.
Example:
Specification of a server function
int *func(int par);
The return value is a pointer to int-type data.
Definition of the server function
int *ret = func([IN DFLT]int par);
In this case, ret is a pointer to int-type data returned within the server by the server function.
Rev. 1.01 Mar. 17, 2008 Page 91 of 128
REJ10J1822-0101
Section 7 Server Functions Not Supported by RPCGEN
Rev. 1.01 Mar. 17, 2008 Page 92 of 128
REJ10J1822-0101
Section 8 Application Interface
Section 8 Application Interface
8.1
Client-Stub Functions Generated by RPCGEN
The client-stub functions are called by the client application.
This section gives the specifications for the client-stub functions generated by RPCGEN. The
client-stub functions must be called in accord with the definitions in these specifications. If
CLNTSTUB is used to prevent creation of client-stub functions, the user must implement clientstub functions in accord with the specifications.
For details on SVR_AUTH, refer to section 5.5.8, SVR_AUTH.
(1) When SVR_AUTH has not been specified
Each of the client-stub functions has the same API as the actual server function. RPCGEN outputs
the client-stub functions themselves to &lt;config file&gt;_clnt.c but does not output prototype
declarations. Prepare a header file with the required prototype declarations and specify this header
file in the definition of CLNT_INCFILE or GLOBAL_INCFILE.
Example:
Contents of a config file
SVR_NAME{ EXAMPLE };
SVR_ID{ 1 };
SVR_VERSION{ 2 };
// SVR_AUTH;
RPC_FUNC{
int ret = func1([IN DFLT]int par1, [IN DFLT]int par2);
func2([OUT PTR]struct ST *ptr);
};
Specification of a client-stub function
int func1(int par1, int par2);
void func2(struct ST *ptr);
Rev. 1.01 Mar. 17, 2008 Page 93 of 128
REJ10J1822-0101
Section 8 Application Interface
(2) When SVR_AUTH has been specified
Each of the client-stub functions has a different API from the corresponding actual server function
and the server ID and server version information are added as parameters. RPCGEN outputs the
client-stub functions themselves to &lt;config file&gt;_clnt.c and the prototype declarations to &lt;config
file&gt;_clnt.h.
The name of each client-stub function takes the form rpcclnt_&lt;server name&gt;_&lt;server function
name&gt;. &lt;Server name&gt; refers to the server name defined with SVR_NAME and &lt;server function
name&gt; refers to server function names defined between the braces {} of RPC_FUNC.
The first and second parameters of the client-stub functions are the server ID and server version,
respectively. The names of the parameters are fixed to __ulID and __ulVers. The third and
subsequent parameters are the first and subsequent parameters of the actual server function and
their names are those defined in RPC_FUNC.
Example:
Contents of a config file
SVR_NAME{ EXAMPLE };
SVR_ID{ 1 };
SVR_VERSION{ 2 };
SVR_AUTH;
RPC_FUNC{
int ret = func1([IN DFLT]int par1, [IN DFLT]int par2);
func2([OUT PTR]struct ST *ptr);
};
Specification of a client-stub function
int rpcclnt_EXAMPLE_func1(UINT32 __ulID, UINT32 __ulVers, int par1, int
par2);
void rpcclnt_EXAMPLE_func2(UINT32 __ulID, UINT32 __ulVers, struct ST
*ptr);
Rev. 1.01 Mar. 17, 2008 Page 94 of 128
REJ10J1822-0101
Section 8 Application Interface
8.2
Server-Stub Functions Generated by RPCGEN
RPCGEN outputs the server-stub functions themselves to &lt;config file&gt;_svr.c and the prototype
declarations to &lt;config file&gt;_svr.h.
The name of each server-stub function takes the form rpcsvr_&lt;server name&gt;_&lt;server function
name&gt;. &lt;Server name&gt; refers to the server name defined with SVR_NAME and &lt;server function
name&gt; refers to server function names defined between the braces {} of RPC_FUNC.
Since the server-stub functions are called from within the RPC library, the user usually does not
need to recognize the APIs of the server-stub functions output by RPCGEN. If SVRSTUB is used
to prevent creation of the server-stub functions, however, the user must implement the server-stub
functions in accord with the specifications.
Example:
Contents of a config file
SVR_NAME{ EXAMPLE };
RPC_FUNC{
int ret = func1([IN DFLT]int par);
func([OUT PTR]struct ST *ptr);
};
Specification of a client-stub function
UINT32 rpcsvr_EXAMPLE_func1(rpc_server_stub_info * const __pInfo);
UINT32 rpcsvr_EXAMPLE_func2(rpc_server_stub_info * const __pInfo);
Rev. 1.01 Mar. 17, 2008 Page 95 of 128
REJ10J1822-0101
Section 8 Application Interface
8.3
Server-Initialization Function
The server-initialization function is called by the server application and starts up the server by
using rpc_start_server() or rpc_start_server_with_paramarea().
When SVR_NOINIT has not been specified, RPCGEN generates a server-initialization function
rpcsvr_&lt;server name&gt;_init. RPCGEN outputs the server-initialization function itself to &lt;config
file&gt;_svr.c and the prototype declaration to &lt;config file&gt;_svr.h.
&lt;Server name&gt; refers to the server name defined with SVR_NAME.
When SVR_NOINIT has been specified, RPCGEN does not generate a server-initialization
function. The server-initialization function must be provided by the user if one is required.
The specification of the server-initialization function generated by RPCGEN is as follows.
• C-language API
INT32 rpcsvr_&lt;server name&gt;_init( rpc_svr_config *__config);
• Return value
The return value of rpc_start_server() or rpc_start_server_with_paramarea()
• Parameter: __config
The definition of an rpc_svr_config structure is given below. Each of the members has the
same meaning as that of the rpc_server_info structure.
typedef struct {
UINT32 ulRPCServerID;
UINT32 ulRPCServerVersion;
UINT32 ServerStubTaskPriority;
UINT32 ulStubStackSize;
UINT32 ulMaxParamAreaSize;
void
*pUserDefinedData;
} rpc_svr_config;
Rev. 1.01 Mar. 17, 2008 Page 96 of 128
REJ10J1822-0101
Section 8 Application Interface
• Specification
The server is started up by calling rpc_start_server() when SVR_STATIC has not been
specified or rpc_start_server_with_paramarea() when SVR_STATIC has been specified.
When SVR_AUTH has not been specified, however, the definitions of server ID and version in
__config. UlRPCServerID and __config. UlRPCServerVersion are ignored. Instead, the
macros RPCSVR_ID_&lt;server name&gt; and RPCSVR_VERS_&lt;server name&gt; output to &lt;config
file&gt;_public.h are taken as the server ID and version in starting up the server.
8.4
Server-Stub Function Table
The server-stub function table is rpc_server_info.ServerStubList, the table defined by
rpc_start_server() or rpc_start_server_with_paramarea() called by the server-initialization
function.
(1) With neither SVR_NOSTUBTBL nor SVR_NOINIT
RPCGEN generates the server-initialization function and server-stub function table. Only the
server-initialization function generated by RPCGEN looks up the server-stub function table. Thus
RPCGEN outputs the server-stub function table as static data to &lt;config file&gt;_svr.c.
(2) Without SVR_NOSTUBTBL and with SVR_NOINIT
RPCGEN does not generate the server-initialization function but does generate the server-stub
function table. RPCGEN outputs the server-stub function table in the form given below to &lt;config
file&gt;_svr.c. The server-initialization function provided in the application must look up the serverstub function table to call rpc_start_server() or rpc_start_server_with_paramarea().
UINT32 (* const __rpcsvr_&lt;server name&gt;
_StubTable[])(rpc_server_stub_info *) =
{
&lt;server-stub function name&gt;,
&lt;server-stub function name&gt;,
};
&lt;Server name&gt; refers to the server name defined with SVR_NAME.
Rev. 1.01 Mar. 17, 2008 Page 97 of 128
REJ10J1822-0101
Section 8 Application Interface
(3) With SVR_NOSTUBTBL and without SVR_NOINIT
RPCGEN does not generate the server-stub function table but does generate the serverinitialization function. RPCGEN assumes that the server-stub function table shown below is
provided in the application and outputs the server-initialization function, which externally refers to
the table, to &lt;config file&gt;_svr.c.
UINT32 (* const __rpcsvr_&lt;server name&gt;_StubTable[])
(rpc_server_stub_info *) =
{
&lt;server-stub function name&gt;,
&lt;server-stub function name&gt;,
};
&lt;Server name&gt; refers to the server name defined with SVR_NAME.
(4) With SVR_NOSTUBTBL and SVR_NOINIT
RPCGEN generates neither a server-initialization function nor a server-stub function table, so they
must be provided in the application.
Rev. 1.01 Mar. 17, 2008 Page 98 of 128
REJ10J1822-0101
Section 8 Application Interface
8.5
Server-Shutdown Function
The server-shutdown function is called by the server application and stops the server by using
rpc_stop_server().
When SVR_NOSHUTDOWN has not been specified, RPCGEN generates a server-shutdown
function rpcsvr_&lt;server name&gt;_shutdown. RPCGEN outputs the server-shutdown function itself
to &lt;config file&gt;_svr.c and the prototype declaration to &lt;config file&gt;_svr.h.
&lt;Server name&gt; refers to the server name defined with SVR_NAME.
When SVR_NOSHUTDOWN has been specified, RPCGEN does not generate a server-shutdown
function. The server-shutdown function must be provided by the user if one is required.
The specification of the server-shutdown function generated by RPCGEN is as follows.
• C-language API
INT32 rpcsvr_&lt;server name&gt;_shutdown(UINT32 __ulServerID, UINT32
__ulServerVersion);
• Return value
The return value of rpc_stop_server()
• Parameter: __ulServerID and __ulServerVersion
These parameters indicate the server ID and server version, respectively. When SVR_AUTH
has not been specified, however, the server ID and server version are ignored. Instead, the
macros RPCSVR_ID_&lt;server name&gt; and RPCSVR_VERS_&lt;server name&gt; output to &lt;config
file&gt;_public.h are taken as the server ID and server version in stopping the server.
• Specification
The server is stopped by calling rpc_stop_server() and no callback function is specifiable for
the server-shutdown function. If you wish to use a callback function, specify
SVR_NOSHUTDOWN and implement the server-shutdown function on the user side.
Rev. 1.01 Mar. 17, 2008 Page 99 of 128
REJ10J1822-0101
Section 8 Application Interface
8.6
Client-Initialization Function
The client-initialization function is called by the client application and initiates connection to the
server by using rpc_connect().
When CLNT_NOINIT has not been specified, RPCGEN generates a client-initialization function
rpcclnt_&lt;server name&gt;_init. RPCGEN outputs the client-initialization function itself to &lt;config
file&gt;_clnt.c and the prototype declaration to &lt;config file&gt;_clnt.h.
&lt;Server name&gt; refers to the server name defined with SVR_NAME.
When CLNT_NOINIT has been specified, RPCGEN does not generate a client-initialization
function. The client-initialization function must be provided by the user if one is required.
The specification of the client-initialization function generated by RPCGEN is as follows.
• C-language API
INT32 rpcclnt_&lt;server name&gt;_init(UINT32 __ulRPCServerID, UINT32
__ulRPCServerVersion);
• Return value
The return value of rpc_connect()
• Parameter: __ulRPCServerID and __ulRPCServerVersion
These parameters indicate the server ID and server version, respectively. When SVR_AUTH
has not been specified, however, the server ID and server version are ignored. Instead, the
macros RPCSVR_ID_&lt;server name&gt; and RPCSVR_VERS_&lt;server name&gt; output to &lt;config
file&gt;_public.h are taken as the server ID and version in initiating connection to the server.
• Specification
Connection to the server is initiated by using rpc_connect().
Rev. 1.01 Mar. 17, 2008 Page 100 of 128
REJ10J1822-0101
Section 8 Application Interface
8.7
Client-Shutdown Function
The client-shutdown function is called by the client application and terminates the connection to
the server by using rpc_disconnect().
When CLNT_NOSHUTDOWN has not been specified, RPCGEN generates a client-shutdown
function rpcclnt_&lt;server name&gt;_shutdown. RPCGEN outputs the client-shutdown function itself
to &lt;config file&gt;_clnt.c and the prototype declaration to &lt;config file&gt;_clnt.h.
&lt;Server name&gt; refers to the server name defined with SVR_NAME.
When CLNT_NOSHUTDOWN has been specified, RPCGEN does not generate a client-shutdown
function. The client-shutdown function must be provided by the user if one is required.
The specification of the client-shutdown function generated by RPCGEN is as follows.
• C-language API
INT32 rpcclnt_&lt;server name&gt;_shutdown(UINT32 __ulRPCServerID, UINT32
__ulRPCServerVersion);
• Return value
The return value of rpc_disconnect()
• Parameter: __ulRPCServerID and __ulRPCServerVersion
These parameters indicate the server ID and server version, respectively. When SVR_AUTH
has not been specified, however, the server ID and server version are ignored. Instead, the
macros RPCSVR_ID_&lt;server name&gt; and RPCSVR_VERS_&lt;server name&gt; output to &lt;config
file&gt;_public.h are taken as the server ID and server version in terminating a connection to the
server.
• Specification
Connection to the server is terminated by using rpc_disconnect() and no callback function is
specifiable for the client-shutdown function. In the current HI7200/MP specification,
rpc_disconnect() handles no processing other than terminating the connection to the server.
Rev. 1.01 Mar. 17, 2008 Page 101 of 128
REJ10J1822-0101
Section 8 Application Interface
8.8
rpc_retval_adr()
rpc_retval_adr() is a client function to be provided by the user when CLNT_CALLCHK (refer to
section 5.6.3, CLNT_CALLCHK) is specified.
rpc_retval_adr() must be created according to the specification given below.
• C-language API
INT32 *rpc_retval_adr(void);
• Specification
The address to hold the return value that depends on the context (task or non-task) in which
rpc_retval_adr() was called is returned.
Rev. 1.01 Mar. 17, 2008 Page 102 of 128
REJ10J1822-0101
Section 8 Application Interface
• Example of implementation (for the HI7200/MP)
#define MAXTSKID
10
/* Maximum task ID */
static INT32 retval[MAXTSKID+1];
/* Array to hold the return */
/* value in the context */
/* [0]: Non-task context */
/* [1] to [MAXTSKID]: Task ID */
INT32 *rpc_retval_adr(void)
{
INT32 *retval_adr;
ID
myid;
if(sns_ctx() == TRUE)
{
/* In a non-task context */
retval_adr = retval;
}
else
{
/* In a task context */
get_tid(%myid);
retval_adr = &amp;retval[GET_LOCALID(myid)];
}
return retval_adr;
}
Rev. 1.01 Mar. 17, 2008 Page 103 of 128
REJ10J1822-0101
Section 8 Application Interface
8.9
&lt;Config file&gt;_public.h
The following macro definitions are output to &lt;config file&gt;_public.h.
#define RPCSVR_ID_&lt;server name&gt;
#define RPCSVR_VERS_&lt;server name&gt;
&lt;server ID&gt;
&lt;server version&gt;
&lt;Server name&gt;, &lt;server ID&gt;, and &lt;server version&gt; refer to the server name, server ID, and server
version defined with SVR_NAME, SVR_ID, and SVR_VERSION, respectively.
The position of &lt;config file&gt;_public.h depends on whether SVR_AUTH has been specified or not.
For details, refer to section 5.5.8, SVR_AUTH.
8.10
Local Variables Used in the Source Code Created by RPCGEN
In the source code of the client and server stubs, the names of local variables start with two
underscores (&quot;__&quot;). In the client and server stubs, on the other hand, RPCGEN uses the parameter
names specified in the definitions of server functions. For this reason, the parameter names
specified in the definitions of server functions must not start with two underscores (&quot;__&quot;).
Rev. 1.01 Mar. 17, 2008 Page 104 of 128
REJ10J1822-0101
Section 9 Notes
Section 9 Notes
(1) Check that the source program generated by RPCGEN works as intended.
We do not guarantee the operation of the program generated by RPCGEN. Be sure to check that
the program works as you intended.
RPCGEN does not report errors except in cases where a fatal error has been detected (i.e. when
continuing with current processing is impossible).
(2) Do not modify the contents of the files generated by RPCGEN.
Even if the contents of the source files generated by RPCGEN are not as you expected, do not
modify the files manually. This is because files that have been manually modified by the user may
be overwritten when RPCGEN is re-executed. Instead of manually correcting the generated files,
check and correct the contents of config files.
Rev. 1.01 Mar. 17, 2008 Page 105 of 128
REJ10J1822-0101
Section 9 Notes
Rev. 1.01 Mar. 17, 2008 Page 106 of 128
REJ10J1822-0101
Section 10 Error Messages
Section 10 Error Messages
RPCGEN shows an error message and terminates processing only when it has detected a fatal
error (i.e. when continuing with the current processing is impossible). In other words, RPCGEN
behaves as if it has successfully completed code generation in many cases where it has not in fact
done so.
Cases in which no errors will be detected:
Note: “-&gt;” in the list below indicates a behavior in the current implementation. The behavior may
be changed in a future implementation.
• A specific keyword is used multiple times.
-&gt; The first instance of the keyword to be found is valid.
• A server function with a specific name is declared multiple times.
-&gt; An error will be reported on compilation of the generated stub.
• An invalid keyword is specified.
-&gt; This is simply ignored.
• SVR_ID (server ID) is a value with size exceeding 4 bytes.
-&gt; An error will be reported on compilation of the file to include rpc_public.h.
• A parameter for which PTR has been specified is not of the pointer type.
-&gt; RPC calls will lead to abnormal operation such as CPU exceptions.
10.1
Format
Error messages are output in the format shown below. The following sections list the error
messages and their meanings.
&lt;Config file&gt; : (E) &lt;Error message&gt;
Rev. 1.01 Mar. 17, 2008 Page 107 of 128
REJ10J1822-0101
Section 10 Error Messages
10.2
General
Cannot open configuration file.
RPCGEN cannot access the specified config file.
No &lt;keyword&gt; definition.
&lt;keyword&gt; must not be omitted.
The &lt;keyword&gt; directory doesn't exist.
The directory &lt;keyword&gt; was specified as a path by a definition such as PUB_INCPATH but
does not exist.
Cannot create file. File: &lt;filename&gt;
RPCGEN cannot generate the file &lt;filename&gt;.
Cannot create temporary file.
RPCGEN cannot generate intermediate files in the current directory.
10.3
Definition Errors (other than RPC_FUNC)
Illegal &lt;keyword&gt; definition.
The definition of parameter &lt;keyword&gt; is illegal.
Cannot define both &lt;keyword 1&gt; and &lt;keyword 2&gt;.
&lt;keyword 1&gt; and &lt;keyword 2&gt; must not be specified at the same time.
10.4
Definition Errors (RPC_FUNC)
[RPC_FUNC] Cannot define both &lt;keyword 1&gt; and &lt;keyword 2&gt; for
&quot;&lt;function name&gt;&quot;.
In the definition of &lt;function name&gt;, &lt;keyword 1&gt; and &lt;keyword 2&gt; must not be specified at
the same time.
[RPC_FUNC] Illegal &lt;keyword&gt; definition for &quot;&lt;function name&gt;&quot;.
In the definition of &lt;function name&gt;, parameter &lt;keyword&gt; is illegal.
[RPC_FUNC] Illegal COUNT definition for &quot;&lt;function name&gt;&quot;.
In the definition of &lt;function name&gt;, COUNT following ARY is illegal.
Rev. 1.01 Mar. 17, 2008 Page 108 of 128
REJ10J1822-0101
Section 11 Samples
Section 11 Samples
This section introduces samples of the code in a config file and the corresponding output files. To
create these samples, we have used the C standard library functions and the HI7200/MP service
calls listed in table 11.1. This is simply because we have assumed that most users will understand
these functions, not because the functions should necessarily be distributed by the RPC facility.
Table 11.1 Files Provided for Illustration
Server Function
Description
double atof(const char *nptr);
C standard library function (stdlib.h)
int atoi(const char *nptr);
C standard library function (stdlib.h) with REF
ER ref_tsk2(ID tskid, T_RTSK *pk_rtsk);
Service call ref_tsk
ER ref_sem2(ID semid, T_RSEM *pk_rsem);
Service call ref_sem
Rev. 1.01 Mar. 17, 2008 Page 109 of 128
REJ10J1822-0101
Section 11 Samples
11.1
Config File (sample.x)
/**********************************************************************
File Header Comment : Sample Config File for RPCGEN
**********************************************************************/
PUB_INCPATH
{&quot;include&quot;};
// Output path for xxx_public.h
SVR_SOURCEPATH
{&quot;server&quot;};
// Output path xxx_svr.c
SVR_INCPATH
{&quot;server&quot;};
// Output path xxx_svr.h
CLNT_SOURCEPATH {&quot;client&quot;};
// Output path xxx_clnt.c
CLNT_INCPATH
xxx_private.h
{&quot;client&quot;};
// Output path xxx_clnt.h and
GLOBAL_INCFILE
{&lt;stdlib.h&gt; &quot;kernel.h&quot;};
//SVR_INCFILE
{&quot;...&quot; &quot;...&quot;};
// Include files for xxx_svr.c
//CLNT_INCFILE
{&quot;...&quot; &quot;...&quot;};
// Include files for xxx_clnt.c
// Include files for xxx_svr.c and xxx_clnt.c
SVR_NAME
{SMPL};
// Server name
SVR_ID
{1};
// Server ID
SVR_VERSION {2};
// Server version
// SVR_AUTH;
// How to authenticate
// SVR_NOINIT;
// Don't generate server initialize function
// SVR_NOSTUBTBL;
// Don't generate server stub function table
// SVR_NOSHUTDOWN;
// Don't generate server shutdown function
// SVR_STATIC {size, section};
// Use static server
SVR_SECTION {C_SAMPLE};
// Section name for server stubs
// CLNT_NOINIT;
// Don't generate client initialize function
// CLNT_NOSHUTDOWN;
// Don't generate server shutdown function
CLNT_CALLCHK;
// Save return value of RPC-call
CLNT_SECTION{C_SAMPLE};
// Section name for client stubs
RPC_FUNC
// Define server functions
Rev. 1.01 Mar. 17, 2008 Page 110 of 128
REJ10J1822-0101
Section 11 Samples
{
// stdlib.h
[RETEXT] double ret = atof ([IN STR] const char *nptr);
// nptr does not have to point to non-cached area
int ret = atoi ([IN REF STR] const char *nptr);
// nptr must point to non-cached area
// HI7200/MP service calls (renamed from original service call
name)
ER ercd = ref_tsk2 ([IN DFLT] ID tskid, [OUT PTR] T_RTSK *pk_rtsk);
ER ercd = ref_sem2 ([IN DFLT] ID semid, [OUT PTR] T_RSEM *pk_rsem);
};
Rev. 1.01 Mar. 17, 2008 Page 111 of 128
REJ10J1822-0101
Section 11 Samples
11.2
sample_clnt.h
/**********************************************************************
File Header Comment : Sample Config File for RPCGEN
**********************************************************************/
/**********************************************************************
* Do not edit, unless you really know what you are doing,
* this file was automatically generated by:
*
*
rpcgen.pl on 2007/11/28
12:54
*
* Be aware that this file may be generated as part of the build and
* therefore any changes made by hand will possibly be lost on a
* rebuild.
**********************************************************************/
#ifndef _RPC_SMPL_CLNT_H
#define _RPC_SMPL_CLNT_H
#ifdef __cplusplus
extern &quot;C&quot; {
#endif
INT32 rpcclnt_SMPL_init ( UINT32 __ulRPCServerID, UINT32
__ulRPCServerVersion );
INT32 rpcclnt_SMPL_shutdown ( UINT32 __ulRPCServerID, UINT32
__ulRPCServerVersion );
double atof (
int atoi (
const char * nptr );
const char * nptr );
ER ref_tsk2 ( ID tskid,
T_RTSK * pk_rtsk );
ER ref_sem2 ( ID semid,
T_RSEM * pk_rsem );
extern INT32 *rpc_retval_adr( void );
#ifdef __cplusplus
}
Rev. 1.01 Mar. 17, 2008 Page 112 of 128
REJ10J1822-0101
Section 11 Samples
#endif
#endif /* End of _RPC_SMPL_CLNT_H */
11.3
sample_private.h
/**********************************************************************
File Header Comment : Sample Config File for RPCGEN
**********************************************************************/
/**********************************************************************
* Do not edit, unless you really know what you are doing,
* this file was automatically generated by:
*
*
rpcgen.pl on 2007/11/28
12:54
*
* Be aware that this file may be generated as part of the build and
* therefore any changes made by hand will possibly be lost on a
* rebuild.
**********************************************************************/
#ifndef _RPC_SMPL_PRIVATE_H
#define _RPC_SMPL_PRIVATE_H
enum
{
RPC_SMPL_ATOF,
RPC_SMPL_ATOI,
RPC_SMPL_REF_TSK2,
RPC_SMPL_REF_SEM2,
};
#endif /* End of _RPC_SMPL_PRIVATE_H */
Rev. 1.01 Mar. 17, 2008 Page 113 of 128
REJ10J1822-0101
Section 11 Samples
11.4
sample_clnt.c
/**********************************************************************
File Header Comment : Sample Config File for RPCGEN
**********************************************************************/
/**********************************************************************
* Do not edit, unless you really know what you are doing,
* this file was automatically generated by:
*
*
rpcgen.pl on 2007/11/28
12:54
*
* Be aware that this file may be generated as part of the build and
* therefore any changes made by hand will possibly be lost on a
* rebuild.
**********************************************************************/
#include &lt;string.h&gt;
#include &quot;types.h&quot;
#include &quot;rpc_public.h&quot;
#include &lt;stdlib.h&gt;
#include &quot;kernel.h&quot;
#include &quot;sample_public.h&quot;
#include &quot;sample_clnt.h&quot;
#include &quot;sample_private.h&quot;
#pragma section C_SAMPLE
double atof (
const char * nptr )
{
UINT32 __ulLastOutputIOVectorSize;
rpc_call_info __info;
UINT32 __ulInputParamCount = 0UL;
IOVEC __input[1];
Rev. 1.01 Mar. 17, 2008 Page 114 of 128
REJ10J1822-0101
Section 11 Samples
UINT32 __ulOutputParamCount = 0UL;
IOVEC __output[1];
double ret;
UINT32 __ulReturn;
__info.ulMarshallingType
= 0UL;
__info.ulServerID
= RPCSVR_ID_SMPL;
__info.ulServerVersion
= RPCSVR_VERS_SMPL;
__info.ulServerProcedureID
= RPC_SMPL_ATOF;
__info.AckMode
= RPC_ACK;
__info.pInputIOVectorTable
__info.ulInputIOVectorTableSize
= __input;
= sizeof(__input) / sizeof (IOVEC);
__info.pOutputIOVectorTable
= __output;
__info.ulOutputIOVectorTableSize = sizeof(__output) / sizeof
(IOVEC);
__info.pulLastOutputIOVectorSize
= &amp;__ulLastOutputIOVectorSize;
__info.pulReturnValue
= (UINT32 *)&amp;__ulReturn;
__input[ __ulInputParamCount ].pBaseAddress = (UINT8 *)(nptr);
__input[ __ulInputParamCount++ ].ulSize = strlen((const char
*)(nptr)) + 1UL;
__output[ __ulOutputParamCount ].pBaseAddress
= &amp;ret;
__output[ __ulOutputParamCount++ ].ulSize
= sizeof(double);
*rpc_retval_adr() =
rpc_call( &amp;__info );
return ret;
}
int atoi (
const char * nptr )
{
UINT32 __ulLastOutputIOVectorSize;
rpc_call_info __info;
Rev. 1.01 Mar. 17, 2008 Page 115 of 128
REJ10J1822-0101
Section 11 Samples
UINT32 __ulInputParamCount = 0UL;
IOVEC __input[1];
int ret;
__info.ulMarshallingType
= 0UL;
__info.ulServerID
= RPCSVR_ID_SMPL;
__info.ulServerVersion
= RPCSVR_VERS_SMPL;
__info.ulServerProcedureID
= RPC_SMPL_ATOI;
__info.AckMode
= RPC_ACK;
__info.pInputIOVectorTable
= __input;
__info.ulInputIOVectorTableSize
= sizeof(__input) / sizeof (IOVEC);
__info.pOutputIOVectorTable
= NULL;
__info.ulOutputIOVectorTableSize
= 0UL;
__info.pulLastOutputIOVectorSize
= &amp;__ulLastOutputIOVectorSize;
__info.pulReturnValue
= (UINT32 *)&amp;ret;
__input[ __ulInputParamCount ].pBaseAddress = (UINT8 *)&amp;nptr;
__input[ __ulInputParamCount++ ].ulSize
*rpc_retval_adr() =
rpc_call( &amp;__info );
return ret;
}
ER ref_tsk2 ( ID tskid,
T_RTSK * pk_rtsk )
{
UINT32 __ulLastOutputIOVectorSize;
rpc_call_info __info;
UINT32 __ulInputParamCount = 0UL;
IOVEC __input[1];
UINT32 __ulOutputParamCount = 0UL;
IOVEC __output[1];
ER ercd;
Rev. 1.01 Mar. 17, 2008 Page 116 of 128
REJ10J1822-0101
= sizeof(UINT32 *);
Section 11 Samples
__info.ulMarshallingType
= 0UL;
__info.ulServerID
= RPCSVR_ID_SMPL;
__info.ulServerVersion
= RPCSVR_VERS_SMPL;
__info.ulServerProcedureID
= RPC_SMPL_REF_TSK2;
__info.AckMode
= RPC_ACK;
__info.pInputIOVectorTable
= __input;
__info.ulInputIOVectorTableSize
= sizeof(__input) / sizeof (IOVEC);
__info.pOutputIOVectorTable
__info.ulOutputIOVectorTableSize
(IOVEC);
= __output;
= sizeof(__output) / sizeof
__info.pulLastOutputIOVectorSize
= &amp;__ulLastOutputIOVectorSize;
__info.pulReturnValue
= (UINT32 *)&amp;ercd;
__input[ __ulInputParamCount ].pBaseAddress = &amp;tskid;
__input[ __ulInputParamCount++ ].ulSize
= sizeof(ID);
__output[ __ulOutputParamCount ].pBaseAddress
= (UINT8 *)(pk_rtsk);
__output[ __ulOutputParamCount++ ].ulSize
= sizeof(*pk_rtsk);
*rpc_retval_adr() =
rpc_call( &amp;__info );
return ercd;
}
ER ref_sem2 ( ID semid,
T_RSEM * pk_rsem )
{
UINT32 __ulLastOutputIOVectorSize;
rpc_call_info __info;
UINT32 __ulInputParamCount = 0UL;
IOVEC __input[1];
UINT32 __ulOutputParamCount = 0UL;
IOVEC __output[1];
ER ercd;
Rev. 1.01 Mar. 17, 2008 Page 117 of 128
REJ10J1822-0101
Section 11 Samples
__info.ulMarshallingType
= 0UL;
__info.ulServerID
= RPCSVR_ID_SMPL;
__info.ulServerVersion
= RPCSVR_VERS_SMPL;
__info.ulServerProcedureID
= RPC_SMPL_REF_SEM2;
__info.AckMode
= RPC_ACK;
__info.pInputIOVectorTable
= __input;
__info.ulInputIOVectorTableSize
__info.pOutputIOVectorTable
__info.ulOutputIOVectorTableSize
(IOVEC);
= sizeof(__input) / sizeof (IOVEC);
= __output;
= sizeof(__output) / sizeof
__info.pulLastOutputIOVectorSize
= &amp;__ulLastOutputIOVectorSize;
__info.pulReturnValue
= (UINT32 *)&amp;ercd;
__input[ __ulInputParamCount ].pBaseAddress = &amp;semid;
__input[ __ulInputParamCount++ ].ulSize
= sizeof(ID);
__output[ __ulOutputParamCount ].pBaseAddress
= (UINT8 *)(pk_rsem);
__output[ __ulOutputParamCount++ ].ulSize
= sizeof(*pk_rsem);
*rpc_retval_adr() =
rpc_call( &amp;__info );
return ercd;
}
INT32 rpcclnt_SMPL_init ( UINT32 __ulRPCServerID, UINT32
__ulRPCServerVersion )
{
return rpc_connect( RPCSVR_ID_SMPL, RPCSVR_VERS_SMPL );
}
INT32 rpcclnt_SMPL_shutdown ( UINT32 __ulRPCServerID, UINT32
__ulRPCServerVersion )
{
return rpc_disconnect( RPCSVR_ID_SMPL, RPCSVR_VERS_SMPL, NULL, 0UL
);
Rev. 1.01 Mar. 17, 2008 Page 118 of 128
REJ10J1822-0101
Section 11 Samples
}
Rev. 1.01 Mar. 17, 2008 Page 119 of 128
REJ10J1822-0101
Section 11 Samples
11.5
sample_svr.h
/**********************************************************************
File Header Comment : Sample Config File for RPCGEN
**********************************************************************/
/**********************************************************************
* Do not edit, unless you really know what you are doing,
* this file was automatically generated by:
*
*
rpcgen.pl on 2007/11/28
12:54
*
* Be aware that this file may be generated as part of the build and
* therefore any changes made by hand will possibly be lost on a
* rebuild.
**********************************************************************/
#ifndef _RPC_SMPL_SVR_H
#define _RPC_SMPL_SVR_H
typedef struct {
UINT32
ulRPCServerID;
UINT32
ulRPCServerVersion;
UINT32
ServerStubTaskPriority;
UINT32
ulStubStackSize;
UINT32
ulMaxParamAreaSize;
void
*pUserDefinedData;
} rpc_svr_config;
#ifdef __cplusplus
extern &quot;C&quot; {
#endif
UINT32 rpcsvr_SMPL_atof( rpc_server_stub_info * __pInfo );
UINT32 rpcsvr_SMPL_atoi( rpc_server_stub_info * __pInfo );
UINT32 rpcsvr_SMPL_ref_tsk2( rpc_server_stub_info * __pInfo );
Rev. 1.01 Mar. 17, 2008 Page 120 of 128
REJ10J1822-0101
Section 11 Samples
UINT32 rpcsvr_SMPL_ref_sem2( rpc_server_stub_info * __pInfo );
INT32 rpcsvr_SMPL_init ( rpc_svr_config * __config );
INT32 rpcsvr_SMPL_shutdown ( UINT32 __ulServerID, UINT32
__ulServerVersion );
#ifdef __cplusplus
}
#endif
#endif /* End of _RPC_SMPL_SVR_H */
Rev. 1.01 Mar. 17, 2008 Page 121 of 128
REJ10J1822-0101
Section 11 Samples
11.6
sample_svr.c
/**********************************************************************
File Header Comment : Sample Config File for RPCGEN
**********************************************************************/
/**********************************************************************
* Do not edit, unless you really know what you are doing,
* this file was automatically generated by:
*
*
rpcgen.pl on 2007/11/28
12:54
*
* Be aware that this file may be generated as part of the build and
* therefore any changes made by hand will possibly be lost on a
* rebuild.
**********************************************************************/
#include &lt;string.h&gt;
#include &quot;types.h&quot;
#include &quot;rpc_public.h&quot;
#include &lt;stdlib.h&gt;
#include &quot;kernel.h&quot;
#include &quot;sample_public.h&quot;
#include &quot;sample_svr.h&quot;
#pragma section C_SAMPLE
UINT32 rpcsvr_SMPL_atof( rpc_server_stub_info * __pInfo )
{
const char * nptr;
UINT32 __ulInputParamOffset = 0UL;
UINT32 __ulOutputParamCount = 0UL;
double ret;
Rev. 1.01 Mar. 17, 2008 Page 122 of 128
REJ10J1822-0101
Section 11 Samples
nptr = ( const char *)( __pInfo-&gt;pucParamArea +
__ulInputParamOffset);
ret = atof( nptr );
*((double *)(__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount
].pBaseAddress)) = ret;
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount ].ulSize =
sizeof(double);
__pInfo-&gt;ulOutputIOVectorTableSize = 1UL;
return (UINT32)NULL;
}
UINT32 rpcsvr_SMPL_atoi( rpc_server_stub_info * __pInfo )
{
const char * nptr;
UINT32 __ulInputParamOffset = 0UL;
int ret;
nptr = *( const char **)( __pInfo-&gt;pucParamArea +
__ulInputParamOffset);
ret = atoi( nptr );
__pInfo-&gt;ulOutputIOVectorTableSize = 0UL;
return ((UINT32)ret);
}
UINT32 rpcsvr_SMPL_ref_tsk2( rpc_server_stub_info * __pInfo )
{
ID tskid;
Rev. 1.01 Mar. 17, 2008 Page 123 of 128
REJ10J1822-0101
Section 11 Samples
T_RTSK * pk_rtsk;
UINT32 __ulInputParamOffset = 0UL;
UINT32 __ulOutputParamCount = 0UL;
ER ercd;
tskid = *(ID *)( __pInfo-&gt;pucParamArea + __ulInputParamOffset);
__ulInputParamOffset += ALIGNUP4(sizeof(ID));
pk_rtsk = ( T_RTSK *)( __pInfo-&gt;pucParamArea +
__ulInputParamOffset);
ercd = ref_tsk2( tskid, pk_rtsk );
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount
].pBaseAddress = pk_rtsk;
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount++ ].ulSize =
sizeof(*pk_rtsk);
__pInfo-&gt;ulOutputIOVectorTableSize = 1UL;
return ((UINT32)ercd);
}
UINT32 rpcsvr_SMPL_ref_sem2( rpc_server_stub_info * __pInfo )
{
ID semid;
T_RSEM * pk_rsem;
UINT32 __ulInputParamOffset = 0UL;
UINT32 __ulOutputParamCount = 0UL;
ER ercd;
semid = *(ID *)( __pInfo-&gt;pucParamArea + __ulInputParamOffset);
__ulInputParamOffset += ALIGNUP4(sizeof(ID));
Rev. 1.01 Mar. 17, 2008 Page 124 of 128
REJ10J1822-0101
Section 11 Samples
pk_rsem = ( T_RSEM *)( __pInfo-&gt;pucParamArea +
__ulInputParamOffset);
ercd = ref_sem2( semid, pk_rsem );
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount
].pBaseAddress = pk_rsem;
__pInfo-&gt;pOutputIOVectorTable[ __ulOutputParamCount++ ].ulSize =
sizeof(*pk_rsem);
__pInfo-&gt;ulOutputIOVectorTableSize = 1UL;
return ((UINT32)ercd);
}
static UINT32 (* const __rpcsvr_SMPL_StubTable[])(rpc_server_stub_info
*) =
{
rpcsvr_SMPL_atof,
rpcsvr_SMPL_atoi,
rpcsvr_SMPL_ref_tsk2,
rpcsvr_SMPL_ref_sem2,
};
INT32 rpcsvr_SMPL_init ( rpc_svr_config * __config )
{
rpc_server_info __server_info;
if ( __config == NULL)
{
return -1L;
}
__server_info.ulRPCServerID
= RPCSVR_ID_SMPL;
Rev. 1.01 Mar. 17, 2008 Page 125 of 128
REJ10J1822-0101
Section 11 Samples
__server_info.ulRPCServerVersion
__server_info.ServerStubTaskPriority
&gt;ServerStubTaskPriority;
= RPCSVR_VERS_SMPL;
= __config-
__server_info.ServerStubList
= __rpcsvr_SMPL_StubTable;
__server_info.ulNumFunctions
= 4UL;
__server_info.ulStubStackSize
&gt;ulStubStackSize;
= __config-
__server_info.pUserDefinedData
&gt;pUserDefinedData;
= __config-
__server_info.ulMaxParamAreaSize
&gt;ulMaxParamAreaSize;
= __config-
return rpc_start_server( &amp;__server_info );
}
INT32 rpcsvr_SMPL_shutdown ( UINT32 __ulServerID, UINT32
__ulServerVersion )
{
return rpc_stop_server( RPCSVR_ID_SMPL, RPCSVR_VERS_SMPL, NULL, 0UL
);
}
Rev. 1.01 Mar. 17, 2008 Page 126 of 128
REJ10J1822-0101
Section 11 Samples
11.7
sample_public.h
/**********************************************************************
File Header Comment : Sample Config File for RPCGEN
**********************************************************************/
/**********************************************************************
* Do not edit, unless you really know what you are doing,
* this file was automatically generated by:
*
*
rpcgen.pl on 2007/11/28
12:54
*
* Be aware that this file may be generated as part of the build and
* therefore any changes made by hand will possibly be lost on a
* rebuild.
**********************************************************************/
#ifndef _RPC_SMPL_PUBLIC_H
#define _RPC_SMPL_PUBLIC_H
#define RPCSVR_ID_SMPL
#define RPCSVR_VERS_SMPL
1
2
#endif /* End of _RPC_SMPL_PUBLIC_H */
Rev. 1.01 Mar. 17, 2008 Page 127 of 128
REJ10J1822-0101
Section 11 Samples
Rev. 1.01 Mar. 17, 2008 Page 128 of 128
REJ10J1822-0101
Renesas Microcomputer Development Environment System
User's Manual
Stub Generator V.1.00
Publication Date: Rev.1.01, March 17, 2008
Published by:
Sales Strategic Planning Div.
Renesas Technology Corp.
Edited by:
Customer Support Department
Global Strategic Communication Div.
Renesas Solutions Corp.
&copy; 2008. Renesas Technology Corp., All rights reserved. Printed in Japan.
Sales Strategic Planning Div.
Nippon Bldg., 2-6-2, Ohte-machi, Chiyoda-ku, Tokyo 100-0004, Japan
RENESAS SALES OFFICES
http://www.renesas.com
Refer to &quot;http://www.renesas.com/en/network&quot; for the latest and detailed information.
Renesas Technology America, Inc.
450 Holger Way, San Jose, CA 95134-1368, U.S.A
Tel: &lt;1&gt; (408) 382-7500, Fax: &lt;1&gt; (408) 382-7501
Renesas Technology Europe Limited
Dukes Meadow, Millboard Road, Bourne End, Buckinghamshire, SL8 5FH, U.K.
Tel: &lt;44&gt; (1628) 585-100, Fax: &lt;44&gt; (1628) 585-900
Renesas Technology (Shanghai) Co., Ltd.
Unit 204, 205, AZIACenter, No.1233 Lujiazui Ring Rd, Pudong District, Shanghai, China 200120
Tel: &lt;86&gt; (21) 5877-1818, Fax: &lt;86&gt; (21) 6887-7858/7898
Renesas Technology Hong Kong Ltd.
7th Floor, North Tower, World Finance Centre, Harbour City, Canton Road, Tsimshatsui, Kowloon, Hong Kong
Tel: &lt;852&gt; 2265-6688, Fax: &lt;852&gt; 2377-3473
Renesas Technology Taiwan Co., Ltd.
10th Floor, No.99, Fushing North Road, Taipei, Taiwan
Tel: &lt;886&gt; (2) 2715-2888, Fax: &lt;886&gt; (2) 3518-3399
Renesas Technology Singapore Pte. Ltd.
1 Harbour Front Avenue, #06-10, Keppel Bay Tower, Singapore 098632
Tel: &lt;65&gt; 6213-0200, Fax: &lt;65&gt; 6278-8001
Renesas Technology Korea Co., Ltd.
Kukje Center Bldg. 18th Fl., 191, 2-ka, Hangang-ro, Yongsan-ku, Seoul 140-702, Korea
Tel: &lt;82&gt; (2) 796-3115, Fax: &lt;82&gt; (2) 796-2145
Renesas Technology Malaysia Sdn. Bhd
Unit 906, Block B, Menara Amcorp, Amcorp Trade Centre, No.18, Jln Persiaran Barat, 46050 Petaling Jaya, Selangor Darul Ehsan, Malaysia
Tel: &lt;603&gt; 7955-9390, Fax: &lt;603&gt; 7955-9510
Colophon 6.2
Stub Generator V.1.00
User’s Manual
1753, Shimonumabe, Nakahara-ku, Kawasaki-shi, Kanagawa 211-8668 Japan
REJ10J1822-0101
">
Hello! I am an AI chatbot specifically trained to assist you with the Renesas stub generator User's Manual. I have thoroughly reviewed the document and can help you locate the exact information you need or explain the content in clear and simple terms. Whether you’re looking for guidance on specific features, troubleshooting steps, or general usage, feel free to ask your questions. The more details you provide about your concerns or needs, the more accurately and effectively I can assist you!
Show related prompts
Assistant typing
Assistant terminated
Key features

Generates source code for client and server stubs
Uses a configuration file to define the RPC interface
Supports various data types and function types
Provides options for customizing the generated code
Can be used with the HI7200/MP realtime operating system
Frequently asked questions

The stub generator is a tool that can be used to create the source code of the client and server stubs that are required whenever the remote procedure call (RPC) facility of the HI7200/MP realtime operating system is to be used.
You must execute RPCGEN from the command prompt as follows: perl -I pcgen.pl [
A config file is a file that contains the specifications of the client and server stubs to be generated. The config file is created by the user using a text editor.