xref: /xsrc/external/mit/libICE/dist/src/ICElibint.h

/******************************************************************************


Copyright 1993, 1998  The Open Group

Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that
the above copyright notice appear in all copies and that both that
copyright notice and this permission notice appear in supporting
documentation.

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of The Open Group shall not be
used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from The Open Group.

Author: Ralph Mor, X Consortium
******************************************************************************/

#ifndef _ICELIBINT_H_
#define _ICELIBINT_H_

#include <X11/Xos.h>
#include <X11/Xfuncs.h>
#include <X11/Xmd.h>
#include <X11/ICE/ICEproto.h>
#include <X11/ICE/ICEconn.h>
#include <X11/ICE/ICEmsg.h>
#include <X11/ICE/ICEutil.h>
#ifdef WIN32
#include <X11/Xwindows.h>
#endif

#include <stdlib.h>
#include <stddef.h>

#ifdef O_CLOEXEC
#define FOPEN_CLOEXEC "e"
#else
#define FOPEN_CLOEXEC ""
#define O_CLOEXEC 0
#endif

/*
 * Vendor & Release
 */

#define IceVendorString  "MIT"
#define IceReleaseString "1.0"


/*
 * Pad to a 64 bit boundary
 */

#define PAD64(_bytes) ((8 - ((unsigned int) (_bytes) % 8)) % 8)

#define PADDED_BYTES64(_bytes) ((unsigned int) _bytes + PAD64 (_bytes))


/*
 * Pad to 32 bit boundary
 */

#define PAD32(_bytes) ((4 - ((unsigned int) (_bytes) % 4)) % 4)

#define PADDED_BYTES32(_bytes) ((unsigned int) _bytes + PAD32 (_bytes))


/*
 * Number of 8 byte units in _bytes.
 */

#define WORD64COUNT(_bytes) (((unsigned int) ((_bytes) + 7)) >> 3)


/*
 * Number of 4 byte units in _bytes.
 */

#define WORD32COUNT(_bytes) (((unsigned int) ((_bytes) + 3)) >> 2)


/*
 * Given a string, compute the number of bytes for the STRING representation
 */

#define STRING_BYTES(_string) \
    (2 + strlen (_string) + PAD32 (2 + strlen (_string)))


/*
 * Size of ICE input/output buffers
 */

#define ICE_INBUFSIZE 1024

#define ICE_OUTBUFSIZE 1024


/*
 * Maximum number of ICE authentication methods allowed, and maximum
 * number of authentication data entries allowed to be set in the
 * IceSetPaAuthData function.
 *
 * We should use linked lists, but this is easier and should suffice.
 */

#define MAX_ICE_AUTH_NAMES 32
#define ICE_MAX_AUTH_DATA_ENTRIES 100


/*
 * ICE listen object
 */

struct _IceListenObj {
    struct _XtransConnInfo 	*trans_conn; /* transport connection object */
    char			*network_id;
    IceHostBasedAuthProc 	host_based_auth_proc;
};


/*
 * Some internal data structures for processing ICE messages.
 */

typedef void (*_IceProcessCoreMsgProc) (
    IceConn 		/* iceConn */,
    int			/* opcode */,
    unsigned long	/* length */,
    Bool		/* swap */,
    IceReplyWaitInfo *  /* replyWait */,
    Bool *		/* replyReadyRet */,
    Bool *		/* connectionClosedRet */
);

typedef struct {
    int 			major_version;
    int 			minor_version;
    _IceProcessCoreMsgProc	process_core_msg_proc;
} _IceVersion;


/*
 * STORE FOO
 */

#define STORE_CARD8(_pBuf, _val) \
do { \
    *((CARD8 *) _pBuf) = _val; \
    _pBuf += 1; \
} while (0)

#define STORE_CARD16(_pBuf, _val) \
do { \
    *((CARD16 *) _pBuf) = _val; \
    _pBuf += 2; \
} while (0)

#define STORE_CARD32(_pBuf, _val) \
do { \
    *((CARD32 *) _pBuf) = _val; \
    _pBuf += 4; \
} while (0)


#define STORE_STRING(_pBuf, _string) \
do { \
    CARD16 _len = (CARD16) strlen (_string); \
    STORE_CARD16 (_pBuf, _len); \
    memcpy (_pBuf, _string, _len); \
    _pBuf += _len; \
    if (PAD32 (2 + _len)) \
        _pBuf += PAD32 (2 + _len); \
} while (0)


