fsm.h
上传用户:yyhongfa
上传日期:2013-01-18
资源大小:267k
文件大小:7k
开发平台:

C/C++

  1. /*****************************************************************************
  2. * fsm.h - Network Control Protocol Finite State Machine header file.
  3. *
  4. * Copyright (c) 2003 by Marc Boucher, Services Informatiques (MBSI) inc.
  5. * Copyright (c) 1997 Global Election Systems Inc.
  6. *
  7. * The authors hereby grant permission to use, copy, modify, distribute,
  8. * and license this software and its documentation for any purpose, provided
  9. * that existing copyright notices are retained in all copies and that this
  10. * notice and the following disclaimer are included verbatim in any 
  11. * distributions. No written agreement, license, or royalty fee is required
  12. * for any of the authorized uses.
  13. *
  14. * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS *AS IS* AND ANY EXPRESS OR
  15. * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
  17. * IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  18. * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23. * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24. *
  25. ******************************************************************************
  26. * REVISION HISTORY
  27. *
  28. * 03-01-01 Marc Boucher <marc@mbsi.ca>
  29. *   Ported to lwIP.
  30. * 97-11-05 Guy Lancaster <glanca@gesn.com>, Global Election Systems Inc.
  31. * Original based on BSD code.
  32. *****************************************************************************/
  33. /*
  34.  * fsm.h - {Link, IP} Control Protocol Finite State Machine definitions.
  35.  *
  36.  * Copyright (c) 1989 Carnegie Mellon University.
  37.  * All rights reserved.
  38.  *
  39.  * Redistribution and use in source and binary forms are permitted
  40.  * provided that the above copyright notice and this paragraph are
  41.  * duplicated in all such forms and that any documentation,
  42.  * advertising materials, and other materials related to such
  43.  * distribution and use acknowledge that the software was developed
  44.  * by Carnegie Mellon University.  The name of the
  45.  * University may not be used to endorse or promote products derived
  46.  * from this software without specific prior written permission.
  47.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  48.  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  49.  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  50.  *
  51.  * $Id: fsm.h,v 1.1 2003/05/27 14:37:56 jani Exp $
  52.  */
  53. #ifndef FSM_H
  54. #define FSM_H
  55. /*****************************************************************************
  56. ************************* PUBLIC DEFINITIONS *********************************
  57. *****************************************************************************/
  58. /*
  59.  * LCP Packet header = Code, id, length.
  60.  */
  61. #define HEADERLEN (sizeof (u_char) + sizeof (u_char) + sizeof (u_short))
  62. /*
  63.  *  CP (LCP, IPCP, etc.) codes.
  64.  */
  65. #define CONFREQ 1 /* Configuration Request */
  66. #define CONFACK 2 /* Configuration Ack */
  67. #define CONFNAK 3 /* Configuration Nak */
  68. #define CONFREJ 4 /* Configuration Reject */
  69. #define TERMREQ 5 /* Termination Request */
  70. #define TERMACK 6 /* Termination Ack */
  71. #define CODEREJ 7 /* Code Reject */
  72. /*
  73.  * Link states.
  74.  */
  75. #define INITIAL 0 /* Down, hasn't been opened */
  76. #define STARTING 1 /* Down, been opened */
  77. #define CLOSED 2 /* Up, hasn't been opened */
  78. #define STOPPED 3 /* Open, waiting for down event */
  79. #define CLOSING 4 /* Terminating the connection, not open */
  80. #define STOPPING 5 /* Terminating, but open */
  81. #define REQSENT 6 /* We've sent a Config Request */
  82. #define ACKRCVD 7 /* We've received a Config Ack */
  83. #define ACKSENT 8 /* We've sent a Config Ack */
  84. #define OPENED 9 /* Connection available */
  85. /*
  86.  * Flags - indicate options controlling FSM operation
  87.  */
  88. #define OPT_PASSIVE 1 /* Don't die if we don't get a response */
  89. #define OPT_RESTART 2 /* Treat 2nd OPEN as DOWN, UP */
  90. #define OPT_SILENT 4 /* Wait for peer to speak first */
  91. /*****************************************************************************
  92. ************************* PUBLIC DATA TYPES **********************************
  93. *****************************************************************************/
  94. /*
  95.  * Each FSM is described by an fsm structure and fsm callbacks.
  96.  */
  97. typedef struct fsm {
  98.     int unit; /* Interface unit number */
  99.     u_short protocol; /* Data Link Layer Protocol field value */
  100.     int state; /* State */
  101.     int flags; /* Contains option bits */
  102.     u_char id; /* Current id */
  103.     u_char reqid; /* Current request id */
  104.     u_char seen_ack; /* Have received valid Ack/Nak/Rej to Req */
  105.     int timeouttime; /* Timeout time in milliseconds */
  106.     int maxconfreqtransmits;/* Maximum Configure-Request transmissions */
  107.     int retransmits; /* Number of retransmissions left */
  108.     int maxtermtransmits; /* Maximum Terminate-Request transmissions */
  109.     int nakloops; /* Number of nak loops since last ack */
  110.     int maxnakloops; /* Maximum number of nak loops tolerated */
  111.     struct fsm_callbacks* callbacks;/* Callback routines */
  112.     char* term_reason; /* Reason for closing protocol */
  113.     int term_reason_len; /* Length of term_reason */
  114. } fsm;
  115. typedef struct fsm_callbacks {
  116.     void (*resetci) /* Reset our Configuration Information */
  117. (fsm*);
  118.     int  (*cilen) /* Length of our Configuration Information */
  119. (fsm*);
  120.     void (*addci)  /* Add our Configuration Information */
  121. (fsm*, u_char*, int*);
  122.     int  (*ackci) /* ACK our Configuration Information */
  123. (fsm*, u_char*, int);
  124.     int  (*nakci) /* NAK our Configuration Information */
  125. (fsm*, u_char*, int);
  126.     int  (*rejci) /* Reject our Configuration Information */
  127. (fsm*, u_char*, int);
  128.     int  (*reqci) /* Request peer's Configuration Information */
  129. (fsm*, u_char*, int*, int);
  130.     void (*up) /* Called when fsm reaches OPENED state */
  131. (fsm*);
  132.     void (*down) /* Called when fsm leaves OPENED state */
  133. (fsm*);
  134.     void (*starting) /* Called when we want the lower layer */
  135. (fsm*);
  136.     void (*finished) /* Called when we don't want the lower layer */
  137. (fsm*);
  138.     void (*protreject) /* Called when Protocol-Reject received */
  139. (int);
  140.     void (*retransmit) /* Retransmission is necessary */
  141. (fsm*);
  142.     int  (*extcode) /* Called when unknown code received */
  143. (fsm*, int, u_char, u_char*, int);
  144.     char *proto_name; /* String name for protocol (for messages) */
  145. } fsm_callbacks;
  146. /*****************************************************************************
  147. *********************** PUBLIC DATA STRUCTURES *******************************
  148. *****************************************************************************/
  149. /*
  150.  * Variables
  151.  */
  152. extern int peer_mru[]; /* currently negotiated peer MRU (per unit) */
  153. /*****************************************************************************
  154. ************************** PUBLIC FUNCTIONS **********************************
  155. *****************************************************************************/
  156. /*
  157.  * Prototypes
  158.  */
  159. void fsm_init (fsm*);
  160. void fsm_lowerup (fsm*);
  161. void fsm_lowerdown (fsm*);
  162. void fsm_open (fsm*);
  163. void fsm_close (fsm*, char*);
  164. void fsm_input (fsm*, u_char*, int);
  165. void fsm_protreject (fsm*);
  166. void fsm_sdata (fsm*, u_char, u_char, u_char*, int);
  167. #endif /* FSM_H */