Google Git
Sign in
goma / wine / e75f9fb806dfcf1f7b3f7519525f141bd76942ee / . / server / object.h
blob: 886950494c9a331491686de0e8b2795abb08c9b3 [file] [log] [blame]
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]1/*
2 * Wine server objects
3 *
4 * Copyright (C) 1998 Alexandre Julliard
5 */
6
7#ifndef __WINE_SERVER_OBJECT_H
8#define __WINE_SERVER_OBJECT_H
9
10#ifndef __WINE_SERVER__
11#error This file can only be used in the Wine server
12#endif
13
Alexandre Julliard247b8ae1999-12-13 00:16:44 +0000[diff] [blame]14#include <sys/poll.h>
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]15#include <sys/time.h>
Alexandre Julliardd30dfd21998-09-27 18:28:36 +0000[diff] [blame]16#include "server.h"
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]17
Alexandre Julliard1bdd1541999-06-04 19:47:04 +0000[diff] [blame]18#define DEBUG_OBJECTS
19
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]20/* kernel objects */
21
22struct object;
23struct object_name;
Alexandre Julliard85ed45e1998-08-22 19:03:56 +0000[diff] [blame]24struct thread;
Alexandre Julliardfdc92ba1999-02-14 18:03:15 +0000[diff] [blame]25struct process;
Alexandre Julliarda8b8d9c1999-01-01 16:59:27 +0000[diff] [blame]26struct file;
Alexandre Julliardc6e45ed1998-12-27 08:35:39 +0000[diff] [blame]27struct wait_queue_entry;
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]28
Alexandre Julliard05625391999-01-03 11:55:56 +0000[diff] [blame]29/* operations valid on all objects */
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]30struct object_ops
31{
Alexandre Julliard5bc78081999-06-22 17:26:53 +0000[diff] [blame]32 /* size of this object type */
33 size_t size;
Alexandre Julliardc6e45ed1998-12-27 08:35:39 +0000[diff] [blame]34 /* dump the object (for debugging) */
35 void (*dump)(struct object *,int);
36 /* add a thread to the object wait queue */
Alexandre Julliarda8b8d9c1999-01-01 16:59:27 +0000[diff] [blame]37 int (*add_queue)(struct object *,struct wait_queue_entry *);
Alexandre Julliardc6e45ed1998-12-27 08:35:39 +0000[diff] [blame]38 /* remove a thread from the object wait queue */
39 void (*remove_queue)(struct object *,struct wait_queue_entry *);
40 /* is object signaled? */
41 int (*signaled)(struct object *,struct thread *);
42 /* wait satisfied; return 1 if abandoned */
43 int (*satisfied)(struct object *,struct thread *);
Alexandre Julliard1dca5e22000-01-01 00:56:27 +0000[diff] [blame]44 /* get the events we want to poll() for on this object */
45 int (*get_poll_events)(struct object *);
46 /* a poll() event occured */
47 void (*poll_event)(struct object *,int event);
Alexandre Julliardaa0ebd01998-12-30 12:06:45 +0000[diff] [blame]48 /* return a Unix fd that can be used to read from the object */
49 int (*get_read_fd)(struct object *);
50 /* return a Unix fd that can be used to write to the object */
51 int (*get_write_fd)(struct object *);
52 /* flush the object buffers */
Alexandre Julliard05625391999-01-03 11:55:56 +0000[diff] [blame]53 int (*flush)(struct object *);
54 /* get file information */
Alexandre Julliardebe29ef1999-06-26 08:43:26 +0000[diff] [blame]55 int (*get_file_info)(struct object *,struct get_file_info_request *);
Alexandre Julliardc6e45ed1998-12-27 08:35:39 +0000[diff] [blame]56 /* destroy on refcount == 0 */
57 void (*destroy)(struct object *);
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]58};
59
60struct object
61{
Alexandre Julliard1dca5e22000-01-01 00:56:27 +0000[diff] [blame]62 unsigned int refcount; /* reference count */
63 int fd; /* file descriptor */
64 int select; /* select() user id */
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]65 const struct object_ops *ops;
Alexandre Julliard85ed45e1998-08-22 19:03:56 +0000[diff] [blame]66 struct wait_queue_entry *head;
67 struct wait_queue_entry *tail;
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]68 struct object_name *name;
Alexandre Julliard1bdd1541999-06-04 19:47:04 +0000[diff] [blame]69#ifdef DEBUG_OBJECTS
70 struct object *prev;
71 struct object *next;
72#endif
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]73};
74
Alexandre Julliardd30dfd21998-09-27 18:28:36 +0000[diff] [blame]75extern void *mem_alloc( size_t size ); /* malloc wrapper */
Alexandre Julliardd7e85d61999-11-23 19:39:11 +0000[diff] [blame]76extern void *memdup( const void *data, size_t len );
Alexandre Julliard1dca5e22000-01-01 00:56:27 +0000[diff] [blame]77extern void *alloc_object( const struct object_ops *ops, int fd );
Alexandre Julliardd16319c1999-11-25 21:30:24 +0000[diff] [blame]78extern void dump_object_name( struct object *obj );
79extern void *create_named_object( const struct object_ops *ops, const WCHAR *name, size_t len );
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]80/* grab/release_object can take any pointer, but you better make sure */
81/* that the thing pointed to starts with a struct object... */
82extern struct object *grab_object( void *obj );
83extern void release_object( void *obj );
Alexandre Julliardd16319c1999-11-25 21:30:24 +0000[diff] [blame]84extern struct object *find_object( const WCHAR *name, size_t len );
Alexandre Julliarda8b8d9c1999-01-01 16:59:27 +0000[diff] [blame]85extern int no_add_queue( struct object *obj, struct wait_queue_entry *entry );
Alexandre Julliardaa0ebd01998-12-30 12:06:45 +0000[diff] [blame]86extern int no_satisfied( struct object *obj, struct thread *thread );
87extern int no_read_fd( struct object *obj );
88extern int no_write_fd( struct object *obj );
89extern int no_flush( struct object *obj );
Alexandre Julliardebe29ef1999-06-26 08:43:26 +0000[diff] [blame]90extern int no_get_file_info( struct object *obj, struct get_file_info_request *info );
Alexandre Julliard5bc78081999-06-22 17:26:53 +0000[diff] [blame]91extern void no_destroy( struct object *obj );
Alexandre Julliard1dca5e22000-01-01 00:56:27 +0000[diff] [blame]92extern int default_poll_add_queue( struct object *obj, struct wait_queue_entry *entry );
93extern void default_poll_remove_queue( struct object *obj, struct wait_queue_entry *entry );
94extern int default_poll_signaled( struct object *obj, struct thread *thread );
95extern void default_poll_event( struct object *obj, int event );
Alexandre Julliard1bdd1541999-06-04 19:47:04 +0000[diff] [blame]96#ifdef DEBUG_OBJECTS
97extern void dump_objects(void);
98#endif
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]99
Alexandre Julliardc6e45ed1998-12-27 08:35:39 +0000[diff] [blame]100/* select functions */
101
Alexandre Julliard1dca5e22000-01-01 00:56:27 +0000[diff] [blame]102extern int add_select_user( struct object *obj );
103extern void remove_select_user( struct object *obj );
104extern void change_select_fd( struct object *obj, int fd );
105extern void set_select_events( struct object *obj, int events );
Alexandre Julliard247b8ae1999-12-13 00:16:44 +0000[diff] [blame]106extern int check_select_events( int fd, int events );
Alexandre Julliardc6e45ed1998-12-27 08:35:39 +0000[diff] [blame]107extern void select_loop(void);
108
Alexandre Julliard88de35c1999-05-16 16:57:49 +0000[diff] [blame]109/* timeout functions */
110
111struct timeout_user;
112
113typedef void (*timeout_callback)( void *private );
114
115extern struct timeout_user *add_timeout_user( struct timeval *when,
116 timeout_callback func, void *private );
117extern void remove_timeout_user( struct timeout_user *user );
Alexandre Julliard247b8ae1999-12-13 00:16:44 +0000[diff] [blame]118extern void add_timeout( struct timeval *when, int timeout );
119/* return 1 if t1 is before t2 */
120static inline int time_before( struct timeval *t1, struct timeval *t2 )
121{
122 return ((t1->tv_sec < t2->tv_sec) ||
123 ((t1->tv_sec == t2->tv_sec) && (t1->tv_usec < t2->tv_usec)));
124}
Alexandre Julliard88de35c1999-05-16 16:57:49 +0000[diff] [blame]125
Alexandre Julliardd6d994f1999-09-28 16:40:07 +0000[diff] [blame]126/* event functions */
127
128struct event;
129
Alexandre Julliard6a72dc52000-04-14 13:42:00 +0000[diff] [blame]130extern struct event *create_event( const WCHAR *name, size_t len,
131 int manual_reset, int initial_state );
Alexandre Julliardd6d994f1999-09-28 16:40:07 +0000[diff] [blame]132extern struct event *get_event_obj( struct process *process, int handle, unsigned int access );
133extern void pulse_event( struct event *event );
134extern void set_event( struct event *event );
135extern void reset_event( struct event *event );
136
Alexandre Julliardd30dfd21998-09-27 18:28:36 +0000[diff] [blame]137/* mutex functions */
138
Alexandre Julliardd30dfd21998-09-27 18:28:36 +0000[diff] [blame]139extern void abandon_mutexes( struct thread *thread );
140
Alexandre Julliard338e7571998-12-27 15:28:54 +0000[diff] [blame]141/* file functions */
142
Alexandre Julliarda8b8d9c1999-01-01 16:59:27 +0000[diff] [blame]143extern struct file *get_file_obj( struct process *process, int handle,
144 unsigned int access );
145extern int file_get_mmap_fd( struct file *file );
Alexandre Julliardcb28bdc1999-02-28 10:13:59 +0000[diff] [blame]146extern int grow_file( struct file *file, int size_high, int size_low );
Alexandre Julliard5bc78081999-06-22 17:26:53 +0000[diff] [blame]147extern int create_anonymous_file(void);
Alexandre Julliardcb28bdc1999-02-28 10:13:59 +0000[diff] [blame]148extern struct file *create_temp_file( int access );
Alexandre Julliardaa0ebd01998-12-30 12:06:45 +0000[diff] [blame]149extern void file_set_error(void);
150
Alexandre Julliardaa0ebd01998-12-30 12:06:45 +0000[diff] [blame]151/* console functions */
152
Alexandre Julliard039aa421999-06-11 18:31:22 +0000[diff] [blame]153extern int alloc_console( struct process *process );
154extern int free_console( struct process *process );
Alexandre Julliardfdc92ba1999-02-14 18:03:15 +0000[diff] [blame]155
Alexandre Julliarde712e071999-05-23 19:53:30 +0000[diff] [blame]156/* debugger functions */
157
Alexandre Julliardea0d0282000-03-10 22:16:10 +0000[diff] [blame]158extern int set_process_debugger( struct process *process, struct thread *debugger );
Alexandre Julliard05f0b712000-03-09 18:18:41 +0000[diff] [blame]159extern void generate_debug_event( struct thread *thread, int code, void *arg );
Alexandre Julliardb73421d2000-03-30 19:30:24 +0000[diff] [blame]160extern void generate_startup_debug_events( struct process *process, void *entry );
Alexandre Julliardff81d782000-03-08 12:01:30 +0000[diff] [blame]161extern void debug_exit_thread( struct thread *thread );
Alexandre Julliarde712e071999-05-23 19:53:30 +0000[diff] [blame]162
Alexandre Julliardc76ad351999-11-13 19:49:05 +0000[diff] [blame]163/* mapping functions */
164
165extern int get_page_size(void);
166
Alexandre Julliardd7e85d61999-11-23 19:39:11 +0000[diff] [blame]167/* registry functions */
168
169extern void close_registry(void);
170
Alexandre Julliardb849d792000-02-13 13:56:13 +0000[diff] [blame]171/* atom functions */
172
173extern void close_atom_table(void);
174
Alexandre Julliard2fe57772000-01-25 01:40:27 +0000[diff] [blame]175/* global variables (command-line options) */
176
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]177extern int debug_level;
Alexandre Julliard2fe57772000-01-25 01:40:27 +0000[diff] [blame]178extern int persistent_server;
Alexandre Julliard767e6f61998-08-09 12:47:43 +0000[diff] [blame]179
180#endif /* __WINE_SERVER_OBJECT_H */