xref: /titanic_41/usr/src/lib/librstp/common/README (revision 4eaa471005973e11a6110b69fe990530b3b95a38)
1*4eaa4710SRishi Srivatsavai
2*4eaa4710SRishi Srivatsavai
3*4eaa4710SRishi SrivatsavaiThe Rapid Spanning Tree Library project contains a  full  implementation
4*4eaa4710SRishi Srivatsavaiof 802.1s as an library  with API.  There is two  processes,  using this
5*4eaa4710SRishi Srivatsavailibrary: 'bridge' & 'mngr'. First simulates RSTP bridge behavior, second
6*4eaa4710SRishi Srivatsavaiis dedicated to link/unlink 'bridges' into virtual RSTP domain (VRSTPD).
7*4eaa4710SRishi SrivatsavaiBoth 'bridge' & 'mngr' has its own simple CLI like language of commands;
8*4eaa4710SRishi Srivatsavaithese  commands  allow  to manage the VRSTPD.  There are  tools to trace
9*4eaa4710SRishi Srivatsavaistate machine transitions and get traps about drastic changes.
10*4eaa4710SRishi Srivatsavai
11*4eaa4710SRishi SrivatsavaiPurpose: studying, debugging, development.
12*4eaa4710SRishi Srivatsavai
13*4eaa4710SRishi SrivatsavaiThe library may be used in real bridges/routers while bounding to a real
14*4eaa4710SRishi Srivatsavaisystem depending environment.
15*4eaa4710SRishi Srivatsavai
16*4eaa4710SRishi SrivatsavaiTo run:
17*4eaa4710SRishi Srivatsavai1. In one shell run 'mngr'
18*4eaa4710SRishi Srivatsavai./mngr
19*4eaa4710SRishi SrivatsavaiYou will get prompt of 'mngr'; type '?' and get full help of
20*4eaa4710SRishi Srivatsavai'mngr' commands.
21*4eaa4710SRishi Srivatsavai
22*4eaa4710SRishi Srivatsavai2. In another shell run bridge instance.
23*4eaa4710SRishi Srivatsavai./bridge
24*4eaa4710SRishi SrivatsavaiYou will get prompt of 'bridge'; type '?' and get full help
25*4eaa4710SRishi Srivatsavaiof bridge management commands.
26*4eaa4710SRishi Srivatsavai
27*4eaa4710SRishi Srivatsavai3. You may (and should) run a number of bridge instances, each in its
28*4eaa4710SRishi Srivatsavaiseparate shell (this way you will be able manage them).
29*4eaa4710SRishi Srivatsavai
30*4eaa4710SRishi SrivatsavaiFor example, if there were two bridge instances, you may see examples
31*4eaa4710SRishi Srivatsavaiof the dialog in files mngr.txt, B5055.txt and B5056.txt.
32*4eaa4710SRishi Srivatsavai
33*4eaa4710SRishi SrivatsavaiNote: prompt both of 'mngr' and of 'bridge' instance contains time stamp,
34*4eaa4710SRishi Srivatsavaiwhile all these process run onto the same computer, these time stamps
35*4eaa4710SRishi Srivatsavaiare synchronized.
36*4eaa4710SRishi Srivatsavai
37*4eaa4710SRishi Srivatsavai
38