wait.c

 
#include <winpr/config.h>
 
#ifdef WINPR_HAVE_UNISTD_H
#include <unistd.h>
#endif
 
#include <winpr/assert.h>
#include <errno.h>
 
#include <winpr/crt.h>
#include <winpr/synch.h>
#include <winpr/platform.h>
#include <winpr/sysinfo.h>
 
#include "synch.h"
#include "pollset.h"
#include "../thread/thread.h"
#include <winpr/thread.h>
#include <winpr/debug.h>
 
#include "../log.h"
#define TAG WINPR_TAG("sync.wait")
 
#ifndef _WIN32
 
#include <stdlib.h>
#include <time.h>
#include <sys/time.h>
#include <sys/wait.h>
 
#include "../handle/handle.h"
 
#include "../pipe/pipe.h"
 
static struct timespec ts_from_ns(void)
{
  const UINT64 ns = winpr_GetUnixTimeNS();
  struct timespec timeout = WINPR_C_ARRAY_INIT;
  timeout.tv_sec = WINPR_TIME_NS_TO_S(ns);
  timeout.tv_nsec = WINPR_TIME_NS_REM_NS(ns);
  return timeout;
}
 
#if !defined(WINPR_HAVE_PTHREAD_MUTEX_TIMEDLOCK)
#include <pthread.h>
 
static long long ts_difftime(const struct timespec* o, const struct timespec* n)
{
  long long oldValue = o->tv_sec * 1000000000LL + o->tv_nsec;
  long long newValue = n->tv_sec * 1000000000LL + n->tv_nsec;
  return newValue - oldValue;
}
 
#ifdef ANDROID
#if (__ANDROID_API__ >= 21)
#define CONST_NEEDED const
#else
#define CONST_NEEDED
#endif
#define STATIC_NEEDED
#else /* ANDROID */
#define CONST_NEEDED const
#define STATIC_NEEDED static
#endif
 
STATIC_NEEDED int pthread_mutex_timedlock(pthread_mutex_t* mutex,
                                          CONST_NEEDED struct timespec* timeout)
{
  struct timespec timenow = WINPR_C_ARRAY_INIT;
  struct timespec sleepytime = WINPR_C_ARRAY_INIT;
  unsigned long long diff = 0;
  int retcode = -1;
  /* This is just to avoid a completely busy wait */
  timenow = ts_from_ns();
  diff = ts_difftime(&timenow, timeout);
  sleepytime.tv_sec = diff / 1000000000LL;
  sleepytime.tv_nsec = diff % 1000000000LL;
 
  while ((retcode = pthread_mutex_trylock(mutex)) == EBUSY)
  {
    timenow = ts_from_ns();
 
    if (ts_difftime(timeout, &timenow) >= 0)
    {
      return ETIMEDOUT;
    }
 
    nanosleep(&sleepytime, nullptr);
  }
 
  return retcode;
}
#endif
 
static void ts_add_ms(struct timespec* ts, DWORD dwMilliseconds)
{
  ts->tv_sec += dwMilliseconds / 1000L;
  ts->tv_nsec += (dwMilliseconds % 1000L) * 1000000L;
  ts->tv_sec += ts->tv_nsec / 1000000000L;
  ts->tv_nsec = ts->tv_nsec % 1000000000L;
}
 
