mirror of https://github.com/grpc/grpc.git
to be traced. Adding tests for Fathom and TracedBuffer. A lot more. Please read PR description.reviewable/pr15941/r1
Yash Tibrewal
7 years ago
parent
31c7ab1aaf
commit
f0397933b0
55 changed files with 1142 additions and 78 deletions
@ -0,0 +1,143 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 gRPC authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
* |
||||
*/ |
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include "src/core/lib/iomgr/buffer_list.h" |
||||
#include "src/core/lib/iomgr/port.h" |
||||
|
||||
#include <grpc/support/log.h> |
||||
|
||||
#ifdef GRPC_LINUX_ERRQUEUE |
||||
#include <time.h> |
||||
|
||||
#include "src/core/lib/gprpp/memory.h" |
||||
|
||||
namespace grpc_core { |
||||
void TracedBuffer::AddNewEntry(TracedBuffer** head, uint32_t seq_no, |
||||
void* arg) { |
||||
gpr_log(GPR_INFO, "Adding new entry %u", seq_no); |
||||
GPR_DEBUG_ASSERT(head != nullptr); |
||||
TracedBuffer* new_elem = New<TracedBuffer>(seq_no, arg); |
||||
/* Store the current time as the sendmsg time. */ |
||||
new_elem->ts_.sendmsg_time = gpr_now(GPR_CLOCK_REALTIME); |
||||
if (*head == nullptr) { |
||||
*head = new_elem; |
||||
gpr_log(GPR_INFO, "returning"); |
||||
return; |
||||
} |
||||
/* Append at the end. */ |
||||
TracedBuffer* ptr = *head; |
||||
while (ptr->next_ != nullptr) { |
||||
ptr = ptr->next_; |
||||
} |
||||
ptr->next_ = new_elem; |
||||
gpr_log(GPR_INFO, "returning"); |
||||
} |
||||
|
||||
namespace { |
||||
void fill_gpr_from_timestamp(gpr_timespec* gts, const struct timespec* ts) { |
||||
gts->tv_sec = ts->tv_sec; |
||||
gts->tv_nsec = static_cast<int32_t>(ts->tv_nsec); |
||||
gts->clock_type = GPR_CLOCK_REALTIME; |
||||
} |
||||
|
||||
void (*timestamps_callback)(void*, grpc_core::Timestamps*, |
||||
grpc_error* shutdown_err); |
||||
} /* namespace */ |
||||
|
||||
void TracedBuffer::ProcessTimestamp(TracedBuffer** head, |
||||
struct sock_extended_err* serr, |
||||
struct scm_timestamping* tss) { |
||||
gpr_log(GPR_INFO, "Got timestamp %d", serr->ee_data); |
||||
GPR_DEBUG_ASSERT(head != nullptr); |
||||
TracedBuffer* elem = *head; |
||||
TracedBuffer* next = nullptr; |
||||
while (elem != nullptr) { |
||||
gpr_log(GPR_INFO, "looping"); |
||||
/* The byte number refers to the sequence number of the last byte which this
|
||||
* timestamp relates to. For scheduled and send, we are interested in the |
||||
* timestamp for the first byte, whereas for ack, we are interested in the |
||||
* last */ |
||||
if (serr->ee_data >= elem->seq_no_) { |
||||
switch (serr->ee_info) { |
||||
case SCM_TSTAMP_SCHED: |
||||
gpr_log(GPR_INFO, "type sched\n"); |
||||
fill_gpr_from_timestamp(&(elem->ts_.scheduled_time), &(tss->ts[0])); |
||||
elem = elem->next_; |
||||
break; |
||||
case SCM_TSTAMP_SND: |
||||
gpr_log(GPR_INFO, "type send\n"); |
||||
fill_gpr_from_timestamp(&(elem->ts_.sent_time), &(tss->ts[0])); |
||||
elem = elem->next_; |
||||
break; |
||||
case SCM_TSTAMP_ACK: |
||||
gpr_log(GPR_INFO, "type ack\n"); |
||||
if (serr->ee_data >= elem->seq_no_) { |
||||
fill_gpr_from_timestamp(&(elem->ts_.acked_time), &(tss->ts[0])); |
||||
/* Got all timestamps. Do the callback and free this TracedBuffer.
|
||||
* The thing below can be passed by value if we don't want the |
||||
* restriction on the lifetime. */ |
||||
timestamps_callback(elem->arg_, &(elem->ts_), GRPC_ERROR_NONE); |
||||
next = elem->next_; |
||||
Delete<TracedBuffer>(elem); |
||||
*head = elem = next; |
||||
break; |
||||
default: |
||||
abort(); |
||||
} |
||||
} |
||||
} else { |
||||
break; |
||||
} |
||||
} |
||||
} |
||||
|
||||
void TracedBuffer::Shutdown(TracedBuffer** head, grpc_error* shutdown_err) { |
||||
GPR_DEBUG_ASSERT(head != nullptr); |
||||
TracedBuffer* elem = *head; |
||||
while (elem != nullptr) { |
||||
if (timestamps_callback) { |
||||
timestamps_callback(elem->arg_, &(elem->ts_), shutdown_err); |
||||
} |
||||
auto* next = elem->next_; |
||||
Delete<TracedBuffer>(elem); |
||||
elem = next; |
||||
} |
||||
*head = nullptr; |
||||
GRPC_ERROR_UNREF(shutdown_err); |
||||
} |
||||
|
||||
void grpc_tcp_set_write_timestamps_callback(void (*fn)(void*, |
||||
grpc_core::Timestamps*, |
||||
grpc_error* error)) { |
||||
timestamps_callback = fn; |
||||
} |
||||
} /* namespace grpc_core */ |
||||
|
||||
#else /* GRPC_LINUX_ERRQUEUE */ |
||||
|
||||
namespace grpc_core { |
||||
void grpc_tcp_set_write_timestamps_callback(void (*fn)(void*, |
||||
grpc_core::Timestamps*, |
||||
grpc_error* error)) { |
||||
gpr_log(GPR_DEBUG, "Timestamps callback is not enabled for this platform"); |
||||
} |
||||
} /* namespace grpc_core */ |
||||
|
||||
#endif /* GRPC_LINUX_ERRQUEUE */ |
||||
@ -0,0 +1,81 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 gRPC authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_CORE_LIB_IOMGR_BUFFER_LIST_H |
||||
#define GRPC_CORE_LIB_IOMGR_BUFFER_LIST_H |
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include "src/core/lib/iomgr/port.h" |
||||
|
||||
#include <grpc/support/time.h> |
||||
|
||||
#include "src/core/lib/gprpp/memory.h" |
||||
#include "src/core/lib/iomgr/error.h" |
||||
#include "src/core/lib/iomgr/internal_errqueue.h" |
||||
|
||||
namespace grpc_core { |
||||
struct Timestamps { |
||||
gpr_timespec sendmsg_time; |
||||
gpr_timespec scheduled_time; |
||||
gpr_timespec sent_time; |
||||
gpr_timespec acked_time; |
||||
}; |
||||
|
||||
#ifdef GRPC_LINUX_ERRQUEUE |
||||
class TracedBuffer { |
||||
public: |
||||
/** Add a new entry in the TracedBuffer list pointed to by head */ |
||||
static void AddNewEntry(grpc_core::TracedBuffer** head, uint32_t seq_no, |
||||
void* arg); |
||||
|
||||
/** Processes a timestamp received */ |
||||
static void ProcessTimestamp(grpc_core::TracedBuffer** head, |
||||
struct sock_extended_err* serr, |
||||
struct scm_timestamping* tss); |
||||
|
||||
/** Calls the callback for each traced buffer in the list with timestamps that
|
||||
* it has. */ |
||||
static void Shutdown(grpc_core::TracedBuffer** head, |
||||
grpc_error* shutdown_err); |
||||
|
||||
private: |
||||
GPRC_ALLOW_CLASS_TO_USE_NON_PUBLIC_NEW |
||||
|
||||
TracedBuffer(int seq_no, void* arg) |
||||
: seq_no_(seq_no), arg_(arg), next_(nullptr) { |
||||
gpr_log(GPR_INFO, "seq_no %d", seq_no_); |
||||
} |
||||
|
||||
uint32_t seq_no_; /* The sequence number for the last byte in the buffer */ |
||||
void* arg_; /* The arg to pass to timestamps_callback */ |
||||
grpc_core::Timestamps ts_; |
||||
grpc_core::TracedBuffer* next_; |
||||
}; |
||||
#else /* GRPC_LINUX_ERRQUEUE */ |
||||
class TracedBuffer {}; |
||||
#endif /* GRPC_LINUX_ERRQUEUE */ |
||||
|
||||
/** Sets the timestamp callback */ |
||||
void grpc_tcp_set_write_timestamps_callback(void (*fn)(void*, |
||||
grpc_core::Timestamps*, |
||||
grpc_error* error)); |
||||
|
||||
}; // namespace grpc_core
|
||||
|
||||
#endif /* GRPC_CORE_LIB_IOMGR_BUFFER_LIST_H */ |
||||
@ -0,0 +1,40 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 gRPC authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
* |
||||
*/ |
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include "src/core/lib/iomgr/port.h" |
||||
|
||||
#include "src/core/lib/iomgr/internal_errqueue.h" |
||||
|
||||
#ifdef GRPC_POSIX_SOCKET_TCP |
||||
|
||||
#ifdef GPR_LINUX |
||||
#include <linux/version.h> |
||||
#endif /* GPR_LINUX */ |
||||
|
||||
bool kernel_supports_errqueue() { |
||||
#ifdef LINUX_VERSION_CODE |
||||
#if LINUX_VERSION_CODE <= KERNEL_VERSION(4, 0, 0) |
||||
return true; |
||||
#endif /* LINUX_VERSION_CODE <= KERNEL_VERSION(4, 0, 0) */ |
||||
#endif /* LINUX_VERSION_CODE */ |
||||
return false; |
||||
} |
||||
|
||||
#endif /* GRPC_POSIX_SOCKET_TCP */ |
||||
@ -0,0 +1,76 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 gRPC authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_CORE_LIB_IOMGR_INTERNAL_ERRQUEUE_H |
||||
#define GRPC_CORE_LIB_IOMGR_INTERNAL_ERRQUEUE_H |
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include "src/core/lib/iomgr/port.h" |
||||
|
||||
#ifdef GRPC_POSIX_SOCKET_TCP |
||||
|
||||
#include <sys/types.h> |
||||
#include <time.h> |
||||
|
||||
#ifdef GRPC_LINUX_ERRQUEUE |
||||
#include <linux/errqueue.h> |
||||
#include <linux/net_tstamp.h> |
||||
#include <sys/socket.h> |
||||
#endif /* GRPC_LINUX_ERRQUEUE */ |
||||
|
||||
namespace grpc_core { |
||||
/* Redefining scm_timestamping in the same way that <linux/errqueue.h> defines
|
||||
* it, so that code compiles on systems that don't have it. */ |
||||
struct scm_timestamping { |
||||
struct timespec ts[3]; |
||||
}; |
||||
|
||||
/* Also redefine timestamp types */ |
||||
/* The timestamp type for when the driver passed skb to NIC, or HW. */ |
||||
constexpr int SCM_TSTAMP_SND = 0; |
||||
/* The timestamp type for when data entered the packet scheduler. */ |
||||
constexpr int SCM_TSTAMP_SCHED = 1; |
||||
/* The timestamp type for when data acknowledged by peer. */ |
||||
constexpr int SCM_TSTAMP_ACK = 2; |
||||
|
||||
/* Redefine required constants from <linux/net_tstamp.h> */ |
||||
constexpr uint32_t SOF_TIMESTAMPING_TX_SOFTWARE = 1u << 1; |
||||
constexpr uint32_t SOF_TIMESTAMPING_SOFTWARE = 1u << 4; |
||||
constexpr uint32_t SOF_TIMESTAMPING_OPT_ID = 1u << 7; |
||||
constexpr uint32_t SOF_TIMESTAMPING_TX_SCHED = 1u << 8; |
||||
constexpr uint32_t SOF_TIMESTAMPING_TX_ACK = 1u << 9; |
||||
constexpr uint32_t SOF_TIMESTAMPING_OPT_TSONLY = 1u << 11; |
||||
|
||||
constexpr uint32_t kTimestampingSocketOptions = SOF_TIMESTAMPING_SOFTWARE | |
||||
SOF_TIMESTAMPING_OPT_ID | |
||||
SOF_TIMESTAMPING_OPT_TSONLY; |
||||
|
||||
constexpr uint32_t kTimestampingRecordingOptions = |
||||
SOF_TIMESTAMPING_TX_SCHED | SOF_TIMESTAMPING_TX_SOFTWARE | |
||||
SOF_TIMESTAMPING_TX_ACK; |
||||
|
||||
/* Returns true if kernel is capable of supporting errqueue and timestamping.
|
||||
* Currently allowing only linux kernels above 4.0.0 |
||||
*/ |
||||
bool kernel_supports_errqueue(); |
||||
} // namespace grpc_core
|
||||
|
||||
#endif /* GRPC_POSIX_SOCKET_TCP */ |
||||
|
||||
#endif /* GRPC_CORE_LIB_IOMGR_INTERNAL_ERRQUEUE_H */ |
||||
@ -0,0 +1,111 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2018 gRPC authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
* |
||||
*/ |
||||
|
||||
#include "src/core/lib/iomgr/port.h" |
||||
|
||||
#include "src/core/lib/iomgr/buffer_list.h" |
||||
|
||||
#include <grpc/grpc.h> |
||||
|
||||
#include "test/core/util/test_config.h" |
||||
|
||||
#ifdef GRPC_LINUX_ERRQUEUE |
||||
|
||||
static void TestShutdownFlushesListVerifier(void* arg, |
||||
grpc_core::Timestamps* ts, |
||||
grpc_error* error) { |
||||
GPR_ASSERT(error == GRPC_ERROR_NONE); |
||||
GPR_ASSERT(arg != nullptr); |
||||
gpr_atm* done = reinterpret_cast<gpr_atm*>(arg); |
||||
gpr_atm_rel_store(done, static_cast<gpr_atm>(1)); |
||||
} |
||||
|
||||
/** Tests that all TracedBuffer elements in the list are flushed out on
|
||||
* shutdown. |
||||
* Also tests that arg is passed correctly. |
||||
*/ |
||||
static void TestShutdownFlushesList() { |
||||
grpc_core::grpc_tcp_set_write_timestamps_callback( |
||||
TestShutdownFlushesListVerifier); |
||||
grpc_core::TracedBuffer* list = nullptr; |
||||
#define NUM_ELEM 5 |
||||
gpr_atm verifier_called[NUM_ELEM]; |
||||
for (auto i = 0; i < NUM_ELEM; i++) { |
||||
gpr_atm_rel_store(&verifier_called[i], static_cast<gpr_atm>(0)); |
||||
grpc_core::TracedBuffer::AddNewEntry( |
||||
&list, i, static_cast<void*>(&verifier_called[i])); |
||||
} |
||||
grpc_core::TracedBuffer::Shutdown(&list, GRPC_ERROR_NONE); |
||||
GPR_ASSERT(list == nullptr); |
||||
for (auto i = 0; i < NUM_ELEM; i++) { |
||||
GPR_ASSERT(gpr_atm_acq_load(&verifier_called[i]) == |
||||
static_cast<gpr_atm>(1)); |
||||
} |
||||
} |
||||
|
||||
static void TestVerifierCalledOnAckVerifier(void* arg, |
||||
grpc_core::Timestamps* ts, |
||||
grpc_error* error) { |
||||
GPR_ASSERT(error == GRPC_ERROR_NONE); |
||||
GPR_ASSERT(arg != nullptr); |
||||
GPR_ASSERT(ts->acked_time.clock_type == GPR_CLOCK_REALTIME); |
||||
GPR_ASSERT(ts->acked_time.tv_sec == 123); |
||||
GPR_ASSERT(ts->acked_time.tv_nsec == 456); |
||||
gpr_atm* done = reinterpret_cast<gpr_atm*>(arg); |
||||
gpr_atm_rel_store(done, static_cast<gpr_atm>(1)); |
||||
} |
||||
|
||||
/** Tests that the timestamp verifier is called on an ACK timestamp.
|
||||
*/ |
||||
static void TestVerifierCalledOnAck() { |
||||
struct sock_extended_err serr; |
||||
serr.ee_data = 213; |
||||
serr.ee_info = grpc_core::SCM_TSTAMP_ACK; |
||||
struct grpc_core::scm_timestamping tss; |
||||
tss.ts[0].tv_sec = 123; |
||||
tss.ts[0].tv_nsec = 456; |
||||
grpc_core::grpc_tcp_set_write_timestamps_callback( |
||||
TestVerifierCalledOnAckVerifier); |
||||
grpc_core::TracedBuffer* list = nullptr; |
||||
gpr_atm verifier_called; |
||||
gpr_atm_rel_store(&verifier_called, static_cast<gpr_atm>(0)); |
||||
grpc_core::TracedBuffer::AddNewEntry(&list, 213, &verifier_called); |
||||
grpc_core::TracedBuffer::ProcessTimestamp(&list, &serr, &tss); |
||||
GPR_ASSERT(gpr_atm_acq_load(&verifier_called) == static_cast<gpr_atm>(1)); |
||||
GPR_ASSERT(list == nullptr); |
||||
grpc_core::TracedBuffer::Shutdown(&list, GRPC_ERROR_NONE); |
||||
} |
||||
|
||||
static void TestTcpBufferList() { |
||||
TestVerifierCalledOnAck(); |
||||
TestShutdownFlushesList(); |
||||
} |
||||
|
||||
int main(int argc, char** argv) { |
||||
grpc_test_init(argc, argv); |
||||
grpc_init(); |
||||
TestTcpBufferList(); |
||||
grpc_shutdown(); |
||||
return 0; |
||||
} |
||||
|
||||
#else /* GRPC_LINUX_ERRQUEUE */ |
||||
|
||||
int main(int argc, char** argv) { return 1; } |
||||
|
||||
#endif /* GRPC_LINUX_ERRQUEUE */ |
||||
Loading…
Reference in new issue