test/core/end2end/cq_verifier_uv.c

/*
 *
 * Copyright 2016, Google Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#include <grpc/support/port_platform.h>

#ifdef GRPC_UV

#include <uv.h>

#include <grpc/support/alloc.h>
#include <grpc/support/log.h>

#include "test/core/end2end/cq_verifier_internal.h"

typedef enum timer_state {
  TIMER_STARTED,
  TIMER_TRIGGERED,
  TIMER_CLOSED
} timer_state;

/* the verifier itself */
struct cq_verifier {
  /* bound completion queue */
  grpc_completion_queue *cq;
  /* start of expectation list */
  expectation *first_expectation;
  uv_timer_t timer;
};

cq_verifier *cq_verifier_create(grpc_completion_queue *cq) {
  cq_verifier *v = gpr_malloc(sizeof(cq_verifier));
  v->cq = cq;
  v->first_expectation = NULL;
  uv_timer_init(uv_default_loop(), &v->timer);
  v->timer.data = (void *)TIMER_STARTED;
  return v;
}

static void timer_close_cb(uv_handle_t *handle) {
  handle->data = (void *)TIMER_CLOSED;
}

void cq_verifier_destroy(cq_verifier *v) {
  cq_verify(v);
  uv_close((uv_handle_t *)&v->timer, timer_close_cb);
  while ((timer_state)v->timer.data != TIMER_CLOSED) {
    uv_run(uv_default_loop(), UV_RUN_NOWAIT);
  }
  gpr_free(v);
}

expectation *cq_verifier_get_first_expectation(cq_verifier *v) {
  return v->first_expectation;
}

void cq_verifier_set_first_expectation(cq_verifier *v, expectation *e) {
  v->first_expectation = e;
}

static void timer_run_cb(uv_timer_t *timer) {
  timer->data = (void *)TIMER_TRIGGERED;
}

grpc_event cq_verifier_next_event(cq_verifier *v, int timeout_seconds) {
  uint64_t timeout_ms =
      timeout_seconds < 0 ? 0 : (uint64_t)timeout_seconds * 1000;
  grpc_event ev;
  v->timer.data = (void *)TIMER_STARTED;
  uv_timer_start(&v->timer, timer_run_cb, timeout_ms, 0);
  ev = grpc_completion_queue_next(v->cq, gpr_inf_past(GPR_CLOCK_MONOTONIC),
                                  NULL);
  // Stop the loop if the timer goes off or we get a non-timeout event
  while (((timer_state)v->timer.data != TIMER_TRIGGERED) &&
         ev.type == GRPC_QUEUE_TIMEOUT) {
    uv_run(uv_default_loop(), UV_RUN_ONCE);
    ev = grpc_completion_queue_next(v->cq, gpr_inf_past(GPR_CLOCK_MONOTONIC),
                                    NULL);
  }
  return ev;
}

#endif /* GRPC_UV */