chadmin(1CC)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXTENDED DESCRIPTION | EXAMPLES | ENVIRONMENT VARIABLES | ATTRIBUTES | SEE ALSO

NAME

chadmin- ChorusOS DebugServer administration tool

SYNOPSIS

chadmin -shutdown
chadmin -stat
chadmin -save file
chadmin -add-serial-target name -device dev-file -layout-file file
chadmin {-remove-target name| -activate name| -deactivate name}
chadmin -set name value

DESCRIPTION

chadmin is a host utility.

chadmin is the ChorusOS DebugServer administration tool. It allows the DebugServer to be stopped, to obtain statistical information about it, and to register new targets dynamically.

OPTIONS

The following options are supported:

-shutdown

Stops the DebugServer.

-stat

Prints certain statistics collected by the ChorusOS DebugServer.

-save file

Saves the DebugServer configuration into file file.

-add-serial-target name

  Registers a new target with a serial line backend. name indicates the name of the target, as it will appear in the object tree of the DebugServer.

-device dev-file

Allows to specify the serial line device that the backend should use. This option is only relevant when a new target is being registered.

-layout-file dev-file

This option indicates the path of the ChorusOS XML layout file. The path should point to the layout.xml file generated during the creation of the target image.

-remove-target name

Removes the target name

-activate name

Activates the target name. When the target is activated, the DebugServer gets the control of the serial line and it is possible for debuggers and other tools to control or get access to the target.

-deactivate name

Deactivates the target name. When the target is deactivated, the DebugServer releases the control of the serial line. The target continues as if it had never been registered to the DebugServer.

-set name value

Sets the value of an attribute. Arguments that follow consist of name-value pairs. The name should be an absolute path. The value is converted into an integer depending on the attribute type.

EXTENDED DESCRIPTION

The chadmin tool is used in the following situations:

To register a new target:

The DebugServer needs to know some information about the target so that it can control it. In general, you will register your target only once. The information that you need to pass are the target name, the serial device name and the path of the XML image layout file generated by mkimage.

To update the information about a target:

Sometimes the information that you have specified during the registration changes. This is often the case for the serial line speed and the path of the XML image layout file. You will use the chadmin tool in that case to update the information.

To activate or deactivate a target:

Activation and deactivation of a target is useful when some targets are momentarily not available to the DebugServer, or, when you want that the DebugServer releases the control of the serial line without having to go to the remove and/or register process of the target.

EXAMPLES

The example below illustrates how you can register a new target:

chadmin -add-serial-target quintet -device /dev/ttyb\ -layout-file image/LILO/kts/layout.xml

If you find out that the serial line was not set correctly, or if you change the dbg.driver.baud tunable for example to increase the speed of the serial line, you can update your target configuration by typing the following commands:

chadmin -set targets/quintet/backends/log:bkpts:\ cache:serial/device /dev/ttya chadmin -set targets/quintet/backends/log:bkpts:\ cache:serial/baud 38400

Assuming that quintet is the name of your target, ttya is the new device and 38400 is the baud rate that you have setup in the debug agent tunable. Sometimes, it happens that the path of the XML layout file is not correct, or is changed. This is the case if you are booting another archive. In that case, you can update the target configuration by typing the following command:

chadmin -set targets/quintet/layout_file image/LILO/chorus/layout.xml

where image/LILO/chorus/layout.xml is the new path.

ENVIRONMENT VARIABLES

The following environment variable is read by chadmin:

CHSERVER_HOST

The host name where the DebugServer is running

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

chserver(1CC)

ChorusOS 4.0  Last Revised December 1999

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXTENDED DESCRIPTION | EXAMPLES | ENVIRONMENT VARIABLES | ATTRIBUTES | SEE ALSO