DWORD WaitForSingleObjectEx(HANDLE hHandle, DWORD dwMilliseconds, BOOL bAlertable)
{
  ULONG Type = 0;
  WINPR_HANDLE* Object = nullptr;
  WINPR_POLL_SET pollset = WINPR_C_ARRAY_INIT;
 
  if (!winpr_Handle_GetInfo(hHandle, &Type, &Object))
  {
    WLog_ERR(TAG, "invalid hHandle.");
    SetLastError(ERROR_INVALID_HANDLE);
    return WAIT_FAILED;
  }
 
  if (Type == HANDLE_TYPE_PROCESS && winpr_Handle_getFd(hHandle) == -1)
  {
    /* note: if we have pidfd support (under linux and we have managed to associate a
     *    pidfd with our process), we use the regular method with pollset below.
     *    If not (on other platforms) we do a waitpid */
    WINPR_PROCESS* process = (WINPR_PROCESS*)Object;
 
    while (TRUE)
    {
      int ret = waitpid(process->pid, &(process->status), WNOHANG);
      if (ret == process->pid)
      {
        if (WIFEXITED(process->status))
          process->dwExitCode = (DWORD)WEXITSTATUS(process->status);
        else if (WIFSIGNALED(process->status))
          process->dwExitCode = (DWORD)(128 + WTERMSIG(process->status));
        else
          process->dwExitCode = (DWORD)process->status;
        return WAIT_OBJECT_0;
      }
      else if (ret < 0)
      {
        char ebuffer[256] = WINPR_C_ARRAY_INIT;
        WLog_ERR(TAG, "waitpid failure [%d] %s", errno,
                 winpr_strerror(errno, ebuffer, sizeof(ebuffer)));
        SetLastError(ERROR_INTERNAL_ERROR);
        return WAIT_FAILED;
      }
 
      if (dwMilliseconds == 0)
        return WAIT_TIMEOUT;
 
      /* sleep by slices of 50ms */
      DWORD waitDelay = 50;
      if (dwMilliseconds != INFINITE)
      {
        if (dwMilliseconds < 50)
          waitDelay = dwMilliseconds;
        dwMilliseconds -= waitDelay;
      }
 
      DWORD status = SleepEx(waitDelay, bAlertable);
      if (status != 0)
        return status;
    }
  }
 
  if (Type == HANDLE_TYPE_MUTEX)
  {
    WINPR_MUTEX* mutex = (WINPR_MUTEX*)Object;
 
    if (dwMilliseconds != INFINITE)
    {
      int status = 0;
      struct timespec timeout = ts_from_ns();
 
      ts_add_ms(&timeout, dwMilliseconds);
      status = pthread_mutex_timedlock(&mutex->mutex, &timeout);
 
      if (ETIMEDOUT == status)
        return WAIT_TIMEOUT;
    }
    else
    {
      pthread_mutex_lock(&mutex->mutex);
    }
 
    return WAIT_OBJECT_0;
  }
  else
  {
    int status = -1;
    WINPR_THREAD* thread = nullptr;
    BOOL isSet = FALSE;
    size_t extraFds = 0;
    DWORD ret = 0;
    BOOL autoSignaled = FALSE;
 
    if (bAlertable)
    {
      thread = (WINPR_THREAD*)_GetCurrentThread();
      if (thread)
      {
        /* treat reentrancy, we can't switch to alertable state when we're already
           treating completions */
        if (thread->apc.treatingCompletions)
          bAlertable = FALSE;
        else
          extraFds = thread->apc.length;
      }
      else
      {
        /* called from a non WinPR thread */
        bAlertable = FALSE;
      }
    }
 
    int fd = winpr_Handle_getFd(Object);
    if (fd < 0)
    {
      WLog_ERR(TAG, "winpr_Handle_getFd did not return a fd!");
      SetLastError(ERROR_INVALID_HANDLE);
      return WAIT_FAILED;
    }
 
    if (!pollset_init(&pollset, 1 + extraFds))
    {
      WLog_ERR(TAG, "unable to initialize pollset");
      SetLastError(ERROR_INTERNAL_ERROR);
      return WAIT_FAILED;
    }
 
    if (!pollset_add(&pollset, fd, Object->Mode))
    {
      WLog_ERR(TAG, "unable to add fd in pollset");
      goto out;
    }
 
    if (bAlertable && !apc_collectFds(thread, &pollset, &autoSignaled))
    {
      WLog_ERR(TAG, "unable to collect APC fds");
      goto out;
    }
 
    if (!autoSignaled)
    {
      status = pollset_poll(&pollset, dwMilliseconds);
      if (status < 0)
      {
        char ebuffer[256] = WINPR_C_ARRAY_INIT;
        WLog_ERR(TAG, "pollset_poll() failure [%d] %s", errno,
                 winpr_strerror(errno, ebuffer, sizeof(ebuffer)));
        goto out;
      }
    }
 
    ret = WAIT_TIMEOUT;
    if (bAlertable && apc_executeCompletions(thread, &pollset, 1))
      ret = WAIT_IO_COMPLETION;
 
    isSet = pollset_isSignaled(&pollset, 0);
    pollset_uninit(&pollset);
 
    if (!isSet)
      return ret;
 
    return winpr_Handle_cleanup(Object);
  }
 
out:
  pollset_uninit(&pollset);
  SetLastError(ERROR_INTERNAL_ERROR);
  return WAIT_FAILED;
}
 
