mono/io-layer/handles-private.h

   1 /*
   2  * handles-private.h:  Internal operations on handles
   3  *
   4  * Author:
   5  *      Dick Porter (dick@ximian.com)
   6  *
   7  * (C) 2002-2006 Novell, Inc.
   8  */
   9
  10 #ifndef _WAPI_HANDLES_PRIVATE_H_
  11 #define _WAPI_HANDLES_PRIVATE_H_
  12
  13 #include <config.h>
  14 #include <glib.h>
  15 #include <errno.h>
  16 #include <signal.h>
  17 #include <string.h>
  18 #include <sys/types.h>
  19
  20 #include <mono/io-layer/wapi-private.h>
  21 #include <mono/io-layer/misc-private.h>
  22 #include <mono/io-layer/collection.h>
  23 #include <mono/io-layer/shared.h>
  24
  25 #define _WAPI_PRIVATE_MAX_SLOTS         (1024 * 16)
  26 #define _WAPI_PRIVATE_HANDLES(x) (_wapi_private_handles [x / _WAPI_HANDLE_INITIAL_COUNT][x % _WAPI_HANDLE_INITIAL_COUNT])
  27 #define _WAPI_PRIVATE_HAVE_SLOT(x) ((GPOINTER_TO_UINT (x) / _WAPI_PRIVATE_MAX_SLOTS) < _WAPI_PRIVATE_MAX_SLOTS && \
  28                                         _wapi_private_handles [GPOINTER_TO_UINT (x) / _WAPI_HANDLE_INITIAL_COUNT] != NULL)
  29 #define _WAPI_PRIVATE_VALID_SLOT(x) (((x) / _WAPI_HANDLE_INITIAL_COUNT) < _WAPI_PRIVATE_MAX_SLOTS)
  30
  31 #undef DEBUG
  32
  33 extern struct _WapiHandleUnshared *_wapi_private_handles [];
  34 extern struct _WapiHandleSharedLayout *_wapi_shared_layout;
  35 extern struct _WapiFileShareLayout *_wapi_fileshare_layout;
  36
  37 extern guint32 _wapi_fd_reserve;
  38 extern mono_mutex_t *_wapi_global_signal_mutex;
  39 extern pthread_cond_t *_wapi_global_signal_cond;
  40 extern int _wapi_sem_id;
  41 extern gboolean _wapi_has_shut_down;
  42
  43 extern pid_t _wapi_getpid (void);
  44 extern gpointer _wapi_handle_new (WapiHandleType type,
  45                                   gpointer handle_specific);
  46 extern gpointer _wapi_handle_new_fd (WapiHandleType type, int fd,
  47                                      gpointer handle_specific);
  48 extern gpointer _wapi_handle_new_from_offset (WapiHandleType type,
  49                                               guint32 offset,
  50                                               gboolean timestamp);
  51 extern gboolean _wapi_lookup_handle (gpointer handle, WapiHandleType type,
  52                                      gpointer *handle_specific);
  53 extern gpointer _wapi_search_handle (WapiHandleType type,
  54                                      gboolean (*check)(gpointer, gpointer),
  55                                      gpointer user_data,
  56                                      gpointer *handle_specific,
  57                                      gboolean search_shared);
  58 extern gint32 _wapi_search_handle_namespace (WapiHandleType type,
  59                                              gchar *utf8_name);
  60 extern void _wapi_handle_ref (gpointer handle);
  61 extern void _wapi_handle_unref (gpointer handle);
  62 extern void _wapi_handle_register_capabilities (WapiHandleType type,
  63                                                 WapiHandleCapability caps);
  64 extern gboolean _wapi_handle_test_capabilities (gpointer handle,
  65                                                 WapiHandleCapability caps);
  66 extern void _wapi_handle_ops_close (gpointer handle, gpointer data);
  67 extern void _wapi_handle_ops_signal (gpointer handle);
  68 extern gboolean _wapi_handle_ops_own (gpointer handle);
  69 extern gboolean _wapi_handle_ops_isowned (gpointer handle);
  70 extern guint32 _wapi_handle_ops_special_wait (gpointer handle,
  71                                               guint32 timeout);
  72 extern void _wapi_handle_ops_prewait (gpointer handle);
  73
  74 extern gboolean _wapi_handle_count_signalled_handles (guint32 numhandles,
  75                                                       gpointer *handles,
  76                                                       gboolean waitall,
  77                                                       guint32 *retcount,
  78                                                       guint32 *lowest);
  79 extern void _wapi_handle_unlock_handles (guint32 numhandles,
  80                                          gpointer *handles);
  81 extern int _wapi_handle_wait_signal (gboolean poll);
  82 extern int _wapi_handle_timedwait_signal (struct timespec *timeout, gboolean poll);
  83 extern int _wapi_handle_wait_signal_handle (gpointer handle, gboolean alertable);
  84 extern int _wapi_handle_timedwait_signal_handle (gpointer handle,
  85                                                                                                  struct timespec *timeout, gboolean alertable, gboolean poll);
  86 extern gboolean _wapi_handle_get_or_set_share (dev_t device, ino_t inode,
  87                                                guint32 new_sharemode,
  88                                                guint32 new_access,
  89                                                guint32 *old_sharemode,
  90                                                guint32 *old_access,
  91                                                struct _WapiFileShare **info);
  92 extern void _wapi_handle_check_share (struct _WapiFileShare *share_info,
  93                                       int fd);
  94 extern void _wapi_handle_dump (void);
  95 extern void _wapi_handle_update_refs (void);
  96 extern void _wapi_handle_foreach (WapiHandleType type,
  97                                         gboolean (*on_each)(gpointer test, gpointer user),
  98                                         gpointer user_data);
  99 void _wapi_free_share_info (_WapiFileShare *share_info);
 100
 101 /* This is OK to use for atomic writes of individual struct members, as they
 102  * are independent
 103  */
 104 #define WAPI_SHARED_HANDLE_DATA(handle) _wapi_shared_layout->handles[_WAPI_PRIVATE_HANDLES(GPOINTER_TO_UINT((handle))).u.shared.offset]
 105
 106 #define WAPI_SHARED_HANDLE_TYPED_DATA(handle, type) _wapi_shared_layout->handles[_WAPI_PRIVATE_HANDLES(GPOINTER_TO_UINT((handle))).u.shared.offset].u.type
 107
 108 static inline WapiHandleType _wapi_handle_type (gpointer handle)
 109 {
 110         guint32 idx = GPOINTER_TO_UINT(handle);
 111
 112         if (!_WAPI_PRIVATE_VALID_SLOT (idx)) {
 113                 return(WAPI_HANDLE_COUNT);      /* An impossible type */
 114         }
 115
 116         return(_WAPI_PRIVATE_HANDLES(idx).type);
 117 }
 118
 119 static inline void _wapi_handle_set_signal_state (gpointer handle,
 120                                                   gboolean state,
 121                                                   gboolean broadcast)
 122 {
 123         guint32 idx = GPOINTER_TO_UINT(handle);
 124         struct _WapiHandleUnshared *handle_data;
 125         int thr_ret;
 126
 127         if (!_WAPI_PRIVATE_VALID_SLOT (idx)) {
 128                 return;
 129         }
 130
 131         g_assert (!_WAPI_SHARED_HANDLE(_wapi_handle_type (handle)));
 132
 133         handle_data = &_WAPI_PRIVATE_HANDLES(idx);
 134
 135 #ifdef DEBUG
 136         g_message ("%s: setting state of %p to %s (broadcast %s)", __func__,
 137                    handle, state?"TRUE":"FALSE", broadcast?"TRUE":"FALSE");
 138 #endif
 139
 140         if (state == TRUE) {
 141                 /* Tell everyone blocking on a single handle */
 142
 143                 /* The condition the global signal cond is waiting on is the signalling of
 144                  * _any_ handle. So lock it before setting the signalled state.
 145                  */
 146                 pthread_cleanup_push ((void(*)(void *))mono_mutex_unlock_in_cleanup, (void *)_wapi_global_signal_mutex);
 147                 thr_ret = mono_mutex_lock (_wapi_global_signal_mutex);
 148                 if (thr_ret != 0)
 149                         g_warning ("Bad call to mono_mutex_lock result %d for global signal mutex", thr_ret);
 150                 g_assert (thr_ret == 0);
 151
 152                 /* This function _must_ be called with
 153                  * handle->signal_mutex locked
 154                  */
 155                 handle_data->signalled=state;
 156
 157                 if (broadcast == TRUE) {
 158                         thr_ret = pthread_cond_broadcast (&handle_data->signal_cond);
 159                         if (thr_ret != 0)
 160                                 g_warning ("Bad call to pthread_cond_broadcast result %d for handle %p", thr_ret, handle);
 161                         g_assert (thr_ret == 0);
 162                 } else {
 163                         thr_ret = pthread_cond_signal (&handle_data->signal_cond);
 164                         if (thr_ret != 0)
 165                                 g_warning ("Bad call to pthread_cond_signal result %d for handle %p", thr_ret, handle);
 166                         g_assert (thr_ret == 0);
 167                 }
 168
 169                 /* Tell everyone blocking on multiple handles that something
 170                  * was signalled
 171                  */
 172                 thr_ret = pthread_cond_broadcast (_wapi_global_signal_cond);
 173                 if (thr_ret != 0)
 174                         g_warning ("Bad call to pthread_cond_broadcast result %d for handle %p", thr_ret, handle);
 175                 g_assert (thr_ret == 0);
 176
 177                 thr_ret = mono_mutex_unlock (_wapi_global_signal_mutex);
 178                 if (thr_ret != 0)
 179                         g_warning ("Bad call to mono_mutex_unlock result %d for global signal mutex", thr_ret);
 180                 g_assert (thr_ret == 0);
 181
 182                 pthread_cleanup_pop (0);
 183         } else {
 184                 handle_data->signalled=state;
 185         }
 186 }
 187
 188 static inline void _wapi_shared_handle_set_signal_state (gpointer handle,
 189                                                          gboolean state)
 190 {
 191         guint32 idx = GPOINTER_TO_UINT(handle);
 192         struct _WapiHandleUnshared *handle_data;
 193         struct _WapiHandle_shared_ref *ref;
 194         struct _WapiHandleShared *shared_data;
 195
 196         if (!_WAPI_PRIVATE_VALID_SLOT (idx)) {
 197                 return;
 198         }
 199
 200         g_assert (_WAPI_SHARED_HANDLE(_wapi_handle_type (handle)));
 201
 202         handle_data = &_WAPI_PRIVATE_HANDLES(idx);
 203
 204         ref = &handle_data->u.shared;
 205         shared_data = &_wapi_shared_layout->handles[ref->offset];
 206         shared_data->signalled = state;
 207
 208 #ifdef DEBUG
 209         g_message ("%s: signalled shared handle offset 0x%x", __func__,
 210                    ref->offset);
 211 #endif
 212 }
 213
 214 static inline gboolean _wapi_handle_issignalled (gpointer handle)
 215 {
 216         guint32 idx = GPOINTER_TO_UINT(handle);
 217
 218         if (!_WAPI_PRIVATE_VALID_SLOT (idx)) {
 219                 return(FALSE);
 220         }
 221
 222         if (_WAPI_SHARED_HANDLE(_wapi_handle_type (handle))) {
 223                 return(WAPI_SHARED_HANDLE_DATA(handle).signalled);
 224         } else {
 225                 return(_WAPI_PRIVATE_HANDLES(idx).signalled);
 226         }
 227 }
 228
 229 static inline int _wapi_handle_lock_signal_mutex (void)
 230 {
 231 #ifdef DEBUG
 232         g_message ("%s: lock global signal mutex", __func__);
 233 #endif
 234
 235         return(mono_mutex_lock (_wapi_global_signal_mutex));
 236 }
 237
 238 /* the parameter makes it easier to call from a pthread cleanup handler */
 239 static inline int _wapi_handle_unlock_signal_mutex (void *unused)
 240 {
 241 #ifdef DEBUG
 242         g_message ("%s: unlock global signal mutex", __func__);
 243 #endif
 244
 245         return(mono_mutex_unlock (_wapi_global_signal_mutex));
 246 }
 247
 248 static inline int _wapi_handle_lock_handle (gpointer handle)
 249 {
 250         guint32 idx = GPOINTER_TO_UINT(handle);
 251
 252 #ifdef DEBUG
 253         g_message ("%s: locking handle %p", __func__, handle);
 254 #endif
 255
 256         if (!_WAPI_PRIVATE_VALID_SLOT (idx)) {
 257                 return(0);
 258         }
 259
 260         _wapi_handle_ref (handle);
 261
 262         if (_WAPI_SHARED_HANDLE (_wapi_handle_type (handle))) {
 263                 return(0);
 264         }
 265
 266         return(mono_mutex_lock (&_WAPI_PRIVATE_HANDLES(idx).signal_mutex));
 267 }
 268
 269 static inline int _wapi_handle_trylock_handle (gpointer handle)
 270 {
 271         guint32 idx = GPOINTER_TO_UINT(handle);
 272         int ret;
 273
 274 #ifdef DEBUG
 275         g_message ("%s: locking handle %p", __func__, handle);
 276 #endif
 277
 278         if (!_WAPI_PRIVATE_VALID_SLOT (idx)) {
 279                 return(0);
 280         }
 281
 282         _wapi_handle_ref (handle);
 283
 284         if (_WAPI_SHARED_HANDLE (_wapi_handle_type (handle))) {
 285                 return(0);
 286         }
 287
 288         ret = mono_mutex_trylock (&_WAPI_PRIVATE_HANDLES(idx).signal_mutex);
 289         if (ret != 0) {
 290                 _wapi_handle_unref (handle);
 291         }
 292
 293         return(ret);
 294 }
 295
 296 static inline int _wapi_handle_unlock_handle (gpointer handle)
 297 {
 298         guint32 idx = GPOINTER_TO_UINT(handle);
 299         int ret;
 300
 301 #ifdef DEBUG
 302         g_message ("%s: unlocking handle %p", __func__, handle);
 303 #endif
 304
 305         if (!_WAPI_PRIVATE_VALID_SLOT (idx)) {
 306                 return(0);
 307         }
 308
 309         if (_WAPI_SHARED_HANDLE (_wapi_handle_type (handle))) {
 310                 _wapi_handle_unref (handle);
 311                 return(0);
 312         }
 313
 314         ret = mono_mutex_unlock (&_WAPI_PRIVATE_HANDLES(idx).signal_mutex);
 315
 316         _wapi_handle_unref (handle);
 317
 318         return(ret);
 319 }
 320
 321 static inline void _wapi_handle_spin (guint32 ms)
 322 {
 323         struct timespec sleepytime;
 324
 325         g_assert (ms < 1000);
 326
 327         sleepytime.tv_sec = 0;
 328         sleepytime.tv_nsec = ms * 1000000;
 329
 330         nanosleep (&sleepytime, NULL);
 331 }
 332
 333 static inline int _wapi_handle_lock_shared_handles (void)
 334 {
 335         return(_wapi_shm_sem_lock (_WAPI_SHARED_SEM_SHARED_HANDLES));
 336 }
 337
 338 static inline int _wapi_handle_trylock_shared_handles (void)
 339 {
 340         return(_wapi_shm_sem_trylock (_WAPI_SHARED_SEM_SHARED_HANDLES));
 341 }
 342
 343 static inline int _wapi_handle_unlock_shared_handles (void)
 344 {
 345         return(_wapi_shm_sem_unlock (_WAPI_SHARED_SEM_SHARED_HANDLES));
 346 }
 347
 348 static inline int _wapi_namespace_lock (void)
 349 {
 350         return(_wapi_shm_sem_lock (_WAPI_SHARED_SEM_NAMESPACE));
 351 }
 352
 353 /* This signature makes it easier to use in pthread cleanup handlers */
 354 static inline int _wapi_namespace_unlock (gpointer data G_GNUC_UNUSED)
 355 {
 356         return(_wapi_shm_sem_unlock (_WAPI_SHARED_SEM_NAMESPACE));
 357 }
 358
 359 static inline void _wapi_handle_share_release (struct _WapiFileShare *info)
 360 {
 361         int thr_ret;
 362
 363         g_assert (info->handle_refs > 0);
 364
 365         /* Prevent new entries racing with us */
 366         thr_ret = _wapi_shm_sem_lock (_WAPI_SHARED_SEM_FILESHARE);
 367         g_assert(thr_ret == 0);
 368
 369         if (InterlockedDecrement ((gint32 *)&info->handle_refs) == 0) {
 370                 _wapi_free_share_info (info);
 371         }
 372
 373         thr_ret = _wapi_shm_sem_unlock (_WAPI_SHARED_SEM_FILESHARE);
 374 }
 375
 376 #endif /* _WAPI_HANDLES_PRIVATE_H_ */