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