home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / CIncludes / OpenTptModule.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-05-01  |  27.9 KB  |  982 lines  |  [TEXT/MPS ]
  1. /*
  2.     File:        OpenTptModule.h
  3.  
  4.     Contains:    headers for STREAM modules developement
  5.  
  6.     Copyright:    © 1993-1996 by Apple Computer, Inc. and Mentat Inc., all rights reserved.
  7.  
  8. */
  9.  
  10. #ifndef __OPENTPTMODULE__
  11. #define __OPENTPTMODULE__
  12.  
  13. #define OTKERNEL    1
  14.  
  15. #ifndef __OPENTRANSPORT__
  16. #include <OpenTransport.h>
  17. #endif
  18. /*
  19.  * Some typedefs needed to include cred.h and mistream.h
  20.  */
  21. typedef UInt32    uint;        // this line deleted from release disk
  22. typedef UInt16    ushort;        // this line deleted from release disk
  23. typedef UInt32    ulong;        // this line deleted from release disk
  24. typedef UInt32    uid_t;
  25. typedef UInt32    gid_t;
  26. typedef UInt32    dev_t;
  27.  
  28. #ifndef _CRED_
  29. #include <cred.h>
  30. #endif
  31. #ifndef __OPENTPTCOMMON__
  32. #include <OpenTptCommon.h>
  33. #endif
  34. #ifndef _STROPTS_
  35. #include <stropts.h>
  36. #endif
  37. #ifndef _STRLOG_
  38. #include <strlog.h>
  39. #endif
  40.  
  41. #ifndef __MEMORY__
  42. #include <Memory.h>
  43. #endif
  44. #if SystemEightOrLater
  45.     #ifndef __SYNCHRONIZATION__
  46.     #include <Synchronization.h>
  47.     #endif
  48. #endif
  49.  
  50. #if defined(__MWERKS__) && GENERATING68K
  51. #pragma pointers_in_D0
  52. #endif
  53.  
  54. /*******************************************************************************
  55. ** Printing functions
  56. ********************************************************************************/
  57.  
  58. enum
  59. {
  60.     kOTPrintOnly        = 0,
  61.     kOTPrintThenStop    = 1
  62. };
  63.  
  64. #ifdef __cplusplus
  65. extern "C" {
  66. #endif
  67.  
  68. int OTKernelPrintf(int toDo, char* fmt, ...);
  69.  
  70. #ifdef __cplusplus
  71. }
  72. #endif
  73.  
  74. /*******************************************************************************
  75. ** Function to convert the "long" value that comes back in some of the
  76. ** netbufs as a result code to the equivalent OSStatus
  77. ********************************************************************************/
  78.  
  79. typedef long                    OTError;
  80.  
  81. #define GetEError(v)            ((OTUnixErr)(((v) >> 16) & 0xffff))
  82. #define GetXTIError(v)            ((OTXTIErr)((v) & 0xffff))
  83. #define MakeTPIEError(e)        ((OTError)(((((UInt16)(e)) << 16) | TSYSERR)))
  84. #define MakeDLPIEError(e)        ((OTError)(((((UInt16)(e)) << 16) | DL_SYSERR)))
  85. #define MakeXTIError(xti)        ((OTError)(xti))
  86. #define MakeOTError(xti, e)        ((OTError)((xti) | ((UInt16)(e)) << 16))
  87.  
  88. #ifdef __cplusplus
  89. extern "C" {
  90. #endif
  91.  
  92. OSStatus OTErrorToOSStatus(OTError);
  93.                     
  94. #ifdef __cplusplus
  95. }
  96. #endif
  97.  
  98. /*******************************************************************************
  99. ** Things need to be able to export a module
  100. ********************************************************************************/
  101.  
  102. /*    -------------------------------------------------------------------------
  103.     Synchronization level codes.  These are supplied to modsw_install and
  104.     stored in the appropriate tables.  sth_osr_open and
  105.     sth_ipush use these to set up synch queue subordination for new devices
  106.     and modules.
  107.     ------------------------------------------------------------------------- */
  108.  
  109.     enum
  110.     {
  111.         SQLVL_QUEUE            = 1,
  112.         SQLVL_QUEUEPAIR        = 2,
  113.         SQLVL_MODULE        = 3,
  114.         SQLVL_GLOBAL        = 4,
  115.     
  116.         SQLVL_DEFAULT        = SQLVL_MODULE
  117.     };
  118.  
  119. /*    -------------------------------------------------------------------------
  120.     The install_info structure.
  121.     ------------------------------------------------------------------------- */
  122.  
  123.     struct install_info
  124.     {
  125.         struct streamtab*    install_str;     /* Streamtab pointer.        */
  126.         UInt32                 install_flags;
  127.         UInt32                 install_sqlvl;    /* Synchronization level.    */
  128.         char*                install_buddy;    /* Shared writer list buddy */
  129.         long                ref_load;        /* Set to 0                    */
  130.         UInt32                ref_count;        /* set to 0                    */
  131.     };
  132.     
  133.     typedef struct install_info    install_info;
  134.     
  135.     //
  136.     //    Flags used in the install_flags field
  137.     //
  138.     enum
  139.     {
  140.          kOTModIsDriver            = 0x00000001,
  141.          kOTModIsModule            = 0x00000002,
  142.          
  143.          kOTModUpperIsTPI        = 0x00001000,
  144.          kOTModUpperIsDLPI        = 0x00002000,
  145.          kOTModLowerIsTPI        = 0x00004000,
  146.          kOTModLowerIsDLPI        = 0x00008000,
  147.         //
  148.         // This flag says you don't want per-context globals
  149.         //
  150.         kOTModGlobalContext        = 0x00800000,
  151.         //
  152.         // This flag is only valid if kOTModIsDriver is set
  153.         // and the driver is a PCI-card driver using the Name Registry
  154.         //
  155.         kOTModUsesInterrupts    = 0x08000000,
  156.         //
  157.         // This flag is only valid if kOTModIsDriver is set.
  158.         //
  159.         kOTModIsComplexDriver    = 0x20000000,
  160.         //
  161.         // These flags are only valid if kOTModIsModule is set.
  162.         //
  163.         kOTModIsFilter            = 0x40000000
  164.     };
  165.  
  166. /*    -------------------------------------------------------------------------
  167.     Typedef for the GetOTInstallInfo function
  168.     
  169.     Your module must export this function, and return a pointer to the
  170.     install_info structure for the module.
  171.     ------------------------------------------------------------------------- */
  172.  
  173.     typedef install_info* (* _CDECL GetOTInstallInfoProcPtr)(void);
  174.  
  175. /*    -------------------------------------------------------------------------
  176.     Typedef for the InitStreamModule function
  177.     
  178.     Your module can optionally export this function.  It will be called 
  179.     whenever your module is about to be loaded into a stream for the
  180.     first time, or if it is about to be reloaded after having been 
  181.     unloaded. Return false if your module should NOT be loaded.
  182.     For STREAMS modules, the void* parameter will be NULL.  For drivers, it
  183.     will be the same cookie parameter that was used for registering the module.
  184.     For PCI card drivers, this will be a pointer to the OTPCIInfo structure,
  185.     which can also be interpreted as a RegEntryIDPtr.
  186.     ------------------------------------------------------------------------- */
  187.     
  188.     typedef Boolean (* _CDECL InitStreamModuleProcPtr)(void*);
  189.  
  190. /*    -------------------------------------------------------------------------
  191.     Typedef for the TerminateStreamModule function
  192.     
  193.     Your module can optionally export this function.  It will be called 
  194.     whenever your module has been closed for the last time (i.e. no other 
  195.     outstanding instances of the module exist).
  196.     ------------------------------------------------------------------------- */
  197.     
  198.     typedef void (* _CDECL TerminateStreamModuleProcPtr)(void*);
  199.  
  200. /*******************************************************************************
  201. ** Equates for shared library prefixes
  202. ********************************************************************************/
  203.  
  204.     /*
  205.      * Prefixes for Open Transport driver experts.
  206.      */
  207.     #define kOTPortScannerPrefix        "ot:pScnr$"
  208.     
  209.     /*
  210.      * Interface ID for STREAMS Modules for ASLM
  211.      */
  212.     #define kOTModuleInterfaceID        kOTModulePrefix "StrmMod"
  213.  
  214. /*******************************************************************************
  215. ** Functions for dealing with major and minor device numbers
  216. ********************************************************************************/
  217.  
  218.     typedef UInt16            major_t;
  219.     typedef UInt16            minor_t;
  220.     
  221.     /* major part of a device */
  222.     #define getmajor(x)         ((major_t)(((unsigned long)(x)>>16)&0xffff))
  223.     
  224.     /* minor part of a device */
  225.     #define getminor(x)         ((minor_t)((x)&0xffff))
  226.     
  227.     /* make a device number */
  228.     #define makedev(x,y)        ((dev_t)((((dev_t)(x))<<16) | ((y) & 0xffff)))
  229.     
  230.     #define getemajor            getmajor
  231.     #define geteminor            getminor
  232.     #define makedevice            makedev
  233.     
  234.     #define    etoimajor(majnum)    (majnum)
  235.     #define    itoemajor(majnum,j)    (majnum)
  236.  
  237. /*******************************************************************************
  238. ** Some definitions
  239. ********************************************************************************/
  240.  
  241.     /*
  242.      * The first minor number that you should use for CLONEOPENs.
  243.      * Minor numbers 0 through 9 are reserved for use by the modules
  244.      * for various control streams.
  245.      */
  246.      enum
  247.      {
  248.          kFirstMinorNumber    = 10
  249.     };
  250.  
  251.     /*
  252.      * Extra OTCommand codes that may appear on your module queue.
  253.      * These are extensions to the TPI specification for Open Transport.
  254.      * T_PRIVATE_REQ is the first available TPI message number for private
  255.      * use by modules (assuming you don't want to be confused by standard
  256.      * TPI messages).
  257.      */
  258.     enum
  259.     {
  260.         T_TIMER_REQ        = 80,    // Timer event
  261.         T_MIB_REQ        = 81,    // Request module's MIB
  262.         T_MIB_ACK        = 82,    // The module's MIB is available
  263.         
  264.         T_PRIVATE_REQ    = 90    // The first private request available
  265.     };
  266.  
  267. /*******************************************************************************
  268. ** Logging Macros
  269. ********************************************************************************/
  270.  
  271. #ifdef __cplusplus
  272. extern "C" {
  273. #endif
  274.  
  275. void            OTStrlog(queue_t*, int, int, const char*);
  276.  
  277. #ifdef __cplusplus
  278. }
  279. #endif
  280. //
  281. // These are enums for the level value
  282. //
  283. enum
  284. {
  285.     kOTLvlFatal                = 0,
  286.     kOTLvlNonfatal            = 1,
  287.     kOTLvlExtFatal            = 2,
  288.     kOTLvlExtNonfatal        = 3,
  289.     kOTLvlUserErr            = 4,
  290.     kOTLvlInfoErr            = 5,
  291.     kOTLvlInfoOnly            = 6
  292. };
  293.  
  294. #define STRLOG(q, lvl, flags, str)        OTStrlog(q, lvl, flags, str)
  295.  
  296. #if qDebug
  297.     #define STRLOG1(q, lvl, flags, str)    OTStrlog(q, lvl, flags, str)
  298. #else
  299.     #define STRLOG1(q, lvl, flags, str)
  300. #endif
  301.  
  302. #if qDebug > 1 || qDebug2 > 1
  303.     #define STRLOG2(q, lvl, flags, str)    OTStrlog(q, lvl, flags, str)
  304. #else
  305.     #define STRLOG2(q, lvl, flags, str)
  306. #endif
  307.  
  308. /*******************************************************************************
  309. ** Structure definitions
  310. **
  311. ** These go along with the extra definitions above.
  312. ********************************************************************************/
  313.  
  314.     struct  T_MIB_req
  315.     {
  316.         long    PRIM_type;        /* Always T_MIB_REQ */
  317.     };
  318.     
  319.     struct  T_MIB_ack
  320.     {
  321.         long    PRIM_type;        /* Always T_MIB_ACK     */
  322.         long    MIB_length;        /* MIB length             */        
  323.         long    MIB_offset;        /* MIB Offset            */        
  324.     };
  325.     
  326.     struct T_stream_timer
  327.     {
  328.         long        PRIM_type;    /* Always T_TIMER_REQ */
  329.         union
  330.         {
  331.             long    USER_long;
  332.             void*    USER_ptr;
  333.     #ifndef __cplusplus
  334.         }            USER_data;
  335.     #else
  336.         };
  337.     #endif
  338.     };
  339.  
  340. /*    -------------------------------------------------------------------------
  341.     Internal port record structures
  342.     ------------------------------------------------------------------------- */
  343.  
  344.     /*    
  345.      * One TPortRecord is created for each instance of a port.
  346.      * For Instance 'enet' identifies an ethernet port.
  347.      * An TPortRecord for each ethernet card it finds, with an
  348.      * OTPortRef that will uniquely allow the ethernet driver to determine which
  349.      * port it is supposed to open on.
  350.      */
  351.  
  352.     typedef struct TPortRecord    TPortRecord;
  353.  
  354.     struct TPortRecord
  355.     {
  356.         OTLink                    fLink;
  357.         char*                    fPortName;
  358.         char*                    fModuleName;
  359.         char*                    fResourceInfo;
  360.         char*                    fSlotID;
  361.         struct TPortRecord*        fAlias;
  362.         size_t                    fNumChildren;
  363.         OTPortRef*                fChildPorts;
  364.         UInt32                    fPortFlags;
  365.         UInt32                    fInfoFlags;
  366.         UInt32                    fCapabilities;
  367.         OTPortRef                fRef;
  368.         struct streamtab*        fStreamtab;
  369.         void*                    fContext;
  370.         void*                    fExtra;
  371.     };
  372.  
  373. /*******************************************************************************
  374. ** "C" Interface routines
  375. ********************************************************************************/
  376.  
  377. #ifdef __cplusplus
  378. extern "C" {
  379. #endif
  380.  
  381. /*    -------------------------------------------------------------------------
  382.     Interrupt control functions
  383.     ------------------------------------------------------------------------- */
  384.  
  385. #if USES68KINLINES
  386.     //
  387.     // MPS_INTR_STATE saves the current interrupt state
  388.     // Its definition undoubtably changes with the definition
  389.     // of mps intr enable/disable, so this typedef is
  390.     // also inside the USE68KINLINES conditional.
  391.     //
  392.     typedef UInt8    MPS_INTR_STATE;
  393.     //
  394.     // Disable interrupts and save the state
  395.     //
  396.     #pragma parameter mps_intr_disable(__A0)
  397.     void mps_intr_disable(MPS_INTR_STATE*) =
  398.     {
  399.         0x40C0,             /*        move    sr,d0        */
  400.         0xE040,                /*        asr.w    #8,d0        */
  401.         0x007C, 0x0600,        /*        ori        #$600,sr    */
  402.         0x027C, 0xFEFF,     /*        andi    #$FEFF,sr    */
  403.         0x1080                /*         move.b d0,(a0)         */
  404.     #if qDebug
  405.         , 0x0200, 0x0070,    /*        andi.b    #$70,d0        */
  406.         0x0c00, 0x0070,        /*        cmpi.b    #$70,d0        */
  407.         0x6602,                /*        bne.s    @3            */
  408.         0xA9FF                /*        DebugBreak            */
  409.     #endif
  410.     };
  411.     //
  412.     // Enable interrupts from the saved state
  413.     //
  414.     #pragma parameter mps_intr_enable(__A0)
  415.     void mps_intr_enable(MPS_INTR_STATE* ptr) =
  416.     {
  417.     #if qDebug
  418.         0x40C0,             /*        move    sr,d0        */
  419.         0x0240, 0x0700,        /*        andi.w    #$700,d0    */
  420.         0x0C40, 0x0600,        /*        cmpi.w    #$600,d0    */
  421.         0x6702,                /*         beq.s    @2             */
  422.         0xA9FF,                /*         DebugBreak             */
  423.     #endif
  424.         0x1010,                /* @2    move.b    (a0),d0        */
  425.     #if qDebug
  426.         0x0200, 0x0070,        /*        andi.b    #$70,d0        */
  427.         0x0c00, 0x0070,        /*        cmpi.b    #$70,d0        */
  428.         0x6602,                /*        bne.s    @3            */
  429.         0xA9FF,                /*        DebugBreak            */
  430.         0x1010,                /* @3    move.b    (a0),d0        */
  431.     #endif
  432.         0xE140,                /*        asl.w    #8,d0        */
  433.         0x46C0                /*        move    d0,sr         */
  434.     };
  435. #else
  436.     #if SystemEightOrLater
  437.  
  438.         typedef InterruptState    MPS_INTR_STATE;
  439.  
  440.         #define mps_intr_disable(x)        *(x) = DisableInterrupts()
  441.         #define mps_intr_enable(x)        RestoreInterrupts(*x)
  442.  
  443.     #else
  444.     
  445.         typedef UInt8    MPS_INTR_STATE;
  446.  
  447.         void mps_intr_disable(MPS_INTR_STATE*);
  448.         void mps_intr_enable(MPS_INTR_STATE*);
  449.  
  450.     #endif
  451.  
  452. #endif
  453.  
  454. /*    -------------------------------------------------------------------------
  455.     The kOTPortScannerInterfaceID define is what you need to add to your
  456.     export file for the "interfaceID = " clause.  
  457.     PortScanProcPtr is the typedef for the scanning function.
  458.     Your port-scanning function must be exported by the name "OTScanPorts".
  459.     Your port-scanning function set must use the prefix kOTPortScannerPrefix.
  460.     ------------------------------------------------------------------------- */
  461.  
  462.     #define kOTPortScannerInterfaceID            kOTKernelPrefix "pScnr,1.0"
  463.     #define kOTPseudoPortScannerInterfaceID        kOTKernelPrefix "ppScnr,1.0"
  464.     
  465.     typedef void (* _CDECL PortScanProcPtr)(UInt32 scanType);
  466.  
  467.     enum    /* scanType */
  468.     {
  469.         kOTInitialScan        = 0,
  470.         kOTScanAfterSleep    = 1
  471.     };
  472.             
  473. /*    -------------------------------------------------------------------------
  474.     Port Registration
  475.     
  476.     These routines can be used to register, find and iterate through the
  477.     various ports on the machine
  478.     ------------------------------------------------------------------------- */
  479.         //
  480.         // Find the TPortRecord for a given Port Name
  481.         //
  482.     TPortRecord*    OTFindPort(const char* portName);
  483.         //
  484.         // Find the "nth" TPortRecord
  485.         //
  486.     TPortRecord*    OTGetIndexedPort(size_t index);
  487.         //
  488.         // Find another port that is active and conflicts with
  489.         // the port described by "ref"
  490.         //
  491.     TPortRecord*    OTFindPortConflict(OTPortRef ref);
  492.         //
  493.         // Other ways of finding the port
  494.         //
  495.     TPortRecord*    OTFindPortByRef(OTPortRef);
  496.     TPortRecord*    OTFindPortByDev(dev_t);
  497.         //
  498.         // Memory allocation for OTRegisterPort persistent data
  499.         //
  500.     void*            OTAllocPortMem(size_t);
  501.     void            OTFreePortMem(void*);
  502.     
  503. /*    -------------------------------------------------------------------------
  504.     Timer functions
  505.     ------------------------------------------------------------------------- */
  506.  
  507.     enum
  508.     {
  509.         kOTMinimumTimerValue    = 8        // 8 milliseconds is the minimum timeout value
  510.     };
  511.     
  512.     mblk_t*            mi_timer_q_switch(mblk_t*, queue_t*, mblk_t*);
  513.     Boolean            mi_timer_cancel(mblk_t*);
  514.     void            mi_timer(mblk_t*, unsigned long);
  515.     mblk_t*            mi_timer_alloc(queue_t*, size_t);
  516.     void            mi_timer_free(mblk_t*);
  517.     Boolean            mi_timer_valid(mblk_t*);
  518.  
  519. /*    -------------------------------------------------------------------------
  520.     Miscellaneous helpful routines
  521.     ------------------------------------------------------------------------- */
  522.     /*
  523.      * This routine is used by a driver at interrupt time to schedule
  524.      * a deferred task or SWI to run their interrupt processing code.
  525.      */
  526.      Boolean OTScheduleDriverDeferredTask(long dtCookie);
  527.     /*
  528.      * This is the typedef for a function that will be called when a message
  529.      * created by OTAllocMsg is destroyed.
  530.      */
  531.     typedef void    (* _CDECL EsbFreeProcPtr)(char* arg);
  532.     
  533.     /*
  534.      * This function creates a message which points to "size" bytes of data
  535.      * at "buf".  When the message is freed, the EsbFreeProcPtr function "func"
  536.      * will be called with the argument "arg".
  537.      * NOTE: This function allows users of your buffer to modify the buffer.
  538.      */
  539.     mblk_t* OTAllocMsg(void* buf, size_t size,  EsbFreeProcPtr func, void* arg);
  540.  
  541.     /*
  542.      * Routines to allocate and free memory in your modules (these are
  543.      * interrupt-time safe!). 
  544.      */
  545.  
  546.     void*    OTAllocMem(size_t);
  547.     void    OTFreeMem(void*);
  548.     void*    OTReallocMem(void* ptr, size_t newSize);
  549.  
  550.     /*
  551.      * Routines to calculate various sizes of STREAM messages
  552.      */
  553.     #define HEAD_SIZE(mp)    ((mp)->b_rptr - (mp)->b_datap->db_base)
  554.     #define TAIL_SIZE(mp)    ((mp)->b_datap->db_lim - (mp)->b_wptr)
  555.     #define MBLK_SIZE(mp)    ((mp)->b_wptr - (mp)->b_rptr)
  556.     #define DBLK_SIZE(mp)    ((mp)->b_datap->db_lim - (mp)->b_datap->db_base)
  557.     
  558.     #ifdef __cplusplus
  559.     extern "C" {
  560.     #endif
  561.     
  562.     int        mi_bcmp(const char* first, const char* second, size_t nBytes);
  563.     int        mi_sprintf (char * buf, char * fmt, ...);
  564.     
  565.     #ifdef __cplusplus
  566.     }
  567.     #endif
  568.     
  569.     #define bcopy(s, d, l)            OTMemcpy(d, s, l)
  570.     #define bzero(d, l)                OTMemzero(d, (size_t)(l))
  571.     #define bcmp(s, d, l)            mi_bcmp(s, d, l)
  572.  
  573.     /*
  574.      * Standard STREAMS bcopy, bzero, & bcmp take char* parameters.
  575.      * The BCOPY, BZERO, and BCMP routines take void* so that we do not have
  576.      * to cast all the pointers.
  577.      */
  578.     #define BCOPY(s, d, l)            bcopy((const char*)(s), (char*)(d), l)
  579.     #define BZERO(d, l)                bzero((char*)(d), l)
  580.     #define BCMP(s, d, l)            mi_bcmp((const char*)(s), (const char*)(d), l)
  581.  
  582.     /*
  583.      * Create sprintf and printf functions that will work in STREAM modules.
  584.      * Also, make sure that calling traditional "C" allocation routines
  585.      * will not compile.
  586.      */
  587.     #define sprintf                        mi_sprintf
  588.     #define printf                        OTKernelPrintf
  589.  
  590.     #define calloc                        (DONT_CALL*THIS_FUNCTION)
  591.     #define malloc                        (DONT_CALL*THIS_FUNCTION)
  592.     #define realloc                        (DONT_CALL*THIS_FUNCTION)
  593.     #define free                        (DONT_CALL*THIS_FUNCTION)
  594.  
  595.     /*
  596.      * A few other miscellaneous functions
  597.      */
  598.     int            drv_priv(struct cred* credp);
  599.     queue_t*    mi_allocq(struct streamtab*);
  600.     mblk_t*        mi_reallocb(mblk_t*, size_t new_Size);
  601.     
  602. #ifdef __cplusplus
  603. }
  604. #endif
  605.  
  606. /*******************************************************************************
  607. ** Some helpful utilites from Mentat
  608. ********************************************************************************/
  609.  
  610. #define    MI_COPY_IN        1
  611. #define    MI_COPY_OUT        2
  612. #define    MI_COPY_DIRECTION(mp)                             \
  613.     (((UInt8*)&(mp)->b_cont->b_prev)[0])
  614. #define    MI_COPY_COUNT(mp)                     \
  615.     (((UInt8*)&(mp)->b_cont->b_prev)[1])
  616. #define    MI_COPY_RVAL(mp)    (*(int *)&(mp)->b_cont->b_next)
  617. #define    MI_COPY_CASE(dir,cnt)    ((int)(((cnt)<<2)|dir))
  618. #define    MI_COPY_STATE(mp)                             \
  619.     ((int)MI_COPY_CASE(MI_COPY_DIRECTION(mp),MI_COPY_COUNT(mp)))
  620.  
  621. #ifdef __cplusplus
  622. extern "C" {
  623. #endif
  624.  
  625. typedef void    (*OTWriterProcPtr)(queue_t*, mblk_t*);
  626.  
  627. void    mps_become_writer(queue_t* q, mblk_t* mp, OTWriterProcPtr proc);
  628.  
  629. mblk_t*    mi_tpi_ack_alloc(mblk_t* mp, size_t size, long);
  630. mblk_t*    mi_tpi_conn_con(mblk_t* trailer_mp, char* src, size_t src_length, char* opt, size_t opt_length);
  631. mblk_t*    mi_tpi_conn_ind(mblk_t* trailer_mp, char* src, size_t src_length, char* opt, size_t opt_length, int seqnum);
  632. mblk_t*    mi_tpi_conn_req(mblk_t* trailer_mp, char* dest, size_t dest_length, char* opt, size_t opt_length);
  633. mblk_t*    mi_tpi_data_ind(mblk_t* trailer_mp, int flags, long type);
  634. mblk_t*    mi_tpi_data_req(mblk_t* trailer_mp, int flags, long type);
  635. mblk_t*    mi_tpi_discon_ind(mblk_t* trailer_mp, int reason, int seqnum);
  636. mblk_t*    mi_tpi_discon_req(mblk_t* trailer_mp, int seqnum);
  637. mblk_t*    mi_tpi_err_ack_alloc(mblk_t* mp, int tlierr, int unixerr);
  638. mblk_t*    mi_tpi_exdata_ind(mblk_t* trailer_mp, int flags, long type);
  639. mblk_t*    mi_tpi_exdata_req(mblk_t* trailer_mp, int flags, long type);
  640. mblk_t*    mi_tpi_info_req(void);
  641. mblk_t*    mi_tpi_ok_ack_alloc(mblk_t* mp);
  642. mblk_t*    mi_tpi_ordrel_ind(void);
  643. mblk_t*    mi_tpi_ordrel_req(void);
  644. mblk_t*    mi_tpi_uderror_ind(char* dest, size_t dest_length, char* opt, size_t opt_length, int error);
  645. mblk_t*    mi_tpi_unitdata_ind(mblk_t* trailer_mp, char* src, size_t src_length, char* opt, size_t opt_length);
  646. mblk_t*    mi_tpi_unitdata_req(mblk_t* trailer_mp, char* dst, size_t dst_length, char* opt, size_t opt_length);
  647.  
  648. mblk_t* mi_reallocb(mblk_t* old_mp, size_t new_size);
  649.  
  650. Boolean    mi_set_sth_hiwat(queue_t* q, size_t size);
  651. Boolean    mi_set_sth_lowat(queue_t* q, size_t size);
  652. Boolean    mi_set_sth_maxblk(queue_t* q, size_t size);
  653. Boolean    mi_set_sth_wroff(queue_t* q, size_t size);
  654.  
  655. UInt8* mi_offset_param(mblk_t* mp, long offset, long len);
  656. UInt8* mi_offset_paramc(mblk_t* mp, long offset, long len);
  657.  
  658. char* mi_open_detached(char** mi_opp_orig, size_t size, dev_t* devp);
  659. int mi_open_comm(char** mi_opp_orig, size_t size, queue_t* q, dev_t* dev,
  660.                  int flag, int sflag, cred_t* credp);
  661. int mi_close_comm(char** mi_opp_orig, queue_t* q);
  662. void mi_bufcall(queue_t* q, size_t size, int pri);
  663. void mi_detach(queue_t* q, char* ptr);
  664. void mi_close_detached(char** mi_opp_orig, char* ptr);
  665. char* mi_next_ptr(char*);
  666.  
  667. void mi_copyin(queue_t* q, mblk_t* mp, char* uaddr, size_t len);
  668. void mi_copyout(queue_t* q, mblk_t* mp);
  669. mblk_t* mi_copyout_alloc(queue_t* q, mblk_t* mp, char* uaddr, size_t len);
  670. void mi_copy_done(queue_t* q, mblk_t* mp, int err);
  671. void mi_copy_set_rval(mblk_t* mp, int rval);
  672. int mi_copy_state(queue_t* q, mblk_t* mp, mblk_t** mpp);
  673.  
  674. #ifdef __cplusplus
  675. }
  676.  
  677. /*******************************************************************************
  678. ** Everything below here is C++ ONLY
  679. ********************************************************************************/
  680.  
  681. /*    -------------------------------------------------------------------------
  682.     TStreamQueue class
  683.     
  684.     This class is just a convenient interface to the queue structure
  685.     ------------------------------------------------------------------------- */
  686.  
  687.     class TStreamQueue : public queue
  688.     {
  689.         public:
  690.             void        EnableQueue();
  691.     };
  692.     
  693.     /*    -------------------------------------------------------------------------
  694.         Inline methods for TStreamQueue
  695.         ------------------------------------------------------------------------- */
  696.     
  697.         inline void TStreamQueue::EnableQueue()
  698.         {
  699.             if ( q_flag & QNOENB )
  700.             {
  701.                 enableok(this);
  702.                 if ( q_first )
  703.                     qenable(this);
  704.             }
  705.         }
  706.  
  707. /*    -------------------------------------------------------------------------
  708.     Class TStreamMessage
  709.     
  710.     This class is a C++ interface to the mblk_t structure defined in STREAMS
  711.     ------------------------------------------------------------------------- */
  712.     //
  713.     // The maximum stream buffer size is the largest "size_t" that
  714.     // doesn't look negative if interpreted as a signed number
  715.     //
  716.     enum
  717.     {
  718.         kMaxStreamBufferSize    = (((size_t)-1L) >> 1)
  719.     };
  720.  
  721. #if GENERATINGPOWERPC
  722. #pragma options align=mac68k
  723. #endif
  724.  
  725.     class TStreamMessage : public msgb
  726.     {
  727.         private:
  728.                 void*        operator new (size_t)    { return NULL; }
  729.                 
  730.         public:
  731.                 void*        operator new(size_t, size_t size)
  732.                     { return (TStreamMessage*)allocb(size, 0); }
  733.                 void*        operator new(size_t, void* buf, size_t size,
  734.                                          EsbFreeProcPtr func, void* arg)
  735.                     { return OTAllocMsg(buf, size, func, arg); }
  736.                 void        operator delete(void* ptr)
  737.                     { freemsg((mblk_t*)ptr); }
  738.     
  739.                     void            Reset(size_t = 0);
  740.                     void            ResetWithLeader(size_t);
  741.             
  742.                     void            FreeData();
  743.                     TStreamMessage*    RemoveData();
  744.                     void            AppendData(TStreamMessage* data);
  745.             
  746.                     size_t            GetSize() const;
  747.                     size_t            GetDataSize() const;
  748.                     size_t            GetMessageDataSize() const;
  749.                     void            SetDataSize(size_t);
  750.         
  751.                     void            SetType(UInt8);
  752.                     UInt8            GetType() const;
  753.                     TStreamMessage*    GetNextBlock() const;
  754.                     void            SetNextBlock(TStreamMessage*);
  755.                     char*            GetDataPointer() const;
  756.                     Boolean            IsReuseable(size_t size) const;
  757.             
  758.                     void            HideBytesAtFront(size_t);
  759.                     void            HideBytesAtEnd(size_t);
  760.             //
  761.             // The following functions ignore non-M_DATA blocks.
  762.             //
  763.                     const TStreamMessage*
  764.                                     _MDECL GetBlockAt(size_t& offset) const;
  765.                     const void*        _MDECL GetPointerTo(size_t offset, size_t* len) const;
  766.                     const void*        _MDECL GetPointerTo(size_t offset, size_t* len, void* bfr) const;
  767.             //
  768.             // This function makes a non-shared copy of any initial non-M_DATA block, and
  769.             // then makes shared copies of the requested data.  It only assumes 1 leading
  770.             // non-M_DATA block, but will skip any other non-M_DATA blocks while 
  771.             // searching for data to copy.
  772.             //
  773.                     TStreamMessage*    _MDECL MakeSharedCopy(size_t offset = 0, 
  774.                                                           size_t len = kMaxStreamBufferSize);
  775.  
  776.                     Boolean            _MDECL HasData() const;
  777.                     Boolean            _MDECL WriteData(void* buf, size_t len);
  778.             //
  779.             // These hide/remove the part of the data already read.  
  780.             //
  781.                     TStreamMessage*    _MDECL ReadData(void* buf, size_t* len);
  782.                     size_t            _MDECL ReadControl(void* buf, size_t len);
  783.     };
  784.     
  785. #if GENERATINGPOWERPC
  786. #pragma options align=reset
  787. #endif
  788.  
  789.     /*    -------------------------------------------------------------------------
  790.         Inline methods for TStreamMessage
  791.         ------------------------------------------------------------------------- */
  792.     
  793.         inline void TStreamMessage::Reset(size_t size)
  794.         {
  795.             b_rptr = b_datap->db_base;
  796.             b_wptr = b_rptr + size;
  797.         }
  798.         
  799.         inline size_t OTLengthWithLeader(size_t size)
  800.         {
  801.             return (size + 3) & ~3;
  802.         }
  803.         
  804.         inline void TStreamMessage::ResetWithLeader(size_t size)
  805.         {
  806.             b_rptr = b_datap->db_lim - OTLengthWithLeader(size);
  807.             b_wptr = b_rptr + size;
  808.         }
  809.         
  810.         inline void TStreamMessage::FreeData()
  811.         {
  812.             if ( b_cont )
  813.             {
  814.                 freemsg(b_cont);
  815.                 b_cont = NULL;
  816.             }
  817.         }
  818.         
  819.         inline TStreamMessage* TStreamMessage::RemoveData()
  820.         {
  821.             TStreamMessage* temp = (TStreamMessage*)b_cont;
  822.             b_cont = NULL;
  823.             return temp;
  824.         }
  825.         
  826.         inline void TStreamMessage::AppendData(TStreamMessage* mp)
  827.         {
  828.             linkb(this, mp);
  829.         }
  830.     
  831.         inline size_t TStreamMessage::GetSize() const
  832.         {
  833.             return b_datap->db_lim - b_datap->db_base;
  834.         }
  835.         
  836.         inline size_t TStreamMessage::GetDataSize() const
  837.         {
  838.             return b_wptr - b_rptr;
  839.         }
  840.         
  841.         inline size_t TStreamMessage::GetMessageDataSize() const
  842.         {
  843.             return (b_cont == NULL) ? 
  844.                 (b_datap->db_type == M_DATA ? (b_wptr - b_rptr) : 0) : msgdsize(this);
  845.         }
  846.     
  847.         inline void TStreamMessage::SetDataSize(size_t size)
  848.         {
  849.             b_wptr = b_rptr + size;
  850.         }
  851.     
  852.         inline void TStreamMessage::SetType(UInt8 type)
  853.         {
  854.             b_datap->db_type = type;
  855.         }
  856.     
  857.         inline unsigned char TStreamMessage::GetType() const
  858.         {
  859.             return b_datap->db_type;
  860.         }
  861.         
  862.         inline TStreamMessage* TStreamMessage::GetNextBlock() const
  863.         {
  864.             return (TStreamMessage*)b_cont;
  865.         }
  866.         
  867.         inline void TStreamMessage::SetNextBlock(TStreamMessage* mp)
  868.         {
  869.             b_cont = (mblk_t*)mp;
  870.         }
  871.         
  872.         inline char* TStreamMessage::GetDataPointer() const
  873.         {
  874.             return (char*)b_rptr;
  875.         }
  876.         
  877.         inline Boolean TStreamMessage::IsReuseable(size_t size) const
  878.         {
  879.             return (b_datap->db_ref == 1 && GetSize() >= size);
  880.         }
  881.         
  882.         inline void TStreamMessage::HideBytesAtFront(size_t len)
  883.         {
  884.             adjmsg(this, len);
  885.         }
  886.         
  887.         inline void TStreamMessage::HideBytesAtEnd(size_t len)
  888.         {
  889.             adjmsg(this, -len);
  890.         }
  891.  
  892. /*    -------------------------------------------------------------------------
  893.     TTimerMessage class
  894.     
  895.     This class implements an interface to the STREAM environment timer
  896.     facilities.  A TTimerMessage will be placed on the queue of your choice
  897.     when it's timer expires.
  898.     ------------------------------------------------------------------------- */
  899.  
  900. #if GENERATINGPOWERPC
  901. #pragma options align=mac68k
  902. #endif
  903.  
  904. #if GENERATINGPOWERPC
  905.     #define TIMER_BUG    1
  906. #else
  907.     #define TIMER_BUG    0
  908. #endif
  909.  
  910.     class TTimerMessage : public TStreamMessage
  911.     {
  912.     #if TIMER_BUG
  913.         private:
  914.     #else
  915.         public:
  916.     #endif
  917.             inline void* operator new(size_t, queue_t* q)
  918.                 {    return mi_timer_alloc(q, sizeof(T_stream_timer)); }
  919.             inline void* operator new(size_t, queue_t* q, size_t extra)
  920.                 {    return mi_timer_alloc(q, extra + sizeof(T_stream_timer)); }
  921.     
  922.             inline void operator delete(void* ptr)
  923.                 {    mi_timer_free((mblk_t*)ptr); }
  924.     
  925.         public:        
  926.                     Boolean            IsValid();
  927.                     TTimerMessage*    ChangeQueue(TStreamQueue* newQ, TTimerMessage* newMP);
  928.                     Boolean            Cancel();
  929.                     void            Schedule(OTTimeout time);
  930.     
  931.         private:
  932.             inline void* operator new(size_t)
  933.                 {    return 0; }
  934.     };
  935.     
  936.     inline TTimerMessage* NewTimerMsg(queue_t* q, size_t extra = 0)
  937.     {
  938.         return (TTimerMessage*)mi_timer_alloc(q, sizeof(T_stream_timer) + extra);
  939.     }
  940.     
  941.     inline void FreeTimerMsg(TTimerMessage* msg)
  942.     {
  943.         mi_timer_free(msg);
  944.     }
  945.     
  946. #if GENERATINGPOWERPC
  947. #pragma options align=reset
  948. #endif
  949.     
  950.     /*    -------------------------------------------------------------------------
  951.         Inline methods for TStreamTimer
  952.         ------------------------------------------------------------------------- */
  953.     
  954.         inline Boolean TTimerMessage::IsValid()
  955.         {
  956.             return mi_timer_valid(this);
  957.         }
  958.         
  959.         inline TTimerMessage* TTimerMessage::ChangeQueue(TStreamQueue* q, TTimerMessage* newMP)
  960.         {
  961.             return( (TTimerMessage*) mi_timer_q_switch(this, q, newMP));
  962.         }
  963.     
  964.         inline Boolean TTimerMessage::Cancel()
  965.         {
  966.             return mi_timer_cancel(this);
  967.         }
  968.         
  969.         inline void TTimerMessage::Schedule(OTTimeout time)
  970.         {
  971.             ((T_stream_timer*)b_rptr)->PRIM_type = T_TIMER_REQ;
  972.             mi_timer(this, (unsigned long)time);
  973.         }
  974.  
  975. #endif    /* __cplusplus    */
  976.  
  977. #if defined(__MWERKS__) && GENERATING68K
  978. #pragma pointers_in_A0
  979. #endif
  980.  
  981. #endif    /* __OPENTPTMODULE__    */
  982.