home *** CD-ROM | disk | FTP | other *** search
/ PC Format (South-Africa) 2001 June / PCFJune.iso / Xenon / C++ / FreeCommandLineTools.exe / Include / bh.h < prev    next >
Encoding:
C/C++ Source or Header  |  2000-01-31  |  20.6 KB  |  489 lines
  1.  
  2. //=============================================================================
  3. //  Microsoft (R) Bloodhound (tm). Copyright (C) 1991-1998.
  4. //
  5. //  MODULE: bh.h
  6. //
  7. //  This is the top-level include file for all Bloodhound components.
  8. //=============================================================================
  9.  
  10. #if !defined(_BH_)
  11. #pragma option push -b -a8 -pc -A- /*P_O_Push*/
  12.  
  13. #define _BH_
  14.  
  15. #include "naltypes.h"               //... Network types.
  16. #include "bhsupp.h"                 //... Supplemental API's.
  17. #include "nal.h"                    //... Network definitions.
  18. #include "bhtypes.h"                //... Type definitions for BH.
  19. #include "bherr.h"                  //... Error code definitions for BH.
  20. #include "bhfilter.h"               //... Filter definitions.
  21. #include "parser.h"                 //... Parser helper functions and structures.
  22. #include "inilib.h"
  23.  
  24. #pragma pack(1)
  25.  
  26. //=============================================================================
  27. //  A frame with no number contains this value as its frame number.
  28. //=============================================================================
  29.  
  30. #define INVALID_FRAME_NUMBER            ((DWORD) -1)
  31.  
  32. //=============================================================================
  33. //  Capture file flags.
  34. //=============================================================================
  35.  
  36. #define CAPTUREFILE_OPEN                OPEN_EXISTING
  37. #define CAPTUREFILE_CREATE              CREATE_NEW
  38.  
  39. //=============================================================================
  40. //  TRANSMIT API's.
  41. //=============================================================================
  42.  
  43. extern LPTRANSMITSTATS      WINAPI TransmitFrame(HNETWORK   hNetwork,
  44.                                                  HFRAME     hFrame,
  45.                                                  DWORD      Iterations,
  46.                                                  DWORD      TimeDelta,
  47.                                                  LPDWORD    TxCorrelator);
  48.  
  49. extern LPTRANSMITSTATS      WINAPI TransmitCapture(HNETWORK     hNetwork,
  50.                                                    HCAPTURE     hCapture,
  51.                                                    DWORD        StartingFrameNumber,
  52.                                                    DWORD        EndingFrameNumber,
  53.                                                    DWORD        Iterations,
  54.                                                    DWORD        IterationTimeDelta,
  55.                                                    DWORD        TimeDelta,
  56.                                                    FILTERPROC   FilterProc,
  57.                                                    LPVOID       FilterInstData,
  58.                                                    LPDWORD      TxCorrelator);
  59.  
  60. //=============================================================================
  61. //  CAPTURE CONTEXT API's.
  62. //=============================================================================
  63.  
  64. extern DWORD                WINAPI StationQuery(DWORD NetworkID,
  65.                                                LPADDRESS DestAddress,
  66.                                                LPQUERYTABLE QueryTable,
  67.                                                HPASSWORD hPassword);
  68.  
  69. extern HCAPTURE             WINAPI CreateCapture(HWND hWnd,
  70.                                                 HBUFFER hBuffer,
  71.                                                 HPASSWORD hPassword);
  72.  
  73. extern DWORD                WINAPI DestroyCapture(HCAPTURE hCapture);
  74.  
  75. extern LPVOID               WINAPI GetCaptureInstanceData(HCAPTURE hCapture);
  76.  
  77. extern HADDRESSDB           WINAPI GetCaptureAddressDB(HCAPTURE hCapture);
  78.  
  79. extern LPSYSTEMTIME         WINAPI GetCaptureTimeStamp(HCAPTURE hCapture);
  80.  
  81. extern DWORD                WINAPI GetCaptureTotalFrames(HCAPTURE hCapture);
  82.  
  83. extern HBUFFER              WINAPI GetCaptureBuffer(HCAPTURE hCapture);
  84.  
  85. extern LPSTR                WINAPI GetCaptureComment(HCAPTURE hCapture);
  86.  
  87. extern DWORD                WINAPI LoadCapture(HCAPTURE hCapture, LPSTR FileName);
  88.  
  89. extern DWORD                WINAPI SaveCapture(HCAPTURE   hCapture,
  90.                                               LPSTR      FileName,
  91.                                               LPSTR      lpComment,
  92.                                               LPVOID     UserData,
  93.                                               DWORD      UserDataLength,
  94.                                               FILTERPROC FilterProc,
  95.                                               LPVOID     FilterInstData,
  96.                                               DWORD      nFirstFrame,
  97.                                               DWORD      nLastFrame);
  98.  
  99. extern LPVOID               WINAPI SetCaptureInstanceData(HCAPTURE hCapture, LPVOID InstData);
  100.  
  101. extern HADDRESSDB           WINAPI SetCaptureAddressDB(HCAPTURE hCapture, HADDRESSDB);
  102.  
  103. //=============================================================================
  104. //  FRAME HELP API's.
  105. //=============================================================================
  106.  
  107. extern BOOL                 WINAPI ConvertMacAddress(LPADDRESS Address, DWORD NewAddressType);
  108.  
  109. extern DWORD                WINAPI MacTypeToAddressType(DWORD MacType);
  110.  
  111. extern DWORD                WINAPI AddressTypeToMacType(DWORD AddressType);
  112.  
  113. extern DWORD                WINAPI GetFrameDstAddressOffset(HFRAME hFrame, DWORD AddressType, LPDWORD AddressLength);
  114.  
  115. extern DWORD                WINAPI GetFrameSrcAddressOffset(HFRAME hFrame, DWORD AddressType, LPDWORD AddressLength);
  116.  
  117. extern HCAPTURE             WINAPI GetFrameCaptureHandle(HFRAME hFrame);
  118.  
  119.  
  120. extern DWORD                WINAPI GetFrameDestAddress(HFRAME       hFrame,
  121.                                                        LPADDRESS    lpAddress,
  122.                                                        DWORD        AddressType,
  123.                                                        DWORD        Flags);
  124.  
  125. extern DWORD                WINAPI GetFrameSourceAddress(HFRAME     hFrame,
  126.                                                          LPADDRESS  lpAddress,
  127.                                                          DWORD      AddressType,
  128.                                                          DWORD      Flags);
  129.  
  130. extern DWORD                WINAPI GetFrameMacHeaderLength(HFRAME hFrame);
  131.  
  132. extern BOOL                 WINAPI CompareFrameDestAddress(HFRAME hFrame, LPADDRESS lpAddress);
  133.  
  134. extern BOOL                 WINAPI CompareFrameSourceAddress(HFRAME hFrame, LPADDRESS lpAddress);
  135.  
  136. extern DWORD                WINAPI GetFrameLength(HFRAME hFrame);
  137.  
  138. extern DWORD                WINAPI GetFrameStoredLength(HFRAME hFrame);
  139.  
  140. extern DWORD                WINAPI GetFrameMacType(HFRAME hFrame);
  141.  
  142. extern DWORD                WINAPI GetFrameMacHeaderLength(HFRAME hFrame);
  143.  
  144. extern DWORD                WINAPI GetFrameNumber(HFRAME hFrame);
  145.  
  146. extern LPBYTE               WINAPI GetFrameRoutingInformation(HFRAME hFrame, LPDWORD lpRILength);
  147.  
  148. extern DWORD                WINAPI GetFrameTimeStamp(HFRAME hFrame);
  149.  
  150. extern int                  WINAPI CompareRawAddresses(LPBYTE Address1, LPBYTE Address2, UINT AddressType);
  151.  
  152. //=============================================================================
  153. //  FRAME API's.
  154. //=============================================================================
  155.  
  156. extern DWORD                WINAPI InsertFrame(HCAPTURE hCapture, HFRAME hFrame, DWORD FrameNumber);
  157.  
  158. extern DWORD                WINAPI DeleteFrame(HCAPTURE hCapture, DWORD FrameNumber);
  159.  
  160. extern HFRAME               WINAPI ModifyFrame(HCAPTURE hCapture,
  161.                                                DWORD    FrameNumber,
  162.                                                LPBYTE   FrameData,
  163.                                                DWORD    FrameLength,
  164.                                                DWORD    TimeStamp);
  165.  
  166. extern HFRAME               WINAPI CreateFrame(LPBYTE FrameData, DWORD FrameLength, DWORD TimeStamp);
  167.  
  168. extern DWORD                WINAPI DestroyFrame(HFRAME hFrame);
  169.  
  170. extern HFRAME               WINAPI FindNextFrame(HFRAME hCurrentFrame,
  171.                                                 LPSTR ProtocolName,
  172.                                                 LPADDRESS lpDesstAddress,
  173.                                                 LPADDRESS lpSrcAddress,
  174.                                                 LPWORD ProtocolOffset,
  175.                                                 DWORD  OriginalFrameNumber,
  176.                                                 DWORD  nHighestFrame);
  177.  
  178. extern HFRAME               WINAPI FindPreviousFrame(HFRAME hCurrentFrame,
  179.                                                     LPSTR ProtocolName,
  180.                                                     LPADDRESS lpDstAddress,
  181.                                                     LPADDRESS lpSrcAddress,
  182.                                                     LPWORD ProtocolOffset,
  183.                                                     DWORD  OriginalFrameNumber,
  184.                                                     DWORD  nLowestFrame );
  185.  
  186. extern DWORD                WINAPI FrameRecognize(HFRAME hFrame);
  187.  
  188. extern HCAPTURE             WINAPI GetFrameCaptureHandle(HFRAME);
  189.  
  190. extern HFRAME               WINAPI GetFrame(HCAPTURE hCapture, DWORD FrameNumber);
  191.  
  192. extern LPRECOGNIZEDATATABLE WINAPI GetFrameRecognizeData(HFRAME hFrame);
  193.  
  194. extern LPBYTE               WINAPI LockFrame(HFRAME hFrame);
  195.  
  196. extern LPPROPERTYTABLE      WINAPI LockFrameText(HFRAME hFrame);
  197.  
  198. extern LPPROPERTYTABLE      WINAPI LockFramePropertyTable(HFRAME hFrame);
  199.  
  200. extern DWORD                WINAPI UnlockFrame(HFRAME hFrame);
  201.  
  202. extern DWORD                WINAPI UnlockFrameText(HFRAME hFrame);
  203.  
  204. extern DWORD                WINAPI UnlockFramePropertyTable(HFRAME hFrame);
  205.  
  206.  
  207. //=============================================================================
  208. //  AddFrame() is a special form of insert frame, it add the frame to
  209. //  the end of the current capture.
  210. //=============================================================================
  211.  
  212. INLINE DWORD WINAPI AddFrame(HCAPTURE hCapture, HFRAME hFrame)
  213. {
  214.     return InsertFrame(hCapture, hFrame, INVALID_FRAME_NUMBER);
  215. }
  216.  
  217.  
  218. #ifdef DEBUG
  219. extern VOID                 WINAPI DebugShowLocks(HCAPTURE hCapture);
  220.  
  221. extern VOID                 WINAPI DebugGetFrameLocks(HFRAME hFrame, LPDWORD lpLocks, LPDWORD lpPropertyTableLocks);
  222.  
  223. extern BOOL                 WINAPI DebugIsRemote(HCAPTURE hCapture);
  224. #endif
  225.  
  226. //=============================================================================
  227. //  Protocol API's.
  228. //=============================================================================
  229.  
  230. extern HPROTOCOL            WINAPI CreateProtocol(LPSTR ProtocolName,
  231.                                                   LPENTRYPOINTS lpEntryPoints,
  232.                                                   DWORD cbEntryPoints);
  233.  
  234. extern VOID                 WINAPI DestroyProtocol(HPROTOCOL hProtocol);
  235.  
  236. extern DWORD                WINAPI DisableProtocol(HCAPTURE hCapture, HPROTOCOL hProtocol);
  237.  
  238. extern DWORD                WINAPI EnableProtocol(HCAPTURE hCapture, HPROTOCOL hProtocol);
  239.  
  240. extern LPPROTOCOLTABLE      WINAPI EnumProtocols(VOID);
  241.  
  242. extern LPPROTOCOLINFO       WINAPI GetProtocolInfo(HPROTOCOL hProtocol);
  243.  
  244. extern LPSTR                WINAPI GetProtocolDLLName(HPROTOCOL hProtocol);
  245.  
  246. extern HPROPERTY            WINAPI GetProperty(HPROTOCOL hProtocol, LPSTR PropertyName);
  247.  
  248. extern HPROTOCOL            WINAPI GetProtocolFromProperty(HPROPERTY hProperty);
  249.  
  250. extern HPROTOCOL            WINAPI GetProtocolFromName(LPSTR ProtocolName);
  251.  
  252. extern DWORD                WINAPI GetProtocolStartOffset(HFRAME hFrame, LPSTR ProtocolName);
  253.  
  254. extern DWORD                WINAPI GetProtocolStartOffsetHandle(HFRAME hFrame, HPROTOCOL hProtocol);
  255.  
  256. extern LPPROTOCOLTABLE      WINAPI GetEnabledProtocols(HCAPTURE hCapture);
  257.  
  258. extern HPROTOCOL            WINAPI GetProtocolFromProtocolID(DWORD dwProtocolID);
  259.  
  260. extern VOID                 WINAPI SetMaxAmountOfProtocols(DWORD dwAmountOfProtocols);
  261.  
  262. extern DWORD                WINAPI GetMaxAmountOfProtocols();
  263.  
  264. //=============================================================================
  265. //  Property API's.
  266. //=============================================================================
  267.  
  268. extern DWORD                WINAPI CreatePropertyDatabase(HPROTOCOL hProtocol, DWORD nProperties);
  269.  
  270. extern DWORD                WINAPI DestroyPropertyDatabase(HPROTOCOL hProtocol);
  271.  
  272. extern HPROPERTY            WINAPI AddProperty(HPROTOCOL hProtocol, LPPROPERTYINFO PropertyInfo);
  273.  
  274. extern LPPROPERTYINST       WINAPI AttachPropertyInstance(HFRAME    hFrame,
  275.                                                           HPROPERTY hProperty,
  276.                                                           DWORD     Length,
  277.                                                           ULPVOID   lpData,
  278.                                                           DWORD     HelpID,
  279.                                                           DWORD     Level,
  280.                                                           DWORD     IFlags);
  281.  
  282. extern LPPROPERTYINST       WINAPI AttachPropertyInstanceEx(HFRAME      hFrame,
  283.                                                             HPROPERTY   hProperty,
  284.                                                             DWORD       Length,
  285.                                                             ULPVOID     lpData,
  286.                                                             DWORD       ExLength,
  287.                                                             ULPVOID     lpExData,
  288.                                                             DWORD       HelpID,
  289.                                                             DWORD       Level,
  290.                                                             DWORD       IFlags);
  291.  
  292. extern LPPROPERTYINST       WINAPI FindPropertyInstance(HFRAME hFrame, HPROPERTY hProperty);
  293.  
  294. extern LPPROPERTYINFO       WINAPI GetPropertyInfo(HPROPERTY hProperty);
  295.  
  296. extern LPSTR                WINAPI GetPropertyText(HFRAME hFrame, LPPROPERTYINST lpPI, LPSTR szBuffer, DWORD BufferSize);
  297.  
  298. extern INT WINAPI QueryProtocolState(HCAPTURE hCapture, HPROTOCOL hProtocol);
  299.  
  300. //=============================================================================
  301. //  ADDRESS API's.
  302. //=============================================================================
  303.  
  304. extern LPADDRESSINFO        WINAPI AddAddress(HADDRESSDB hAddressDB,
  305.                                               LPADDRESS  lpAddress,
  306.                                               LPSTR      lpName,
  307.                                               LPVOID     InstData);
  308.  
  309. extern HADDRESSDB           WINAPI CreateAddressDatabase(VOID);
  310.  
  311. extern DWORD                WINAPI DeleteAddress(HADDRESSDB hAddressDB, LPADDRESS lpAddressToDelete);
  312.  
  313. extern DWORD                WINAPI DestroyAddressDatabase(HADDRESSDB hAddressDB);
  314.  
  315. extern DWORD                WINAPI EmptyAddressDatabase(HADDRESSDB hAddressDB);
  316.  
  317. extern LPADDRESSINFO        WINAPI GetAddressInfo(HADDRESSDB hAddressDB, LPADDRESS lpAddress);
  318.  
  319. extern LPADDRESSINFO        WINAPI GetAddressInfoByName(HADDRESSDB hAddressDB, LPSTR lpName);
  320.  
  321. extern LPADDRESSINFOTABLE   WINAPI EnumAddresses(HADDRESSDB hAddressDB, int SortByType);
  322.  
  323. extern LPVOID               WINAPI GetAddressDatabaseInstanceData(HADDRESSDB hAddressDB);
  324.  
  325. extern LPVOID               WINAPI SetAddressDatabaseInstanceData(HADDRESSDB hAddressDB, LPVOID InstData);
  326.  
  327. extern LPADDRESSINFO *      WINAPI FindAddressInfoByAddress(LPADDRESSINFOTABLE lpAddressInfoTable, LPADDRESS lpAddress);
  328.  
  329. extern LPADDRESSINFO *      WINAPI FindAddressInfoByName(LPADDRESSINFOTABLE lpAddressInfoTable, LPSTR lpName,
  330.                                                          LPADDRESS lpSpecificAddress );
  331.  
  332. //=============================================================================
  333. //  MISC. API's.
  334. //=============================================================================
  335.  
  336. extern LPSTR                WINAPI GetSystemPath(LPSTR Path, DWORD Length);
  337.  
  338. extern DWORD                WINAPI GetCaptureCommentFromFilename(LPSTR lpFilename, LPSTR lpComment, DWORD BufferSize);
  339.  
  340. extern int                  WINAPI CompareAddresses(LPADDRESS lpAddress1, LPADDRESS lpAddress2);
  341.  
  342. extern DWORD                WINAPIV FormatPropertyInstance(LPPROPERTYINST lpPropertyInst, ...);
  343.  
  344. extern SYSTEMTIME *         WINAPI AdjustSystemTime(SYSTEMTIME *SystemTime, DWORD TimeDelta);
  345.  
  346. //=============================================================================
  347. //  MISC. API's.
  348. //=============================================================================
  349.  
  350. extern VOID                 WINAPI eprintf(LPSTR format, ...);
  351.  
  352. extern VOID                 WINAPI CreateErrorLogEntry(VOID);
  353.  
  354. extern DWORD                WINAPI BHGetLastError(VOID);
  355.  
  356. extern DWORD                WINAPI BHSetLastError(DWORD Error);
  357.  
  358. extern DWORD                WINAPI ResetPropertyInstanceLength( LPPROPERTYINST lpProp,
  359.                                                                 WORD nOrgLen,
  360.                                                                 WORD nNewLen );
  361.  
  362. //=============================================================================
  363. //  DEBUG API's.
  364. //=============================================================================
  365.  
  366. #ifdef DEBUG
  367.  
  368. //=============================================================================
  369. //  BreakPoint() macro.
  370. //=============================================================================
  371.  
  372. #ifdef _X86_
  373. #define BreakPoint()        _asm { int 3h }
  374. #else
  375. #define BreakPoint()        DebugBreak()
  376. #endif
  377.  
  378. //=============================================================================
  379. //  FUNCTION: BhAssert()
  380. //=============================================================================
  381.  
  382. INLINE VOID BhAssert(
  383.     LPVOID  assert,
  384.     LPSTR   file,
  385.     UINT    line,
  386.     LPVOID  msg
  387.     )
  388. {
  389.     if ( msg == NULL )
  390.     {
  391.         dprintf("ASSERT -- %s occured on line %u of file %s.\n",
  392.                  assert,
  393.                  line,
  394.                  file);
  395.     }
  396.     else
  397.     {
  398.         dprintf("ASSERT -- %s occured on line %u of file %s: Message = %s.\n",
  399.                 assert,
  400.                 line,
  401.                 file,
  402.                 msg);
  403.     }
  404. }
  405.  
  406. //=============================================================================
  407. //  MACRO: ASSERT()
  408. //=============================================================================
  409.  
  410. #define ASSERT(exp)                                 \
  411. {                                                   \
  412.     if ( !(exp) )                                   \
  413.     {                                               \
  414.         BhAssert(#exp, __FILE__, __LINE__, NULL);   \
  415.         BreakPoint();                               \
  416.     }                                               \
  417. }                                                   \
  418.  
  419. #define ASSERTMSG(exp, msg)                         \
  420. {                                                   \
  421.     if ( !(exp) )                                   \
  422.     {                                               \
  423.         BhAssert(#exp, __FILE__, __LINE__, msg);    \
  424.         BreakPoint();                               \
  425.     }                                               \
  426. }                                                   \
  427.  
  428. #else   //... DEBUG
  429.  
  430. #define ASSERT(exp)
  431.  
  432. #define ASSERTMSG(exp, msg)
  433.  
  434. #define ASSERT_DWORD_ALIGNMENT(p)       (p)
  435.  
  436. #endif  //... DEBUG
  437.  
  438. //=============================================================================
  439. //  PanicPoint().
  440. //=============================================================================
  441.  
  442. extern VOID WINAPI PanicMessage(UINT line, LPSTR file, LPSTR msg);
  443.  
  444. #ifdef DEBUG
  445.  
  446. #define PanicPoint()                            \
  447.     {                                           \
  448.         PanicMessage(__LINE__, __FILE__, NULL); \
  449.         BreakPoint();                           \
  450.     }
  451.  
  452. #else
  453.  
  454. #define PanicPoint()                            \
  455.     {                                           \
  456.         PanicMessage(__LINE__, __FILE__, NULL); \
  457.     }
  458.  
  459. #endif
  460.  
  461. //=============================================================================
  462. //  Alignment macro.
  463. //=============================================================================
  464.  
  465. #ifndef _X86_
  466. #ifdef DEBUG
  467.  
  468. INLINE LPVOID WINAPI ASSERT_DWORD_ALIGNMENT(LPVOID p)
  469. {
  470.     if ( (((DWORD) (p)) & 0x00000003) != 0 )
  471.     {
  472.         dprintf("Fatal error on line %u of %s. Pointer is not DWORD aligned.", __LINE__, __FILE__);
  473.  
  474.         BreakPoint();
  475.     }
  476.  
  477.     return p;
  478. }
  479.  
  480. #endif
  481.  
  482. #else
  483. #define ASSERT_DWORD_ALIGNMENT(p)       (p)
  484. #endif
  485.  
  486. #pragma pack()
  487. #pragma option pop /*P_O_Pop*/
  488. #endif
  489.