Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge pull request #5 from JakeMont/master

Updated to v0.4.1
  • Loading branch information...
commit 67ffb00dc3129353afd010c85a80851b76e8424a 2 parents 054e98c + 1a896c5
@JakeMont JakeMont authored
View
15 ChangeLog
@@ -1,3 +1,18 @@
+2011-11-14 Jake Montgomery Update Version to 0.4.1
+
+ * Added GitHub Wiki
+
+ * Documentaion changes.
+
+ * The --enable-silent-rules configuration option is now the default.
+
+2011-11-08 Jake Montgomery Update Version to 0.4.0
+ * Added IPv6v Support.
+
+ * Other Bug Fixes
+
+ * Documentation Fixes
+
2011-1-14 Jake Montgomery Update Version to 0.3.2
* Small bug fixes.
View
53 DEVELOPERS
@@ -1,53 +0,0 @@
-Developing the OpenBFDD Project
-*************************
-
-This document is intended for those wishing to work on the OpenBFDD
-project instead of dimply building and running a supplied distribution
-package.
-
-Development information and support can be found at http://github.com/dyninc/OpenBFDD/.
-
-=====================
-+ Setup From Source Repository
-=====================
-
-If you are not using a supplied distribution package, but instead, are
-working directly with the sources from the open source repository, then it
-ill be necessary to have the GNU Autotools installed (automake, autoconf,
-etc.).
-
-The code was originally setup using automake-1.11 and autoconf-2.62, but
-it may be possible to use other versions. If you are using a version of
-automake prior to 1.11 then the --enable-silent-rules ./configure option
-will not be available.
-
-Running `./autogen.sh' should create the support files necessary to build
-and install as described in the INSTALL document.
-
-
-=====================
-+ Configuration Options For Development
-=====================
-
-The standard configuration options are available. Run `./configure --help'
-or a list of these.
-
-In addition the --enable-debug optional will enable additional runtime
-checking and asserts. Be aware that, by default, these asserts will halt
-execution of the bfdd-beacon. This build is for testing only and is not
-recommended for production systems. For development, the following is
-recommended to disable code optimization and ensure the program can be
-easily debugged:
-
- ./configure --enable-debug CXXFLAGS='-g -O0'
-
-
-=====================
-+ Creating a Distribution Package
-========================
-
-Once the project has been setup, you can create a distribution package
-that can be used as described in the INSTALL document, using the command
-`make dist'.
-
-
View
42 INSTALL
@@ -2,9 +2,21 @@ Installation Instructions For OpenBFDD
*************************
=====================
++ Use the Wiki
+=====================
+This document contains only very minimal information. More detailed
+information can be obtained on the projects GitHub wiki, currently located
+at: https://github.com/dyninc/OpenBFDD/wiki
+
+
+=====================
+ Basic Installation From Distribution Package
=====================
+See the "Build and Install" wiki page at
+https://github.com/dyninc/OpenBFDD/wiki/Building-the-OpenBFDD-Project for
+more detailed build instructions.
+
If you are building OpenBFDD from a distribution package, the following
should build and install the package if run from the directory containing
the package source code:
@@ -14,33 +26,3 @@ the package source code:
This will builds and install bfdd-beacon, bfdd-control and the manpages
for both of these.
-====================
-+ Compiling For Your Operating System
-====================
-
-OpenBFDD may not build, without modification, on all operating systems.
-See the README file for a list of tested operating systems. If your system
-s not included, then we encourage you to make the modifications necessary
-and submit them to http://github.com/dyninc/OpenBFDD for inclusion in future releases.
-
-=====================
-+ Configuration Options
-=====================
-
-The standard configuration options are available. Run `./configure --help'
-or a list of these.
-
-In addition the --enable-debug optional will enable additional runtime
-checking and asserts. Be aware that, by default, these asserts will halt
-execution of the bfdd-beacon. This build is for testing only and is not
-recommended for production systems.
-
-=====================
-+ Setup From Source Repository
-=====================
-
-If you are not using a supplied ditribution package, but instead, are
-working directly with the sources from the open source repository, then
-you should have the DEVELOPERS document in your sources. See this document
-or more information on building from the source repository.
-
View
2  LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2010, Dynamic Network Services, Inc
+Copyright (c) 2010-2011, Dynamic Network Services, Inc
Jake Montgomery (jmontgomery@dyn.com) & Tom Daly (tom@dyn.com)
All rights reserved.
View
2  Makefile.am
@@ -21,7 +21,7 @@ bfdd_control_SOURCES = $(COMMON_SRC) $(CONTROL_SRC)
bfdd_control_LDADD = $(INTI_LIBS)
bfdd_control_MANS = bfdd-control.8
-EXTRA_DIST = $(bfdd_beacon_MANS) $(bfdd_control_MANS) DEVELOPERS LICENSE
+EXTRA_DIST = $(bfdd_beacon_MANS) $(bfdd_control_MANS) LICENSE
man_MANS = $(bfdd_beacon_MANS) $(bfdd_control_MANS)
View
21 NEWS
@@ -1,26 +1,9 @@
News for OpenBFDD
-------------------------------------------------
+See ChangeLog for more detailed information
+-------------------------------------------------
-OpenBFDD 0.4.0 2011-11-08
- Added IPv6v Support.
- Bug Fixes.
-
-OpenBFDD 0.3.2 2011-01-14
- Builds on Ubuntu
- Bug Fixes.
-
-OpenBFDD 0.3.1 2010-12-03
- Fixed runaway cpu bug.
-
-OpenBFDD 0.3.0 2010-10-18
- Builds on Debian
- Fixed accept bug on 32 bit architecture.
- Improved configure.
-
-OpenBFDD 0.2.1 2010-10-07
- Bug Fixes.
- Improved low memory handling.
OpenBFDD 0.2.0 2010-09-30
View
194 README
@@ -1,19 +1,13 @@
README for OpenBFDD
*******************
-================
-+ Contents
-================
+=====================
++ Use the Wiki
+=====================
+This document contains only very minimal information. More detailed
+information can be obtained on the projects GitHub wiki, currently located
+at: https://github.com/dyninc/OpenBFDD/wiki
- * Intro
- * Building and Installing
- * License
- * Platforms
- * About bfdd-beacon
- * About bfdd-control
- * Limitations and Bugs
- * Notes on Remote BFD Platforms
- * Bidirectional Forwarding Detection (BFD) Protocol
================
+ Intro
@@ -29,13 +23,6 @@ configured, BFD enabled, router. A control utility, bfdd-control, can be
used to configure the running bfdd-beacon daemon, and to change the state
of its BFD sessions.
-================
-+ Building and Installing
-================
-
-See the included INSTALL document for instructions on building and
-installing the OpenBFDD tools and documentation.
-
================
+ License
@@ -43,172 +30,3 @@ installing the OpenBFDD tools and documentation.
See the included LICENSE file for licensing information.
-
-================
-+ Platforms
-================
-
-The software was originally developed on FreeBSD 7.1. It has been built,
-and tested on the following platforms:
-
- * FreeBSD 7.1 amd64
- * FreeBSD 8.1 amd64
- * Debian 2.6.26-2-amd64
- * Debian 2.6.26-2-686 (i386)
- * Ubuntu 10.10 (amd64)
-
-
-It may, or may not, be possible to build and run it on other BSD and Linux
-platforms without modification. If your system is not included, then we
-encourage you o make the modifications necessary and submit them to
-http://github.com/dyninc/OpenBFDD/ for inclusion in future releases.
-
-
-================
-+ About bfdd-beacon
-================
-
-The bfdd-beacon is a daemon that implements a simple, configurable,
-Bidirectional Forwarding Detection (BFD) client. When running the
-bfdd-control utility can be used to control and communicate with the
-bfdd-beacon.
-
-Once the project is installed, you can obtain more information using `man
-bfdd-beacon'
-
-== Communication ==
-
-Currently the bfdd-beacon opens two ports 957 and 958 on 127.0.0.1 to
-allow for socket communication with the bfdd-control utility. The first
-port is "primary" and is used by default. This will probably be made
-configurable in the future.
-
-== Timing ==
-
-BFD requires that packets be sent with fairly precise timing. Since
-bfdd-beacon is implemented in software and is running on the same platform
-s other services, it is possible for the link to go "down" under system
-stress conditions. Further testing will be needed to determine if this is
-an actual issue.
-
-== Notes ==
-
-While the bfdd-beacon does (as of v 0.2.0) support setting "Required
-Minimum Receive Interval" to 0, not all remote platforms support it. See
-the "Notes on Remote BFD Platforms" section in this document for more
-details Therefore it is advisable not to set "Required Minimum Receive
-Interval" to 0 without first testing the feature, and confirming that the
-remote system supports this.
-
-================
-+ About bfdd-control
-================
-
-The bfdd-control is a utility that communicates with the bfdd-beacon
-daemon when it is running. Once the project is installed, you can obtain
-more information, including a complete list of command that can be sent
-to the bfdd-beacon using `man bfdd-control'
-
-== Communication ==
-
-See also the Communication section of the `About bfdd-beacon' entry in
-this document as well. Communication normally happens through a single
-(primary) port. It is unlikely, put possible, for connection to fail if
-multiple simultaneous instances of bfdd-control are being run. For that
-reason a second, alternate, port is provided as a backup, or when making
-repeated bfdd-control calls, such as a "monitoring" script. Use the
-`--altport' parameter as described in the bfdd-control manpage.
-
-================
-+ Limitations and Bugs
-================
-
- * BFD Demand Mode ( http://tools.ietf.org/html/rfc5880#section-6.6 ) is
- not implemented in the current version.
-
- * BFD Echo Mode ( http://tools.ietf.org/html/rfc5880#section-6.4 ) is
- not implemented in the current version.
-
- * BFD Authentication ( http://tools.ietf.org/html/rfc5880#section-6.7 )
- s not implemented in the current version.
-
- * Although it attempts to follow the protocol specification, it was
- designed and tested to work with the Juniper line of routers. It has
- currently been tested with JUNOS 8.5.
-
-
-================
-+ Notes on Remote BFD Platforms
-================
-
-bfdd-beacon communicates with a "remote" system. Since the BFD
-specification was, until recently, in the draft stage, and many
-implementations may have not been fully exercised, this page provides a
-location for notes about various BFD implementations.
-
-== JUNOS 8.5S4 ==
-
- * This platform does not handle a remote "Required Minimum Receive
- Interval" of 0. It treats it as an actual 0 value and proceeds to spew
- control packets at the fastest possible rate. This is contrary to the
- bfd.RequiredMinRxInterval clause in Section 6.8.1 of RFC 5880 (
- http://tools.ietf.org/html/rfc5880#section-6.8.1 ). Therefore it is
- advisable not to set "Required Minimum Receive Interval" to 0 with this
- ystem.
-
- * This platform does not set bfd.RemoteDiscr to 0 after a Detection
- time has elapsed, as mandated by the bfd.RemoteDiscr clause in Section
- .8.1 of RFC 5880 ( http://tools.ietf.org/html/rfc5880#section-6.8.1
- ). It maintains bfd.RemoteDiscr for 2 detection times. Without the
- "workaround" the result is that is a session is removed, either
- intentionally, or from a timeout on our end, the remote system will
- continue to send packets with a non-zero "Your Discriminator",
- preventing us from starting a new session. A "workaround" for this has
- been added. Passive sessions are now not deleted (and so the
- discriminator is maintained) for at least 3 times the remote detection
- time.
-
-
- * This platform, in some cases, delays sending a packet when its state
- changes from Down to Init. This is contrary to Section 6.8.7 paragraph
- 10 of RFC 5880 ( http://tools.ietf.org/html/rfc5880#section-6.8.7 ).
- This section does refer to "SHOULD", not "MUST", so this is not
- technically a bug. It can be seen when the local system goes from
- Up->AdminDown->Up. If the period spent in AdminDown is relatively short
- ompared with the "Local Desired Min Rx Interval", then the Local state
- will transition from AdminDown->Down and the Remote system will
- immediately transition to the Init state, but it will delay sending a
- packet, despite the state change, until the next scheduled transmit.
- This can delay the Local systems transition to the Up state. A
- workaround has been added, and is enabled by default. This consists of
- setting the Poll bit on the packet for the transition from
- AdminDown->Down. This will force the remote system to respond
- immediately. See `session set admin_up_poll' in the bfdd-control manpage.
-
-
-================
-+ Bidirectional Forwarding Detection (BFD) Protocol
-================
-
-As of this writing the bfdd-beacon implements the RFC5880 (June 2010) BFD
-pecification.
-
-See also:
- * IETF BFd home page at:
- http://www.ietf.org/dyn/wg/charter/bfdd-charter.html
-
- * BFD Base Specification RFC5880 (June 2010) at:
- http://tools.ietf.org/html/rfc5880
-
- * BFD Generic Application Specification RFC5882 at:
- http://tools.ietf.org/html/rfc5882
-
- * BFD for IPv4 & IPv6 Single Hop Specification RFC5881 at:
- http://tools.ietf.org/html/rfc5881
-
-
-
-
-
-
-
View
10 TODO
@@ -1,9 +1,3 @@
-OpenBFDD todo:
+The OpenBFDD TODO list can be found on the GitHub wiki at:
- * Support Demand Mode.
- * Support Echo Mode.
- * Support Authentication
- * The communication ports 957 and 958 should be configurable.
- * Handle signals. Currently the app will exit on many common signals.
- * We need a way to query the settings for the 'new' session using bfdd-control.
- * Optionaly log bfdd-command message replies to bfdd-beacon log.
+https://github.com/dyninc/OpenBFDD/wiki/Todo
View
2  bfdd-beacon.8
@@ -1,5 +1,5 @@
.\" Manpage for bfdd-beacon.
-.TH "bfdd-beacon" "8" "December 3, 2010" "OpenBFDD v0.4.0" "OpenBFDD v0.4.0"
+.TH "bfdd-beacon" "8" "December 14, 2010" "OpenBFDD v0.4.1" "OpenBFDD v0.4.1"
.SH NAME
\fBbfdd-beacon\fR - a Bidirectional Forwarding Detection (BFD) beacon daemon.
.SH SYNOPSIS
View
4 bfdd-control.8
@@ -1,5 +1,5 @@
.\" Manpage for bfdd-control.
-.TH "bfdd-control" "8" "December 3, 2010" "OpenBFDD v0.4.0" "OpenBFDD v0.4.0"
+.TH "bfdd-control" "8" "December 14, 2010" "OpenBFDD v0.4.1" "OpenBFDD v0.4.1"
.SH NAME
\fBbfdd-control\fR - control utility for \fBbfdd-beacon\fR(8)
.SH SYNOPSIS
@@ -57,7 +57,7 @@ The default \fIlevel\fR is 1.
\fBcompact\fR will cause the stats for each session to be displayed on a single line.
\fBnocompact\fR will place each stat on its own line (this is the default).
-The items returned in the status are documented in the \fBSTATUS ITEMS\fP(8) section of this document.
+The items returned in the status are documented in the \fBSTATUS ITEMS\fP section of this document.
.TP
\fBsession\fR (\fIid\fR | \fIip-pair\fR | \fBall\fR) \fBstate\fR \fIstateval\fR [\fIdiagnostic\fR]
Changes the state of the session specified by \fIid\fR or \fIip-pair\fR, or all sessions. \fIstateval\fR Can be one of the following:
View
4 configure.ac
@@ -4,10 +4,10 @@
AC_PREREQ(2.61)
sinclude(acx_nlnetlabs.m4)
-AC_INIT(openbfdd, 0.4.0)
+AC_INIT(openbfdd, 0.4.1)
AM_INIT_AUTOMAKE([subdir-objects])
AC_CONFIG_SRCDIR([BeaconMain.cpp])
-m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES])
+m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
# Checks for programs.
AC_PROG_CXX
Please sign in to comment.
Something went wrong with that request. Please try again.