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