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