wine  6.0.1
About: Wine is an Open Source implementation of the MS Windows API on top of X, OpenGL, and Unix. Think of Wine as a compatibility layer for running Windows programs.
  Fossies Dox: wine-6.0.1.tar.xz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

server.h
Go to the documentation of this file.
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 
33 {
34  const void *ptr;
36 };
37 
38 #define __SERVER_MAX_DATA 5
39 
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 CDECL 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 
58 /* do a server call and set the last error code */
59 static inline unsigned int wine_server_call_err( void *req_ptr )
60 {
61  unsigned int res = wine_server_call( req_ptr );
63  return res;
64 }
65 
66 /* get the size of the variable part of the returned reply */
67 static inline data_size_t wine_server_reply_size( const void *reply )
68 {
69  return ((const struct reply_header *)reply)->reply_size;
70 }
71 
72 /* add some data to be sent along with the request */
73 static inline void wine_server_add_data( void *req_ptr, const void *ptr, data_size_t size )
74 {
75  struct __server_request_info * const req = req_ptr;
76  if (size)
77  {
78  req->data[req->data_count].ptr = ptr;
79  req->data[req->data_count++].size = size;
80  req->u.req.request_header.request_size += size;
81  }
82 }
83 
84 /* set the pointer and max size for the reply var data */
85 static inline void wine_server_set_reply( void *req_ptr, void *ptr, data_size_t max_size )
86 {
87  struct __server_request_info * const req = req_ptr;
88  req->reply_data = ptr;
89  req->u.req.request_header.reply_size = max_size;
90 }
91 
92 /* convert an object handle to a server handle */
94 {
95  if ((int)(INT_PTR)handle != (INT_PTR)handle) return 0xfffffff0; /* some invalid handle */
96  return (INT_PTR)handle;
97 }
98 
99 /* convert a user handle to a server handle */
101 {
102  return (UINT_PTR)handle;
103 }
104 
105 /* convert a server handle to a generic handle */
107 {
108  return (HANDLE)(INT_PTR)(int)handle;
109 }
110 
111 /* convert a client pointer to a server client_ptr_t */
112 static inline client_ptr_t wine_server_client_ptr( const void *ptr )
113 {
114  return (client_ptr_t)(ULONG_PTR)ptr;
115 }
116 
117 /* convert a server client_ptr_t to a real pointer */
118 static inline void *wine_server_get_ptr( client_ptr_t ptr )
119 {
120  return (void *)(ULONG_PTR)ptr;
121 }
122 
123 
124 /* macros for server requests */
125 
126 #define SERVER_START_REQ(type) \
127  do { \
128  struct __server_request_info __req; \
129  struct type##_request * const req = &__req.u.req.type##_request; \
130  const struct type##_reply * const reply = &__req.u.reply.type##_reply; \
131  memset( &__req.u.req, 0, sizeof(__req.u.req) ); \
132  __req.u.req.request_header.req = REQ_##type; \
133  __req.data_count = 0; \
134  (void)reply; \
135  do
136 
137 #define SERVER_END_REQ \
138  while(0); \
139  } while(0)
140 
141 
142 #endif /* __WINE_WINE_SERVER_H */
unsigned long UINT_PTR
Definition: basetsd.h:128
unsigned long ULONG_PTR
Definition: basetsd.h:130
long INT_PTR
Definition: basetsd.h:127
static int access(const char *path, int mode)
Definition: io.h:110
ULONG RtlNtStatusToDosError(NTSTATUS status)
Definition: error.c:79
static void size_t size
Definition: oledb_private.h:32
static void * wine_server_get_ptr(client_ptr_t ptr)
Definition: server.h:118
static HANDLE wine_server_ptr_handle(obj_handle_t handle)
Definition: server.h:106
static user_handle_t wine_server_user_handle(HANDLE handle)
Definition: server.h:100
static void wine_server_add_data(void *req_ptr, const void *ptr, data_size_t size)
Definition: server.h:73
int wine_server_fd_to_handle(int fd, unsigned int access, unsigned int attributes, HANDLE *handle)
Definition: server.c:1066
static unsigned int wine_server_call_err(void *req_ptr)
Definition: server.h:59
static void wine_server_set_reply(void *req_ptr, void *ptr, data_size_t max_size)
Definition: server.h:85
static client_ptr_t wine_server_client_ptr(const void *ptr)
Definition: server.h:112
void wine_server_send_fd(int fd)
Definition: server.c:781
int wine_server_handle_to_fd(HANDLE handle, unsigned int access, int *unix_fd, unsigned int *options)
Definition: server.c:1090
void wine_server_release_fd(HANDLE handle, int unix_fd)
Definition: server.c:1107
unsigned int wine_server_call(void *req_ptr)
Definition: server.c:283
#define __SERVER_MAX_DATA
Definition: server.h:38
static obj_handle_t wine_server_obj_handle(HANDLE handle)
Definition: server.h:93
static data_size_t wine_server_reply_size(const void *reply)
Definition: server.h:67
unsigned int user_handle_t
unsigned int obj_handle_t
unsigned long long client_ptr_t
unsigned int data_size_t
const void * ptr
Definition: server.h:34
data_size_t size
Definition: server.h:35
union generic_request req
Definition: server.h:44
unsigned int data_count
Definition: server.h:47
union generic_reply reply
Definition: server.h:45
struct __server_iovec data[5]
Definition: server.h:49
union __server_request_info::@1645 u
Definition: fd.c:176
Definition: wrctypes.h:93
Definition: ticket.c:41
struct request_header request_header
DECLSPEC_IMPORT VOID WINAPI SetLastError(DWORD)
#define CDECL
Definition: windef.h:198