The C based gRPC (C++, Python, Ruby, Objective-C, PHP, C#)
https://grpc.io/
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
371 lines
13 KiB
371 lines
13 KiB
#region Copyright notice and license |
|
|
|
// Copyright 2015, 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. |
|
|
|
#endregion |
|
|
|
using System; |
|
using System.Collections.Generic; |
|
using System.Linq; |
|
using System.Runtime.InteropServices; |
|
using System.Threading.Tasks; |
|
using Grpc.Core.Internal; |
|
using Grpc.Core.Logging; |
|
using Grpc.Core.Utils; |
|
|
|
namespace Grpc.Core |
|
{ |
|
/// <summary> |
|
/// Encapsulates initialization and shutdown of gRPC library. |
|
/// </summary> |
|
public class GrpcEnvironment |
|
{ |
|
const LogLevel DefaultLogLevel = LogLevel.Info; |
|
const int MinDefaultThreadPoolSize = 4; |
|
|
|
static object staticLock = new object(); |
|
static GrpcEnvironment instance; |
|
static int refCount; |
|
static int? customThreadPoolSize; |
|
static int? customCompletionQueueCount; |
|
static readonly HashSet<Channel> registeredChannels = new HashSet<Channel>(); |
|
static readonly HashSet<Server> registeredServers = new HashSet<Server>(); |
|
|
|
static ILogger logger = new LogLevelFilterLogger(new ConsoleLogger(), DefaultLogLevel); |
|
|
|
readonly object myLock = new object(); |
|
readonly GrpcThreadPool threadPool; |
|
readonly DebugStats debugStats = new DebugStats(); |
|
readonly AtomicCounter cqPickerCounter = new AtomicCounter(); |
|
|
|
bool isClosed; |
|
|
|
/// <summary> |
|
/// Returns a reference-counted instance of initialized gRPC environment. |
|
/// Subsequent invocations return the same instance unless reference count has dropped to zero previously. |
|
/// </summary> |
|
internal static GrpcEnvironment AddRef() |
|
{ |
|
ShutdownHooks.Register(); |
|
|
|
lock (staticLock) |
|
{ |
|
refCount++; |
|
if (instance == null) |
|
{ |
|
instance = new GrpcEnvironment(); |
|
} |
|
return instance; |
|
} |
|
} |
|
|
|
/// <summary> |
|
/// Decrements the reference count for currently active environment and asynchronously shuts down the gRPC environment if reference count drops to zero. |
|
/// </summary> |
|
internal static async Task ReleaseAsync() |
|
{ |
|
GrpcEnvironment instanceToShutdown = null; |
|
lock (staticLock) |
|
{ |
|
GrpcPreconditions.CheckState(refCount > 0); |
|
refCount--; |
|
if (refCount == 0) |
|
{ |
|
instanceToShutdown = instance; |
|
instance = null; |
|
} |
|
} |
|
|
|
if (instanceToShutdown != null) |
|
{ |
|
await instanceToShutdown.ShutdownAsync(); |
|
} |
|
} |
|
|
|
internal static int GetRefCount() |
|
{ |
|
lock (staticLock) |
|
{ |
|
return refCount; |
|
} |
|
} |
|
|
|
internal static void RegisterChannel(Channel channel) |
|
{ |
|
lock (staticLock) |
|
{ |
|
GrpcPreconditions.CheckNotNull(channel); |
|
registeredChannels.Add(channel); |
|
} |
|
} |
|
|
|
internal static void UnregisterChannel(Channel channel) |
|
{ |
|
lock (staticLock) |
|
{ |
|
GrpcPreconditions.CheckNotNull(channel); |
|
GrpcPreconditions.CheckArgument(registeredChannels.Remove(channel), "Channel not found in the registered channels set."); |
|
} |
|
} |
|
|
|
internal static void RegisterServer(Server server) |
|
{ |
|
lock (staticLock) |
|
{ |
|
GrpcPreconditions.CheckNotNull(server); |
|
registeredServers.Add(server); |
|
} |
|
} |
|
|
|
internal static void UnregisterServer(Server server) |
|
{ |
|
lock (staticLock) |
|
{ |
|
GrpcPreconditions.CheckNotNull(server); |
|
GrpcPreconditions.CheckArgument(registeredServers.Remove(server), "Server not found in the registered servers set."); |
|
} |
|
} |
|
|
|
/// <summary> |
|
/// Requests shutdown of all channels created by the current process. |
|
/// </summary> |
|
public static Task ShutdownChannelsAsync() |
|
{ |
|
HashSet<Channel> snapshot = null; |
|
lock (staticLock) |
|
{ |
|
snapshot = new HashSet<Channel>(registeredChannels); |
|
} |
|
return Task.WhenAll(snapshot.Select((channel) => channel.ShutdownAsync())); |
|
} |
|
|
|
/// <summary> |
|
/// Requests immediate shutdown of all servers created by the current process. |
|
/// </summary> |
|
public static Task KillServersAsync() |
|
{ |
|
HashSet<Server> snapshot = null; |
|
lock (staticLock) |
|
{ |
|
snapshot = new HashSet<Server>(registeredServers); |
|
} |
|
return Task.WhenAll(snapshot.Select((server) => server.KillAsync())); |
|
} |
|
|
|
/// <summary> |
|
/// Gets application-wide logger used by gRPC. |
|
/// </summary> |
|
/// <value>The logger.</value> |
|
public static ILogger Logger |
|
{ |
|
get |
|
{ |
|
return logger; |
|
} |
|
} |
|
|
|
/// <summary> |
|
/// Sets the application-wide logger that should be used by gRPC. |
|
/// </summary> |
|
public static void SetLogger(ILogger customLogger) |
|
{ |
|
GrpcPreconditions.CheckNotNull(customLogger, "customLogger"); |
|
logger = customLogger; |
|
} |
|
|
|
/// <summary> |
|
/// Sets the number of threads in the gRPC thread pool that polls for internal RPC events. |
|
/// Can be only invoke before the <c>GrpcEnviroment</c> is started and cannot be changed afterwards. |
|
/// Setting thread pool size is an advanced setting and you should only use it if you know what you are doing. |
|
/// Most users should rely on the default value provided by gRPC library. |
|
/// Note: this method is part of an experimental API that can change or be removed without any prior notice. |
|
/// </summary> |
|
public static void SetThreadPoolSize(int threadCount) |
|
{ |
|
lock (staticLock) |
|
{ |
|
GrpcPreconditions.CheckState(instance == null, "Can only be set before GrpcEnvironment is initialized"); |
|
GrpcPreconditions.CheckArgument(threadCount > 0, "threadCount needs to be a positive number"); |
|
customThreadPoolSize = threadCount; |
|
} |
|
} |
|
|
|
/// <summary> |
|
/// Sets the number of completion queues in the gRPC thread pool that polls for internal RPC events. |
|
/// Can be only invoke before the <c>GrpcEnviroment</c> is started and cannot be changed afterwards. |
|
/// Setting the number of completions queues is an advanced setting and you should only use it if you know what you are doing. |
|
/// Most users should rely on the default value provided by gRPC library. |
|
/// Note: this method is part of an experimental API that can change or be removed without any prior notice. |
|
/// </summary> |
|
public static void SetCompletionQueueCount(int completionQueueCount) |
|
{ |
|
lock (staticLock) |
|
{ |
|
GrpcPreconditions.CheckState(instance == null, "Can only be set before GrpcEnvironment is initialized"); |
|
GrpcPreconditions.CheckArgument(completionQueueCount > 0, "threadCount needs to be a positive number"); |
|
customCompletionQueueCount = completionQueueCount; |
|
} |
|
} |
|
|
|
/// <summary> |
|
/// Creates gRPC environment. |
|
/// </summary> |
|
private GrpcEnvironment() |
|
{ |
|
GrpcNativeInit(); |
|
threadPool = new GrpcThreadPool(this, GetThreadPoolSizeOrDefault(), GetCompletionQueueCountOrDefault()); |
|
threadPool.Start(); |
|
} |
|
|
|
/// <summary> |
|
/// Gets the completion queues used by this gRPC environment. |
|
/// </summary> |
|
internal IReadOnlyCollection<CompletionQueueSafeHandle> CompletionQueues |
|
{ |
|
get |
|
{ |
|
return this.threadPool.CompletionQueues; |
|
} |
|
} |
|
|
|
internal bool IsAlive |
|
{ |
|
get |
|
{ |
|
return this.threadPool.IsAlive; |
|
} |
|
} |
|
|
|
/// <summary> |
|
/// Picks a completion queue in a round-robin fashion. |
|
/// Shouldn't be invoked on a per-call basis (used at per-channel basis). |
|
/// </summary> |
|
internal CompletionQueueSafeHandle PickCompletionQueue() |
|
{ |
|
var cqIndex = (int) ((cqPickerCounter.Increment() - 1) % this.threadPool.CompletionQueues.Count); |
|
return this.threadPool.CompletionQueues.ElementAt(cqIndex); |
|
} |
|
|
|
/// <summary> |
|
/// Gets the completion queue used by this gRPC environment. |
|
/// </summary> |
|
internal DebugStats DebugStats |
|
{ |
|
get |
|
{ |
|
return this.debugStats; |
|
} |
|
} |
|
|
|
/// <summary> |
|
/// Gets version of gRPC C core. |
|
/// </summary> |
|
internal static string GetCoreVersionString() |
|
{ |
|
var ptr = NativeMethods.Get().grpcsharp_version_string(); // the pointer is not owned |
|
return Marshal.PtrToStringAnsi(ptr); |
|
} |
|
|
|
internal static void GrpcNativeInit() |
|
{ |
|
NativeMethods.Get().grpcsharp_init(); |
|
} |
|
|
|
internal static void GrpcNativeShutdown() |
|
{ |
|
NativeMethods.Get().grpcsharp_shutdown(); |
|
} |
|
|
|
/// <summary> |
|
/// Shuts down this environment. |
|
/// </summary> |
|
private async Task ShutdownAsync() |
|
{ |
|
if (isClosed) |
|
{ |
|
throw new InvalidOperationException("Close has already been called"); |
|
} |
|
await threadPool.StopAsync().ConfigureAwait(false); |
|
GrpcNativeShutdown(); |
|
isClosed = true; |
|
|
|
debugStats.CheckOK(); |
|
} |
|
|
|
private int GetThreadPoolSizeOrDefault() |
|
{ |
|
if (customThreadPoolSize.HasValue) |
|
{ |
|
return customThreadPoolSize.Value; |
|
} |
|
// In systems with many cores, use half of the cores for GrpcThreadPool |
|
// and the other half for .NET thread pool. This heuristic definitely needs |
|
// more work, but seems to work reasonably well for a start. |
|
return Math.Max(MinDefaultThreadPoolSize, Environment.ProcessorCount / 2); |
|
} |
|
|
|
private int GetCompletionQueueCountOrDefault() |
|
{ |
|
if (customCompletionQueueCount.HasValue) |
|
{ |
|
return customCompletionQueueCount.Value; |
|
} |
|
// by default, create a completion queue for each thread |
|
return GetThreadPoolSizeOrDefault(); |
|
} |
|
|
|
private static class ShutdownHooks |
|
{ |
|
static object staticLock = new object(); |
|
static bool hooksRegistered; |
|
|
|
public static void Register() |
|
{ |
|
lock (staticLock) |
|
{ |
|
if (!hooksRegistered) |
|
{ |
|
AppDomain.CurrentDomain.ProcessExit += ShutdownHookHandler; |
|
AppDomain.CurrentDomain.DomainUnload += ShutdownHookHandler; |
|
} |
|
hooksRegistered = true; |
|
} |
|
} |
|
|
|
/// <summary> |
|
/// Handler for AppDomain.DomainUnload and AppDomain.ProcessExit hooks. |
|
/// </summary> |
|
private static void ShutdownHookHandler(object sender, EventArgs e) |
|
{ |
|
Task.WaitAll(GrpcEnvironment.ShutdownChannelsAsync(), GrpcEnvironment.KillServersAsync()); |
|
} |
|
} |
|
} |
|
}
|
|
|