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