mono/io-layer/wapi-private.h

   1 /*
   2  * wapi-private.h:  internal definitions of handles and shared memory layout
   3  *
   4  * Author:
   5  *      Dick Porter (dick@ximian.com)
   6  *
   7  * (C) 2002 Ximian, Inc.
   8  */
   9
  10 #ifndef _WAPI_PRIVATE_H_
  11 #define _WAPI_PRIVATE_H_
  12
  13 #include <config.h>
  14 #include <glib.h>
  15
  16 #include <mono/io-layer/handles.h>
  17 #include <mono/io-layer/io.h>
  18
  19 /* Catch this here rather than corrupt the shared data at runtime */
  20 #if MONO_SIZEOF_SUNPATH==0
  21 #error configure failed to discover size of unix socket path
  22 #endif
  23
  24 /* Increment this whenever an incompatible change is made to the
  25  * shared handle structure.
  26  */
  27 #define _WAPI_HANDLE_VERSION 10
  28
  29 typedef enum {
  30         WAPI_HANDLE_UNUSED=0,
  31         WAPI_HANDLE_FILE,
  32         WAPI_HANDLE_CONSOLE,
  33         WAPI_HANDLE_THREAD,
  34         WAPI_HANDLE_SEM,
  35         WAPI_HANDLE_MUTEX,
  36         WAPI_HANDLE_EVENT,
  37         WAPI_HANDLE_SOCKET,
  38         WAPI_HANDLE_FIND,
  39         WAPI_HANDLE_PROCESS,
  40         WAPI_HANDLE_PIPE,
  41         WAPI_HANDLE_NAMEDMUTEX,
  42         WAPI_HANDLE_NAMEDSEM,
  43         WAPI_HANDLE_NAMEDEVENT,
  44         WAPI_HANDLE_COUNT
  45 } WapiHandleType;
  46
  47 extern const char *_wapi_handle_typename[];
  48
  49 #define _WAPI_SHARED_HANDLE(type) (type == WAPI_HANDLE_PROCESS || \
  50                                    type == WAPI_HANDLE_THREAD || \
  51                                    type == WAPI_HANDLE_NAMEDMUTEX || \
  52                                    type == WAPI_HANDLE_NAMEDSEM || \
  53                                    type == WAPI_HANDLE_NAMEDEVENT)
  54
  55 #define _WAPI_FD_HANDLE(type) (type == WAPI_HANDLE_FILE || \
  56                                type == WAPI_HANDLE_CONSOLE || \
  57                                type == WAPI_HANDLE_SOCKET || \
  58                                type == WAPI_HANDLE_PIPE)
  59
  60 #define _WAPI_SHARED_NAMESPACE(type) (type == WAPI_HANDLE_NAMEDMUTEX || \
  61                                       type == WAPI_HANDLE_NAMEDSEM || \
  62                                       type == WAPI_HANDLE_NAMEDEVENT)
  63
  64 typedef struct
  65 {
  66         gchar name[MAX_PATH + 1];
  67 } WapiSharedNamespace;
  68
  69 typedef enum {
  70         WAPI_HANDLE_CAP_WAIT=0x01,
  71         WAPI_HANDLE_CAP_SIGNAL=0x02,
  72         WAPI_HANDLE_CAP_OWN=0x04,
  73         WAPI_HANDLE_CAP_SPECIAL_WAIT=0x08
  74 } WapiHandleCapability;
  75
  76 struct _WapiHandleOps
  77 {
  78         void (*close)(gpointer handle, gpointer data);
  79
  80         /* SignalObjectAndWait */
  81         void (*signal)(gpointer signal);
  82
  83         /* Called by WaitForSingleObject and WaitForMultipleObjects,
  84          * with the handle locked (shared handles aren't locked.)
  85          * Returns TRUE if ownership was established, false otherwise.
  86          */
  87         gboolean (*own_handle)(gpointer handle);
  88
  89         /* Called by WaitForSingleObject and WaitForMultipleObjects, if the
  90          * handle in question is "ownable" (ie mutexes), to see if the current
  91          * thread already owns this handle
  92          */
  93         gboolean (*is_owned)(gpointer handle);
  94
  95         /* Called by WaitForSingleObject and WaitForMultipleObjects,
  96          * if the handle in question needs a special wait function
  97          * instead of using the normal handle signal mechanism.
  98          * Returns the WaitForSingleObject return code.
  99          */
 100         guint32 (*special_wait)(gpointer handle, guint32 timeout);
 101 };
 102
 103 #include <mono/io-layer/event-private.h>
 104 #include <mono/io-layer/io-private.h>
 105 #include <mono/io-layer/mutex-private.h>
 106 #include <mono/io-layer/semaphore-private.h>
 107 #include <mono/io-layer/socket-private.h>
 108 #include <mono/io-layer/thread-private.h>
 109 #include <mono/io-layer/process-private.h>
 110
 111 struct _WapiHandle_shared_ref
 112 {
 113         /* This will be split 16:16 with the shared file segment in
 114          * the top half, when I implement space increases
 115          */
 116         guint32 offset;
 117 };
 118
 119 #define _WAPI_HANDLE_INITIAL_COUNT 4096
 120
 121 struct _WapiHandleUnshared
 122 {
 123         WapiHandleType type;
 124         guint ref;
 125         gboolean signalled;
 126         mono_mutex_t signal_mutex;
 127         pthread_cond_t signal_cond;
 128
 129         union
 130         {
 131                 struct _WapiHandle_event event;
 132                 struct _WapiHandle_file file;
 133                 struct _WapiHandle_find find;
 134                 struct _WapiHandle_mutex mutex;
 135                 struct _WapiHandle_sem sem;
 136                 struct _WapiHandle_socket sock;
 137                 struct _WapiHandle_shared_ref shared;
 138         } u;
 139 };
 140
 141 struct _WapiHandleShared
 142 {
 143         WapiHandleType type;
 144         guint32 timestamp;
 145         guint32 handle_refs;
 146         volatile gboolean signalled;
 147
 148         union
 149         {
 150                 struct _WapiHandle_thread thread;
 151                 struct _WapiHandle_process process;
 152                 struct _WapiHandle_namedmutex namedmutex;
 153                 struct _WapiHandle_namedsem namedsem;
 154                 struct _WapiHandle_namedevent namedevent;
 155         } u;
 156 };
 157
 158 #define _WAPI_SHARED_SEM_NAMESPACE 0
 159 /*#define _WAPI_SHARED_SEM_COLLECTION 1*/
 160 #define _WAPI_SHARED_SEM_FILESHARE 2
 161 #define _WAPI_SHARED_SEM_SHARED_HANDLES 3
 162 #define _WAPI_SHARED_SEM_COUNT 8        /* Leave some future expansion space */
 163
 164 struct _WapiHandleSharedLayout
 165 {
 166         volatile guint32 collection_count;
 167         volatile key_t sem_key;
 168
 169         struct _WapiHandleShared handles[_WAPI_HANDLE_INITIAL_COUNT];
 170 };
 171
 172 #define _WAPI_FILESHARE_SIZE 102400
 173
 174 struct _WapiFileShare
 175 {
 176         dev_t device;
 177         ino_t inode;
 178         pid_t opened_by_pid;
 179         guint32 sharemode;
 180         guint32 access;
 181         guint32 handle_refs;
 182         guint32 timestamp;
 183 };
 184
 185 struct _WapiFileShareLayout
 186 {
 187         guint32 hwm;
 188
 189         struct _WapiFileShare share_info[_WAPI_FILESHARE_SIZE];
 190 };
 191
 192
 193
 194 #define _WAPI_HANDLE_INVALID (gpointer)-1
 195
 196 #endif /* _WAPI_PRIVATE_H_ */