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     /* destroy on refcount == 0 */
  64     void (*destroy)(struct object *);
  65 };
  66
  67 struct object
  68 {
  69     unsigned int              refcount;    /* reference count */
  70     struct fd                *fd_obj;      /* file descriptor */
  71     int                       fd;          /* file descriptor */
  72     int                       select;      /* select() user id */
  73     const struct object_ops  *ops;
  74     struct wait_queue_entry  *head;
  75     struct wait_queue_entry  *tail;
  76     struct object_name       *name;
  77 #ifdef DEBUG_OBJECTS
  78     struct list               obj_list;
  79 #endif
  80 };
  81
  82 struct wait_queue_entry
  83 {
  84     struct wait_queue_entry *next;
  85     struct wait_queue_entry *prev;
  86     struct object           *obj;
  87     struct thread           *thread;
  88 };
  89
  90 extern void *mem_alloc( size_t size );  /* malloc wrapper */
  91 extern void *memdup( const void *data, size_t len );
  92 extern void *alloc_object( const struct object_ops *ops, int fd );
  93 extern void dump_object_name( struct object *obj );
  94 extern void *create_named_object( struct namespace *namespace, const struct object_ops *ops,
  95                                   const WCHAR *name, size_t len );
  96 extern struct namespace *create_namespace( unsigned int hash_size, int case_sensitive );
  97 /* grab/release_object can take any pointer, but you better make sure */
  98 /* that the thing pointed to starts with a struct object... */
  99 extern struct object *grab_object( void *obj );
 100 extern void release_object( void *obj );
 101 extern struct object *find_object( const struct namespace *namespace, const WCHAR *name, size_t len );
 102 extern int no_add_queue( struct object *obj, struct wait_queue_entry *entry );
 103 extern int no_satisfied( struct object *obj, struct thread *thread );
 104 extern struct fd *no_get_fd( struct object *obj );
 105 extern struct fd *default_get_fd( struct object *obj );
 106 extern void no_destroy( struct object *obj );
 107 #ifdef DEBUG_OBJECTS
 108 extern void dump_objects(void);
 109 #endif
 110
 111 /* select functions */
 112
 113 extern int add_select_user( struct object *obj );
 114 extern void remove_select_user( struct object *obj );
 115 extern void change_select_fd( struct object *obj, int fd, int events );
 116 extern void set_select_events( struct object *obj, int events );
 117 extern void select_loop(void);
 118
 119 /* timeout functions */
 120
 121 struct timeout_user;
 122
 123 typedef void (*timeout_callback)( void *private );
 124
 125 extern struct timeout_user *add_timeout_user( struct timeval *when,
 126                                               timeout_callback func, void *private );
 127 extern void remove_timeout_user( struct timeout_user *user );
 128 extern void add_timeout( struct timeval *when, int timeout );
 129 /* return 1 if t1 is before t2 */
 130 static inline int time_before( struct timeval *t1, struct timeval *t2 )
 131 {
 132     return ((t1->tv_sec < t2->tv_sec) ||
 133             ((t1->tv_sec == t2->tv_sec) && (t1->tv_usec < t2->tv_usec)));
 134 }
 135
 136 /* event functions */
 137
 138 struct event;
 139
 140 extern struct event *create_event( const WCHAR *name, size_t len,
 141                                    int manual_reset, int initial_state );
 142 extern struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
 143 extern void pulse_event( struct event *event );
 144 extern void set_event( struct event *event );
 145 extern void reset_event( struct event *event );
 146
 147 /* mutex functions */
 148
 149 extern void abandon_mutexes( struct thread *thread );
 150
 151 /* serial functions */
 152
 153 int get_serial_async_timeout(struct object *obj, int type, int count);
 154
 155 /* socket functions */
 156
 157 extern void sock_init(void);
 158
 159 /* debugger functions */
 160
 161 extern int set_process_debugger( struct process *process, struct thread *debugger );
 162 extern void generate_debug_event( struct thread *thread, int code, void *arg );
 163 extern void generate_startup_debug_events( struct process *process, void *entry );
 164 extern void debug_exit_thread( struct thread *thread );
 165
 166 /* mapping functions */
 167
 168 extern int get_page_size(void);
 169
 170 /* registry functions */
 171
 172 extern void init_registry(void);
 173 extern void flush_registry(void);
 174 extern void close_registry(void);
 175 extern void registry_close_handle( struct object *obj, obj_handle_t hkey );
 176
 177 /* atom functions */
 178
 179 extern void close_atom_table(void);
 180 extern int grab_global_atom( atom_t atom );
 181 extern void release_global_atom( atom_t atom );
 182
 183 /* global variables */
 184
 185   /* command-line options */
 186 extern int debug_level;
 187 extern int master_socket_timeout;
 188 extern const char *server_argv0;
 189
 190   /* server start time used for GetTickCount() */
 191 extern unsigned int server_start_ticks;
 192
 193 /* name space for synchronization objects */
 194 extern struct namespace *sync_namespace;
 195
 196 #endif  /* __WINE_SERVER_OBJECT_H */