af062818b47340eef15700d2f0211576ba3506eevboxsync/*
af062818b47340eef15700d2f0211576ba3506eevboxsync * Definitions for the client side of the Wine server communication
af062818b47340eef15700d2f0211576ba3506eevboxsync *
af062818b47340eef15700d2f0211576ba3506eevboxsync * Copyright (C) 1998 Alexandre Julliard
af062818b47340eef15700d2f0211576ba3506eevboxsync *
af062818b47340eef15700d2f0211576ba3506eevboxsync * This library is free software; you can redistribute it and/or
af062818b47340eef15700d2f0211576ba3506eevboxsync * modify it under the terms of the GNU Lesser General Public
af062818b47340eef15700d2f0211576ba3506eevboxsync * License as published by the Free Software Foundation; either
af062818b47340eef15700d2f0211576ba3506eevboxsync * version 2.1 of the License, or (at your option) any later version.
af062818b47340eef15700d2f0211576ba3506eevboxsync *
af062818b47340eef15700d2f0211576ba3506eevboxsync * This library is distributed in the hope that it will be useful,
af062818b47340eef15700d2f0211576ba3506eevboxsync * but WITHOUT ANY WARRANTY; without even the implied warranty of
af062818b47340eef15700d2f0211576ba3506eevboxsync * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
af062818b47340eef15700d2f0211576ba3506eevboxsync * Lesser General Public License for more details.
af062818b47340eef15700d2f0211576ba3506eevboxsync *
af062818b47340eef15700d2f0211576ba3506eevboxsync * You should have received a copy of the GNU Lesser General Public
af062818b47340eef15700d2f0211576ba3506eevboxsync * License along with this library; if not, write to the Free Software
af062818b47340eef15700d2f0211576ba3506eevboxsync * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
af062818b47340eef15700d2f0211576ba3506eevboxsync */
af062818b47340eef15700d2f0211576ba3506eevboxsync
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync/*
4b9d6701570cb98fd36e209314239d104ec584d3vboxsync * Oracle LGPL Disclaimer: For the avoidance of doubt, except that if any license choice
4b9d6701570cb98fd36e209314239d104ec584d3vboxsync * other than GPL or LGPL is available it will apply instead, Oracle elects to use only
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * the Lesser General Public License version 2.1 (LGPLv2) at this time for any software where
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * a choice of LGPL license versions is made available with the language indicating
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * that LGPLv2 or any later version may be used, or where a choice of which version
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * of the LGPL is applied is otherwise unspecified.
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync */
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync#ifndef __WINE_WINE_SERVER_H
af062818b47340eef15700d2f0211576ba3506eevboxsync#define __WINE_WINE_SERVER_H
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync#include <stdarg.h>
af062818b47340eef15700d2f0211576ba3506eevboxsync#include <windef.h>
af062818b47340eef15700d2f0211576ba3506eevboxsync#include <winbase.h>
af062818b47340eef15700d2f0211576ba3506eevboxsync#include <winternl.h>
af062818b47340eef15700d2f0211576ba3506eevboxsync#include <wine/server_protocol.h>
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync/* client communication functions */
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsyncstruct __server_iovec
af062818b47340eef15700d2f0211576ba3506eevboxsync{
af062818b47340eef15700d2f0211576ba3506eevboxsync const void *ptr;
af062818b47340eef15700d2f0211576ba3506eevboxsync data_size_t size;
af062818b47340eef15700d2f0211576ba3506eevboxsync};
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync#define __SERVER_MAX_DATA 5
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsyncstruct __server_request_info
af062818b47340eef15700d2f0211576ba3506eevboxsync{
af062818b47340eef15700d2f0211576ba3506eevboxsync union
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync union generic_request req; /* request structure */
af062818b47340eef15700d2f0211576ba3506eevboxsync union generic_reply reply; /* reply structure */
af062818b47340eef15700d2f0211576ba3506eevboxsync } u;
af062818b47340eef15700d2f0211576ba3506eevboxsync unsigned int data_count; /* count of request data pointers */
af062818b47340eef15700d2f0211576ba3506eevboxsync void *reply_data; /* reply data pointer */
af062818b47340eef15700d2f0211576ba3506eevboxsync struct __server_iovec data[__SERVER_MAX_DATA]; /* request variable size data */
af062818b47340eef15700d2f0211576ba3506eevboxsync};
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsyncextern unsigned int wine_server_call( void *req_ptr );
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncextern void CDECL wine_server_send_fd( int fd );
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncextern int CDECL wine_server_fd_to_handle( int fd, unsigned int access, unsigned int attributes, HANDLE *handle );
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncextern int CDECL wine_server_handle_to_fd( HANDLE handle, unsigned int access, int *unix_fd, unsigned int *options );
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncextern void CDECL wine_server_release_fd( HANDLE handle, int unix_fd );
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync/* do a server call and set the last error code */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic inline unsigned int wine_server_call_err( void *req_ptr )
af062818b47340eef15700d2f0211576ba3506eevboxsync{
af062818b47340eef15700d2f0211576ba3506eevboxsync unsigned int res = wine_server_call( req_ptr );
af062818b47340eef15700d2f0211576ba3506eevboxsync if (res) SetLastError( RtlNtStatusToDosError(res) );
af062818b47340eef15700d2f0211576ba3506eevboxsync return res;
af062818b47340eef15700d2f0211576ba3506eevboxsync}
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync/* get the size of the variable part of the returned reply */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic inline data_size_t wine_server_reply_size( const void *reply )
af062818b47340eef15700d2f0211576ba3506eevboxsync{
af062818b47340eef15700d2f0211576ba3506eevboxsync return ((const struct reply_header *)reply)->reply_size;
af062818b47340eef15700d2f0211576ba3506eevboxsync}
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync/* add some data to be sent along with the request */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic inline void wine_server_add_data( void *req_ptr, const void *ptr, data_size_t size )
af062818b47340eef15700d2f0211576ba3506eevboxsync{
af062818b47340eef15700d2f0211576ba3506eevboxsync struct __server_request_info * const req = req_ptr;
af062818b47340eef15700d2f0211576ba3506eevboxsync if (size)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync req->data[req->data_count].ptr = ptr;
af062818b47340eef15700d2f0211576ba3506eevboxsync req->data[req->data_count++].size = size;
af062818b47340eef15700d2f0211576ba3506eevboxsync req->u.req.request_header.request_size += size;
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync}
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync/* set the pointer and max size for the reply var data */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic inline void wine_server_set_reply( void *req_ptr, void *ptr, data_size_t max_size )
af062818b47340eef15700d2f0211576ba3506eevboxsync{
af062818b47340eef15700d2f0211576ba3506eevboxsync struct __server_request_info * const req = req_ptr;
af062818b47340eef15700d2f0211576ba3506eevboxsync req->reply_data = ptr;
af062818b47340eef15700d2f0211576ba3506eevboxsync req->u.req.request_header.reply_size = max_size;
af062818b47340eef15700d2f0211576ba3506eevboxsync}
af062818b47340eef15700d2f0211576ba3506eevboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync/* convert an object handle to a server handle */
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncstatic inline obj_handle_t wine_server_obj_handle( HANDLE handle )
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync{
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync if ((int)(INT_PTR)handle != (INT_PTR)handle) return 0xfffffff0; /* some invalid handle */
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync return (INT_PTR)handle;
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync}
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync/* convert a user handle to a server handle */
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncstatic inline user_handle_t wine_server_user_handle( HANDLE handle )
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync{
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync return (UINT_PTR)handle;
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync}
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync/* convert a server handle to a generic handle */
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncstatic inline HANDLE wine_server_ptr_handle( obj_handle_t handle )
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync{
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync return (HANDLE)(INT_PTR)(int)handle;
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync}
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync/* convert a client pointer to a server client_ptr_t */
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncstatic inline client_ptr_t wine_server_client_ptr( const void *ptr )
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync{
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync return (client_ptr_t)(ULONG_PTR)ptr;
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync}
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync/* convert a server client_ptr_t to a real pointer */
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncstatic inline void *wine_server_get_ptr( client_ptr_t ptr )
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync{
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync return (void *)(ULONG_PTR)ptr;
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync}
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync/* macros for server requests */
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync#define SERVER_START_REQ(type) \
af062818b47340eef15700d2f0211576ba3506eevboxsync do { \
af062818b47340eef15700d2f0211576ba3506eevboxsync struct __server_request_info __req; \
af062818b47340eef15700d2f0211576ba3506eevboxsync struct type##_request * const req = &__req.u.req.type##_request; \
af062818b47340eef15700d2f0211576ba3506eevboxsync const struct type##_reply * const reply = &__req.u.reply.type##_reply; \
af062818b47340eef15700d2f0211576ba3506eevboxsync memset( &__req.u.req, 0, sizeof(__req.u.req) ); \
af062818b47340eef15700d2f0211576ba3506eevboxsync __req.u.req.request_header.req = REQ_##type; \
af062818b47340eef15700d2f0211576ba3506eevboxsync __req.data_count = 0; \
af062818b47340eef15700d2f0211576ba3506eevboxsync (void)reply; \
af062818b47340eef15700d2f0211576ba3506eevboxsync do
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync#define SERVER_END_REQ \
af062818b47340eef15700d2f0211576ba3506eevboxsync while(0); \
af062818b47340eef15700d2f0211576ba3506eevboxsync } while(0)
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* __WINE_WINE_SERVER_H */