| /* |
| * |
| * Copyright 2017 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_CHANNEL_CHANNELZ_REGISTRY_H |
| #define GRPC_CORE_LIB_CHANNEL_CHANNELZ_REGISTRY_H |
| |
| #include <grpc/impl/codegen/port_platform.h> |
| |
| #include "src/core/lib/channel/channel_trace.h" |
| #include "src/core/lib/channel/channelz.h" |
| #include "src/core/lib/gprpp/inlined_vector.h" |
| |
| #include <stdint.h> |
| |
| namespace grpc_core { |
| namespace channelz { |
| |
| namespace testing { |
| class ChannelzRegistryPeer; |
| } |
| |
| // singleton registry object to track all objects that are needed to support |
| // channelz bookkeeping. All objects share globally distributed uuids. |
| class ChannelzRegistry { |
| public: |
| // To be called in grpc_init() |
| static void Init(); |
| |
| // To be called in grpc_shutdown(); |
| static void Shutdown(); |
| |
| static void Register(BaseNode* node) { |
| return Default()->InternalRegister(node); |
| } |
| static void Unregister(intptr_t uuid) { Default()->InternalUnregister(uuid); } |
| static BaseNode* Get(intptr_t uuid) { return Default()->InternalGet(uuid); } |
| |
| // Returns the allocated JSON string that represents the proto |
| // GetTopChannelsResponse as per channelz.proto. |
| static char* GetTopChannels(intptr_t start_channel_id) { |
| return Default()->InternalGetTopChannels(start_channel_id); |
| } |
| |
| // Returns the allocated JSON string that represents the proto |
| // GetServersResponse as per channelz.proto. |
| static char* GetServers(intptr_t start_server_id) { |
| return Default()->InternalGetServers(start_server_id); |
| } |
| |
| // Test only helper function to dump the JSON representation to std out. |
| // This can aid in debugging channelz code. |
| static void LogAllEntities() { Default()->InternalLogAllEntities(); } |
| |
| private: |
| GPRC_ALLOW_CLASS_TO_USE_NON_PUBLIC_NEW |
| GPRC_ALLOW_CLASS_TO_USE_NON_PUBLIC_DELETE |
| friend class testing::ChannelzRegistryPeer; |
| |
| ChannelzRegistry(); |
| ~ChannelzRegistry(); |
| |
| // Returned the singleton instance of ChannelzRegistry; |
| static ChannelzRegistry* Default(); |
| |
| // globally registers an Entry. Returns its unique uuid |
| void InternalRegister(BaseNode* node); |
| |
| // globally unregisters the object that is associated to uuid. Also does |
| // sanity check that an object doesn't try to unregister the wrong type. |
| void InternalUnregister(intptr_t uuid); |
| |
| // if object with uuid has previously been registered as the correct type, |
| // returns the void* associated with that uuid. Else returns nullptr. |
| BaseNode* InternalGet(intptr_t uuid); |
| |
| char* InternalGetTopChannels(intptr_t start_channel_id); |
| char* InternalGetServers(intptr_t start_server_id); |
| |
| // If entities_ has over a certain threshold of empty slots, it will |
| // compact the vector and move all used slots to the front. |
| void MaybePerformCompactionLocked(); |
| |
| // Performs binary search on entities_ to find the index with that uuid. |
| // If direct_hit_needed, then will return -1 in case of absence. |
| // Else, will return idx of the first uuid higher than the target. |
| int FindByUuidLocked(intptr_t uuid, bool direct_hit_needed); |
| |
| void InternalLogAllEntities(); |
| |
| // protects members |
| gpr_mu mu_; |
| InlinedVector<BaseNode*, 20> entities_; |
| intptr_t uuid_generator_ = 0; |
| int num_empty_slots_ = 0; |
| }; |
| |
| } // namespace channelz |
| } // namespace grpc_core |
| |
| #endif /* GRPC_CORE_LIB_CHANNEL_CHANNELZ_REGISTRY_H */ |