include/wine/server.h

   1 /*
   2  * Definitions for the client side of the Wine server communication
   3  *
   4  * Copyright (C) 1998 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #ifndef __WINE_WINE_SERVER_H
  22 #define __WINE_WINE_SERVER_H
  23
  24 #include <stdarg.h>
  25 #include <windef.h>
  26 #include <winbase.h>
  27 #include <winternl.h>
  28 #include <wine/server_protocol.h>
  29
  30 /* client communication functions */
  31
  32 struct __server_iovec
  33 {
  34     const void  *ptr;
  35     data_size_t  size;
  36 };
  37
  38 #define __SERVER_MAX_DATA 5
  39
  40 struct __server_request_info
  41 {
  42     union
  43     {
  44         union generic_request req;    /* request structure */
  45         union generic_reply   reply;  /* reply structure */
  46     } u;
  47     unsigned int          data_count; /* count of request data pointers */
  48     void                 *reply_data; /* reply data pointer */
  49     struct __server_iovec data[__SERVER_MAX_DATA];  /* request variable size data */
  50 };
  51
  52 extern unsigned int wine_server_call( void *req_ptr );
  53 extern void CDECL wine_server_send_fd( int fd );
  54 extern int CDECL wine_server_fd_to_handle( int fd, unsigned int access, unsigned int attributes, HANDLE *handle );
  55 extern int CDECL wine_server_handle_to_fd( HANDLE handle, unsigned int access, int *unix_fd, unsigned int *options );
  56 extern void CDECL wine_server_release_fd( HANDLE handle, int unix_fd );
  57 extern void CDECL wine_server_clear_handle_fd( HANDLE handle );
  58
  59 /* do a server call and set the last error code */
  60 static inline unsigned int wine_server_call_err( void *req_ptr )
  61 {
  62     unsigned int res = wine_server_call( req_ptr );
  63     if (res) SetLastError( RtlNtStatusToDosError(res) );
  64     return res;
  65 }
  66
  67 /* get the size of the variable part of the returned reply */
  68 static inline data_size_t wine_server_reply_size( const void *reply )
  69 {
  70     return ((const struct reply_header *)reply)->reply_size;
  71 }
  72
  73 /* add some data to be sent along with the request */
  74 static inline void wine_server_add_data( void *req_ptr, const void *ptr, data_size_t size )
  75 {
  76     struct __server_request_info * const req = req_ptr;
  77     if (size)
  78     {
  79         req->data[req->data_count].ptr = ptr;
  80         req->data[req->data_count++].size = size;
  81         req->u.req.request_header.request_size += size;
  82     }
  83 }
  84
  85 /* set the pointer and max size for the reply var data */
  86 static inline void wine_server_set_reply( void *req_ptr, void *ptr, data_size_t max_size )
  87 {
  88     struct __server_request_info * const req = req_ptr;
  89     req->reply_data = ptr;
  90     req->u.req.request_header.reply_size = max_size;
  91 }
  92
  93 /* convert an object handle to a server handle */
  94 static inline obj_handle_t wine_server_obj_handle( HANDLE handle )
  95 {
  96     if ((int)(INT_PTR)handle != (INT_PTR)handle) return 0xfffffff0;  /* some invalid handle */
  97     return (INT_PTR)handle;
  98 }
  99
 100 /* convert a user handle to a server handle */
 101 static inline user_handle_t wine_server_user_handle( HANDLE handle )
 102 {
 103     return (UINT_PTR)handle;
 104 }
 105
 106 /* convert a server handle to a generic handle */
 107 static inline HANDLE wine_server_ptr_handle( obj_handle_t handle )
 108 {
 109     return (HANDLE)(INT_PTR)(int)handle;
 110 }
 111
 112 /* convert a client pointer to a server client_ptr_t */
 113 static inline client_ptr_t wine_server_client_ptr( const void *ptr )
 114 {
 115     return (client_ptr_t)(ULONG_PTR)ptr;
 116 }
 117
 118 /* convert a server client_ptr_t to a real pointer */
 119 static inline void *wine_server_get_ptr( client_ptr_t ptr )
 120 {
 121     return (void *)(ULONG_PTR)ptr;
 122 }
 123
 124
 125 /* macros for server requests */
 126
 127 #define SERVER_START_REQ(type) \
 128     do { \
 129         struct __server_request_info __req; \
 130         struct type##_request * const req = &__req.u.req.type##_request; \
 131         const struct type##_reply * const reply = &__req.u.reply.type##_reply; \
 132         memset( &__req.u.req, 0, sizeof(__req.u.req) ); \
 133         __req.u.req.request_header.req = REQ_##type; \
 134         __req.data_count = 0; \
 135         (void)reply; \
 136         do
 137
 138 #define SERVER_END_REQ \
 139         while(0); \
 140     } while(0)
 141
 142
 143 #endif  /* __WINE_WINE_SERVER_H */