LpmApi.h
上传用户:dzyhzl
上传日期:2019-04-29
资源大小:56270k
文件大小:33k
源码类别:

模拟服务器

开发平台:

C/C++

  1. /*++
  2. Copyright (c) 1998-1999  Microsoft Corporation
  3. Module Name:
  4.     LPMAPI.H - Include file for Local Policy Module
  5. Abstract:
  6.     This module defines the LPM structures and types.
  7. Revision History:
  8.     There is no support for ACS in Windows XP or later versions of Windows.
  9. --*/
  10. /****************************************************************************
  11.             RSVPD -- ReSerVation Protocol Daemon
  12.                 USC Information Sciences Institute
  13.                 Marina del Rey, California
  14.         Original Version: Shai Herzog, Nov. 1993.
  15.         Current Version:  Steven Berson & Bob Braden, may 1996.
  16.   Copyright (c) 1996 by the University of Southern California
  17.   All rights reserved.
  18.   Permission to use, copy, modify, and distribute this software and its
  19.   documentation in source and binary forms for any purpose and without
  20.   fee is hereby granted, provided that both the above copyright notice
  21.   and this permission notice appear in all copies, and that any
  22.   documentation, advertising materials, and other materials related to
  23.   such distribution and use acknowledge that the software was developed
  24.   in part by the University of Southern California, Information
  25.   Sciences Institute.  The name of the University may not be used to
  26.   endorse or promote products derived from this software without
  27.   specific prior written permission.
  28.   THE UNIVERSITY OF SOUTHERN CALIFORNIA makes no representations about
  29.   the suitability of this software for any purpose.  THIS SOFTWARE IS
  30.   PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
  31.   INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  32.   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  33.   Other copyrights might apply to parts of this software and are so
  34.   noted when applicable.
  35. ********************************************************************/
  36. #ifndef __LPMAPI_H_
  37. #define __LPMAPI_H_
  38. #if _MSC_VER > 1000
  39. #pragma once
  40. #endif
  41. #ifdef __cplusplus
  42. extern "C"
  43. {
  44. #endif
  45. #ifndef CALLBACK
  46. #define CALLBACK __stdcall
  47. #endif
  48. #ifndef APIENTRY
  49. #define APIENTRY FAR __stdcall
  50. #endif
  51. /*
  52.  *  Standard format of an RSVP object header
  53.  */
  54. typedef struct {
  55.     USHORT  obj_length; /* Length in bytes */
  56.     UCHAR   obj_class;  /* Class (values defined below) */
  57.     UCHAR   obj_ctype;  /* C-Type (values defined below) */
  58. } RsvpObjHdr;
  59. #define ObjLength(x)   ((RsvpObjHdr *)x)->obj_length
  60. #define ObjCType(x)    ((RsvpObjHdr *)x)->obj_ctype
  61. #define ObjClass(x)    ((RsvpObjHdr *)x)->obj_class
  62. #define ObjData(x)     ((RsvpObjHdr *)(x)+1)
  63. /*
  64.  *  Define object classes: Class-Num values
  65.  */
  66. #define class_NULL              0
  67. #define class_SESSION           1
  68. #define class_SESSION_GROUP     2
  69. #define class_RSVP_HOP          3
  70. #define class_INTEGRITY         4
  71. #define class_TIME_VALUES       5
  72. #define class_ERROR_SPEC        6
  73. #define class_SCOPE             7
  74. #define class_STYLE             8
  75. #define class_FLOWSPEC          9   // these two are the same
  76. #define class_IS_FLOWSPEC       9  // since we added IS in front of the name
  77. #define class_FILTER_SPEC       10
  78. #define class_SENDER_TEMPLATE   11
  79. #define class_SENDER_TSPEC      12
  80. #define class_ADSPEC            13
  81. #define class_POLICY_DATA       14
  82. #define class_CONFIRM           15
  83. #define class_MAX               15
  84. /*
  85.  *  RSVP SESSION object
  86.  */
  87. #define ctype_SESSION_ipv4      1
  88. #define ctype_SESSION_ipv4GPI   3   /* IPSEC: Generalized Port Id */
  89. #define SESSFLG_E_Police    0x01    /* E_Police: Entry policing flag*/
  90. typedef struct {
  91.     IN_ADDR sess_destaddr;  // DestAddress
  92.     UCHAR   sess_protid;    // Protocol Id
  93.     UCHAR   sess_flags;     // Use the flags defined above
  94.     USHORT  sess_destport;  // DestPort
  95. } Session_IPv4;
  96. /*    GPI versions have virtual dest port instead of dest port; this
  97.  *    changes the interpretation but not the format, so we do not
  98.  *    define new structs for GPI.
  99.  */
  100. typedef struct {
  101.     RsvpObjHdr          sess_header;
  102.     union {
  103.         Session_IPv4    sess_ipv4;
  104.     }       sess_u;
  105. } RSVP_SESSION;
  106. // Useful defines to access components of SESSION obect
  107. #define Sess4Addr       sess_u.sess_ipv4.sess_destaddr
  108. #define Sess4Port       sess_u.sess_ipv4.sess_destport
  109. #define Sess4Protocol   sess_u.sess_ipv4.sess_protid
  110. #define Sess4Flags      sess_u.sess_ipv4.sess_flags
  111. /*
  112.  *  RSVP HOP object
  113.  */
  114. #define ctype_RSVP_HOP_ipv4 1
  115. typedef struct {
  116.     IN_ADDR     hop_ipaddr; // Next/Previous Hop Address
  117.     ULONG       hop_LIH;        // Logical Interface Handle
  118. } Rsvp_Hop_IPv4;
  119. typedef struct {
  120.     RsvpObjHdr          hop_header;
  121.     union {
  122.         Rsvp_Hop_IPv4   hop_ipv4;
  123.     } hop_u;
  124. } RSVP_HOP;
  125. #define Hop4LIH    hop_u.hop_ipv4.hop_LIH
  126. #define Hop4Addr   hop_u.hop_ipv4.hop_ipaddr
  127. /*
  128.  *  RSVP STYLE object
  129.  */
  130. //  Define values for option vector
  131. #define Opt_Share_mask  0x00000018  // 2 bits: Sharing control
  132. #define Opt_Distinct    0x00000008  // Distinct reservations
  133. #define Opt_Shared      0x00000010  // Shared reservations
  134. #define Opt_SndSel_mask 0x00000007  // 3 bits: Sender selection
  135. #define Opt_Wildcard    0x00000001  // Wildcard scope
  136. #define Opt_Explicit    0x00000002  // Explicit scope
  137. #define Style_is_Wildcard(p)    (((p)&Opt_SndSel_mask) == Opt_Wildcard)
  138. #define Style_is_Shared(p)      (((p)&Opt_Share_mask) == Opt_Shared)
  139. //  Define style values
  140. #define STYLE_WF    Opt_Shared + Opt_Wildcard
  141. #define STYLE_FF    Opt_Distinct + Opt_Explicit
  142. #define STYLE_SE    Opt_Shared + Opt_Explicit
  143. #define ctype_STYLE 1
  144. typedef struct {
  145.     RsvpObjHdr  style_header;
  146.     ULONG       style_word;
  147. } RESV_STYLE;
  148. /*
  149.  *  RSVP FILTER SPEC object
  150.  */
  151. #define ctype_FILTER_SPEC_ipv4      1   // IPv4 FILTER_SPEC
  152. #define ctype_FILTER_SPEC_ipv4GPI   4   // IPv4/GPI FILTER_SPEC
  153. typedef struct {
  154.     IN_ADDR filt_ipaddr;    // IPv4 SrcAddress
  155.     USHORT  filt_unused;
  156.     USHORT  filt_port;      // SrcPort
  157. } Filter_Spec_IPv4;
  158. typedef struct {
  159.     IN_ADDR filt_ipaddr;    // IPv4 SrcAddress
  160.     ULONG   filt_gpi;       // Generalized Port Id
  161. } Filter_Spec_IPv4GPI;
  162. typedef struct {
  163.     RsvpObjHdr              filt_header;
  164.     union {
  165.         Filter_Spec_IPv4    filt_ipv4;
  166.         Filter_Spec_IPv4GPI filt_ipv4gpi;
  167.     } filt_u;
  168. } FILTER_SPEC;
  169. #define FilterSrcaddr   filt_u.filt_ipv4.filt_ipaddr
  170. #define FilterSrcport   filt_u.filt_ipv4.filt_port
  171. /*
  172.  *  RSVP SENDER_TEMPLATE object
  173.  */
  174. #define ctype_SENDER_TEMPLATE_ipv4      1   // IPv4 SENDER_TEMPLATE
  175. #define ctype_SENDER_TEMPLATE_ipv4GPI   4   // IPv4/GPI SENDER_TEMPLATE
  176. typedef FILTER_SPEC  SENDER_TEMPLATE;       // Identical to FILTER_SPEC
  177. /*
  178.  *  RSVP SCOPE object class
  179.  */
  180. #define ctype_SCOPE_list_ipv4       1
  181. typedef struct {
  182.     IN_ADDR     scopl_ipaddr[1];        // var-len list of IP sender addrs
  183. } Scope_list_ipv4;
  184. typedef struct {
  185.     RsvpObjHdr          scopl_header;
  186.     union {
  187.         Scope_list_ipv4 scopl_ipv4;
  188.     } scope_u;
  189. } RSVP_SCOPE;
  190. #define Scope4Addr      scope_u.scopl_ipv4.scopl_ipaddr
  191. #define ScopeCnt(scp)   ((ObjLength(scp)-sizeof(RsvpObjHdr))/sizeof(struct in_addr))
  192. #define ScopeLen(cnt)   (cnt*sizeof(struct in_addr)+sizeof(RsvpObjHdr))
  193. /*
  194.  *  ERROR_SPEC object class
  195.  */
  196. #define ctype_ERROR_SPEC_ipv4   1
  197. typedef struct {
  198.     struct in_addr  errs_errnode;   /* Error Node Address       */
  199.     u_char      errs_flags; /* Flags:           */
  200. #define ERROR_SPECF_InPlace 0x01    /*   Left resv in place     */
  201. #define ERROR_SPECF_NotGuilty   0x02    /*   This rcvr not guilty   */
  202.     UCHAR       errs_code;  /* Error Code (def'd below) */
  203.     USHORT      errs_value; /* Error Value      */
  204. #define ERR_FORWARD_OK  0x8000      /* Flag: OK to forward state */
  205. #define Error_Usage(x)  (((x)>>12)&3)
  206. #define ERR_Usage_globl 0x00        /* Globally-defined sub-code */
  207. #define ERR_Usage_local 0x10        /* Locally-defined sub-code */
  208. #define ERR_Usage_serv  0x11        /* Service-defined sub-code */
  209. #define ERR_global_mask 0x0fff      /* Sub-code bits in Error Val */
  210. }    Error_Spec_IPv4;
  211. typedef struct {
  212.     RsvpObjHdr  errs_header;
  213.     union {
  214.         Error_Spec_IPv4 errs_ipv4;
  215.     } errs_u;
  216. }    ERROR_SPEC;
  217. #define errspec4_enode  errs_u.errs_ipv4.errs_errnode
  218. #define errspec4_code   errs_u.errs_ipv4.errs_code
  219. #define errspec4_value  errs_u.errs_ipv4.errs_value
  220. #define errspec4_flags  errs_u.errs_ipv4.errs_flags
  221. /*
  222.  *  POLICY_DATA object class
  223.  *
  224.  *      Contents are Opaque RSVP/SBM
  225.  */
  226. #define ctype_POLICY_DATA   1
  227. typedef struct {
  228.     RsvpObjHdr      PolicyObjHdr;
  229.     USHORT          usPeOffset;     // Offset to the start of Policy Elements
  230.                                     // from the begining of Policy Data
  231.     USHORT          usReserved;
  232. } POLICY_DATA;
  233. #define PD_HDR_LEN  sizeof(POLICY_DATA)
  234. typedef struct {
  235.     USHORT      usPeLength;     // Policy Element length
  236.     USHORT      usPeType;       // Policy Element type
  237.     UCHAR       ucPeData[4];    // Just a place holder to the start of
  238.                                 // Policy Element data
  239. } POLICY_ELEMENT;
  240. #define PE_HDR_LEN  (2 * sizeof(USHORT))
  241. /**************************************************************************
  242.  *
  243.  *  Int-Serv Data Structures
  244.  *
  245.  **************************************************************************/
  246. /*
  247.  *  Service numbers
  248.  */
  249. #define GENERAL_INFO            1
  250. #define GUARANTEED_SERV         2
  251. #define PREDICTIVE_SERV         3
  252. #define CONTROLLED_DELAY_SERV   4
  253. #define CONTROLLED_LOAD_SERV    5
  254. #define QUALITATIVE_SERV        6
  255. /*
  256.  *  Well-known parameter IDs
  257.  */
  258. enum  int_serv_wkp {
  259.     IS_WKP_HOP_CNT =        4,
  260.     IS_WKP_PATH_BW =        6,
  261.     IS_WKP_MIN_LATENCY =    8,
  262.     IS_WKP_COMPOSED_MTU =   10,
  263.     IS_WKP_TB_TSPEC =       127, /* Token-bucket TSPEC parm */
  264.     IS_WKP_Q_TSPEC =        128
  265. };
  266. /*
  267.  *  Int-serv Main header
  268.  */
  269. typedef struct {
  270.     UCHAR   ismh_version;   // Version
  271.     UCHAR   ismh_unused;
  272.     USHORT  ismh_len32b;    // # 32-bit words excluding this hdr
  273. } IntServMainHdr;
  274. #define INTSERV_VERS_MASK   0xf0
  275. #define INTSERV_VERSION0    0
  276. #define Intserv_Version(x)      (((x)&INTSERV_VERS_MASK)>>4)
  277. #define Intserv_Version_OK(x)   (((x)->ismh_version&INTSERV_VERS_MASK)== 
  278.                                 INTSERV_VERSION0)
  279. // Convert ishm_length to equivalent RSVP object size, for checking
  280. #define Intserv_Obj_size(x) (((IntServMainHdr *)(x))->ismh_len32b * 4 + 
  281.                             sizeof(IntServMainHdr) + sizeof(RsvpObjHdr))
  282. /*
  283.  *  Int-serv Service Element Header
  284.  */
  285. // Flag: Break bit
  286. #define ISSH_BREAK_BIT    0x80
  287. typedef struct {
  288.     UCHAR       issh_service;   // Service number
  289.     UCHAR       issh_flags;     // Flag byte
  290.     USHORT      issh_len32b;    // #32-bit words excluding this hdr
  291. }  IntServServiceHdr;
  292. #define Issh_len32b(p)  ((p)->issh_len32b)
  293. /*
  294.  *  Int-serv Parameter Element Header
  295.  */
  296. #define ISPH_FLG_INV    0x80        // Flag: Invalid
  297. typedef struct {
  298.     UCHAR       isph_parm_num;  // Parameter number
  299.     UCHAR       isph_flags;     // Flags
  300.     USHORT      isph_len32b;    // #32-bit words excluding this hdr
  301. }  IntServParmHdr;
  302. #define Next_Main_Hdr(p)   (IntServMainHdr *)((ULONG *)(p)+1+(p)->ismh_len32b)
  303. #define Next_Serv_Hdr(p)   (IntServServiceHdr *)((ULONG *)(p)+1+(p)->issh_len32b)
  304. #define Next_Parm_Hdr(p)   (IntServParmHdr *)((ULONG *)(p)+1+(p)->isph_len32b)
  305. /*
  306.  *  Generic Tspec Parameters
  307.  */
  308. typedef struct {
  309.     FLOAT       TB_Tspec_r;     // Token bucket rate (B/sec)
  310.     FLOAT       TB_Tspec_b;     // Token bucket depth (B)
  311.     FLOAT       TB_Tspec_p;     // Peak data rate (B/sec)
  312.     ULONG       TB_Tspec_m;     // Min Policed Unit (B)
  313.     ULONG       TB_Tspec_M;     // Max pkt size (B)
  314. } GenTspecParms;
  315. /*
  316.  *  Generic Tspec
  317.  */
  318. typedef struct {
  319.     IntServServiceHdr   gen_Tspec_serv_hdr; // (GENERAL_INFO, length)
  320.     IntServParmHdr      gen_Tspec_parm_hdr; // (IS_WKP_TB_TSPEC)
  321.     GenTspecParms       gen_Tspec_parms;
  322. } GenTspec;
  323. #define gtspec_r        gen_Tspec_parms.TB_Tspec_r
  324. #define gtspec_b        gen_Tspec_parms.TB_Tspec_b
  325. #define gtspec_m        gen_Tspec_parms.TB_Tspec_m
  326. #define gtspec_M        gen_Tspec_parms.TB_Tspec_M
  327. #define gtspec_p        gen_Tspec_parms.TB_Tspec_p
  328. #define gtspec_parmno   gen_Tspec_parm_hdr.isph_parm_num
  329. #define gtspec_flags    gen_Tspec_parm_hdr.isph_flags
  330. #define gtspec_len      (sizeof(GenTspec) - sizeof(IntServServiceHdr))
  331. /* contents of qualitative tspec */
  332. typedef struct {
  333.     ULONG       TB_Tspec_M;     // Max pkt size (M)
  334. } QualTspecParms;
  335. typedef struct {
  336.     IntServServiceHdr   qual_Tspec_serv_hdr; // (QUALITATIVE_SERV, length)
  337.     IntServParmHdr      qual_Tspec_parm_hdr; // (IS_WKP_Q_TSPEC)
  338.     QualTspecParms      qual_Tspec_parms;
  339. } QualTspec;
  340. typedef struct {
  341.     IntServServiceHdr   Q_spec_serv_hdr;    // (QUALITATIVE_SERV,0,len)
  342.     IntServParmHdr      Q_spec_parm_hdr;    // (IS_WKP_Q_TSPEC)
  343.     QualTspecParms      Q_spec_parms;       // QUALITATIVE Tspec parameters
  344. }  QualAppFlowSpec;
  345. #define QAspec_M        Q_spec_parms.TB_Tspec_M
  346. /*
  347.  *  Contents of int-serv Tspec
  348.  */
  349. typedef struct {
  350.     IntServMainHdr  st_mh;
  351.     union {
  352.         GenTspec    gen_stspec; // Generic Tspec
  353.         QualTspec   qual_stspec;
  354.     } tspec_u;
  355. } IntServTspecBody;
  356. /*
  357.  *  SENDER_TSPEC class object
  358.  */
  359. #define ctype_SENDER_TSPEC  2
  360. typedef struct {
  361.     RsvpObjHdr          stspec_header;
  362.     IntServTspecBody    stspec_body;
  363. } SENDER_TSPEC;
  364. /*
  365.  *  Controlled-Load Flowspec
  366.  */
  367. typedef struct {
  368.     IntServServiceHdr   CL_spec_serv_hdr;    // (CONTROLLED_LOAD_SERV,0,len)
  369.     IntServParmHdr      CL_spec_parm_hdr;    // (IS_WKP_TB_TSPEC)
  370.     GenTspecParms       CL_spec_parms;       // GENERIC Tspec parameters
  371. }  CtrlLoadFlowspec;
  372. #define CLspec_r        CL_spec_parms.TB_Tspec_r
  373. #define CLspec_b        CL_spec_parms.TB_Tspec_b
  374. #define CLspec_p        CL_spec_parms.TB_Tspec_p
  375. #define CLspec_m        CL_spec_parms.TB_Tspec_m
  376. #define CLspec_M        CL_spec_parms.TB_Tspec_M
  377. #define CLspec_parmno   CL_spec_parm_hdr.isph_parm_num
  378. #define CLspec_flags    CL_spec_parm_hdr.isph_flags
  379. #define CLspec_len32b   CL_spec_parm_hdr.isph_len32b
  380. #define CLspec_len      (sizeof(CtrlLoadFlowspec) - sizeof(IntServServiceHdr))
  381. /*  Service-specific Parameter IDs
  382.  */
  383. enum    {
  384.     IS_GUAR_RSPEC =     130,
  385.     GUAR_ADSPARM_C  =   131,
  386.     GUAR_ADSPARM_D  =   132,
  387.     GUAR_ADSPARM_Ctot = 133,
  388.     GUAR_ADSPARM_Dtot = 134,
  389.     GUAR_ADSPARM_Csum = 135,
  390.     GUAR_ADSPARM_Dsum = 136
  391. };
  392. /*
  393.  *  Guaranteed Rspec parameters
  394.  */
  395. typedef struct {
  396.     FLOAT       Guar_R;         //  Guaranteed Rate B/s
  397.     ULONG       Guar_S;         //  Slack term secs
  398. } GuarRspec;
  399. /*
  400.  *  Guaranteed Flowspec
  401.  */
  402. typedef struct {
  403.     IntServServiceHdr   Guar_serv_hdr;      // (GUARANTEED, 0, length)
  404.     IntServParmHdr      Guar_Tspec_hdr;     // (IS_WKP_TB_TSPEC,)
  405.     GenTspecParms       Guar_Tspec_parms;   // GENERIC Tspec parms
  406.     IntServParmHdr      Guar_Rspec_hdr;     // (IS_GUAR_RSPEC)
  407.     GuarRspec           Guar_Rspec;         // Guaranteed rate (B/sec)
  408. }   GuarFlowSpec;
  409. #define Gspec_r         Guar_Tspec_parms.TB_Tspec_r
  410. #define Gspec_b         Guar_Tspec_parms.TB_Tspec_b
  411. #define Gspec_p         Guar_Tspec_parms.TB_Tspec_p
  412. #define Gspec_m         Guar_Tspec_parms.TB_Tspec_m
  413. #define Gspec_M         Guar_Tspec_parms.TB_Tspec_M
  414. #define Gspec_R         Guar_Rspec.Guar_R
  415. #define Gspec_S         Guar_Rspec.Guar_S
  416. #define Gspec_T_parmno  Guar_Tspec_hdr.isph_parm_num
  417. #define Gspec_T_flags   Guar_Tspec_hdr.isph_flags
  418. #define Gspec_R_parmno  Guar_Rspec_hdr.isph_parm_num
  419. #define Gspec_R_flags   Guar_Rspec_hdr.isph_flags
  420. #define Gspec_len       (sizeof(GuarFlowSpec) - sizeof(IntServServiceHdr))
  421. /*
  422.  *  Contents of int-serv flowspec
  423.  */
  424. typedef struct {
  425.     IntServMainHdr          spec_mh;
  426.     union {
  427.         CtrlLoadFlowspec    CL_spec;   // Controlled-Load service
  428.         GuarFlowSpec        G_spec;    // Guaranteed service
  429.         
  430.         QualAppFlowSpec     Q_spec;
  431.         
  432.     } spec_u;
  433. }   IntServFlowSpec;
  434. #define ISmh_len32b     spec_mh.ismh_len32b
  435. #define ISmh_version    spec_mh.ismh_version
  436. #define ISmh_unused     spec_mh.ismh_unused
  437. /*
  438.  *  Int-Serv FLOWSPEC object
  439.  */
  440. #define ctype_FLOWSPEC_Intserv0  2  // The int-serv flowspec (v.0)
  441. typedef struct {
  442.     RsvpObjHdr          flow_header;
  443.     IntServFlowSpec     flow_body;
  444. }IS_FLOWSPEC;
  445. /*
  446.  *  FLOW DESCRIPTOR
  447.  */
  448. typedef struct flow_desc {
  449.     union {
  450.         SENDER_TSPEC   *stspec;
  451.         IS_FLOWSPEC    *isflow;
  452.     } u1;
  453.     union {
  454.        SENDER_TEMPLATE *stemp;
  455.        FILTER_SPEC     *fspec;
  456.     } u2;
  457. } FLOW_DESC;
  458. #define FdSenderTspec       u1.stspec
  459. #define FdIsFlowSpec        u1.isflow
  460. #define FdSenderTemplate    u2.stemp
  461. #define FdFilterSpec        u2.fspec
  462. /*
  463.  *  ADSPEC class object
  464.  *
  465.  *      Opaque to RSVP -- Contents defined in rapi_lib.h
  466.  */
  467. #define ctype_ADSPEC_INTSERV    2
  468. /*
  469.  *  Guaranteed service Adspec parameters -- fixed part
  470.  */
  471. typedef struct {
  472.     IntServServiceHdr   Gads_serv_hdr;  // GUARANTEED, x, len
  473.     
  474.     IntServParmHdr      Gads_Ctot_hdr;  // GUAR_ADSPARM_Ctot
  475.     ULONG               Gads_Ctot;
  476.     
  477.     IntServParmHdr      Gads_Dtot_hdr;  // (GUAR_ADSPARM_Dtot
  478.     ULONG               Gads_Dtot;
  479.     
  480.     IntServParmHdr      Gads_Csum_hdr;  // GUAR_ADSPARM_Csum
  481.     ULONG               Gads_Csum;
  482.     
  483.     IntServParmHdr      Gads_Dsum_hdr;  // GUAR_ADSPARM_Dsum
  484.     ULONG               Gads_Dsum;
  485.     
  486.     /*
  487.      *  May be followed by override general param values
  488.      */
  489. } Gads_parms_t;
  490. /*
  491.  *  General Path Characterization Parameters
  492.  */
  493. typedef struct {
  494.     IntServServiceHdr   gen_parm_hdr;           // GENERAL_INFO, len
  495.     IntServParmHdr      gen_parm_hopcnt_hdr;    // (IS_WKP_HOP_CNT
  496.     ULONG               gen_parm_hopcnt;
  497.     IntServParmHdr      gen_parm_pathbw_hdr;    // IS_WKP_PATH_BW
  498.     FLOAT               gen_parm_path_bw;
  499.     IntServParmHdr      gen_parm_minlat_hdr;    // IS_WKP_MIN_LATENCY
  500.     ULONG               gen_parm_min_latency;
  501.     IntServParmHdr      gen_parm_compmtu_hdr;   // IS_WKP_COMPOSED_MTU 
  502.     ULONG               gen_parm_composed_MTU;
  503.     
  504. } GenAdspecParams;
  505. /*
  506.  *  Contents of (minimal) int-serv Adspec
  507.  */
  508. typedef struct {
  509.     IntServMainHdr      adspec_mh;      // Main header
  510.     
  511.     GenAdspecParams     adspec_genparms;// General char parm fragment
  512.     
  513.     /*
  514.      *  Followed by variable-length fragments for some or all
  515.      *  services.  These can be minimal length fragments.
  516.      */
  517.      
  518. } IS_ADSPEC_BODY;
  519. #define GEN_ADSPEC_LEN (sizeof(Object_header) + sizeof(IS_adsbody_t ) )
  520. typedef struct {
  521.     RsvpObjHdr      adspec_header;
  522.     
  523.     IS_ADSPEC_BODY  adspec_body;    /* Defined in rapi_lib.h */
  524. } ADSPEC;
  525. // RSVP message types
  526. #define RSVP_PATH       1
  527. #define RSVP_RESV       2
  528. #define RSVP_PATH_ERR   3
  529. #define RSVP_RESV_ERR   4
  530. #define RSVP_PATH_TEAR  5
  531. #define RSVP_RESV_TEAR  6
  532. /*  RSVP error codes
  533.  */
  534. #define RSVP_Err_NONE       0   /* No error (CONFIRM)       */
  535. #define RSVP_Erv_Nonev      0   /*    No-error Error Value  */
  536. /* Admission Control failure    */
  537. #define RSVP_Err_ADMISSION  1
  538. /* Globally-defined sub-codes for : Admission Control failure */
  539. #define RSVP_Erv_Other      0   /* Unspecified cause        */
  540. #define RSVP_Erv_DelayBnd   1   /* Cannot meet delay bound req  */
  541. #define RSVP_Erv_Bandwidth  2   /* Insufficient bandwidth   */
  542. #define RSVP_Erv_MTU        3   /* MTU in flowspec too large    */
  543. // Microsoft specific error values
  544. #define RSVP_Erv_Flow_Rate          0x8001
  545. #define RSVP_Erv_Bucket_szie        0x8002
  546. #define RSVP_Erv_Peak_Rate          0x8003
  547. #define RSVP_Erv_Min_Policied_size  0x8004
  548. /* Policy control failure   */
  549. #define RSVP_Err_POLICY     2
  550. // Policy error values from Identity draft
  551. #define POLICY_ERRV_NO_MORE_INFO                1
  552. #define POLICY_ERRV_UNSUPPORTED_CREDENTIAL_TYPE 2
  553. #define POLICY_ERRV_INSUFFICIENT_PRIVILEGES     3
  554. #define POLICY_ERRV_EXPIRED_CREDENTIALS         4
  555. #define POLICY_ERRV_IDENTITY_CHANGED            5
  556. // Microsoft specific policy error values
  557. #define POLICY_ERRV_UNKNOWN                         0
  558. #define POLICY_ERRV_GLOBAL_DEF_FLOW_COUNT           1
  559. #define POLICY_ERRV_GLOBAL_GRP_FLOW_COUNT           2
  560. #define POLICY_ERRV_GLOBAL_USER_FLOW_COUNT          3
  561. #define POLICY_ERRV_GLOBAL_UNAUTH_USER_FLOW_COUNT   4
  562. #define POLICY_ERRV_SUBNET_DEF_FLOW_COUNT           5
  563. #define POLICY_ERRV_SUBNET_GRP_FLOW_COUNT           6
  564. #define POLICY_ERRV_SUBNET_USER_FLOW_COUNT          7
  565. #define POLICY_ERRV_SUBNET_UNAUTH_USER_FLOW_COUNT   8
  566. #define POLICY_ERRV_GLOBAL_DEF_FLOW_DURATION        9
  567. #define POLICY_ERRV_GLOBAL_GRP_FLOW_DURATION        10
  568. #define POLICY_ERRV_GLOBAL_USER_FLOW_DURATION       11
  569. #define POLICY_ERRV_GLOBAL_UNAUTH_USER_FLOW_DURATION 12
  570. #define POLICY_ERRV_SUBNET_DEF_FLOW_DURATION        13
  571. #define POLICY_ERRV_SUBNET_GRP_FLOW_DURATION        14
  572. #define POLICY_ERRV_SUBNET_USER_FLOW_DURATION       15
  573. #define POLICY_ERRV_SUBNET_UNAUTH_USER_FLOW_DURATION   16
  574. #define POLICY_ERRV_GLOBAL_DEF_FLOW_RATE            17
  575. #define POLICY_ERRV_GLOBAL_GRP_FLOW_RATE            18
  576. #define POLICY_ERRV_GLOBAL_USER_FLOW_RATE           19
  577. #define POLICY_ERRV_GLOBAL_UNAUTH_USER_FLOW_RATE    20
  578. #define POLICY_ERRV_SUBNET_DEF_FLOW_RATE            21
  579. #define POLICY_ERRV_SUBNET_GRP_FLOW_RATE            22
  580. #define POLICY_ERRV_SUBNET_USER_FLOW_RATE           23
  581. #define POLICY_ERRV_SUBNET_UNAUTH_USER_FLOW_RATE    24
  582. #define POLICY_ERRV_GLOBAL_DEF_PEAK_RATE            25
  583. #define POLICY_ERRV_GLOBAL_GRP_PEAK_RATE            26
  584. #define POLICY_ERRV_GLOBAL_USER_PEAK_RATE           27
  585. #define POLICY_ERRV_GLOBAL_UNAUTH_USER_PEAK_RATE    28
  586. #define POLICY_ERRV_SUBNET_DEF_PEAK_RATE            29
  587. #define POLICY_ERRV_SUBNET_GRP_PEAK_RATE            30
  588. #define POLICY_ERRV_SUBNET_USER_PEAK_RATE           31
  589. #define POLICY_ERRV_SUBNET_UNAUTH_USER_PEAK_RATE    32
  590. #define POLICY_ERRV_GLOBAL_DEF_SUM_FLOW_RATE        33
  591. #define POLICY_ERRV_GLOBAL_GRP_SUM_FLOW_RATE        34
  592. #define POLICY_ERRV_GLOBAL_USER_SUM_FLOW_RATE       35
  593. #define POLICY_ERRV_GLOBAL_UNAUTH_USER_SUM_FLOW_RATE 36
  594. #define POLICY_ERRV_SUBNET_DEF_SUM_FLOW_RATE        37
  595. #define POLICY_ERRV_SUBNET_GRP_SUM_FLOW_RATE        38
  596. #define POLICY_ERRV_SUBNET_USER_SUM_FLOW_RATE       39
  597. #define POLICY_ERRV_SUBNET_UNAUTH_USER_SUM_FLOW_RATE 40
  598. #define POLICY_ERRV_GLOBAL_DEF_SUM_PEAK_RATE        41
  599. #define POLICY_ERRV_GLOBAL_GRP_SUM_PEAK_RATE        42
  600. #define POLICY_ERRV_GLOBAL_USER_SUM_PEAK_RATE       43
  601. #define POLICY_ERRV_GLOBAL_UNAUTH_USER_SUM_PEAK_RATE 44
  602. #define POLICY_ERRV_SUBNET_DEF_SUM_PEAK_RATE        45
  603. #define POLICY_ERRV_SUBNET_GRP_SUM_PEAK_RATE        46
  604. #define POLICY_ERRV_SUBNET_USER_SUM_PEAK_RATE       47
  605. #define POLICY_ERRV_SUBNET_UNAUTH_USER_SUM_PEAK_RATE 48
  606. #define POLICY_ERRV_UNKNOWN_USER                    49
  607. #define POLICY_ERRV_NO_PRIVILEGES                   50
  608. #define POLICY_ERRV_EXPIRED_USER_TOKEN              51
  609. #define POLICY_ERRV_NO_RESOURCES                    52
  610. #define POLICY_ERRV_PRE_EMPTED                      53
  611. #define POLICY_ERRV_USER_CHANGED                    54
  612. #define POLICY_ERRV_NO_ACCEPTS                      55
  613. #define POLICY_ERRV_NO_MEMORY                       56
  614. #define POLICY_ERRV_CRAZY_FLOWSPEC                  57
  615. // Other RSVP defined Error codes
  616. #define RSVP_Err_NO_PATH        3   /* No path state for Resv   */
  617. #define RSVP_Err_NO_SENDER      4   /* No sender info for Resv  */
  618. #define RSVP_Err_BAD_STYLE      5   /* Conflicting style        */
  619. #define RSVP_Err_UNKNOWN_STYLE  6   /* Unknown reservation style    */
  620. #define RSVP_Err_BAD_DSTPORT    7   /* Conflicting DstPort in Sess  */
  621. #define RSVP_Err_BAD_SNDPORT    8   /* Conflicting Sender port  */
  622. #define RSVP_Err_AMBIG_FILTER   9   /* Ambiguous Filter spec in Resv*/
  623. #define RSVP_Err_PREEMPTED      12  /* Service Preempted        */
  624. /* Unknown object Class-Num */
  625. #define RSVP_Err_UNKN_OBJ_CLASS 13
  626. /*   ErrVal = Class_num, CType  */
  627.  /* Unknown object C-Type    */
  628. #define RSVP_Err_UNKNOWN_CTYPE  14
  629. /*   ErrVal = Class_num, CType  */
  630. #define RSVP_Err_API_ERROR      20  /* API client error     */
  631. /*   ErrVal = API error code    */
  632. /* Traffic Control error    */
  633. #define RSVP_Err_TC_ERROR       21
  634. /* Globally-defined sub-codes for : Traffic Control errors */
  635. #define RSVP_Erv_Conflict_Serv  01  /* Service Conflict     */
  636. #define RSVP_Erv_No_Serv        02  /* Unknown Service      */
  637. #define RSVP_Erv_Crazy_Flowspec 03  /* Unreasonable Flowspec    */
  638. #define RSVP_Erv_Crazy_Tspec    04  /* Unreasonable Tspec       */
  639. #define RSVP_Err_TC_SYS_ERROR   22  /* Traffic control system error */
  640.       /* ErrVal = kernel error code   */
  641. /* RSVP System error      */
  642. #define RSVP_Err_RSVP_SYS_ERROR 23
  643. /* Globally-defined sub-codes for : RSVP system errors */
  644. #define RSVP_Erv_MEMORY         1   /* Out of memory */
  645. #define RSVP_Erv_API            2   /* API logic error */
  646. // Identity Policy elements related defines
  647. // Reseved Identity PE types
  648. #define LPM_PE_USER_IDENTITY    2
  649. #define LPM_PE_APP_IDENTITY     3
  650. // Defines for Identity error values
  651. #define ERROR_NO_MORE_INFO          1
  652. #define UNSUPPORTED_CREDENTIAL_TYPE 2
  653. #define INSUFFICIENT_PRIVILEGES     3
  654. #define EXPIRED_CREDENTIAL          4
  655. #define IDENTITY_CHANGED            5
  656. typedef struct {
  657.     USHORT      usIdErrLength;
  658.     UCHAR       ucAType;
  659.     UCHAR       ucSubType;
  660.     USHORT      usReserved;
  661.     USHORT      usIdErrorValue;
  662.     UCHAR       ucIdErrData[4];
  663. } ID_ERROR_OBJECT;
  664.     
  665. #define ID_ERR_OBJ_HDR_LEN     (sizeof(ID_ERROR_OBJECT) - 4 * sizeof(UCHAR) )
  666. /*
  667.     LPM API specific definitions
  668. */
  669. /**************************************
  670.     LPM_Initialize
  671. ***************************************/
  672. DECLARE_HANDLE(LPM_HANDLE);
  673. DECLARE_HANDLE(RHANDLE);
  674. typedef ULONG   LPV;
  675. typedef USHORT  PETYPE;
  676. #define LPM_OK  0
  677. typedef int     MSG_TYPE;
  678. typedef struct rsvpmsgobjs {
  679.     MSG_TYPE        RsvpMsgType;
  680.     
  681.     RSVP_SESSION    *pRsvpSession;
  682.     
  683.     RSVP_HOP        *pRsvpFromHop;
  684.     
  685.     RSVP_HOP        *pRsvpToHop;
  686.     
  687.     RESV_STYLE      *pResvStyle;
  688.     
  689.     RSVP_SCOPE      *pRsvpScope;
  690.     
  691.     int             FlowDescCount;
  692.     
  693.     FLOW_DESC       *pFlowDescs;
  694.     
  695.     int             PdObjectCount;
  696.     
  697.     POLICY_DATA     **ppPdObjects;
  698.     
  699.     ERROR_SPEC      *pErrorSpec;
  700.     ADSPEC          *pAdspec;
  701.     
  702. } RSVP_MSG_OBJS;
  703. #ifdef DBG
  704. typedef void *
  705. (APIENTRY * PALLOCMEM) ( DWORD Size, char *szFileName, DWORD nLine );
  706. #else
  707. typedef void *
  708. (APIENTRY * PALLOCMEM) ( DWORD Size );
  709. #endif
  710. #ifdef DBG
  711. typedef void
  712. (APIENTRY * PFREEMEM) ( void *pv, char *szFileName, DWORD nLine );
  713. #else
  714. typedef void
  715. (APIENTRY * PFREEMEM) ( void *pv );
  716. #endif
  717. typedef struct policy_decision
  718. {
  719.     LPV             lpvResult;        // Use the LPV values from above
  720.     
  721.     WORD            wPolicyErrCode;   // RSVP defined error codes
  722.     
  723.     WORD            wPolicyErrValue;  // RSVP defined error values
  724.     
  725. } POLICY_DECISION;
  726. typedef
  727. ULONG *
  728. (CALLBACK * CBADMITRESULT) (    
  729.         LPM_HANDLE      LpmHandle,
  730.         
  731.         RHANDLE         RequestHandle,
  732.         ULONG           ulPcmActionFlags,
  733.     
  734.         int             LpmError,
  735.         
  736.         int             PolicyDecisionsCount,
  737.         
  738.         POLICY_DECISION *pPolicyDecisions );
  739. typedef
  740. ULONG *
  741. (CALLBACK * CBGETRSVPOBJECTS) (  
  742.         LPM_HANDLE  LpmHandle,
  743.         
  744.         RHANDLE     RequestHandle,
  745.         
  746.         int         LpmError,
  747.         
  748.         int         RsvpObjectsCount,
  749.         RsvpObjHdr  **ppRsvpObjects );
  750. // The above 2 call backs can return the following errors
  751. #define INV_LPM_HANDLE      1       // Supplied LpmHandle is invalid
  752. #define LPM_TIME_OUT        2       // LPM has returned results after the time limit
  753. #define INV_REQ_HANDLE      3       // Supplied Request handle is invalid
  754. #define DUP_RESULTS         4       // LPM has already returned results for this request
  755. #define INV_RESULTS         5       // Results supplied are invalid
  756. typedef struct lpminitinfo {
  757.     DWORD           PcmVersionNumber;
  758.     
  759.     DWORD           ResultTimeLimit;
  760.     
  761.     int             ConfiguredLpmCount;
  762.     
  763.     PALLOCMEM       AllocMemory;
  764.     
  765.     PFREEMEM        FreeMemory;
  766.     
  767.     CBADMITRESULT   PcmAdmitResultCallback;
  768.     
  769.     CBGETRSVPOBJECTS GetRsvpObjectsCallback;
  770.     
  771. } LPM_INIT_INFO;
  772. // Valid PE types
  773. // XXX ISSUE - Is 0xFFFF a better choice?
  774. #define LPM_PE_ALL_TYPES        0
  775. // Current LPM API version number
  776. #define LPM_API_VERSION_1        1
  777. // Current PCM version number
  778. #define PCM_VERSION_1    1
  779. ULONG
  780. APIENTRY
  781. LPM_Initialize (
  782.     IN  LPM_HANDLE      LpmHandle,
  783.     
  784.     IN  LPM_INIT_INFO   *pLpmInitInfo,
  785.     
  786.     OUT DWORD           *pLpmVersionNumber,
  787.     
  788.     OUT PETYPE          *pSupportedPeType,
  789.     
  790.     OUT VOID            *Reserved );
  791. /**************************************
  792.     LPM_Deiitialize
  793.     
  794. ***************************************/
  795. ULONG
  796. APIENTRY
  797. LPM_Deinitialize (    
  798.     IN  LPM_HANDLE      LpmHandle );
  799.             
  800. /**************************************
  801.     LPM_AdmitRsvpMsg
  802. ***************************************/
  803. // Valid LPV - LPM Priority Values
  804. #define LPV_RESERVED        0
  805. #define LPV_MIN_PRIORITY    1
  806. #define LPV_MAX_PRIORITY    0xFF00
  807. #define LPV_DROP_MSG        0xFFFD
  808. #define LPV_DONT_CARE       0xFFFE
  809. #define LPV_REJECT          0xFFFF
  810. // Valid values for PcmActionFlags
  811. #define FORCE_IMMEDIATE_REFRESH         1
  812. // Function return values for LPM_AdmitResvMsg
  813. #define LPM_RESULT_READY    0
  814. #define LPM_RESULT_DEFER    1
  815. ULONG
  816. APIENTRY
  817. LPM_AdmitRsvpMsg (
  818.     IN  RHANDLE         PcmReqHandle,
  819.     
  820.     IN  RSVP_HOP        *pRecvdIntf,
  821.     
  822.     IN  RSVP_MSG_OBJS   *pRsvpMsgObjs,
  823.     
  824.     IN  int             RcvdRsvpMsgLength,
  825.     
  826.     IN  UCHAR           *RcvdRsvpMsg,
  827.     OUT ULONG           *pulPcmActionFlags,
  828.     
  829.     OUT POLICY_DECISION *pPolicyDecisions,
  830.     
  831.     OUT void            *Reserved );
  832. /**************************************
  833.     LPM_GetRsvpObjects
  834. ***************************************/
  835. // Function return values are defined in LPM_AdmitResvMsg section
  836. ULONG
  837. APIENTRY
  838. LPM_GetRsvpObjects (
  839.     IN  RHANDLE         PcmReqHandle,
  840.     
  841.     IN  ULONG           MaxPdSize,
  842.     
  843.     IN  RSVP_HOP        *SendingIntfAddr,
  844.     
  845.     IN  RSVP_MSG_OBJS   *pRsvpMsgObjs,
  846.     
  847.     OUT int             *pRsvpObjectsCount,
  848.     OUT RsvpObjHdr      ***pppRsvpObjects,
  849.     
  850.     OUT void            *Reserved );
  851. /**************************************
  852.     LPM_DeleteState
  853. ***************************************/
  854. // TearDown reasons
  855. #define RCVD_PATH_TEAR      1
  856. #define RCVD_RESV_TEAR      2
  857. #define ADM_CTRL_FAILED     3
  858. #define STATE_TIMEOUT       4
  859. #define FLOW_DURATION       5
  860. VOID
  861. APIENTRY
  862. LPM_DeleteState(
  863.     IN  RSVP_HOP        *pRcvdIfAddr,
  864.     
  865.     IN  MSG_TYPE        RsvpMsgType,
  866.     
  867.     IN  RSVP_SESSION    *pRsvpSession,
  868.     
  869.     IN  RSVP_HOP        *pRsvpFromHop,
  870.     
  871.     IN  RESV_STYLE      *pResvStyle,
  872.     
  873.     IN  int             FilterSpecCount,
  874.     
  875.     IN  FILTER_SPEC     **ppFilterSpecList,
  876.     
  877.     IN  int             TearDownReason );
  878. /**************************************
  879.     LPM_IpAddrTable
  880. ***************************************/
  881. typedef struct lpmiptable {
  882.     ULONG       ulIfIndex;  // SNMP index for this interface
  883.     ULONG       MediaType;  // As defined in IPIFCONS.H
  884.     IN_ADDR     IfIpAddr;   // Interface IP address
  885.     IN_ADDR     IfNetMask;  // Interface subnet mask
  886. } LPMIPTABLE;
  887. BOOL
  888. APIENTRY
  889. LPM_IpAddressTable (
  890.     IN  ULONG       cIpAddrTable,
  891.     
  892.     IN  LPMIPTABLE  *pIpAddrTable );
  893. /**************************************
  894.     LPM_CommitResv
  895. ***************************************/
  896. // CommitDecision values
  897. #define RESOURCES_ALLOCATED             1
  898. #define RESOURCES_MODIFIED              2
  899. VOID
  900. APIENTRY
  901. LPM_CommitResv (
  902.     IN  RSVP_SESSION    *RsvpSession,
  903.     
  904.     IN  RSVP_HOP        *FlowInstalledIntf,
  905.     
  906.     IN  RESV_STYLE      *RsvpStyle,
  907.     
  908.     IN  int             FilterSpecCount,
  909.     
  910.     IN  FILTER_SPEC     **ppFilterSpecList,
  911.     
  912.     IN  IS_FLOWSPEC     *pMergedFlowSpec,
  913.     
  914.     IN  ULONG           CommitDecision );
  915. #ifdef __cplusplus
  916. }
  917. #endif
  918. #endif // __LPMAPI_H_