1#!/usr/bin/env perl 2#*************************************************************************** 3# _ _ ____ _ 4# Project ___| | | | _ \| | 5# / __| | | | |_) | | 6# | (__| |_| | _ <| |___ 7# \___|\___/|_| \_\_____| 8# 9# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 10# 11# This software is licensed as described in the file COPYING, which 12# you should have received as part of this distribution. The terms 13# are also available at https://curl.se/docs/copyright.html. 14# 15# You may opt to use, copy, modify, merge, publish, distribute and/or sell 16# copies of the Software, and permit persons to whom the Software is 17# furnished to do so, under the terms of the COPYING file. 18# 19# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 20# KIND, either express or implied. 21# 22# SPDX-License-Identifier: curl 23# 24########################################################################### 25# 26# This script is aimed to help scan for and detect globally declared functions 27# that are not used from other source files. 28# 29# Use it like this: 30# 31# $ ./scripts/singleuse.pl lib/.libs/libcurl.a 32# 33# Be aware that it might cause false positives due to various build options. 34# 35 36my $file = $ARGV[0]; 37 38my %wl = ( 39 'Curl_none_cert_status_request' => 'multiple TLS backends', 40 'Curl_none_check_cxn' => 'multiple TLS backends', 41 'Curl_none_cleanup' => 'multiple TLS backends', 42 'Curl_none_close_all' => 'multiple TLS backends', 43 'Curl_none_data_pending' => 'multiple TLS backends', 44 'Curl_none_engines_list' => 'multiple TLS backends', 45 'Curl_none_init' => 'multiple TLS backends', 46 'Curl_none_md5sum' => 'multiple TLS backends', 47 'Curl_none_random' => 'multiple TLS backends', 48 'Curl_none_session_free' => 'multiple TLS backends', 49 'Curl_none_set_engine' => 'multiple TLS backends', 50 'Curl_none_set_engine_default' => 'multiple TLS backends', 51 'Curl_none_shutdown' => 'multiple TLS backends', 52 'Curl_multi_dump' => 'debug build only', 53 'Curl_parse_port' => 'UNITTEST', 54 'Curl_shuffle_addr' => 'UNITTEST', 55 'de_cleanup' => 'UNITTEST', 56 'doh_decode' => 'UNITTEST', 57 'doh_encode' => 'UNITTEST', 58 'Curl_auth_digest_get_pair' => 'by digest_sspi', 59 'curlx_uztoso' => 'cmdline tool use', 60 'curlx_uztoul' => 'by krb5_sspi', 61 'curlx_uitous' => 'by schannel', 62 'Curl_islower' => 'by curl_fnmatch', 63 'getaddressinfo' => 'UNITTEST', 64 ); 65 66my %api = ( 67 'curl_easy_cleanup' => 'API', 68 'curl_easy_duphandle' => 'API', 69 'curl_easy_escape' => 'API', 70 'curl_easy_getinfo' => 'API', 71 'curl_easy_init' => 'API', 72 'curl_easy_pause' => 'API', 73 'curl_easy_perform' => 'API', 74 'curl_easy_recv' => 'API', 75 'curl_easy_reset' => 'API', 76 'curl_easy_send' => 'API', 77 'curl_easy_setopt' => 'API', 78 'curl_easy_strerror' => 'API', 79 'curl_easy_unescape' => 'API', 80 'curl_easy_upkeep' => 'API', 81 'curl_easy_option_by_id' => 'API', 82 'curl_easy_option_by_name' => 'API', 83 'curl_easy_option_next' => 'API', 84 'curl_escape' => 'API', 85 'curl_formadd' => 'API', 86 'curl_formfree' => 'API', 87 'curl_formget' => 'API', 88 'curl_free' => 'API', 89 'curl_getdate' => 'API', 90 'curl_getenv' => 'API', 91 'curl_global_cleanup' => 'API', 92 'curl_global_init' => 'API', 93 'curl_global_init_mem' => 'API', 94 'curl_global_sslset' => 'API', 95 'curl_maprintf' => 'API', 96 'curl_mfprintf' => 'API', 97 'curl_mime_addpart' => 'API', 98 'curl_mime_data' => 'API', 99 'curl_mime_data_cb' => 'API', 100 'curl_mime_encoder' => 'API', 101 'curl_mime_filedata' => 'API', 102 'curl_mime_filename' => 'API', 103 'curl_mime_free' => 'API', 104 'curl_mime_headers' => 'API', 105 'curl_mime_init' => 'API', 106 'curl_mime_name' => 'API', 107 'curl_mime_subparts' => 'API', 108 'curl_mime_type' => 'API', 109 'curl_mprintf' => 'API', 110 'curl_msnprintf' => 'API', 111 'curl_msprintf' => 'API', 112 'curl_multi_add_handle' => 'API', 113 'curl_multi_assign' => 'API', 114 'curl_multi_cleanup' => 'API', 115 'curl_multi_fdset' => 'API', 116 'curl_multi_info_read' => 'API', 117 'curl_multi_init' => 'API', 118 'curl_multi_perform' => 'API', 119 'curl_multi_remove_handle' => 'API', 120 'curl_multi_setopt' => 'API', 121 'curl_multi_socket' => 'API', 122 'curl_multi_socket_action' => 'API', 123 'curl_multi_socket_all' => 'API', 124 'curl_multi_poll' => 'API', 125 'curl_multi_strerror' => 'API', 126 'curl_multi_timeout' => 'API', 127 'curl_multi_wait' => 'API', 128 'curl_multi_wakeup' => 'API', 129 'curl_mvaprintf' => 'API', 130 'curl_mvfprintf' => 'API', 131 'curl_mvprintf' => 'API', 132 'curl_mvsnprintf' => 'API', 133 'curl_mvsprintf' => 'API', 134 'curl_pushheader_byname' => 'API', 135 'curl_pushheader_bynum' => 'API', 136 'curl_share_cleanup' => 'API', 137 'curl_share_init' => 'API', 138 'curl_share_setopt' => 'API', 139 'curl_share_strerror' => 'API', 140 'curl_slist_append' => 'API', 141 'curl_slist_free_all' => 'API', 142 'curl_strequal' => 'API', 143 'curl_strnequal' => 'API', 144 'curl_unescape' => 'API', 145 'curl_url' => 'API', 146 'curl_url_cleanup' => 'API', 147 'curl_url_dup' => 'API', 148 'curl_url_get' => 'API', 149 'curl_url_set' => 'API', 150 'curl_url_strerror' => 'API', 151 'curl_version' => 'API', 152 'curl_version_info' => 'API', 153 154 # the following functions are provided globally in debug builds 155 'curl_easy_perform_ev' => 'debug-build', 156 ); 157 158open(N, "nm $file|") || 159 die; 160 161my %exist; 162my %uses; 163my $file; 164while (<N>) { 165 my $l = $_; 166 chomp $l; 167 168 if($l =~ /^([0-9a-z_-]+)\.o:/) { 169 $file = $1; 170 } 171 if($l =~ /^([0-9a-f]+) T (.*)/) { 172 my ($name)=($2); 173 #print "Define $name in $file\n"; 174 $file =~ s/^libcurl_la-//; 175 $exist{$name} = $file; 176 } 177 elsif($l =~ /^ U (.*)/) { 178 my ($name)=($1); 179 #print "Uses $name in $file\n"; 180 $uses{$name} .= "$file, "; 181 } 182} 183close(N); 184 185my $err; 186for(sort keys %exist) { 187 #printf "%s is defined in %s, used by: %s\n", $_, $exist{$_}, $uses{$_}; 188 if(!$uses{$_}) { 189 # this is a symbol with no "global" user 190 if($_ =~ /^curl_dbg_/) { 191 # we ignore the memdebug symbols 192 } 193 elsif($_ =~ /^curl_/) { 194 if(!$api{$_}) { 195 # not present in the API, or for debug-builds 196 print STDERR "Bad curl-prefix: $_\n"; 197 $err++; 198 } 199 } 200 elsif($wl{$_}) { 201 #print "$_ is WL\n"; 202 } 203 else { 204 printf "%s is defined in %s, but not used outside\n", $_, $exist{$_}; 205 $err++; 206 } 207 } 208 elsif($_ =~ /^curl_/) { 209 # global prefix, make sure it is "blessed" 210 if(!$api{$_}) { 211 # not present in the API, or for debug-builds 212 if($_ !~ /^curl_dbg_/) { 213 # ignore the memdebug symbols 214 print STDERR "Bad curl-prefix $_\n"; 215 $err++; 216 } 217 } 218 } 219} 220 221exit $err; 222