2 .\" ===================================
3 .\" HARP | Host ATM Research Platform
4 .\" ===================================
7 .\" This Host ATM Research Platform ("HARP") file (the "Software") is
8 .\" made available by Network Computing Services, Inc. ("NetworkCS")
9 .\" "AS IS". NetworkCS does not provide maintenance, improvements or
10 .\" support of any kind.
12 .\" NETWORKCS MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED,
13 .\" INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY
14 .\" AND FITNESS FOR A PARTICULAR PURPOSE, AS TO ANY ELEMENT OF THE
15 .\" SOFTWARE OR ANY SUPPORT PROVIDED IN CONNECTION WITH THIS SOFTWARE.
16 .\" In no event shall NetworkCS be responsible for any damages, including
17 .\" but not limited to consequential damages, arising from or relating to
18 .\" any use of the Software or related support.
20 .\" Copyright 1994-1998 Network Computing Services, Inc.
22 .\" Copies of this Software may be made, however, the above copyright
23 .\" notice must be reproduced on all copies.
25 .\" @(#) $FreeBSD: src/usr.sbin/atm/scspd/scspd.8,v 1.2.2.3 2003/03/11 21:13:48 trhodes Exp $
36 .Op Fl f Aq Ar cfg\-file
38 .Op Fl T Ns Aq Ar options
42 utility is an implementation of the Server Cache Synchronization
43 Protocol (SCSP) for the Host ATM Research Platform (HARP)
47 utility synchronizes the cache(s) of server(s)
48 running on a host with the caches of servers on remote hosts.
49 SCSP is defined for a number of different protocols, but the present
58 one can provide multiple
59 ATMARP servers in a single ATM LIS.
60 This might be useful, for example, when a LIS consists of a number of
61 local-area ATM networks connected by long-distance links.
62 Each local-area network could have its own ATMARP server, with all the
63 servers' caches being synchronized by SCSP.
64 Then, if a long-distance link fails, hosts on a local-area network
65 will still have connectivity to other local hosts (since they all use
66 the local ATMARP server); when the long-distance link is restored,
67 SCSP will re-synchronize the servers' caches, restoring
68 connectivity to remote hosts.
73 must be running before any ATMARP
74 cache synchronization can take place.
78 utility implements SCSP as specified in RFC 2334,
79 .%T "Server Cache Synchronization Protocol (SCSP)"
81 .Pa draft\-ietf\-ion\-scspd\-atmarpd\-00.txt ,
82 .%T "A Distributed ATMARP Service using SCSP" .
86 starts, it parses its command line and puts
87 itself into the background.
89 Some of the vocabulary associated with SCSP can be confusing.
90 In this document, the following definitions are used:
95 means the server running on
98 whose cache is to be synchronized with that
99 of one or more remote servers.
102 is used alone, it means
103 .Em "client server" .
106 means a server running on some host other than
111 .Em "Directly Connected Server"
112 (DCS) means a remote server that
114 communicates with directly.
115 The remote server will also be running an implementation of SCSP.
117 .Em "Cache Alignment"
118 (CA) has two meanings.
119 The Cache Alignment protocol is a part of the SCSP protocol
120 specification, and the Cache Alignment finite state machine (FSM)
121 is a finite state machine that implements the Cache Alignment
124 The command-line options are:
125 .Bl -tag -width "-f <cfg\-file>"
126 .It Fl f Aq Ar cfg\-file
127 Specifies the name of the configuration file.
128 If this option is not specified,
132 .Pa /etc/scspd.conf .
136 is to be run in debug mode.
137 In debug mode, the daemon is not put into the background.
138 Log messages are written to standard output instead of to
139 the log file specified in the configuration file.
140 .It Fl T Ns Aq Ar options
143 will trace specified events and messages
147 flag is followed by one or more of the following
150 .Bl -tag -width 4n -compact
154 CA Finite State Machine (FSM),
162 Client Interface FSM,
164 trace CA, CSUS, CSU Request, and CSU Reply messages,
166 trace Hello messages,
168 trace interface messages to and from
174 The configuration file consists of a sequence of configuration
176 These statements specify information about the servers,
177 both local and remote, whose
178 caches are to be synchronized by
181 .%T "Server Cache Synchronization Protocol (SCSP)"
183 .Pa draft\-ietf\-ion\-scspd\-atmarpd\-00.txt ,
184 .%T "A Distributed ATMARP Service using SCSP"
185 will be valuable in understanding how to configure
188 A configuration statement other than a comment is terminated by a
190 Some statements contain blocks, delimited by braces
194 Configuration statement keywords are not case-sensitive,
195 but some parameters (e.g. interface names) are.
196 Configuration statements can span multiple lines.
198 Three types of comments are allowed:
200 .It Sy "# comments" :
203 to the end of the line are ignored.
204 .It Sy "C comments" :
205 any characters between
210 .It Sy "C++ comments" :
213 to the end of the line are ignored.
216 The configuration statements recognized by
221 Protocol <protocol ID>;
226 ATMaddr <ATM address>;
244 Where a host address needs to be specified in the configuration file,
245 either a DNS name or an IP address in dotted decimal format can
248 ATM addresses are specified as strings of hex digits, with an
251 Fields within the address may be separated by periods, but periods
252 are for readability only and are ignored.
253 ATM addresses are 20 bytes long.
254 The full address, including any leading zeroes, must be given.
257 .Dl "0x47.0005.80.ffe100.0000.f21a.0170.0020481a0170.00"
258 .Ss "Server Statement"
261 statement specifies a client server whose cache
262 to be synchronized with the caches of other servers
263 running on remote hosts.
266 statement in the configuration file
267 for each client server whose cache is to be synchronized by
272 .Bd -ragged -offset indent
282 must be specified on the
287 It is expected to give a brief description of the server's purpose.
291 statement has several sub-statements
292 that specify the details of the
296 .Bl -tag -width indent
297 .It Ic Protocol Cm ATMARP ;
298 The only protocol supported by the current version of
304 statement must always be specified.
305 .It Ic Netif Aq Ar intf ;
308 statement specifies the name of the ATM network
309 interface on which a client server is providing service.
312 statement must always be specified.
313 .It Ic ServerGroupID Aq Ar ID ;
316 statement specifies an identifier for the
317 group of servers being synchronized by
321 is specified as a decimal number in the range 0 - 65,535.
322 The server group ID must be the same for all servers whose caches
323 are being synchronized by an SCSP session.
324 That is, the server group ID for a host must be the same for all
325 Directly Connected Servers (DCSs) pointed to within a
330 statement must always be specified.
331 .It Ic FamilyID Aq Ar ID ;
334 statement specifies an identifier for a family
335 of parallel SCSP sessions running between a group of hosts (i.e. a
336 set of SCSP sessions with different protocol IDs but the same set
340 is specified as a decimal number in the range 0 - 65,535.
341 The family ID is currently not used by
347 statement is a sub-statement of the
350 that specifies the characteristics of a Directly Connected Server (DCS).
353 statement will have one
358 is to exchange information with.
361 statement has a number of sub-statements that specify the
362 details of the configuration for the DCS.
364 .Bl -tag -width indent
365 .It Ic ATMaddr Aq Ar ATM\ address ;
368 statement specifies the ATM address of the DCS.
371 statement must always be specified.
372 .It Ic ID Aq Ar host ;
375 statement specifies the SCSP identifier of the DCS.
376 For ATMARP, the ID is the IP address or DNS name associated with the
377 ATM interface of the DCS.
380 statement must always be specified.
381 .It Ic CAReXmitInt Aq Ar int ;
384 statement specifies the interval that is
385 allowed to elapse between retransmissions of CA messages.
386 If a CA message is sent and an acknowledgement is not received within
388 seconds, the message will be retransmitted.
389 The default value for
392 .It Ic CSUSReXmitInt Aq Ar int ;
395 statement specifies the interval that is
396 allowed to elapse between retransmissions of CSU Solicit messages.
397 When a CSUS message is sent, any Cache State Advertisements (CSAs)
398 requested by the CSUS that have
399 not been received within
401 seconds will be requested
402 again by another CSUS message.
403 The default value for
406 Be careful not to confuse
410 .It Ic CSUReXmitInt Aq Ar int ;
413 statement specifies the interval that is
414 allowed to elapse between retransmissions of CSU Request messages.
415 When a CSU Request message is sent, any CSAs that are not acknowledged
416 by a CSU Reply message within
420 The default value for
423 Be careful not to confuse
427 .It Ic CSUReXmitMax Aq Ar cnt ;
430 statement specifies the number of times that
431 a CSA will be retransmitted as described above before SCSP gives up
432 on the CSA and discards it.
433 The default value for
436 .It Ic HelloDead Aq Ar cnt ;
439 statement specifies the Hello Dead Factor that
440 will be sent to the DCS in Hello messages.
443 condition will be detected when nothing is received from
445 .Ic HelloDead No * Ic HelloInt
447 The default value for
450 .It Ic HelloInt Aq Ar int ;
453 statement specifies the Hello Interval that
454 will be sent to the DCS in Hello messages.
455 The default value for
458 .It Ic Hops Aq Ar cnt ;
461 statement specifies the number of hops (DCS to DCS)
462 that will be specified in CSAs originating from the local server.
463 This number must be at least as large as the diameter of the
465 That is, it must be large enough for a CSA to be propagated from
466 server to server all the way across the server group.
467 The default value for
474 statement specifies how
477 information about its operation.
480 utility can write log information to a file, to the system log,
482 .Bl -tag -width indent
483 .It Ic File Aq Ar file\ name ;
486 statement specifies that
489 its log messages to the named file.
490 Log messages will be appended to the end of the file if
495 statement specifies that
498 its log messages to the syslog facility.
501 utility writes its messages to syslog with a facility code
508 statement is specified,
511 messages to the system log.
519 write log messages to both the named file and the system log.
521 An example of a simple configuration file for
524 .Bd -literal -offset indent
531 ATMaddr 0x47.0005.80.ffdc00.0000.0002.0001.002048061de7.00;
537 This configuration would synchronize the cache of the ATMARP server
538 operating on network interface ni0 with the cache of a second server
539 running on a host whose IP address is 10.1.1.2.
540 Log messages would be written to the system log.
541 .Sh SIGNAL PROCESSING
542 The following signals can be used to control
544 .Bl -tag -width indent
546 Reread the configuration file and restart
549 Dump debugging information to a file.
555 its control blocks to a text file (see
559 .Bl -tag -width indent
560 .It Pa /etc/scspd.conf
562 default configuration file name.
563 A different file name can be specified with the
576 debugging information dump file name.
579 utility writes a summary of its control blocks to this file
584 is the process ID of the daemon and
587 number which is incremented every time a dump is taken.
598 utility writes trace information to this file if the
600 option is specified on the command line.
607 .%T "Server Cache Synchronization Protocol (SCSP)"
610 .%O "draft\-ietf\-ion\-scsp\-atmarpd\-00.txt"
611 .%T "A Distributed ATMARP Service Using SCSP"
616 terminates and is restarted, there will be a period of
617 instability while previously-synchronized cache entries time out and are
620 Please report any bugs to
621 .Aq harp\-bugs@magic.net .
623 Copyright (c) 1994-1998, Network Computing Services, Inc.
626 Network Computing Services, Inc.
628 Network Computing Services, Inc.
630 Network Computing Services, Inc.
632 This software was developed with the support of the Defense
633 Advanced Research Projects Agency (DARPA).