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 $
26 .\" @(#) $DragonFly: src/usr.sbin/atm/scspd/scspd.8,v 1.3 2006/02/17 19:40:11 swildner Exp $
37 .Op Fl f Aq Ar cfg\-file
39 .Op Fl T Ns Aq Ar options
43 utility is an implementation of the Server Cache Synchronization
44 Protocol (SCSP) for the Host ATM Research Platform (HARP)
48 utility synchronizes the cache(s) of server(s)
49 running on a host with the caches of servers on remote hosts.
50 SCSP is defined for a number of different protocols, but the present
59 one can provide multiple
60 ATMARP servers in a single ATM LIS.
61 This might be useful, for example, when a LIS consists of a number of
62 local-area ATM networks connected by long-distance links.
63 Each local-area network could have its own ATMARP server, with all the
64 servers' caches being synchronized by SCSP.
65 Then, if a long-distance link fails, hosts on a local-area network
66 will still have connectivity to other local hosts (since they all use
67 the local ATMARP server); when the long-distance link is restored,
68 SCSP will re-synchronize the servers' caches, restoring
69 connectivity to remote hosts.
74 must be running before any ATMARP
75 cache synchronization can take place.
79 utility implements SCSP as specified in RFC 2334,
80 .%T "Server Cache Synchronization Protocol (SCSP)"
82 .Pa draft\-ietf\-ion\-scspd\-atmarpd\-00.txt ,
83 .%T "A Distributed ATMARP Service using SCSP" .
87 starts, it parses its command line and puts
88 itself into the background.
90 Some of the vocabulary associated with SCSP can be confusing.
91 In this document, the following definitions are used:
96 means the server running on
99 whose cache is to be synchronized with that
100 of one or more remote servers.
103 is used alone, it means
104 .Em "client server" .
107 means a server running on some host other than
112 .Em "Directly Connected Server"
113 (DCS) means a remote server that
115 communicates with directly.
116 The remote server will also be running an implementation of SCSP.
118 .Em "Cache Alignment"
119 (CA) has two meanings.
120 The Cache Alignment protocol is a part of the SCSP protocol
121 specification, and the Cache Alignment finite state machine (FSM)
122 is a finite state machine that implements the Cache Alignment
125 The command-line options are:
126 .Bl -tag -width "-f <cfg\-file>"
127 .It Fl f Aq Ar cfg\-file
128 Specifies the name of the configuration file.
129 If this option is not specified,
133 .Pa /etc/scspd.conf .
137 is to be run in debug mode.
138 In debug mode, the daemon is not put into the background.
139 Log messages are written to standard output instead of to
140 the log file specified in the configuration file.
141 .It Fl T Ns Aq Ar options
144 will trace specified events and messages
148 flag is followed by one or more of the following
151 .Bl -tag -width 4n -compact
155 CA Finite State Machine (FSM),
163 Client Interface FSM,
165 trace CA, CSUS, CSU Request, and CSU Reply messages,
167 trace Hello messages,
169 trace interface messages to and from
175 The configuration file consists of a sequence of configuration
177 These statements specify information about the servers,
178 both local and remote, whose
179 caches are to be synchronized by
182 .%T "Server Cache Synchronization Protocol (SCSP)"
184 .Pa draft\-ietf\-ion\-scspd\-atmarpd\-00.txt ,
185 .%T "A Distributed ATMARP Service using SCSP"
186 will be valuable in understanding how to configure
189 A configuration statement other than a comment is terminated by a
191 Some statements contain blocks, delimited by braces
195 Configuration statement keywords are not case-sensitive,
196 but some parameters (e.g. interface names) are.
197 Configuration statements can span multiple lines.
199 Three types of comments are allowed:
201 .It Sy "# comments" :
204 to the end of the line are ignored.
205 .It Sy "C comments" :
206 any characters between
211 .It Sy "C++ comments" :
214 to the end of the line are ignored.
217 The configuration statements recognized by
222 Protocol <protocol ID>;
227 ATMaddr <ATM address>;
245 Where a host address needs to be specified in the configuration file,
246 either a DNS name or an IP address in dotted decimal format can
249 ATM addresses are specified as strings of hex digits, with an
252 Fields within the address may be separated by periods, but periods
253 are for readability only and are ignored.
254 ATM addresses are 20 bytes long.
255 The full address, including any leading zeroes, must be given.
258 .Dl "0x47.0005.80.ffe100.0000.f21a.0170.0020481a0170.00"
259 .Ss "Server Statement"
262 statement specifies a client server whose cache
263 to be synchronized with the caches of other servers
264 running on remote hosts.
267 statement in the configuration file
268 for each client server whose cache is to be synchronized by
273 .Bd -ragged -offset indent
283 must be specified on the
288 It is expected to give a brief description of the server's purpose.
292 statement has several sub-statements
293 that specify the details of the
297 .Bl -tag -width indent
298 .It Ic Protocol Cm ATMARP ;
299 The only protocol supported by the current version of
305 statement must always be specified.
306 .It Ic Netif Aq Ar intf ;
309 statement specifies the name of the ATM network
310 interface on which a client server is providing service.
313 statement must always be specified.
314 .It Ic ServerGroupID Aq Ar ID ;
317 statement specifies an identifier for the
318 group of servers being synchronized by
322 is specified as a decimal number in the range 0 - 65,535.
323 The server group ID must be the same for all servers whose caches
324 are being synchronized by an SCSP session.
325 That is, the server group ID for a host must be the same for all
326 Directly Connected Servers (DCSs) pointed to within a
331 statement must always be specified.
332 .It Ic FamilyID Aq Ar ID ;
335 statement specifies an identifier for a family
336 of parallel SCSP sessions running between a group of hosts (i.e. a
337 set of SCSP sessions with different protocol IDs but the same set
341 is specified as a decimal number in the range 0 - 65,535.
342 The family ID is currently not used by
348 statement is a sub-statement of the
351 that specifies the characteristics of a Directly Connected Server (DCS).
354 statement will have one
359 is to exchange information with.
362 statement has a number of sub-statements that specify the
363 details of the configuration for the DCS.
365 .Bl -tag -width indent
366 .It Ic ATMaddr Aq Ar ATM\ address ;
369 statement specifies the ATM address of the DCS.
372 statement must always be specified.
373 .It Ic ID Aq Ar host ;
376 statement specifies the SCSP identifier of the DCS.
377 For ATMARP, the ID is the IP address or DNS name associated with the
378 ATM interface of the DCS.
381 statement must always be specified.
382 .It Ic CAReXmitInt Aq Ar int ;
385 statement specifies the interval that is
386 allowed to elapse between retransmissions of CA messages.
387 If a CA message is sent and an acknowledgement is not received within
389 seconds, the message will be retransmitted.
390 The default value for
393 .It Ic CSUSReXmitInt Aq Ar int ;
396 statement specifies the interval that is
397 allowed to elapse between retransmissions of CSU Solicit messages.
398 When a CSUS message is sent, any Cache State Advertisements (CSAs)
399 requested by the CSUS that have
400 not been received within
402 seconds will be requested
403 again by another CSUS message.
404 The default value for
407 Be careful not to confuse
411 .It Ic CSUReXmitInt Aq Ar int ;
414 statement specifies the interval that is
415 allowed to elapse between retransmissions of CSU Request messages.
416 When a CSU Request message is sent, any CSAs that are not acknowledged
417 by a CSU Reply message within
421 The default value for
424 Be careful not to confuse
428 .It Ic CSUReXmitMax Aq Ar cnt ;
431 statement specifies the number of times that
432 a CSA will be retransmitted as described above before SCSP gives up
433 on the CSA and discards it.
434 The default value for
437 .It Ic HelloDead Aq Ar cnt ;
440 statement specifies the Hello Dead Factor that
441 will be sent to the DCS in Hello messages.
444 condition will be detected when nothing is received from
446 .Ic HelloDead No * Ic HelloInt
448 The default value for
451 .It Ic HelloInt Aq Ar int ;
454 statement specifies the Hello Interval that
455 will be sent to the DCS in Hello messages.
456 The default value for
459 .It Ic Hops Aq Ar cnt ;
462 statement specifies the number of hops (DCS to DCS)
463 that will be specified in CSAs originating from the local server.
464 This number must be at least as large as the diameter of the
466 That is, it must be large enough for a CSA to be propagated from
467 server to server all the way across the server group.
468 The default value for
475 statement specifies how
478 information about its operation.
481 utility can write log information to a file, to the system log,
483 .Bl -tag -width indent
484 .It Ic File Aq Ar file\ name ;
487 statement specifies that
490 its log messages to the named file.
491 Log messages will be appended to the end of the file if
496 statement specifies that
499 its log messages to the syslog facility.
502 utility writes its messages to syslog with a facility code
509 statement is specified,
512 messages to the system log.
520 write log messages to both the named file and the system log.
522 An example of a simple configuration file for
525 .Bd -literal -offset indent
532 ATMaddr 0x47.0005.80.ffdc00.0000.0002.0001.002048061de7.00;
538 This configuration would synchronize the cache of the ATMARP server
539 operating on network interface ni0 with the cache of a second server
540 running on a host whose IP address is 10.1.1.2.
541 Log messages would be written to the system log.
542 .Sh SIGNAL PROCESSING
543 The following signals can be used to control
545 .Bl -tag -width indent
547 Reread the configuration file and restart
550 Dump debugging information to a file.
556 its control blocks to a text file (see
560 .Bl -tag -width indent
561 .It Pa /etc/scspd.conf
563 default configuration file name.
564 A different file name can be specified with the
577 debugging information dump file name.
580 utility writes a summary of its control blocks to this file
585 is the process ID of the daemon and
588 number which is incremented every time a dump is taken.
599 utility writes trace information to this file if the
601 option is specified on the command line.
608 .%T "Server Cache Synchronization Protocol (SCSP)"
611 .%O "draft\-ietf\-ion\-scsp\-atmarpd\-00.txt"
612 .%T "A Distributed ATMARP Service Using SCSP"
615 Copyright (c) 1994-1998, Network Computing Services, Inc.
618 Network Computing Services, Inc.
620 Network Computing Services, Inc.
622 Network Computing Services, Inc.
624 This software was developed with the support of the Defense
625 Advanced Research Projects Agency (DARPA).
629 terminates and is restarted, there will be a period of
630 instability while previously-synchronized cache entries time out and are
633 Please report any bugs to
634 .Aq harp\-bugs@magic.net .