src/core/lib/iomgr/error_internal.h

   1 /*
   2  *
   3  * Copyright 2016 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_CORE_LIB_IOMGR_ERROR_INTERNAL_H
  20 #define GRPC_CORE_LIB_IOMGR_ERROR_INTERNAL_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include <inttypes.h>
  25 #include <stdbool.h>  // TODO, do we need this?
  26
  27 #include <grpc/support/sync.h>
  28 #include "src/core/lib/iomgr/error.h"
  29
  30 typedef struct grpc_linked_error grpc_linked_error;
  31
  32 struct grpc_linked_error {
  33   grpc_error* err;
  34   uint8_t next;
  35 };
  36
  37 // c core representation of an error. See error.h for high level description of
  38 // this object.
  39 struct grpc_error {
  40   // All atomics in grpc_error must be stored in this nested struct. The rest of
  41   // the object is memcpy-ed in bulk in copy_and_unref.
  42   struct atomics {
  43     gpr_refcount refs;
  44     gpr_atm error_string;
  45   } atomics;
  46   // These arrays index into dynamic arena at the bottom of the struct.
  47   // UINT8_MAX is used as a sentinel value.
  48   uint8_t ints[GRPC_ERROR_INT_MAX];
  49   uint8_t strs[GRPC_ERROR_STR_MAX];
  50   uint8_t times[GRPC_ERROR_TIME_MAX];
  51   // The child errors are stored in the arena, but are effectively a linked list
  52   // structure, since they are contained within grpc_linked_error objects.
  53   uint8_t first_err;
  54   uint8_t last_err;
  55   // The arena is dynamically reallocated with a grow factor of 1.5.
  56   uint8_t arena_size;
  57   uint8_t arena_capacity;
  58   intptr_t arena[0];
  59 };
  60
  61 #endif /* GRPC_CORE_LIB_IOMGR_ERROR_INTERNAL_H */