/*
 * SEND FOO - write to connection instead of buffer
 */
#define SEND_STRING(_iceConn, _string) \
do { \
    char _padding[3] = { 0 }; \
    CARD16 _len = (CARD16) strlen (_string); \
    IceWriteData32 (_iceConn, 2, &_len); \
    if (_len) \
        IceSendData (_iceConn, _len, (char *) _string);  \
    if (PAD32 (2 + _len)) \
        IceSendData (_iceConn, PAD32 (2 + _len), _padding); \
} while (0)

/*
 * EXTRACT FOO
 */

#define EXTRACT_CARD8(_pBuf, _val) \
do { \
    _val = *((CARD8 *) _pBuf); \
    _pBuf += 1; \
} while (0)

#define EXTRACT_CARD16(_pBuf, _swap, _val) \
do { \
    _val = *((CARD16 *) _pBuf); \
    _pBuf += 2; \
    if (_swap) \
        _val = lswaps (_val); \
} while (0)

#define EXTRACT_CARD32(_pBuf, _swap, _val) \
do { \
    _val = *((CARD32 *) _pBuf); \
    _pBuf += 4; \
    if (_swap) \
        _val = lswapl (_val); \
} while (0)


#define EXTRACT_STRING(_pBuf, _swap, _string) \
do { \
    CARD16 _len; \
    EXTRACT_CARD16 (_pBuf, _swap, _len); \
    _string = malloc (_len + 1); \
    if (_string != NULL) { \
        memcpy (_string, _pBuf, _len); \
        _string[_len] = '\0'; \
    } \
    _pBuf += _len; \
    if (PAD32 (2 + _len)) \
        _pBuf += PAD32 (2 + _len); \
} while (0)

#define EXTRACT_LISTOF_STRING(_pBuf, _swap, _count, _strings) \
do { \
    int _i; \
    for (_i = 0; _i < _count; _i++) \
        EXTRACT_STRING (_pBuf, _swap, _strings[_i]); \
} while (0)


#define SKIP_STRING(_pBuf, _swap, _end, _bail) \
do { \
    CARD16 _len; \
    EXTRACT_CARD16 (_pBuf, _swap, _len); \
    _pBuf += _len + PAD32(2+_len); \
    if (_pBuf > _end) { \
	_bail; \
    } \
} while (0)

#define SKIP_LISTOF_STRING(_pBuf, _swap, _count, _end, _bail) \
do { \
    int _i; \
    for (_i = 0; _i < _count; _i++) \
        SKIP_STRING (_pBuf, _swap, _end, _bail); \
} while (0)



/*
 * Byte swapping
 */

/* byte swap a long literal */
#define lswapl(_val) ((((_val) & 0xff) << 24) |\
		   (((_val) & 0xff00) << 8) |\
		   (((_val) & 0xff0000) >> 8) |\
		   (((_val) >> 24) & 0xff))

/* byte swap a short literal */
#define lswaps(_val) ((((_val) & 0xff) << 8) | (((_val) >> 8) & 0xff))



/*
 * ICE replies (not processed via callbacks because we block)
 */

#define ICE_CONNECTION_REPLY	1
#define ICE_CONNECTION_ERROR	2
#define ICE_PROTOCOL_REPLY	3
#define ICE_PROTOCOL_ERROR	4

typedef struct {
    int		  type;
    int 	  version_index;
    char	  *vendor;
    char          *release;
} _IceConnectionReply;

typedef struct {
    int		  type;
    char	  *error_message;
} _IceConnectionError;

typedef struct {
    int		  type;
    int 	  major_opcode;
    int		  version_index;
    char	  *vendor;
    char	  *release;
} _IceProtocolReply;

typedef struct {
    int		  type;
    char	  *error_message;
} _IceProtocolError;


typedef union {
    int			type;
    _IceConnectionReply	connection_reply;
    _IceConnectionError	connection_error;
    _IceProtocolReply	protocol_reply;
    _IceProtocolError	protocol_error;
} _IceReply;


/*
 * Watch for ICE connection create/destroy.
 */

typedef struct _IceWatchedConnection {
    IceConn				iceConn;
    IcePointer				watch_data;
    struct _IceWatchedConnection	*next;
} _IceWatchedConnection;

typedef struct _IceWatchProc {
    IceWatchProc		watch_proc;
    IcePointer			client_data;
    _IceWatchedConnection	*watched_connections;
    struct _IceWatchProc	*next;
} _IceWatchProc;


