tools/run_tests/sanity/core_banned_functions.py

   1 #!/usr/bin/env python
   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 from __future__ import print_function
  18
  19 import os
  20 import sys
  21
  22 os.chdir(os.path.join(os.path.dirname(sys.argv[0]), '../../..'))
  23
  24 # map of banned function signature to whitelist
  25 BANNED_EXCEPT = {
  26     'grpc_resource_quota_ref(': ['src/core/lib/iomgr/resource_quota.cc'],
  27     'grpc_resource_quota_unref(':
  28     ['src/core/lib/iomgr/resource_quota.cc', 'src/core/lib/surface/server.cc'],
  29     'grpc_slice_buffer_destroy(': ['src/core/lib/slice/slice_buffer.cc'],
  30     'grpc_slice_buffer_reset_and_unref(':
  31     ['src/core/lib/slice/slice_buffer.cc'],
  32     'grpc_slice_ref(': ['src/core/lib/slice/slice.cc'],
  33     'grpc_slice_unref(': ['src/core/lib/slice/slice.cc'],
  34     'grpc_error_create(':
  35     ['src/core/lib/iomgr/error.cc', 'src/core/lib/iomgr/error_cfstream.cc'],
  36     'grpc_error_ref(': ['src/core/lib/iomgr/error.cc'],
  37     'grpc_error_unref(': ['src/core/lib/iomgr/error.cc'],
  38     'grpc_os_error(': ['src/core/lib/iomgr/error.cc'],
  39     'grpc_wsa_error(': ['src/core/lib/iomgr/error.cc'],
  40     'grpc_log_if_error(': ['src/core/lib/iomgr/error.cc'],
  41     'grpc_slice_malloc(': ['src/core/lib/slice/slice.cc'],
  42     'grpc_call_cancel_internal(': ['src/core/lib/surface/call.cc'],
  43     'grpc_closure_create(': ['src/core/lib/iomgr/closure.cc'],
  44     'grpc_closure_init(': ['src/core/lib/iomgr/closure.cc'],
  45     'grpc_closure_sched(': ['src/core/lib/iomgr/closure.cc'],
  46     'grpc_closure_run(': ['src/core/lib/iomgr/closure.cc'],
  47     'grpc_closure_list_sched(': ['src/core/lib/iomgr/closure.cc'],
  48     'gpr_getenv_silent(': [
  49         'src/core/lib/gpr/log.cc', 'src/core/lib/gpr/env_linux.cc',
  50         'src/core/lib/gpr/env_posix.cc', 'src/core/lib/gpr/env_windows.cc'
  51     ],
  52 }
  53
  54 errors = 0
  55 num_files = 0
  56 for root, dirs, files in os.walk('src/core'):
  57     if root.startswith('src/core/tsi'): continue
  58     for filename in files:
  59         num_files += 1
  60         path = os.path.join(root, filename)
  61         if os.path.splitext(path)[1] != '.cc': continue
  62         with open(path) as f:
  63             text = f.read()
  64         for banned, exceptions in BANNED_EXCEPT.items():
  65             if path in exceptions: continue
  66             if banned in text:
  67                 print('Illegal use of "%s" in %s' % (banned, path))
  68                 errors += 1
  69
  70 assert errors == 0
  71 # This check comes about from this issue:
  72 # https://github.com/grpc/grpc/issues/15381
  73 # Basically, a change rendered this script useless and we did not realize it.
  74 # This dumb check ensures that this type of issue doesn't occur again.
  75 assert num_files > 300  # we definitely have more than 300 files