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 "wine/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 token;
  42 struct file;
  43 struct wait_queue_entry;
  44 struct async;
  45 struct async_queue;
  46
  47 /* operations valid on all objects */
  48 struct object_ops
  49 {
  50     /* size of this object type */
  51     size_t size;
  52     /* dump the object (for debugging) */
  53     void (*dump)(struct object *,int);
  54     /* add a thread to the object wait queue */
  55     int  (*add_queue)(struct object *,struct wait_queue_entry *);
  56     /* remove a thread from the object wait queue */
  57     void (*remove_queue)(struct object *,struct wait_queue_entry *);
  58     /* is object signaled? */
  59     int  (*signaled)(struct object *,struct thread *);
  60     /* wait satisfied; return 1 if abandoned */
  61     int  (*satisfied)(struct object *,struct thread *);
  62     /* signal an object */
  63     int  (*signal)(struct object *, unsigned int);
  64     /* return an fd object that can be used to read/write from the object */
  65     struct fd *(*get_fd)(struct object *);
  66     /* destroy on refcount == 0 */
  67     void (*destroy)(struct object *);
  68 };
  69
  70 struct object
  71 {
  72     unsigned int              refcount;    /* reference count */
  73     const struct object_ops  *ops;
  74     struct list               wait_queue;
  75     struct object_name       *name;
  76 #ifdef DEBUG_OBJECTS
  77     struct list               obj_list;
  78 #endif
  79 };
  80
  81 struct wait_queue_entry
  82 {
  83     struct list     entry;
  84     struct object  *obj;
  85     struct thread  *thread;
  86 };
  87
  88 extern void *mem_alloc( size_t size );  /* malloc wrapper */
  89 extern void *memdup( const void *data, size_t len );
  90 extern void *alloc_object( const struct object_ops *ops );
  91 extern void dump_object_name( struct object *obj );
  92 extern void *create_named_object( struct namespace *namespace, const struct object_ops *ops,
  93                                   const WCHAR *name, size_t len );
  94 extern struct namespace *create_namespace( unsigned int hash_size, int case_sensitive );
  95 /* grab/release_object can take any pointer, but you better make sure */
  96 /* that the thing pointed to starts with a struct object... */
  97 extern struct object *grab_object( void *obj );
  98 extern void release_object( void *obj );
  99 extern struct object *find_object( const struct namespace *namespace, const WCHAR *name, size_t len );
 100 extern int no_add_queue( struct object *obj, struct wait_queue_entry *entry );
 101 extern int no_satisfied( struct object *obj, struct thread *thread );
 102 extern int no_signal( struct object *obj, unsigned int access );
 103 extern struct fd *no_get_fd( struct object *obj );
 104 extern void no_destroy( struct object *obj );
 105 #ifdef DEBUG_OBJECTS
 106 extern void dump_objects(void);
 107 #endif
 108
 109 /* event functions */
 110
 111 struct event;
 112
 113 extern struct event *create_event( const WCHAR *name, size_t len,
 114                                    int manual_reset, int initial_state );
 115 extern struct event *get_event_obj( struct process *process, obj_handle_t handle, unsigned int access );
 116 extern void pulse_event( struct event *event );
 117 extern void set_event( struct event *event );
 118 extern void reset_event( struct event *event );
 119
 120 /* mutex functions */
 121
 122 extern void abandon_mutexes( struct thread *thread );
 123
 124 /* serial functions */
 125
 126 int get_serial_async_timeout(struct object *obj, int type, int count);
 127
 128 /* socket functions */
 129
 130 extern void sock_init(void);
 131
 132 /* debugger functions */
 133
 134 extern int set_process_debugger( struct process *process, struct thread *debugger );
 135 extern void generate_debug_event( struct thread *thread, int code, void *arg );
 136 extern void generate_startup_debug_events( struct process *process, void *entry );
 137 extern void debug_exit_thread( struct thread *thread );
 138
 139 /* mapping functions */
 140
 141 extern int get_page_size(void);
 142
 143 /* registry functions */
 144
 145 extern void init_registry(void);
 146 extern void flush_registry(void);
 147 extern void close_registry(void);
 148 extern void registry_close_handle( struct object *obj, obj_handle_t hkey );
 149
 150 /* signal functions */
 151
 152 extern void init_signals(void);
 153 extern void close_signals(void);
 154
 155 /* atom functions */
 156
 157 extern void close_atom_table(void);
 158 extern atom_t add_global_atom( const WCHAR *str, size_t len );
 159 extern atom_t find_global_atom( const WCHAR *str, size_t len );
 160 extern int grab_global_atom( atom_t atom );
 161 extern void release_global_atom( atom_t atom );
 162
 163 /* global variables */
 164
 165   /* command-line options */
 166 extern int debug_level;
 167 extern int master_socket_timeout;
 168 extern int foreground;
 169 extern const char *server_argv0;
 170
 171   /* server start time used for GetTickCount() */
 172 extern unsigned int server_start_ticks;
 173
 174 /* name space for synchronization objects */
 175 extern struct namespace *sync_namespace;
 176
 177 #endif  /* __WINE_SERVER_OBJECT_H */