/*
 * Locking
 */

#define IceLockConn(_iceConn)
#define IceUnlockConn(_iceConn)


/*
 * Extern declarations
 */

extern IceConn			_IceConnectionObjs[];
extern char			*_IceConnectionStrings[];
extern int			_IceConnectionCount;

extern _IceProtocol		_IceProtocols[];
extern int			_IceLastMajorOpcode;

extern int			_IceAuthCount;
extern const char		*_IceAuthNames[];
extern IcePoAuthProc		_IcePoAuthProcs[];
extern IcePaAuthProc		_IcePaAuthProcs[];

extern const int		_IceVersionCount;
extern const _IceVersion	_IceVersions[];

extern _IceWatchProc		*_IceWatchProcs;

extern IceErrorHandler		_IceErrorHandler;
extern IceIOErrorHandler	_IceIOErrorHandler;

extern IceAuthDataEntry		_IcePaAuthDataEntries[];
extern int			_IcePaAuthDataEntryCount;

extern void _IceErrorBadMajor (
    IceConn		/* iceConn */,
    int			/* offendingMajor */,
    int			/* offendingMinor */,
    int			/* severity */
);

extern void _IceErrorNoAuthentication (
    IceConn		/* iceConn */,
    int			/* offendingMinor */
);

extern void _IceErrorNoVersion (
    IceConn		/* iceConn */,
    int			/* offendingMinor */
);

extern void _IceErrorSetupFailed (
    IceConn		/* iceConn */,
    int			/* offendingMinor */,
    const char *	/* reason */
);

extern void _IceErrorAuthenticationRejected (
    IceConn		/* iceConn */,
    int			/* offendingMinor */,
    const char *	/* reason */
);

extern void _IceErrorAuthenticationFailed (
    IceConn		/* iceConn */,
    int			/* offendingMinor */,
    const char *	/* reason */
);

extern void _IceErrorProtocolDuplicate (
    IceConn		/* iceConn */,
    const char *	/* protocolName */
);

extern void _IceErrorMajorOpcodeDuplicate (
    IceConn		/* iceConn */,
    int			/* majorOpcode */
);

extern void _IceErrorUnknownProtocol (
    IceConn		/* iceConn */,
    const char *	/* protocolName */
);

extern void _IceAddOpcodeMapping (
    IceConn		/* iceConn */,
    int			/* hisOpcode */,
    int			/* myOpcode */
);

extern char *_IceGetPeerName (
    IceConn		/* iceConn */
);

extern void _IceFreeConnection (
    IceConn		/* iceConn */
);

extern void _IceAddReplyWait (
    IceConn		/* iceConn */,
    IceReplyWaitInfo *	/* replyWait */
);

extern IceReplyWaitInfo *_IceSearchReplyWaits (
    IceConn		/* iceConn */,
    int			/* majorOpcode */
);

extern void _IceSetReplyReady (
    IceConn		/* iceConn */,
    IceReplyWaitInfo *	/* replyWait */
);

extern Bool _IceCheckReplyReady (
    IceConn		/* iceConn */,
    IceReplyWaitInfo *	/* replyWait */
);

extern void _IceConnectionOpened (
    IceConn		/* iceConn */
);

extern void _IceConnectionClosed (
    IceConn		/* iceConn */
);

extern void _IceGetPoAuthData (
    const char *	/* protocol_name */,
    const char *	/* address */,
    const char *	/* auth_name */,
    unsigned short *	/* auth_data_length_ret */,
    char **		/* auth_data_ret */
);

extern void _IceGetPaAuthData (
    const char *	/* protocol_name */,
    const char *	/* address */,
    const char *	/* auth_name */,
    unsigned short *	/* auth_data_length_ret */,
    char **		/* auth_data_ret */
);

extern void _IceGetPoValidAuthIndices (
    const char *	/* protocol_name */,
    const char *	/* address */,
    int			/* num_auth_names */,
    const char **	/* auth_names */,
    int	*		/* num_indices_ret */,
    int	*		/* indices_ret */
);

extern void _IceGetPaValidAuthIndices (
    const char *	/* protocol_name */,
    const char *	/* address */,
    int			/* num_auth_names */,
    const char **	/* auth_names */,
    int	*		/* num_indices_ret */,
    int	*		/* indices_ret */
);

#endif /* _ICELIBINT_H_ */