server/object.h

   1 /*
   2  * Wine server objects
   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_SERVER_OBJECT_H
  22 #define __WINE_SERVER_OBJECT_H
  23
  24 #include <sys/poll.h>
  25 #include <sys/time.h>
  26 #include "wine/server_protocol.h"
  27
  28 #define DEBUG_OBJECTS
  29
  30 /* kernel objects */
  31
  32 struct object;
  33 struct object_name;
  34 struct thread;
  35 struct process;
  36 struct file;
  37 struct wait_queue_entry;
  38 struct async;
  39 struct async_queue;
  40
  41 /* operations valid on all objects */
  42 struct object_ops
  43 {
  44     /* size of this object type */
  45     size_t size;
  46     /* dump the object (for debugging) */
  47     void (*dump)(struct object *,int);
  48     /* add a thread to the object wait queue */
  49     int  (*add_queue)(struct object *,struct wait_queue_entry *);
  50     /* remove a thread from the object wait queue */
  51     void (*remove_queue)(struct object *,struct wait_queue_entry *);
  52     /* is object signaled? */
  53     int  (*signaled)(struct object *,struct thread *);
  54     /* wait satisfied; return 1 if abandoned */
  55     int  (*satisfied)(struct object *,struct thread *);
  56     /* get the events we want to poll() for on this object */
  57     int  (*get_poll_events)(struct object *);
  58     /* a poll() event occured */
  59     void (*poll_event)(struct object *,int event);
  60     /* return a Unix fd that can be used to read/write from the object */
  61     int  (*get_fd)(struct object *);
  62     /* flush the object buffers */
  63     int  (*flush)(struct object *);
  64     /* get file information */
  65     int  (*get_file_info)(struct object *,struct get_file_info_reply *, int *flags);
  66     /* queue an async operation - see register_async handler in async.c*/
  67     void (*queue_async)(struct object *, void* ptr, unsigned int status, int type, int count);
  68     /* destroy on refcount == 0 */
  69     void (*destroy)(struct object *);
  70 };
  71
  72 struct object
  73 {
  74     unsigned int              refcount;    /* reference count */
  75     int                       fd;          /* file descriptor */
  76     int                       select;      /* select() user id */
  77     const struct object_ops  *ops;
  78     struct wait_queue_entry  *head;
  79     struct wait_queue_entry  *tail;
  80     struct object_name       *name;
  81 #ifdef DEBUG_OBJECTS
  82     struct object            *prev;
  83     struct object            *next;
  84 #endif
  85 };
  86
  87 struct wait_queue_entry
  88 {
  89     struct wait_queue_entry *next;
  90     struct wait_queue_entry *prev;
  91     struct object           *obj;
  92     struct thread           *thread;
  93 };
  94
  95 extern void *mem_alloc( size_t size );  /* malloc wrapper */
  96 extern void *memdup( const void *data, size_t len );
  97 extern void *alloc_object( const struct object_ops *ops, int fd );
  98 extern void dump_object_name( struct object *obj );
  99 extern void *create_named_object( const struct object_ops *ops, const WCHAR *name, size_t len );
 100 /* grab/release_object can take any pointer, but you better make sure */
 101 /* that the thing pointed to starts with a struct object... */
 102 extern struct object *grab_object( void *obj );
 103 extern void release_object( void *obj );
 104 extern struct object *find_object( const WCHAR *name, size_t len );
 105 extern int no_add_queue( struct object *obj, struct wait_queue_entry *entry );
 106 extern int no_satisfied( struct object *obj, struct thread *thread );
 107 extern int no_get_fd( struct object *obj );
 108 extern int no_flush( struct object *obj );
 109 extern int no_get_file_info( struct object *obj, struct get_file_info_reply *info, int *flags );
 110 extern void no_destroy( struct object *obj );
 111 extern int default_poll_add_queue( struct object *obj, struct wait_queue_entry *entry );
 112 extern void default_poll_remove_queue( struct object *obj, struct wait_queue_entry *entry );
 113 extern int default_poll_signaled( struct object *obj, struct thread *thread );
 114 extern void default_poll_event( struct object *obj, int event );
 115 #ifdef DEBUG_OBJECTS
 116 extern void dump_objects(void);
 117 #endif
 118
 119 /* select functions */
 120
 121 extern int add_select_user( struct object *obj );
 122 extern void remove_select_user( struct object *obj );
 123 extern void change_select_fd( struct object *obj, int fd, int events );
 124 extern void set_select_events( struct object *obj, int events );
 125 extern int check_select_events( int fd, int events );
 126 extern void select_loop(void);
 127
 128 /* timeout functions */
 129
 130 struct timeout_user;
 131
 132 typedef void (*timeout_callback)( void *private );
 133
 134 extern struct timeout_user *add_timeout_user( struct timeval *when,
 135                                               timeout_callback func, void *private );
 136 extern void remove_timeout_user( struct timeout_user *user );
 137 extern void add_timeout( struct timeval *when, int timeout );
 138 /* return 1 if t1 is before t2 */
 139 static inline int time_before( struct timeval *t1, struct timeval *t2 )
 140 {
 141     return ((t1->tv_sec < t2->tv_sec) ||
 142             ((t1->tv_sec == t2->tv_sec) && (t1->tv_usec < t2->tv_usec)));
 143 }
 144
 145 /* event functions */
 146
 147 struct event;
 148
 149 extern struct event *create_event( const WCHAR *name, size_t len,
 150                                    int manual_reset, int initial_state );
 151 extern struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
 152 extern void pulse_event( struct event *event );
 153 extern void set_event( struct event *event );
 154 extern void reset_event( struct event *event );
 155
 156 /* mutex functions */
 157
 158 extern void abandon_mutexes( struct thread *thread );
 159
 160 /* file functions */
 161
 162 extern struct file *get_file_obj( struct process *process, obj_handle_t handle,
 163                                   unsigned int access );
 164 extern int is_same_file( struct file *file1, struct file *file2 );
 165 extern int get_file_drive_type( struct file *file );
 166 extern int grow_file( struct file *file, int size_high, int size_low );
 167 extern int create_anonymous_file(void);
 168 extern struct file *create_temp_file( int access );
 169 extern void file_set_error(void);
 170
 171 /* serial functions */
 172
 173 int get_serial_async_timeout(struct object *obj, int type, int count);
 174
 175 /* socket functions */
 176
 177 extern void sock_init(void);
 178
 179 /* debugger functions */
 180
 181 extern int set_process_debugger( struct process *process, struct thread *debugger );
 182 extern void generate_debug_event( struct thread *thread, int code, void *arg );
 183 extern void generate_startup_debug_events( struct process *process, void *entry );
 184 extern void debug_exit_thread( struct thread *thread );
 185
 186 /* mapping functions */
 187
 188 extern int get_page_size(void);
 189
 190 /* registry functions */
 191
 192 extern void init_registry(void);
 193 extern void flush_registry(void);
 194 extern void close_registry(void);
 195
 196 /* atom functions */
 197
 198 extern void close_atom_table(void);
 199 extern int grab_global_atom( atom_t atom );
 200 extern void release_global_atom( atom_t atom );
 201
 202 /* global variables */
 203
 204   /* command-line options */
 205 extern int debug_level;
 206 extern int master_socket_timeout;
 207 extern const char *server_argv0;
 208
 209   /* server start time used for GetTickCount() */
 210 extern unsigned int server_start_ticks;
 211
 212 #endif  /* __WINE_SERVER_OBJECT_H */