include/server.h

   1 /*
   2  * Wine server definitions
   3  *
   4  * Copyright (C) 1998 Alexandre Julliard
   5  */
   6
   7 #ifndef __WINE_SERVER_H
   8 #define __WINE_SERVER_H
   9
  10 #include <stdlib.h>
  11 #include <time.h>
  12
  13 /* message header as sent on the wire */
  14 struct header
  15 {
  16     unsigned int  len;     /* total msg length (including this header) */
  17     unsigned int  type;    /* msg type */
  18     unsigned int  seq;     /* sequence number */
  19 };
  20
  21 /* max msg length (not including the header) */
  22 #define MAX_MSG_LENGTH (16384 - sizeof(struct header))
  23
  24 /* data structure used to pass an fd with sendmsg/recvmsg */
  25 struct cmsg_fd
  26 {
  27     int len;   /* sizeof structure */
  28     int level; /* SOL_SOCKET */
  29     int type;  /* SCM_RIGHTS */
  30     int fd;    /* fd to pass */
  31 };
  32
  33
  34 /* Request structures */
  35
  36 /* following are the definitions of all the client<->server  */
  37 /* communication format; requests are from client to server, */
  38 /* replies are from server to client. All requests must have */
  39 /* a corresponding structure; the replies can be empty in    */
  40 /* which case it isn't necessary to define a structure.      */
  41
  42
  43 /* Create a new thread from the context of the parent */
  44 struct new_thread_request
  45 {
  46     void*        pid;          /* process id for the new thread (or 0 if none yet) */
  47 };
  48 struct new_thread_reply
  49 {
  50     void*        tid;          /* thread id */
  51     int          thandle;      /* thread handle (in the current process) */
  52     void*        pid;          /* process id (created if necessary) */
  53     int          phandle;      /* process handle (in the current process) */
  54 };
  55
  56
  57 /* Set the server debug level */
  58 struct set_debug_request
  59 {
  60     int          level;        /* New debug level */
  61 };
  62
  63
  64 /* Initialize a thread; called from the child after fork()/clone() */
  65 struct init_thread_request
  66 {
  67     int          unix_pid;     /* Unix pid of new thread */
  68     char         cmd_line[0];  /* Thread command line */
  69 };
  70
  71
  72 /* Terminate a process */
  73 struct terminate_process_request
  74 {
  75     int          handle;       /* process handle to terminate */
  76     int          exit_code;    /* process exit code */
  77 };
  78
  79
  80 /* Terminate a thread */
  81 struct terminate_thread_request
  82 {
  83     int          handle;       /* thread handle to terminate */
  84     int          exit_code;    /* thread exit code */
  85 };
  86
  87
  88 /* Retrieve information about a process */
  89 struct get_process_info_request
  90 {
  91     int          handle;       /* process handle */
  92 };
  93 struct get_process_info_reply
  94 {
  95     void*        pid;          /* server process id */
  96     int          exit_code;    /* process exit code */
  97 };
  98
  99
 100 /* Retrieve information about a thread */
 101 struct get_thread_info_request
 102 {
 103     int          handle;       /* thread handle */
 104 };
 105 struct get_thread_info_reply
 106 {
 107     void*        pid;          /* server thread id */
 108     int          exit_code;    /* thread exit code */
 109 };
 110
 111
 112 /* Close a handle for the current process */
 113 struct close_handle_request
 114 {
 115     int          handle;       /* handle to close */
 116 };
 117
 118
 119 /* Duplicate a handle */
 120 struct dup_handle_request
 121 {
 122     int          src_process;  /* src process handle */
 123     int          src_handle;   /* src handle to duplicate */
 124     int          dst_process;  /* dst process handle */
 125     int          dst_handle;   /* handle to duplicate to (or -1 for any) */
 126     unsigned int access;       /* wanted access rights */
 127     int          inherit;      /* inherit flag */
 128     int          options;      /* duplicate options (see below) */
 129 };
 130 #define DUP_HANDLE_CLOSE_SOURCE  DUPLICATE_CLOSE_SOURCE
 131 #define DUP_HANDLE_SAME_ACCESS   DUPLICATE_SAME_ACCESS
 132 #define DUP_HANDLE_MAKE_GLOBAL   0x80000000  /* Not a Windows flag */
 133 struct dup_handle_reply
 134 {
 135     int          handle;       /* duplicated handle in dst process */
 136 };
 137
 138
 139 /* Open a handle to a process */
 140 struct open_process_request
 141 {
 142     void*        pid;          /* process id to open */
 143     unsigned int access;       /* wanted access rights */
 144     int          inherit;      /* inherit flag */
 145 };
 146 struct open_process_reply
 147 {
 148     int          handle;       /* handle to the process */
 149 };
 150
 151
 152 /* Wait for handles */
 153 struct select_request
 154 {
 155     int          count;        /* handles count */
 156     int          flags;        /* wait flags (see below) */
 157     int          timeout;      /* timeout in ms */
 158     /* int handles[] */
 159 };
 160 struct select_reply
 161 {
 162     int          signaled;     /* signaled handle */
 163 };
 164 #define SELECT_ALL       1
 165 #define SELECT_MSG       2
 166 #define SELECT_ALERTABLE 4
 167 #define SELECT_TIMEOUT   8
 168
 169
 170 /* Create an event */
 171 struct create_event_request
 172 {
 173     int          manual_reset;  /* manual reset event */
 174     int          initial_state; /* initial state of the event */
 175     int          inherit;       /* inherit flag */
 176     char         name[0];       /* event name */
 177 };
 178 struct create_event_reply
 179 {
 180     int          handle;        /* handle to the event */
 181 };
 182
 183 /* Event operation */
 184 struct event_op_request
 185 {
 186     int           handle;       /* handle to event */
 187     int           op;           /* event operation (see below) */
 188 };
 189 enum event_op { PULSE_EVENT, SET_EVENT, RESET_EVENT };
 190
 191
 192 /* Create a mutex */
 193 struct create_mutex_request
 194 {
 195     int          owned;         /* initially owned? */
 196     int          inherit;       /* inherit flag */
 197     char         name[0];       /* mutex name */
 198 };
 199 struct create_mutex_reply
 200 {
 201     int          handle;        /* handle to the mutex */
 202 };
 203
 204
 205 /* Release a mutex */
 206 struct release_mutex_request
 207 {
 208     int          handle;        /* handle to the mutex */
 209 };
 210
 211
 212 /* Create a semaphore */
 213 struct create_semaphore_request
 214 {
 215     unsigned int initial;       /* initial count */
 216     unsigned int max;           /* maximum count */
 217     int          inherit;       /* inherit flag */
 218     char         name[0];       /* semaphore name */
 219 };
 220 struct create_semaphore_reply
 221 {
 222     int          handle;        /* handle to the semaphore */
 223 };
 224
 225
 226 /* Release a semaphore */
 227 struct release_semaphore_request
 228 {
 229     int          handle;        /* handle to the semaphore */
 230     unsigned int count;         /* count to add to semaphore */
 231 };
 232 struct release_semaphore_reply
 233 {
 234     unsigned int prev_count;    /* previous semaphore count */
 235 };
 236
 237
 238 /* Open a named object (event, mutex, semaphore) */
 239 struct open_named_obj_request
 240 {
 241     int          type;          /* object type (see below) */
 242     unsigned int access;        /* wanted access rights */
 243     int          inherit;       /* inherit flag */
 244     char         name[0];       /* object name */
 245 };
 246 enum open_named_obj { OPEN_EVENT, OPEN_MUTEX, OPEN_SEMAPHORE };
 247
 248 struct open_named_obj_reply
 249 {
 250     int          handle;        /* handle to the object */
 251 };
 252
 253
 254 /* Create a file */
 255 struct create_file_request
 256 {
 257     unsigned int access;        /* wanted access rights */
 258     int          inherit;       /* inherit flag */
 259 };
 260 struct create_file_reply
 261 {
 262     int          handle;        /* handle to the file */
 263 };
 264
 265
 266 /* Get a Unix handle to a file */
 267 struct get_unix_handle_request
 268 {
 269     int          handle;        /* handle to the file */
 270     unsigned int access;        /* desired access */
 271 };
 272
 273
 274 /* Get a Unix fd to read from a file */
 275 struct get_read_fd_request
 276 {
 277     int          handle;        /* handle to the file */
 278 };
 279
 280
 281 /* Get a Unix fd to write to a file */
 282 struct get_write_fd_request
 283 {
 284     int          handle;        /* handle to the file */
 285 };
 286
 287
 288 /* Set a file current position */
 289 struct set_file_pointer_request
 290 {
 291     int          handle;        /* handle to the file */
 292     int          low;           /* position low word */
 293     int          high;          /* position high word */
 294     int          whence;        /* whence to seek */
 295 };
 296 struct set_file_pointer_reply
 297 {
 298     int          low;           /* new position low word */
 299     int          high;          /* new position high word */
 300 };
 301
 302
 303 /* Truncate (or extend) a file */
 304 struct truncate_file_request
 305 {
 306     int          handle;        /* handle to the file */
 307 };
 308
 309
 310 /* Flush a file buffers */
 311 struct flush_file_request
 312 {
 313     int          handle;        /* handle to the file */
 314 };
 315
 316
 317 /* Get information about a file */
 318 struct get_file_info_request
 319 {
 320     int          handle;        /* handle to the file */
 321 };
 322 struct get_file_info_reply
 323 {
 324     int          attr;          /* file attributes */
 325     time_t       access_time;   /* last access time */
 326     time_t       write_time;    /* last write time */
 327     int          size_high;     /* file size */
 328     int          size_low;      /* file size */
 329     int          links;         /* number of links */
 330     int          index_high;    /* unique index */
 331     int          index_low;     /* unique index */
 332     unsigned int serial;        /* volume serial number */
 333 };
 334
 335
 336 /* Create an anonymous pipe */
 337 struct create_pipe_request
 338 {
 339     int          inherit;       /* inherit flag */
 340 };
 341 struct create_pipe_reply
 342 {
 343     int          handle_read;   /* handle to the read-side of the pipe */
 344     int          handle_write;  /* handle to the write-side of the pipe */
 345 };
 346
 347
 348 /* Create a console */
 349 struct create_console_request
 350 {
 351     int          inherit;       /* inherit flag */
 352 };
 353 struct create_console_reply
 354 {
 355     int          handle_read;   /* handle to read from the console */
 356     int          handle_write;  /* handle to write to the console */
 357 };
 358
 359
 360 /* Set a console file descriptor */
 361 struct set_console_fd_request
 362 {
 363     int          handle;        /* handle to the console */
 364 };
 365
 366
 367 /* Create a console */
 368 struct create_change_notification_request
 369 {
 370     int          subtree;       /* watch all the subtree */
 371     int          filter;        /* notification filter */
 372 };
 373 struct create_change_notification_reply
 374 {
 375     int          handle;        /* handle to the change notification */
 376 };
 377
 378
 379 /* client-side functions */
 380
 381 #ifndef __WINE_SERVER__
 382
 383 #include "server/request.h"
 384
 385 /* client communication functions */
 386 #define CHECK_LEN(len,wanted) \
 387   if ((len) == (wanted)) ; \
 388   else CLIENT_ProtocolError( __FUNCTION__ ": len %d != %d\n", (len), (wanted) );
 389 extern void CLIENT_ProtocolError( const char *err, ... );
 390 extern void CLIENT_SendRequest( enum request req, int pass_fd,
 391                                 int n, ... /* arg_1, len_1, etc. */ );
 392 extern unsigned int CLIENT_WaitReply( int *len, int *passed_fd,
 393                                       int n, ... /* arg_1, len_1, etc. */ );
 394
 395 struct _THDB;
 396 extern int CLIENT_NewThread( struct _THDB *thdb, int *thandle, int *phandle );
 397 extern int CLIENT_SetDebug( int level );
 398 extern int CLIENT_InitThread(void);
 399 extern int CLIENT_CloseHandle( int handle );
 400 extern int CLIENT_DuplicateHandle( int src_process, int src_handle, int dst_process,
 401                                    int dst_handle, DWORD access, BOOL32 inherit, DWORD options );
 402 extern int CLIENT_GetThreadInfo( int handle, struct get_thread_info_reply *reply );
 403 extern int CLIENT_GetProcessInfo( int handle, struct get_process_info_reply *reply );
 404 extern int CLIENT_OpenProcess( void *pid, DWORD access, BOOL32 inherit );
 405 extern int CLIENT_Select( int count, int *handles, int flags, int timeout );
 406 #endif  /* __WINE_SERVER__ */
 407
 408 #endif  /* __WINE_SERVER_H */