DWORD WaitForSingleObject(HANDLE hHandle, DWORD dwMilliseconds)
{
  return WaitForSingleObjectEx(hHandle, dwMilliseconds, FALSE);
}
 
DWORD WaitForMultipleObjectsEx(DWORD nCount, const HANDLE* lpHandles, BOOL bWaitAll,
                               DWORD dwMilliseconds, BOOL bAlertable)
{
  DWORD signalled = 0;
  DWORD polled = 0;
  DWORD poll_map[MAXIMUM_WAIT_OBJECTS] = WINPR_C_ARRAY_INIT;
  BOOL signalled_handles[MAXIMUM_WAIT_OBJECTS] = { FALSE };
  int fd = -1;
  int status = -1;
  ULONG Type = 0;
  WINPR_HANDLE* Object = nullptr;
  WINPR_THREAD* thread = nullptr;
  WINPR_POLL_SET pollset = WINPR_C_ARRAY_INIT;
  DWORD ret = WAIT_FAILED;
  size_t extraFds = 0;
  UINT64 now = 0;
  UINT64 dueTime = 0;
 
  if (!nCount || (nCount > MAXIMUM_WAIT_OBJECTS))
  {
    WLog_ERR(TAG, "invalid handles count(%" PRIu32 ")", nCount);
    return WAIT_FAILED;
  }
 
  if (bAlertable)
  {
    thread = winpr_GetCurrentThread();
    if (thread)
    {
      /* treat reentrancy, we can't switch to alertable state when we're already
         treating completions */
      if (thread->apc.treatingCompletions)
        bAlertable = FALSE;
      else
        extraFds = thread->apc.length;
    }
    else
    {
      /* most probably we're not called from WinPR thread, so we can't have any APC */
      bAlertable = FALSE;
    }
  }
 
  if (!pollset_init(&pollset, nCount + extraFds))
  {
    WLog_ERR(TAG, "unable to initialize pollset for nCount=%" PRIu32 " extraCount=%" PRIuz "",
             nCount, extraFds);
    return WAIT_FAILED;
  }
 
  signalled = 0;
 
  now = GetTickCount64();
  if (dwMilliseconds != INFINITE)
    dueTime = now + dwMilliseconds;
  else
    dueTime = 0xFFFFFFFFFFFFFFFF;
 
  do
  {
    BOOL autoSignaled = FALSE;
    polled = 0;
 
    /* first collect file descriptors to poll */
    DWORD idx = 0;
    for (; idx < nCount; idx++)
    {
      if (bWaitAll)
      {
        if (signalled_handles[idx])
          continue;
 
        poll_map[polled] = idx;
      }
 
      if (!winpr_Handle_GetInfo(lpHandles[idx], &Type, &Object))
      {
        WLog_ERR(TAG, "invalid event file descriptor at %" PRIu32, idx);
        winpr_log_backtrace(TAG, WLOG_ERROR, 20);
        SetLastError(ERROR_INVALID_HANDLE);
        goto out;
      }
 
      fd = winpr_Handle_getFd(Object);
      if (fd == -1)
      {
        WLog_ERR(TAG, "invalid file descriptor at %" PRIu32, idx);
        winpr_log_backtrace(TAG, WLOG_ERROR, 20);
        SetLastError(ERROR_INVALID_HANDLE);
        goto out;
      }
 
      if (!pollset_add(&pollset, fd, Object->Mode))
      {
        WLog_ERR(TAG, "unable to register fd in pollset at %" PRIu32, idx);
        winpr_log_backtrace(TAG, WLOG_ERROR, 20);
        SetLastError(ERROR_INVALID_HANDLE);
        goto out;
      }
 
      polled++;
    }
 
    /* treat file descriptors of the APC if needed */
    if (bAlertable && !apc_collectFds(thread, &pollset, &autoSignaled))
    {
      WLog_ERR(TAG, "unable to register APC fds");
      winpr_log_backtrace(TAG, WLOG_ERROR, 20);
      SetLastError(ERROR_INTERNAL_ERROR);
      goto out;
    }
 
    /* poll file descriptors */
    status = 0;
    if (!autoSignaled)
    {
      DWORD waitTime = 0;
 
      if (dwMilliseconds == INFINITE)
        waitTime = INFINITE;
      else
        waitTime = (DWORD)(dueTime - now);
 
      status = pollset_poll(&pollset, waitTime);
      if (status < 0)
      {
        char ebuffer[256] = WINPR_C_ARRAY_INIT;
#ifdef WINPR_HAVE_POLL_H
        WLog_ERR(TAG, "poll() handle %" PRIu32 " (%" PRIu32 ") failure [%d] %s", idx,
                 nCount, errno, winpr_strerror(errno, ebuffer, sizeof(ebuffer)));
#else
        WLog_ERR(TAG, "select() handle %" PRIu32 " (%" PRIu32 ") failure [%d] %s", idx,
                 nCount, errno, winpr_strerror(errno, ebuffer, sizeof(ebuffer)));
#endif
        winpr_log_backtrace(TAG, WLOG_ERROR, 20);
        SetLastError(ERROR_INTERNAL_ERROR);
        goto out;
      }
    }
 
    /* give priority to the APC queue, to return WAIT_IO_COMPLETION */
    if (bAlertable && apc_executeCompletions(thread, &pollset, polled))
    {
      ret = WAIT_IO_COMPLETION;
      goto out;
    }
 
    /* then treat pollset */
    if (status)
    {
      for (DWORD index = 0; index < polled; index++)
      {
        DWORD handlesIndex = 0;
        BOOL signal_set = FALSE;
 
        if (bWaitAll)
          handlesIndex = poll_map[index];
        else
          handlesIndex = index;
 
        signal_set = pollset_isSignaled(&pollset, index);
        if (signal_set)
        {
          DWORD rc = winpr_Handle_cleanup(lpHandles[handlesIndex]);
          if (rc != WAIT_OBJECT_0)
          {
            WLog_ERR(TAG, "error in cleanup function for handle at index=%" PRIu32,
                     handlesIndex);
            ret = rc;
            goto out;
          }
 
          if (bWaitAll)
          {
            signalled_handles[handlesIndex] = TRUE;
 
            /* Continue checks from last position. */
            for (; signalled < nCount; signalled++)
            {
              if (!signalled_handles[signalled])
                break;
            }
          }
          else
          {
            ret = (WAIT_OBJECT_0 + handlesIndex);
            goto out;
          }
 
          if (signalled >= nCount)
          {
            ret = WAIT_OBJECT_0;
            goto out;
          }
        }
      }
    }
 
    if (bAlertable && thread->apc.length > extraFds)
    {
      pollset_uninit(&pollset);
      extraFds = thread->apc.length;
      if (!pollset_init(&pollset, nCount + extraFds))
      {
        WLog_ERR(TAG, "unable reallocate pollset");
        SetLastError(ERROR_INTERNAL_ERROR);
        return WAIT_FAILED;
      }
    }
    else
      pollset_reset(&pollset);
 
    now = GetTickCount64();
  } while (now < dueTime);
 
  ret = WAIT_TIMEOUT;
 
out:
  pollset_uninit(&pollset);
  return ret;
}
 
DWORD WaitForMultipleObjects(DWORD nCount, const HANDLE* lpHandles, BOOL bWaitAll,
                             DWORD dwMilliseconds)
{
  return WaitForMultipleObjectsEx(nCount, lpHandles, bWaitAll, dwMilliseconds, FALSE);
}
 
DWORD SignalObjectAndWait(HANDLE hObjectToSignal, HANDLE hObjectToWaitOn, DWORD dwMilliseconds,
                          BOOL bAlertable)
{
  if (!SetEvent(hObjectToSignal))
    return WAIT_FAILED;
 
  return WaitForSingleObjectEx(hObjectToWaitOn, dwMilliseconds, bAlertable);
}
 
#endif