include/grpc/support/cpu.h

   1 /*
   2  *
   3  * Copyright 2015 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #ifndef GRPC_SUPPORT_CPU_H
  20 #define GRPC_SUPPORT_CPU_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /** Interface providing CPU information for currently running system */
  29
  30 /** Return the number of CPU cores on the current system. Will return 0 if
  31    the information is not available. */
  32 GPRAPI unsigned gpr_cpu_num_cores(void);
  33
  34 /** Return the CPU on which the current thread is executing; N.B. This should
  35    be considered advisory only - it is possible that the thread is switched
  36    to a different CPU at any time. Returns a value in range
  37    [0, gpr_cpu_num_cores() - 1] */
  38 GPRAPI unsigned gpr_cpu_current_cpu(void);
  39
  40 #ifdef __cplusplus
  41 }  // extern "C"
  42 #endif
  43
  44 #endif /* GRPC_SUPPORT_CPU_H */