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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 <winreg.h>
  28 #include <winternl.h>
  29 #include <wine/server_protocol.h>
  30
  31 /* client communication functions */
  32
  33 struct __server_iovec
  34 {
  35     const void  *ptr;
  36     unsigned int size;
  37 };
  38
  39 #define __SERVER_MAX_DATA 5
  40
  41 struct __server_request_info
  42 {
  43     union
  44     {
  45         union generic_request req;    /* request structure */
  46         union generic_reply   reply;  /* reply structure */
  47     } u;
  48     unsigned int          data_count; /* count of request data pointers */
  49     void                 *reply_data; /* reply data pointer */
  50     struct __server_iovec data[__SERVER_MAX_DATA];  /* request variable size data */
  51 };
  52
  53 extern unsigned int wine_server_call( void *req_ptr );
  54 extern void wine_server_send_fd( int fd );
  55 extern int wine_server_fd_to_handle( int fd, unsigned int access, int inherit, obj_handle_t *handle );
  56 extern int wine_server_handle_to_fd( obj_handle_t handle, unsigned int access, int *unix_fd, int *flags );
  57 extern void wine_server_release_fd( obj_handle_t handle, int unix_fd );
  58 extern void DECLSPEC_NORETURN wine_server_exit_thread( int status );
  59
  60 /* do a server call and set the last error code */
  61 inline static unsigned int wine_server_call_err( void *req_ptr )
  62 {
  63     unsigned int res = wine_server_call( req_ptr );
  64     if (res) SetLastError( RtlNtStatusToDosError(res) );
  65     return res;
  66 }
  67
  68 /* get the size of the variable part of the returned reply */
  69 inline static size_t wine_server_reply_size( const void *reply )
  70 {
  71     return ((const struct reply_header *)reply)->reply_size;
  72 }
  73
  74 /* add some data to be sent along with the request */
  75 inline static void wine_server_add_data( void *req_ptr, const void *ptr, unsigned int size )
  76 {
  77     struct __server_request_info * const req = req_ptr;
  78     if (size)
  79     {
  80         req->data[req->data_count].ptr = ptr;
  81         req->data[req->data_count++].size = size;
  82         req->u.req.request_header.request_size += size;
  83     }
  84 }
  85
  86 /* set the pointer and max size for the reply var data */
  87 inline static void wine_server_set_reply( void *req_ptr, void *ptr, unsigned int max_size )
  88 {
  89     struct __server_request_info * const req = req_ptr;
  90     req->reply_data = ptr;
  91     req->u.req.request_header.reply_size = max_size;
  92 }
  93
  94
  95 /* macros for server requests */
  96
  97 #define SERVER_START_REQ(type) \
  98     do { \
  99         struct __server_request_info __req; \
 100         struct type##_request * const req = &__req.u.req.type##_request; \
 101         const struct type##_reply * const reply = &__req.u.reply.type##_reply; \
 102         memset( &__req.u.req, 0, sizeof(__req.u.req) ); \
 103         __req.u.req.request_header.req = REQ_##type; \
 104         __req.data_count = 0; \
 105         (void)reply; \
 106         do
 107
 108 #define SERVER_END_REQ \
 109         while(0); \
 110     } while(0)
 111
 112
 113 #endif  /* __WINE_WINE_SERVER_H */