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