OPTIONS(SVAS)

Shore Programmer's Manual - 3 November 94

NAME

options \- configuration options used by the Shore Value-Added Server

SYNOPSIS

setenv SHORE_RC configuration-file

svas_option_name:  value

DESCRIPTION

Each of the following options must appear on the command line or in a configuration file. On the command line, each option is prepended with a dash ('-'); in a configuration file, it is prepended by a type, a class, and a program name (in the style of X configuration options).

For applications, the type is "shore", and the class and program name are determined by the application.

For the server, the type is "shore", the class is "server", and program name is the name of the program's executable file ("shore" if it is run as made in the source tree).

Wild cards "?" and "*" may be used as with X configuration options.

Examples are:

shore.server.shore.sm_logdir: ./log
?.server.shore.sm_logdir: ./log
shore.server.?.sm_logdir: ./log
*.sm_logdir: ./log

SERVER OPTIONS

The following options are used by the Shore Value-Added Server process and its subordinate layers of software. Options that are required are so marked.

sm_bufpoolsize: Required. The size of the Storage Manager's buffer pool, in kilobytes. It must be an integer greater than 64. No default value.
sm_logdir: Required. The path name of a Unix directory in which the recovery log will be written. No default value.
sm_logsize: Not required. The maximum size that the log may reach before the Storage Manager aborts a transaction and shuts down the server in error. The minimum size is 1 megabyte, which is too small for any real work. Default value is 10 megabytes.
sm_diskrw: The path name of the program that the Shore Storage Manager will fork to perform disk I/O. The path name should be the place you installed the executable program that was made in the source tree as src/sthread/diskrw. The default value is "diskrw".
sm_logging: A Boolean-valued option that determines whether the Shore Storage Manager will perform logging and recovery during this program execution. The default is true.
svas_root: This option determines where the server will find the root of the Shore name space. The value must be of the form pathname volume-id. The pathname is the Unix path name of the device on which the root volume is to be found. The volume-id is the logical volume identifier ("high.low") of the volume whose root directory will correspond to "/". The device must already have been formatted, and the volume must already have been created and formatted as a Shore file system. This option has no default value. If no value is given, the server will come up, to allow devices to be formatted and file systems to be created.
svas_shellrc: The file name of a Tcl shell command file that will be read when the shell is started (only if the shell was configured into the executable and the shell is started).

The next four options determine the ports on which the server serves requests for its various services. Each of these port numbers should be an integer between 1024 and 65535.

svas_nfsd_port: This is the port on which the server receives NFS requests over UDP. Default is 2999.
svas_mountd_port: This is the port on which the server receives MOUNT requests over UDP. Default is 2998.
svas_client_port: This is the port on which the server listens for client requests over TCP. Default is 2999.
svas_remote_port: This is the port on which the server listens for requests from other Shore Value-Added Servers over TCP. Default is 2998. (This is not used yet.)

The next four options determine the destinations of messages that are logged by the various services. There are three possible destinations: a file in the Unix file system, the syslog daemon, or the standard error file (usually the terminal). If the value of the option is "-", the standard error file is used. If it is "syslogd", the messages are sent to the syslog daemon. If it is any other string, it is interpreted as a Unix path name.

svas_nfsd_log: The destination of log messages generated by the NFS service. Default is "-".
svas_mountd_log: The destination of log messages generated by the MOUNT service. Default is "-".
svas_client_log: The destination of log messages generated by the Shore client request service. Default is "-".
svas_remote_log: The destination of log messages generated by the Shore remote-server service. Default is "-".

The rest of the server options are Boolean-valued options. Values can be given as "yes", "no", "true", or "false".

svas_nfsd_pmap: If true, the server will register this service with the portmapper. Default is false.
svas_mountd_pmap: If true, the server will register this service with the portmapper. Default is false.
svas_remote_pmap: If true, the server will register this service with the portmapper. Default is false.
svas_client_pmap: If true, the server will register this service with the portmapper. Default is false.
svas_noshm: If true, the server prohibits the use of shared memory when communicating with clients (overriding client options regarding the use of shared memory). This is for debugging purposes only. Default is false.
svas_rpc_unregister: If true, and the server is unable to register with the portmapper, it will try to un-register and re-register. For restarting after a crash; avoids running "rpcinfo -d". Default is false. Use carefully!
svas_print_user_errors: If true, the server will print messages about user errors to the standard output file. Default is false.
svas_print_user_stats: If true, the server will print statistics to the standard output file every time a client's transaction changes state. Default is false.
svas_clear_user_stats: If true, the server will clear its statistics every time a client's transaction changes state.
svas_tclshell: If true, the server will start a Tcl shell (if the shell was configured into the executable). Default is true.
svas_sysp_cache_size: An integer-valued option, whose value should be a small integer. It determines the size (number of entries in) of the meta-data cache created for each client. The meta-data cache caches system properties of pools and of objects containing indexes, in order to expedite permissions checking during operations on anonymous objects and indexes. The default value is 1.

SHUTDOWN OPTIONS

The shutdown program is a client program, which uses the following server options:

svas_remote_pmap
svas_remote_port

and it uses the following client option:

svas_host

CLIENT LIBRARY OPTIONS

The following options are used by the Shore Value-Added Server client library. Options that are required are so marked.

svas_host: The name of the host on which the server runs. The default value is "localhost", which is really the only way Shore is intended to be run. This option is available only for debugging purposes.
svas_log: The name of the Unix file to which the client library will log information as it runs. The value "-" means that information will be logged to the standard error file (usually the terminal). If given the value "syslogd", the client library will log to the syslog daemon, as the facility LOG_USER. The default value is "-" (log to standard error).
svas_shm_small_obj: The number of kilobytes of shared memory to allocate for transferring small objects between the server and the client. The default is 32.
svas_shm_large_obj: The number of kilobytes of shared memory to allocate for transferring large objects between the server and the client. The default is 16.
svas_use_pmap: If "yes" or "true", the client library consults the portmapper to locate the server. If "no" or "false", the client library does not contact the portmapper, and uses the value of the option "svas_port" to locate the server. The default is false.
svas_port: The port at which the server is listening. The default is 2999.
svas_audit: Boolean-valued option available only in a server compiled with -DDEBUG. If true, lots of internal auditing code is run, which slows down the client. The default is false.
svas_print_user_errors: A Boolean-valued option that determines whether the client library will print messages about user errors to the standard output file. The default is false.

VERSION

This manual page applies to Version 0.1 of theShore software.

SPONSORSHIP

The Shore project is sponsored by the Advanced Research Project Agency, ARPA order number 018 (formerly 8230), monitored by the U.S. Army Research Laboratory under contract DAAB07-91-C-Q518.