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