cfg.mk 47.1 KB
Newer Older
1
# Customize Makefile.maint.                           -*- makefile -*-
M
Martin Kletzander 已提交
2
# Copyright (C) 2008-2015 Red Hat, Inc.
3
# Copyright (C) 2003-2008 Free Software Foundation, Inc.
4 5 6 7 8 9 10 11 12 13 14 15

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
16 17
# along with this program.  If not, see
# <http://www.gnu.org/licenses/>.
18 19 20 21 22 23 24 25 26 27 28

# Use alpha.gnu.org for alpha and beta releases.
# Use ftp.gnu.org for major releases.
gnu_ftp_host-alpha = alpha.gnu.org
gnu_ftp_host-beta = alpha.gnu.org
gnu_ftp_host-major = ftp.gnu.org
gnu_rel_host = $(gnu_ftp_host-$(RELEASE_TYPE))

url_dir_list = \
  ftp://$(gnu_rel_host)/gnu/coreutils

29 30 31
# We use .gnulib, not gnulib.
gnulib_dir = $(srcdir)/.gnulib

E
Eric Blake 已提交
32 33 34
# List of additional files that we want to pick up in our POTFILES.in
# This is all gnulib files, as well as generated files for RPC code.
generated_files = \
E
Eric Blake 已提交
35
  $(srcdir)/daemon/*_dispatch.h \
E
Eric Blake 已提交
36
  $(srcdir)/src/*/*_dispatch.h \
E
Eric Blake 已提交
37
  $(srcdir)/src/remote/*_client_bodies.h \
E
Eric Blake 已提交
38
  $(srcdir)/src/*/*_protocol.[ch] \
E
Eric Blake 已提交
39 40
  $(srcdir)/gnulib/lib/*.[ch]

E
Eric Blake 已提交
41 42 43
# We haven't converted all scripts to using gnulib's init.sh yet.
_test_script_regex = \<\(init\|test-lib\)\.sh\>

44 45
# Tests not to run as part of "make distcheck".
local-checks-to-skip =			\
46
  changelog-check			\
47
  makefile-check			\
48 49
  makefile_path_separator_check		\
  patch-check				\
50 51 52
  sc_GPL_version			\
  sc_always_defined_macros		\
  sc_cast_of_alloca_return_value	\
53
  sc_cross_check_PATH_usage_in_tests	\
54 55 56
  sc_dd_max_sym_length			\
  sc_error_exit_success			\
  sc_file_system			\
57 58
  sc_immutable_NEWS			\
  sc_makefile_path_separator_check	\
59
  sc_obsolete_symbols			\
60
  sc_prohibit_S_IS_definition		\
61
  sc_prohibit_atoi_atof			\
62
  sc_prohibit_hash_without_use		\
63 64 65
  sc_prohibit_jm_in_m4			\
  sc_prohibit_quote_without_use		\
  sc_prohibit_quotearg_without_use	\
66
  sc_prohibit_stat_st_blocks		\
67
  sc_prohibit_undesirable_word_seq	\
68 69 70 71
  sc_root_tests				\
  sc_space_tab				\
  sc_sun_os_names			\
  sc_system_h_headers			\
E
Eric Blake 已提交
72
  sc_texinfo_acronym			\
73
  sc_tight_scope			\
74
  sc_two_space_separator_in_usage	\
J
Jim Meyering 已提交
75 76 77 78
  sc_error_message_uppercase		\
  sc_program_name			\
  sc_require_test_exit_idiom		\
  sc_makefile_check			\
79
  sc_useless_cpp_parens
80

81 82 83 84 85 86 87 88
# Most developers don't run 'make distcheck'.  We want the official
# dist to be secure, but don't want to penalize other developers
# using a distro that has not yet picked up the automake fix.
# FIXME remove this ifeq (making the syntax check unconditional)
# once fixed automake (1.11.6 or 1.12.2+) is more common.
ifeq ($(filter dist%, $(MAKECMDGOALS)), )
local-checks-to-skip +=	sc_vulnerable_makefile_CVE-2012-3386
else
89
distdir: sc_vulnerable_makefile_CVE-2012-3386.z
90 91
endif

92
# Files that should never cause syntax check failures.
93
VC_LIST_ALWAYS_EXCLUDE_REGEX = \
A
Andrea Bolognani 已提交
94
  (^(HACKING|docs/(news(-[0-9]*)?\.html\.in|.*\.patch))|\.(po|fig|gif|ico|png))$$
95 96

# Functions like free() that are no-ops on NULL arguments.
97
useless_free_options =				\
J
John Ferlan 已提交
98 99 100
  --name=VBOX_UTF16_FREE			\
  --name=VBOX_UTF8_FREE				\
  --name=VBOX_COM_UNALLOC_MEM			\
101
  --name=VIR_FREE				\
102
  --name=qemuCapsFree				\
103
  --name=qemuMigrationCookieFree                \
104
  --name=qemuMigrationCookieGraphicsFree        \
105
  --name=sexpr_free				\
106
  --name=usbFreeDevice                          \
107
  --name=virBandwidthDefFree			\
108
  --name=virBitmapFree                          \
109 110 111 112 113 114 115 116 117
  --name=virCPUDefFree				\
  --name=virCapabilitiesFree			\
  --name=virCapabilitiesFreeGuest		\
  --name=virCapabilitiesFreeGuestDomain		\
  --name=virCapabilitiesFreeGuestFeature	\
  --name=virCapabilitiesFreeGuestMachine	\
  --name=virCapabilitiesFreeHostNUMACell	\
  --name=virCapabilitiesFreeMachines		\
  --name=virCgroupFree				\
118
  --name=virCommandFree				\
119 120
  --name=virConfFreeList			\
  --name=virConfFreeValue			\
121
  --name=virDomainActualNetDefFree		\
122
  --name=virDomainChrDefFree			\
123
  --name=virDomainChrSourceDefFree		\
124 125 126 127 128
  --name=virDomainControllerDefFree		\
  --name=virDomainDefFree			\
  --name=virDomainDeviceDefFree			\
  --name=virDomainDiskDefFree			\
  --name=virDomainEventCallbackListFree		\
129 130
  --name=virObjectEventQueueFree		\
  --name=virObjectEventStateFree		\
131 132 133 134 135 136
  --name=virDomainFSDefFree			\
  --name=virDomainGraphicsDefFree		\
  --name=virDomainHostdevDefFree		\
  --name=virDomainInputDefFree			\
  --name=virDomainNetDefFree			\
  --name=virDomainObjFree			\
E
Eric Blake 已提交
137
  --name=virDomainSmartcardDefFree		\
138 139 140 141 142
  --name=virDomainSnapshotDefFree		\
  --name=virDomainSnapshotObjFree		\
  --name=virDomainSoundDefFree			\
  --name=virDomainVideoDefFree			\
  --name=virDomainWatchdogDefFree		\
143
  --name=virFileDirectFdFree			\
144
  --name=virHashFree				\
145 146 147 148 149 150
  --name=virInterfaceDefFree			\
  --name=virInterfaceIpDefFree			\
  --name=virInterfaceObjFree			\
  --name=virInterfaceProtocolDefFree		\
  --name=virJSONValueFree			\
  --name=virLastErrFreeData			\
151
  --name=virNetMessageFree                      \
152 153 154
  --name=virNetServerMDNSFree                   \
  --name=virNetServerMDNSEntryFree              \
  --name=virNetServerMDNSGroupFree              \
155 156 157 158 159
  --name=virNWFilterDefFree			\
  --name=virNWFilterEntryFree			\
  --name=virNWFilterHashTableFree		\
  --name=virNWFilterIPAddrLearnReqFree		\
  --name=virNWFilterIncludeDefFree		\
160
  --name=virNWFilterObjFree			\
161 162 163 164 165
  --name=virNWFilterRuleDefFree			\
  --name=virNWFilterRuleInstFree		\
  --name=virNetworkDefFree			\
  --name=virNodeDeviceDefFree			\
  --name=virNodeDeviceObjFree			\
166 167
  --name=virObjectUnref                         \
  --name=virObjectFreeCallback                  \
168
  --name=virPCIDeviceFree                       \
169 170 171
  --name=virSecretDefFree			\
  --name=virStorageEncryptionFree		\
  --name=virStorageEncryptionSecretFree		\
172
  --name=virStorageFileFreeMetadata		\
173 174 175 176
  --name=virStoragePoolDefFree			\
  --name=virStoragePoolObjFree			\
  --name=virStoragePoolSourceFree		\
  --name=virStorageVolDefFree			\
H
Hu Tao 已提交
177
  --name=virThreadPoolFree			\
178
  --name=xmlBufferFree				\
179
  --name=xmlFree				\
180
  --name=xmlFreeDoc				\
E
Eric Blake 已提交
181
  --name=xmlFreeNode				\
182
  --name=xmlXPathFreeContext			\
183
  --name=xmlXPathFreeObject
184

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
# The following template was generated by this command:
# make ID && aid free|grep '^vi'|sed 's/ .*//;s/^/#   /'
# N virBufferFreeAndReset
# y virCPUDefFree
# y virCapabilitiesFree
# y virCapabilitiesFreeGuest
# y virCapabilitiesFreeGuestDomain
# y virCapabilitiesFreeGuestFeature
# y virCapabilitiesFreeGuestMachine
# y virCapabilitiesFreeHostNUMACell
# y virCapabilitiesFreeMachines
# N virCapabilitiesFreeNUMAInfo FIXME
# y virCgroupFree
# N virConfFree               (diagnoses the "error")
# y virConfFreeList
# y virConfFreeValue
# y virDomainChrDefFree
# y virDomainControllerDefFree
# y virDomainDefFree
# y virDomainDeviceDefFree
# y virDomainDiskDefFree
# y virDomainEventCallbackListFree
# y virDomainEventQueueFree
# y virDomainFSDefFree
# n virDomainFree
# n virDomainFreeName (can't fix -- returns int)
# y virDomainGraphicsDefFree
# y virDomainHostdevDefFree
# y virDomainInputDefFree
# y virDomainNetDefFree
# y virDomainObjFree
# y virDomainSnapshotDefFree
# n virDomainSnapshotFree (returns int)
# n virDomainSnapshotFreeName (returns int)
# y virDomainSnapshotObjFree
# y virDomainSoundDefFree
# y virDomainVideoDefFree
# y virDomainWatchdogDefFree
# n virDrvNodeGetCellsFreeMemory (returns int)
# n virDrvNodeGetFreeMemory (returns long long)
E
Eric Blake 已提交
225
# n virFree - dereferences param
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
# n virFreeError
# n virHashFree (takes 2 args)
# y virInterfaceDefFree
# n virInterfaceFree (returns int)
# n virInterfaceFreeName
# y virInterfaceIpDefFree
# y virInterfaceObjFree
# n virInterfaceObjListFree
# y virInterfaceProtocolDefFree
# y virJSONValueFree
# y virLastErrFreeData
# y virNWFilterDefFree
# y virNWFilterEntryFree
# n virNWFilterFree (returns int)
# y virNWFilterHashTableFree
# y virNWFilterIPAddrLearnReqFree
# y virNWFilterIncludeDefFree
243 244 245
# n virNWFilterFreeName (returns int)
# y virNWFilterObjFree
# n virNWFilterObjListFree FIXME
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
# y virNWFilterRuleDefFree
# n virNWFilterRuleFreeInstanceData (typedef)
# y virNWFilterRuleInstFree
# y virNetworkDefFree
# n virNetworkFree (returns int)
# n virNetworkFreeName (returns int)
# n virNodeDevCapsDefFree FIXME
# y virNodeDeviceDefFree
# n virNodeDeviceFree (returns int)
# y virNodeDeviceObjFree
# n virNodeDeviceObjListFree FIXME
# n virNodeGetCellsFreeMemory (returns int)
# n virNodeGetFreeMemory (returns non-void)
# y virSecretDefFree
# n virSecretFree (returns non-void)
# n virSecretFreeName (2 args)
# n virSecurityLabelDefFree FIXME
# n virStorageBackendDiskMakeFreeExtent (returns non-void)
# y virStorageEncryptionFree
# y virStorageEncryptionSecretFree
# n virStorageFreeType (enum)
# y virStoragePoolDefFree
# n virStoragePoolFree (returns non-void)
# n virStoragePoolFreeName (returns non-void)
# y virStoragePoolObjFree
# n virStoragePoolObjListFree FIXME
# y virStoragePoolSourceFree
# y virStorageVolDefFree
# n virStorageVolFree (returns non-void)
# n virStorageVolFreeName (returns non-void)
# n virStreamFree

278 279 280
# Avoid uses of write(2).  Either switch to streams (fwrite), or use
# the safewrite wrapper.
sc_avoid_write:
E
Eric Blake 已提交
281 282 283
	@prohibit='\<write *\('						\
	in_vc_files='\.c$$'						\
	halt='consider using safewrite instead of write'		\
284
	  $(_sc_search_regexp)
285

286 287 288
# In debug statements, print flags as bitmask and mode_t as octal.
sc_flags_debug:
	@prohibit='\<mode=%[0-9.]*[diux]'				\
289
	halt='use %o to debug mode_t values'				\
290
	  $(_sc_search_regexp)
291 292 293 294 295 296 297 298 299 300 301 302 303
	@prohibit='[Ff]lags=%[0-9.]*l*[diou]'				\
	halt='use %x to debug flag values'				\
	  $(_sc_search_regexp)

# Prefer 'unsigned int flags', along with checks for unknown flags.
# For historical reasons, we are stuck with 'unsigned long flags' in
# migration, so check for those known 4 instances and no more in public
# API.  Also check that no flags are marked unused, and 'unsigned' should
# appear before any declaration of a flags variable (achieved by
# prohibiting the word prior to the type from ending in anything other
# than d).  The existence of long long, and of documentation about
# flags, makes the regex in the third test slightly harder.
sc_flags_usage:
304
	@test "$$(cat $(srcdir)/include/libvirt/libvirt-domain.h	\
305 306
	    $(srcdir)/include/libvirt/virterror.h			\
	    $(srcdir)/include/libvirt/libvirt-qemu.h			\
307
	    $(srcdir)/include/libvirt/libvirt-lxc.h			\
M
Martin Kletzander 已提交
308
	    $(srcdir)/include/libvirt/libvirt-admin.h			\
309 310 311
	  | grep -c '\(long\|unsigned\) flags')" != 4 &&		\
	  { echo '$(ME): new API should use "unsigned int flags"' 1>&2;	\
	    exit 1; } || :
312
	@prohibit=' flags ATTRIBUTE_UNUSED'				\
313 314 315 316
	halt='flags should be checked with virCheckFlags'		\
	  $(_sc_search_regexp)
	@prohibit='^[^@]*([^d] (int|long long)|[^dg] long) flags[;,)]'	\
	halt='flags should be unsigned'					\
317 318
	  $(_sc_search_regexp)

E
Eric Blake 已提交
319 320
# Avoid functions that should only be called via macro counterparts.
sc_prohibit_internal_functions:
321
	@prohibit='vir(Free|AllocN?|ReallocN|(Insert|Delete)ElementsN|File(Close|Fclose|Fdopen)) *\(' \
E
Eric Blake 已提交
322 323 324
	halt='use VIR_ macros instead of internal functions'		\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
325 326 327
# Avoid raw malloc and free, except in documentation comments.
sc_prohibit_raw_allocation:
	@prohibit='^.[^*].*\<((m|c|re)alloc|free) *\([^)]'		\
328
	halt='use VIR_ macros from viralloc.h instead of malloc/free'	\
E
Eric Blake 已提交
329 330
	  $(_sc_search_regexp)

E
Eric Blake 已提交
331 332
# Avoid functions that can lead to double-close bugs.
sc_prohibit_close:
333
	@prohibit='([^>.]|^)\<[fp]?close *\('				\
E
Eric Blake 已提交
334 335 336 337 338 339
	halt='use VIR_{FORCE_}[F]CLOSE instead of [f]close'		\
	  $(_sc_search_regexp)
	@prohibit='\<fdopen *\('					\
	halt='use VIR_FDOPEN instead of fdopen'				\
	  $(_sc_search_regexp)

340 341 342 343 344 345
# Prefer virCommand for all child processes.
sc_prohibit_fork_wrappers:
	@prohibit='= *\<(fork|popen|system) *\('			\
	halt='use virCommand for child processes'			\
	  $(_sc_search_regexp)

346 347 348 349 350 351
# Prefer mkostemp with O_CLOEXEC.
sc_prohibit_mkstemp:
	@prohibit='[^"]\<mkstemps? *\('					\
	halt='use mkostemp with O_CLOEXEC instead of mkstemp'		\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
352 353 354
# access with X_OK accepts directories, but we can't exec() those.
# access with F_OK or R_OK is okay, though.
sc_prohibit_access_xok:
355 356
	@prohibit='access(at)? *\(.*X_OK'				\
	halt='use virFileIsExecutable instead of access(,X_OK)'		\
E
Eric Blake 已提交
357 358
	  $(_sc_search_regexp)

E
Eric Blake 已提交
359 360
# Similar to the gnulib maint.mk rule for sc_prohibit_strcmp
# Use STREQLEN or STRPREFIX rather than comparing strncmp == 0, or != 0.
E
Eric Blake 已提交
361
snp_ = strncmp *\(.+\)
E
Eric Blake 已提交
362
sc_prohibit_strncmp:
E
Eric Blake 已提交
363 364
	@prohibit='! *strncmp *\(|\<$(snp_) *[!=]=|[!=]= *$(snp_)'	\
	exclude=':# *define STR(N?EQLEN|PREFIX)\('			\
365
	halt='use STREQLEN or STRPREFIX instead of strncmp'		\
E
Eric Blake 已提交
366
	  $(_sc_search_regexp)
367

E
Eric Blake 已提交
368 369 370 371
# strtol and friends are too easy to misuse
sc_prohibit_strtol:
	@prohibit='\bstrto(u?ll?|[ui]max) *\('				\
	exclude='exempt from syntax-check'				\
372
	halt='use virStrToLong_*, not strtol variants'			\
E
Eric Blake 已提交
373 374 375
	  $(_sc_search_regexp)
	@prohibit='\bstrto[df] *\('					\
	exclude='exempt from syntax-check'				\
376
	halt='use virStrToDouble, not strtod variants'			\
E
Eric Blake 已提交
377 378
	  $(_sc_search_regexp)

E
Eric Blake 已提交
379
# Use virAsprintf rather than as'printf since *strp is undefined on error.
E
Eric Blake 已提交
380
# But for plain %s, virAsprintf is overkill compared to strdup.
381
sc_prohibit_asprintf:
E
Eric Blake 已提交
382
	@prohibit='\<v?a[s]printf\>'					\
383
	halt='use virAsprintf, not asprintf'				\
E
Eric Blake 已提交
384
	  $(_sc_search_regexp)
E
Eric Blake 已提交
385
	@prohibit='virAsprintf.*, *"%s",'				\
386 387 388 389 390 391
	halt='use VIR_STRDUP instead of virAsprintf with "%s"'		\
	  $(_sc_search_regexp)

sc_prohibit_strdup:
	@prohibit='\<strn?dup\> *\('					\
	halt='use VIR_STRDUP, not strdup'				\
E
Eric Blake 已提交
392
	  $(_sc_search_regexp)
E
Eric Blake 已提交
393

E
Eric Blake 已提交
394 395 396 397 398 399
# Prefer virSetUIDGID.
sc_prohibit_setuid:
	@prohibit='\<set(re)?[ug]id\> *\('				\
	halt='use virSetUIDGID, not raw set*id'				\
	  $(_sc_search_regexp)

400 401 402 403 404 405
# Don't compare *id_t against raw -1.
sc_prohibit_risky_id_promotion:
	@prohibit='\b(user|group|[ug]id) *[=!]= *-'			\
	halt='cast -1 to ([ug]id_t) before comparing against id'	\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
406 407 408 409
# Use snprintf rather than s'printf, even if buffer is provably large enough,
# since gnulib has more guarantees for snprintf portability
sc_prohibit_sprintf:
	@prohibit='\<[s]printf\>'					\
410
	halt='use snprintf, not sprintf'				\
E
Eric Blake 已提交
411
	  $(_sc_search_regexp)
412

413
sc_prohibit_readlink:
414
	@prohibit='\<readlink *\('					\
E
Eric Blake 已提交
415 416
	halt='use virFileResolveLink, not readlink'			\
	  $(_sc_search_regexp)
417

418
sc_prohibit_gethostname:
E
Eric Blake 已提交
419 420 421
	@prohibit='gethostname *\('					\
	halt='use virGetHostname, not gethostname'			\
	  $(_sc_search_regexp)
422

E
Eric Blake 已提交
423
sc_prohibit_readdir:
J
Ján Tomko 已提交
424
	@prohibit='\b(read|close|open)dir *\('				\
E
Eric Blake 已提交
425
	exclude='exempt from syntax-check'				\
J
Ján Tomko 已提交
426
	halt='use virDirOpen, virDirRead and VIR_DIR_CLOSE'		\
E
Eric Blake 已提交
427 428
	  $(_sc_search_regexp)

E
Eric Blake 已提交
429
sc_prohibit_gettext_noop:
E
Eric Blake 已提交
430 431 432
	@prohibit='gettext_noop *\('					\
	halt='use N_, not gettext_noop'					\
	  $(_sc_search_regexp)
E
Eric Blake 已提交
433

434
sc_prohibit_VIR_ERR_NO_MEMORY:
435 436
	@prohibit='\<VIR_ERR_NO_MEMORY\>'				\
	halt='use virReportOOMError, not VIR_ERR_NO_MEMORY'		\
E
Eric Blake 已提交
437
	  $(_sc_search_regexp)
438

439
sc_prohibit_PATH_MAX:
440 441
	@prohibit='\<PATH_MAX\>'				\
	halt='dynamically allocate paths, do not use PATH_MAX'	\
442 443
	  $(_sc_search_regexp)

444
include $(srcdir)/Makefile.nonreentrant
445
sc_prohibit_nonreentrant:
446 447 448
	@prohibit="\\<(${NON_REENTRANT_RE}) *\\("			\
	halt="use re-entrant functions (usually ending with _r)"	\
	  $(_sc_search_regexp)
449

450
sc_prohibit_select:
451
	@prohibit='\<select *\('					\
452
	halt='use poll(), not select()'					\
453 454
	  $(_sc_search_regexp)

455 456
# Prohibit the inclusion of <ctype.h>.
sc_prohibit_ctype_h:
E
Eric Blake 已提交
457
	@prohibit='^# *include  *<ctype\.h>'				\
458
	halt='use c-ctype.h instead of ctype.h'				\
459
	  $(_sc_search_regexp)
460

461 462 463
# Insist on correct types for [pug]id.
sc_correct_id_types:
	@prohibit='\<(int|long) *[pug]id\>'				\
464
	halt='use pid_t for pid, uid_t for uid, gid_t for gid'		\
465 466
	  $(_sc_search_regexp)

467 468 469
# "const fooPtr a" is the same as "foo * const a", even though it is
# usually desired to have "foo const *a".  It's easier to just prevent
# the confusing mix of typedef vs. const placement.
470
# Also requires that all 'fooPtr' typedefs are actually pointers.
471 472 473 474
sc_forbid_const_pointer_typedef:
	@prohibit='(^|[^"])const \w*Ptr'				\
	halt='"const fooPtr var" does not declare what you meant'	\
	  $(_sc_search_regexp)
475 476 477
	@prohibit='typedef [^(]+ [^*]\w*Ptr\b'				\
	halt='use correct style and type for Ptr typedefs'		\
	  $(_sc_search_regexp)
478

479 480 481 482 483 484
# Forbid sizeof foo or sizeof (foo), require sizeof(foo)
sc_size_of_brackets:
	@prohibit='sizeof\s'						\
	halt='use sizeof(foo), not sizeof (foo) or sizeof foo'		\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
485
# Ensure that no C source file, docs, or rng schema uses TABs for
D
David Allan 已提交
486 487
# indentation.  Also match *.h.in files, to get libvirt.h.in.  Exclude
# files in gnulib, since they're imported.
488
space_indent_files=(\.(rng|s?[ch](\.in)?|html.in|py|pl|syms)|(daemon|tools)/.*\.in)
489
sc_TAB_in_indentation:
E
Eric Blake 已提交
490
	@prohibit='^ *	'						\
491
	in_vc_files='$(space_indent_files)$$'				\
492
	halt='indent with space, not TAB, in C, sh, html, py, syms and RNG schemas' \
493
	  $(_sc_search_regexp)
494 495 496 497 498

ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
|isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper

sc_avoid_ctype_macros:
E
Eric Blake 已提交
499
	@prohibit='\b($(ctype_re)) *\('					\
500
	halt='use c-ctype.h instead of ctype macros'			\
501
	  $(_sc_search_regexp)
502

503 504
sc_avoid_strcase:
	@prohibit='\bstrn?case(cmp|str) *\('				\
505
	halt='use c-strcase.h instead of raw strcase functions'		\
506 507
	  $(_sc_search_regexp)

508
sc_prohibit_virBufferAdd_with_string_literal:
E
Eric Blake 已提交
509 510 511
	@prohibit='\<virBufferAdd *\([^,]+, *"[^"]'			\
	halt='use virBufferAddLit, not virBufferAdd, with a string literal' \
	  $(_sc_search_regexp)
512

513 514 515 516 517
sc_prohibit_virBufferAsprintf_with_string_literal:
	@prohibit='\<virBufferAsprintf *\([^,]+, *"([^%"\]|\\.|%%)*"\)'		\
	halt='use virBufferAddLit, not virBufferAsprintf, with a string literal' \
	  $(_sc_search_regexp)

518 519 520 521 522
sc_forbid_manual_xml_indent:
	@prohibit='virBuffer.*" +<'					      \
	halt='use virBufferAdjustIndent instead of spaces when indenting xml' \
	  $(_sc_search_regexp)

523 524 525
# Not only do they fail to deal well with ipv6, but the gethostby*
# functions are also not thread-safe.
sc_prohibit_gethostby:
E
Eric Blake 已提交
526 527 528
	@prohibit='\<gethostby(addr|name2?) *\('			\
	halt='use getaddrinfo, not gethostby*'				\
	  $(_sc_search_regexp)
529

530 531 532 533 534 535
# dirname and basename from <libgen.h> are not required to be thread-safe
sc_prohibit_libgen:
	@prohibit='( (base|dir)name *\(|include .libgen\.h)'		\
	halt='use functions from gnulib "dirname.h", not <libgen.h>'	\
	  $(_sc_search_regexp)

536 537 538 539 540 541
# raw xmlGetProp requires some nasty casts
sc_prohibit_xmlGetProp:
	@prohibit='\<xmlGetProp *\('					\
	halt='use virXMLPropString, not xmlGetProp'			\
	  $(_sc_search_regexp)

M
Martin Kletzander 已提交
542 543 544 545 546 547
# xml(ParseURI|SaveUri) doesn't handle IPv6 URIs well
sc_prohibit_xmlURI:
	@prohibit='\<xml(ParseURI|SaveUri) *\('				\
	halt='use virURI(Parse|Format), not xml(ParseURI|SaveUri)'	\
	  $(_sc_search_regexp)

548 549 550 551 552 553
# we don't want old old-style return with parentheses around argument
sc_prohibit_return_as_function:
	@prohibit='\<return *\(([^()]*(\([^()]*\)[^()]*)*)\) *;'    \
	halt='avoid extra () with return statements'                \
	  $(_sc_search_regexp)

554 555 556 557 558 559 560 561
# ATTRIBUTE_UNUSED should only be applied in implementations, not
# header declarations
sc_avoid_attribute_unused_in_header:
	@prohibit='^[^#]*ATTRIBUTE_UNUSED([^:]|$$)'			\
	in_vc_files='\.h$$'						\
	halt='use ATTRIBUTE_UNUSED in .c rather than .h files'		\
	  $(_sc_search_regexp)

562 563 564 565 566
sc_prohibit_int_index:
	@prohibit='\<(int|unsigned)\s*\*?index\>(\s|,|;)'	\
	halt='use different name than 'index' for declaration'	        \
	  $(_sc_search_regexp)

567
sc_prohibit_int_ijk:
568
	@prohibit='\<(int|unsigned) ([^(=]* )*(i|j|k)\>(\s|,|;)'	\
569
	exclude='exempt from syntax-check'				\
570 571 572 573
	halt='use size_t, not int/unsigned int for loop vars i, j, k'	\
	  $(_sc_search_regexp)

sc_prohibit_loop_iijjkk:
574
	@prohibit='\<(int|unsigned) ([^=]+ )*(ii|jj|kk)\>(\s|,|;)'	\
575
	halt='use i, j, k for loop iterators, not ii, jj, kk'		\
576 577
	  $(_sc_search_regexp)

E
Eric Blake 已提交
578 579 580 581 582 583
# RHEL 5 gcc can't grok "for (int i..."
sc_prohibit_loop_var_decl:
	@prohibit='\<for *\(\w+[ *]+\w+'				\
	in_vc_files='\.[ch]$$'						\
	halt='declare loop iterators outside the for statement'		\
	  $(_sc_search_regexp)
E
Eric Blake 已提交
584 585 586 587 588 589

# Use 'bool', not 'int', when assigning true or false
sc_prohibit_int_assign_bool:
	@prohibit='\<int\>.*= *(true|false)'				\
	halt='use bool type for boolean values'				\
	  $(_sc_search_regexp)
590

591 592 593 594 595 596
# Many of the function names below came from this filter:
# git grep -B2 '\<_('|grep -E '\.c- *[[:alpha:]_][[:alnum:]_]* ?\(.*[,;]$' \
# |sed 's/.*\.c-  *//'|perl -pe 's/ ?\(.*//'|sort -u \
# |grep -vE '^(qsort|if|close|assert|fputc|free|N_|vir.*GetName|.*Unlock|virNodeListDevices|virHashRemoveEntry|freeaddrinfo|.*[fF]ree|xdrmem_create|xmlXPathFreeObject|virUUIDFormat|openvzSetProgramSentinal|polkit_action_unref)$'

msg_gen_function =
597
msg_gen_function += VIR_ERROR
598 599
msg_gen_function += lxcError
msg_gen_function += regerror
600 601
msg_gen_function += vah_error
msg_gen_function += vah_warning
602
msg_gen_function += virGenericReportError
603
msg_gen_function += virRaiseError
604
msg_gen_function += virReportError
605 606
msg_gen_function += virReportErrorHelper
msg_gen_function += virReportSystemError
607
msg_gen_function += xenapiSessionErrorHandler
608 609 610 611 612 613 614 615 616

# Uncomment the following and run "make syntax-check" to see diagnostics
# that are not yet marked for translation, but that need to be rewritten
# so that they are translatable.
# msg_gen_function += fprintf
# msg_gen_function += testError
# msg_gen_function += vshPrint
# msg_gen_function += vshError

617
func_or := $(shell echo $(msg_gen_function)|tr -s ' ' '|')
618 619 620 621 622 623 624 625
func_re := ($(func_or))

# Look for diagnostics that aren't marked for translation.
# This won't find any for which error's format string is on a separate line.
# The sed filters eliminate false-positives like these:
#    _("...: "
#    "%s", _("no storage vol w..."
sc_libvirt_unmarked_diagnostics:
E
Eric Blake 已提交
626 627
	@prohibit='\<$(func_re) *\([^"]*"[^"]*[a-z]{3}'			\
	exclude='_\('							\
628
	halt='found unmarked diagnostic(s)'				\
E
Eric Blake 已提交
629
	  $(_sc_search_regexp)
630 631
	@{ grep     -nE '\<$(func_re) *\(.*;$$' $$($(VC_LIST_EXCEPT));   \
	   grep -A1 -nE '\<$(func_re) *\(.*,$$' $$($(VC_LIST_EXCEPT)); } \
632
	   | $(SED) 's/_("\([^\"]\|\\.\)\+"//;s/[	 ]"%s"//'		\
633 634 635
	   | grep '[	 ]"' &&						\
	  { echo '$(ME): found unmarked diagnostic(s)' 1>&2;		\
	    exit 1; } || :
636

637 638 639 640 641 642 643 644 645 646 647 648 649 650
# Like the above, but prohibit a newline at the end of a diagnostic.
# This is subject to false positives partly because it naively looks for
# `\n"', which may not be the end of the string, and also because it takes
# two lines of context (the -A2) after the line with the function name.
# FIXME: this rule might benefit from a separate function list, in case
# there are functions to which this one applies but that do not get marked
# diagnostics.
sc_prohibit_newline_at_end_of_diagnostic:
	@grep -A2 -nE							\
	    '\<$(func_re) *\(' $$($(VC_LIST_EXCEPT))			\
	    | grep '\\n"'						\
	  && { echo '$(ME): newline at end of message(s)' 1>&2;		\
	    exit 1; } || :

651 652 653 654 655 656
# Look for diagnostics that lack a % in the format string, except that we
# allow VIR_ERROR to do this, and ignore functions that take a single
# string rather than a format argument.
sc_prohibit_diagnostic_without_format:
	@{ grep     -nE '\<$(func_re) *\(.*;$$' $$($(VC_LIST_EXCEPT));   \
	   grep -A2 -nE '\<$(func_re) *\(.*,$$' $$($(VC_LIST_EXCEPT)); } \
657
	   | $(SED) -rn -e ':l; /[,"]$$/ {N;b l;}'				 \
658 659 660 661 662 663
		-e '/(xenapiSessionErrorHandler|vah_(error|warning))/d'	 \
		-e '/\<$(func_re) *\([^"]*"([^%"]|"\n[^"]*")*"[,)]/p'	 \
           | grep -vE 'VIR_ERROR' &&					 \
	  { echo '$(ME): found diagnostic without %' 1>&2;		 \
	    exit 1; } || :

664
# The strings "" and "%s" should never be marked for translation.
665
# Files under tests/ and examples/ should not be translated.
666 667
sc_prohibit_useless_translation:
	@prohibit='_\("(%s)?"\)'					\
668 669 670 671 672
	halt='found useless translation'				\
	  $(_sc_search_regexp)
	@prohibit='\<N?_ *\('						\
	in_vc_files='^(tests|examples)/'				\
	halt='no translations in tests or examples'			\
673 674
	  $(_sc_search_regexp)

675 676 677 678
# When splitting a diagnostic across lines, ensure that there is a space
# or \n on one side of the split.
sc_require_whitespace_in_translation:
	@grep -n -A1 '"$$' $$($(VC_LIST_EXCEPT))   			\
679
	   | $(SED) -ne ':l; /"$$/ {N;b l;}; s/"\n[^"]*"/""/g; s/\\n/ /g'	\
680 681 682 683
		-e '/_(.*[^\ ]""[^\ ]/p' | grep . &&			\
	  { echo '$(ME): missing whitespace at line split' 1>&2;	\
	    exit 1; } || :

684 685
# Enforce recommended preprocessor indentation style.
sc_preprocessor_indentation:
686
	@if cppi --version >/dev/null 2>&1; then			\
687
	  $(VC_LIST_EXCEPT) | grep -E '\.[ch](\.in)?$$' | xargs cppi -a -c	\
688 689 690 691 692 693
	    || { echo '$(ME): incorrect preprocessor indentation' 1>&2;	\
		exit 1; };						\
	else								\
	  echo '$(ME): skipping test $@: cppi not installed' 1>&2;	\
	fi

694 695 696 697 698
# Enforce similar spec file indentation style, by running cppi on a
# (comment-only) C file that mirrors the same layout as the spec file.
sc_spec_indentation:
	@if cppi --version >/dev/null 2>&1; then			\
	  for f in $$($(VC_LIST_EXCEPT) | grep '\.spec\.in$$'); do	\
699
	    $(SED) -e 's|#|// #|; s|%ifn*\(arch\)* |#if a // |'		\
700 701 702
		-e 's/%\(else\|endif\|define\)/#\1/'			\
		-e 's/^\( *\)\1\1\1#/#\1/'				\
		-e 's|^\( *[^#/ ]\)|// \1|; s|^\( */[^/]\)|// \1|' $$f	\
703
	    | cppi -a -c 2>&1 | $(SED) "s|standard input|$$f|";		\
704 705 706 707 708 709 710
	  done | { if grep . >&2; then false; else :; fi; }		\
	    || { echo '$(ME): incorrect preprocessor indentation' 1>&2;	\
		exit 1; };						\
	else								\
	  echo '$(ME): skipping test $@: cppi not installed' 1>&2;	\
	fi

711 712 713 714 715 716 717 718
# Nested conditionals are easier to understand if we enforce that endifs
# can be paired back to the if
sc_makefile_conditionals:
	@prohibit='(else|endif)($$| *#)'				\
	in_vc_files='Makefile\.am'					\
	halt='match "if FOO" with "endif FOO" in Makefiles'		\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
719 720 721 722 723 724 725 726
# Long lines can be harder to diff; too long, and git send-email chokes.
# For now, only enforce line length on files where we have intentionally
# fixed things and don't want to regress.
sc_prohibit_long_lines:
	@prohibit='.{90}'						\
	in_vc_files='\.arg[sv]'						\
	halt='Wrap long lines in expected output files'			\
	  $(_sc_search_regexp)
727 728 729 730
	@prohibit='.{80}'						\
	in_vc_files='Makefile\.am'					\
	halt='Wrap long lines in Makefiles'				\
	  $(_sc_search_regexp)
E
Eric Blake 已提交
731

732
sc_copyright_format:
E
Eric Blake 已提交
733 734 735
	@require='Copyright .*Red 'Hat', Inc\.'				\
	containing='Copyright .*Red 'Hat				\
	halt='Red Hat copyright is missing Inc.'			\
736
	  $(_sc_search_regexp)
E
Eric Blake 已提交
737 738
	@prohibit='Copyright [^(].*Red 'Hat				\
	halt='consistently use (C) in Red Hat copyright'		\
739
	  $(_sc_search_regexp)
740
	@prohibit='\<RedHat\>'						\
E
Eric Blake 已提交
741 742
	halt='spell Red Hat as two words'				\
	  $(_sc_search_regexp)
743

744
# Prefer the new URL listing over the old street address listing when
745 746 747 748 749 750
# calling out where to get a copy of the [L]GPL.  Also, while we have
# to ship COPYING (GPL) alongside COPYING.LESSER (LGPL), we want any
# source file that calls out a top-level file to call out the LGPL
# version.  Note that our typical copyright boilerplate refers to the
# license by name, not by reference to a top-level file.
sc_copyright_usage:
751 752 753
	@prohibit=Boston,' MA'						\
	halt='Point to <http://www.gnu.org/licenses/>, not an address'	\
	  $(_sc_search_regexp)
754 755 756 757 758 759 760
	@require='COPYING\.LESSER'					\
	containing='COPYING'						\
	halt='Refer to COPYING.LESSER for LGPL'				\
	  $(_sc_search_regexp)
	@prohibit='COPYING\.LIB'					\
	halt='Refer to COPYING.LESSER for LGPL'				\
	  $(_sc_search_regexp)
761

762 763 764
# Some functions/macros produce messages intended solely for developers
# and maintainers.  Do not mark them for translation.
sc_prohibit_gettext_markup:
765
	@prohibit='\<VIR_(WARN|INFO|DEBUG) *\(_\('			\
766 767
	halt='do not mark these strings for translation'		\
	  $(_sc_search_regexp)
768

E
Eric Blake 已提交
769 770 771 772
# Our code is divided into modular subdirectories for a reason, and
# lower-level code must not include higher-level headers.
cross_dirs=$(patsubst $(srcdir)/src/%.,%,$(wildcard $(srcdir)/src/*/.))
cross_dirs_re=($(subst / ,/|,$(cross_dirs)))
773
mid_dirs=access|conf|cpu|locking|logging|network|node_device|rpc|security|storage
E
Eric Blake 已提交
774 775 776 777
sc_prohibit_cross_inclusion:
	@for dir in $(cross_dirs); do					\
	  case $$dir in							\
	    util/) safe="util";;					\
778 779 780
	    access/ | conf/) safe="($$dir|conf|util)";;			\
	    locking/) safe="($$dir|util|conf|rpc)";;			\
	    cpu/| network/| node_device/| rpc/| security/| storage/)	\
781
	      safe="($$dir|util|conf|storage)";;			\
J
Jim Fehlig 已提交
782
	    xenapi/ | xenconfig/ ) safe="($$dir|util|conf|xen)";;	\
783
	    *) safe="($$dir|$(mid_dirs)|util)";;			\
E
Eric Blake 已提交
784 785 786 787 788 789 790 791
	  esac;								\
	  in_vc_files="^src/$$dir"					\
	  prohibit='^# *include .$(cross_dirs_re)'			\
	  exclude="# *include .$$safe"					\
	  halt='unsafe cross-directory include'				\
	    $(_sc_search_regexp)					\
	done

E
Eric Blake 已提交
792 793 794 795
# When converting an enum to a string, make sure that we track any new
# elements added to the enum by using a _LAST marker.
sc_require_enum_last_marker:
	@grep -A1 -nE '^[^#]*VIR_ENUM_IMPL *\(' $$($(VC_LIST_EXCEPT))	\
796
	   | $(SED) -ne '/VIR_ENUM_IMPL[^,]*,$$/N'				\
E
Eric Blake 已提交
797 798 799 800 801 802
	     -e '/VIR_ENUM_IMPL[^,]*,[^,]*[^_,][^L,][^A,][^S,][^T,],/p'	\
	     -e '/VIR_ENUM_IMPL[^,]*,[^,]\{0,4\},/p'			\
	   | grep . &&							\
	  { echo '$(ME): enum impl needs to use _LAST marker' 1>&2;	\
	    exit 1; } || :

803 804 805 806
# In Python files we don't want to end lines with a semicolon like in C
sc_prohibit_semicolon_at_eol_in_python:
	@prohibit='^[^#].*\;$$'			                        \
	in_vc_files='\.py$$'						\
807
	halt='python does not require to end lines with a semicolon'	\
808 809
	  $(_sc_search_regexp)

810 811 812 813 814 815 816
# mymain() in test files should use return, not exit, for nicer output
sc_prohibit_exit_in_tests:
	@prohibit='\<exit *\('						\
	in_vc_files='^tests/'						\
	halt='use return, not exit(), in tests'				\
	  $(_sc_search_regexp)

817
# Don't include "libvirt/*.h" in "" form.
818
sc_prohibit_include_public_headers_quote:
819
	@prohibit='# *include *"libvirt/.*\.h"'				\
820 821 822 823 824 825 826 827 828
	in_vc_files='\.[ch]$$'						\
	halt='Do not include libvirt/*.h in internal source'		\
	  $(_sc_search_regexp)

# Don't include "libvirt/*.h" in <> form. Except for external tools,
# e.g. Python binding, examples and tools subdirectories.
sc_prohibit_include_public_headers_brackets:
	@prohibit='# *include *<libvirt/.*\.h>'				\
	in_vc_files='\.[ch]$$'						\
829 830 831
	halt='Do not include libvirt/*.h in internal source'		\
	  $(_sc_search_regexp)

832 833 834 835 836 837 838 839
# <config.h> is only needed in .c files; .h files do not need it since
# .c files must include config.h before any other .h.
sc_prohibit_config_h_in_headers:
	@prohibit='^# *include\>.*config\.h'				\
	in_vc_files='\.h$$'						\
	halt='headers should not include <config.h>'			\
	  $(_sc_search_regexp)

840 841 842 843 844 845
sc_prohibit_unbounded_arrays_in_rpc:
	@prohibit='<>'							\
	in_vc_files='\.x$$'						\
	halt='Arrays in XDR must have a upper limit set for <NNN>'	\
	  $(_sc_search_regexp)

846 847 848 849 850
sc_prohibit_getenv:
	@prohibit='\b(secure_)?getenv *\('				\
	exclude='exempt from syntax-check'				\
	halt='Use virGetEnv{Allow,Block}SUID instead of getenv'		\
	  $(_sc_search_regexp)
851

P
Peter Krempa 已提交
852 853 854 855 856
sc_prohibit_atoi:
	@prohibit='\bato(i|f|l|ll|q) *\('	\
	halt='Use virStrToLong* instead of atoi, atol, atof, atoq, atoll' \
	  $(_sc_search_regexp)

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
sc_prohibit_wrong_filename_in_comment:
	@fail=0;                                                       \
	awk 'BEGIN {                                                   \
	  fail=0;                                                      \
	} FNR < 3 {                                                    \
	  n=match($$0, /[[:space:]][^[:space:]]*[.][ch][[:space:]:]/); \
	  if (n > 0) {                                                 \
	    A=substr($$0, RSTART+1, RLENGTH-2);                        \
	    n=split(FILENAME, arr, "/");                               \
	    if (A != arr[n]) {                                         \
	      print "in " FILENAME ": " A " mentioned in comments ";   \
	      fail=1;                                                  \
	    }                                                          \
	  }                                                            \
	} END {                                                        \
	  if (fail == 1) {                                             \
	    exit 1;                                                    \
	  }                                                            \
	}' $$($(VC_LIST_EXCEPT) | grep '\.[ch]$$') || fail=1;          \
	if test $$fail -eq 1; then                                     \
877
	  { echo '$(ME): The file name in comments must match the'     \
878 879 880
	    'actual file name' 1>&2; exit 1; }	                       \
	fi;

881
sc_prohibit_virConnectOpen_in_virsh:
M
Martin Kletzander 已提交
882 883 884
	@prohibit='\bvirConnectOpen[a-zA-Z]* *\('                      \
	in_vc_files='^tools/virsh-.*\.[ch]$$'                          \
	halt='Use vshConnect() in virsh instead of virConnectOpen*'    \
885 886
	  $(_sc_search_regexp)

J
Ján Tomko 已提交
887 888 889
sc_require_space_before_label:
	@prohibit='^(   ?)?[_a-zA-Z0-9]+:$$'                           \
	in_vc_files='\.[ch]$$'                                         \
890
	halt='Top-level labels should be indented by one space'        \
J
Ján Tomko 已提交
891 892
	  $(_sc_search_regexp)

893 894 895 896 897 898
# Allow for up to three spaces before the label: this is to avoid running
# into situations where neither this rule nor require_space_before_label
# would apply, eg. a line matching ^[a-zA-Z0-9]+ :$
sc_prohibit_space_in_label:
	@prohibit='^ {0,3}[_a-zA-Z0-9]+ +:$$'                          \
	in_vc_files='\.[ch]$$'                                         \
899
	halt='There should be no space between label name and colon'   \
900 901
	  $(_sc_search_regexp)

902 903 904 905
# Doesn't catch all cases of mismatched braces across if-else, but it helps
sc_require_if_else_matching_braces:
	@prohibit='(  else( if .*\))? {|} else( if .*\))?$$)'		\
	in_vc_files='\.[chx]$$'						\
906
	halt='if one side of if-else uses {}, both sides must use it'	\
907 908
	  $(_sc_search_regexp)

909
sc_curly_braces_style:
910 911 912 913 914 915 916 917 918 919 920 921
	@files=$$($(VC_LIST_EXCEPT) | grep '\.[ch]$$');			\
	if $(GREP) -nHP							\
'^\s*(?!([a-zA-Z_]*for_?each[a-zA-Z_]*) ?\()([_a-zA-Z0-9]+( [_a-zA-Z0-9]+)* ?\()?(\*?[_a-zA-Z0-9]+(,? \*?[_a-zA-Z0-9\[\]]+)+|void)\) ?\{'		\
	$$files; then							\
	  echo '$(ME): Non-K&R style used for curly braces around'	\
		'function body, see HACKING' 1>&2; exit 1;		\
	fi;								\
	if $(GREP) -A1 -En ' ((if|for|while|switch) \(|(else|do)\b)[^{]*$$'\
	  $$files | $(GREP) '^[^ ]*- *{'; then				\
	  echo '$(ME): Use hanging braces for compound statements,'	\
		'see HACKING' 1>&2; exit 1;				\
	fi
P
Peter Krempa 已提交
922

923 924 925 926 927
sc_prohibit_windows_special_chars_in_filename:
	@files=$$($(VC_LIST_EXCEPT) | grep '[:*?"<>|]');               \
	test -n "$$files" && { echo '$(ME): Windows special chars'     \
	  'in filename not allowed:' 1>&2; echo $$files 1>&2; exit 1; } || :

928 929 930 931 932 933
sc_prohibit_mixed_case_abbreviations:
	@prohibit='Pci|Usb|Scsi'			\
	in_vc_files='\.[ch]$$'				\
	halt='Use PCI, USB, SCSI, not Pci, Usb, Scsi'	\
	  $(_sc_search_regexp)

934 935
# Require #include <locale.h> in all files that call setlocale()
sc_require_locale_h:
936 937 938 939
	@require='include.*locale\.h'					\
	containing='setlocale *('					\
	halt='setlocale() requires <locale.h>'				\
	  $(_sc_search_regexp)
940

941 942 943 944 945 946 947
sc_prohibit_empty_first_line:
	@awk 'BEGIN { fail=0; }						\
	FNR == 1 { if ($$0 == "") { print FILENAME ":1:"; fail=1; } }	\
	END { if (fail == 1) {						\
	  print "$(ME): Prohibited empty first line" > "/dev/stderr";	\
	} exit fail; }' $$($(VC_LIST_EXCEPT));

948 949 950 951 952 953
sc_prohibit_paren_brace:
	@prohibit='\)\{$$'						\
	in_vc_files='\.[chx]$$'						\
	halt='Put space between closing parenthesis and opening brace'	\
	  $(_sc_search_regexp)

954 955 956 957 958 959 960 961
# C guarantees that static variables are zero initialized, and some compilers
# waste space by sticking explicit initializers in .data instead of .bss
sc_prohibit_static_zero_init:
	@prohibit='\bstatic\b.*= *(0[^xX0-9]|NULL|false)'		\
	in_vc_files='\.[chx](\.in)?$$'					\
	halt='static variables do not need explicit zero initialization'\
	  $(_sc_search_regexp)

962 963 964 965
# FreeBSD exports the "devname" symbol which produces a warning.
sc_prohibit_devname:
	@prohibit='\bdevname\b'	\
	exclude='sc_prohibit_devname' \
966
	halt='avoid using devname as FreeBSD exports the symbol' \
967 968
	  $(_sc_search_regexp)

J
Jiri Denemark 已提交
969 970 971 972 973
sc_prohibit_system_error_with_vir_err:
	@prohibit='\bvirReportSystemError *\(VIR_ERR_' \
	halt='do not use virReportSystemError with VIR_ERR_* error codes' \
	  $(_sc_search_regexp)

974 975 976 977
# Rule to prohibit usage of virXXXFree within library, daemon, remote, etc.
# functions. There's a corresponding exclude to allow usage within tests,
# docs, examples, tools, src/libvirt-*.c, and include/libvirt/libvirt-*.h
sc_prohibit_virXXXFree:
978
	@prohibit='\bvir(Domain|Network|NodeDevice|StorageVol|StoragePool|Stream|Secret|NWFilter|Interface|DomainSnapshot)Free\b'	\
979
	exclude='sc_prohibit_virXXXFree' \
980
	halt='avoid using virXXXFree, use virObjectUnref instead' \
981 982
	  $(_sc_search_regexp)

983 984 985 986 987
sc_prohibit_sysconf_pagesize:
	@prohibit='sysconf\(_SC_PAGESIZE' \
	halt='use virGetSystemPageSize[KB] instead of sysconf(_SC_PAGESIZE)' \
	  $(_sc_search_regexp)

J
Jiri Denemark 已提交
988 989 990
sc_prohibit_pthread_create:
	@prohibit='\bpthread_create\b' \
	exclude='sc_prohibit_pthread_create' \
991
	halt='avoid using pthread_create, use virThreadCreate instead' \
J
Jiri Denemark 已提交
992 993
	  $(_sc_search_regexp)

994 995 996 997 998 999 1000 1001 1002 1003
sc_prohibit_not_streq:
	@prohibit='! *STREQ *\(.*\)'		\
	halt='Use STRNEQ instead of !STREQ'	\
	  $(_sc_search_regexp)

sc_prohibit_not_strneq:
	@prohibit='! *STRNEQ *\(.*\)'       \
	halt='Use STREQ instead of !STRNEQ'	\
	  $(_sc_search_regexp)

J
Ján Tomko 已提交
1004 1005 1006 1007 1008 1009
sc_prohibit_verbose_strcat:
	@prohibit='strncat\([^,]*,\s+([^,]*),\s+strlen\(\1\)\)'     \
	in_vc_files='\.[ch]$$'                                      \
	halt='Use strcat(a, b) instead of strncat(a, b, strlen(b))' \
	  $(_sc_search_regexp)

1010 1011 1012 1013 1014 1015 1016 1017 1018
# Ensure that each .c file containing a "main" function also
# calls virGettextInitialize
sc_gettext_init:
	@require='virGettextInitialize *\('					\
	in_vc_files='\.c$$'						\
	containing='\<main *('						\
	halt='the above files do not call virGettextInitialize'		\
	  $(_sc_search_regexp)

1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
# <dt> is mostly used to document symbols, in which case it should contain
# a <code> element. The regular expression below trades speed and readability
# for accuracy, and won't catch someone trying to stick a <canvas> inside a
# <dt>, but that's what code reviews are for :)
sc_prohibit_dt_without_code:
	@prohibit='<dt>([^<]|<[^c])' \
	exclude='exempt from syntax-check' \
	in_vc_files='docs/.*$$' \
	halt='Use <code> inside <dt> when documenting symbols' \
	  $(_sc_search_regexp)

1030 1031
# We don't use this feature of maint.mk.
prev_version_file = /dev/null
1032

1033
ifneq ($(_gl-Makefile),)
1034 1035
ifeq (0,$(MAKELEVEL))
  _curr_status = .git-module-status
1036 1037 1038 1039 1040 1041
  # The sed filter accommodates those who check out on a commit from which
  # no tag is reachable.  In that case, git submodule status prints a "-"
  # in column 1 and does not print a "git describe"-style string after the
  # submodule name.  Contrast these:
  # -b653eda3ac4864de205419d9f41eec267cb89eeb .gnulib
  #  b653eda3ac4864de205419d9f41eec267cb89eeb .gnulib (v0.0-2286-gb653eda)
1042 1043
  # $ cat .git-module-status
  # b653eda3ac4864de205419d9f41eec267cb89eeb
1044 1045
  #
  # Keep this logic in sync with autogen.sh.
1046
  _submodule_hash = $(SED) 's/^[ +-]//;s/ .*//'
1047
  _update_required := $(shell						\
1048
      cd '$(srcdir)';							\
1049
      test -d .git || { echo 0; exit; };				\
1050
      test -f po/Makevars || { echo 1; exit; };				\
1051
      test -f AUTHORS || { echo 1; exit; };				\
E
Eric Blake 已提交
1052
      test "no-git" = "$$(cat $(_curr_status))" && { echo 0; exit; };	\
1053
      actual=$$(git submodule status | $(_submodule_hash);		\
1054
		git hash-object bootstrap.conf;				\
E
Eric Blake 已提交
1055
		git ls-tree -d HEAD gnulib/local | awk '{print $$3}';	\
1056
		git diff .gnulib);					\
1057 1058
      stamp="$$($(_submodule_hash) $(_curr_status) 2>/dev/null)";	\
      test "$$stamp" = "$$actual"; echo $$?)
1059 1060
  _clean_requested = $(filter %clean,$(MAKECMDGOALS))
  ifeq (1,$(_update_required)$(_clean_requested))
1061
    $(info INFO: gnulib update required; running ./autogen.sh first)
C
Cole Robinson 已提交
1062
    $(shell touch $(srcdir)/AUTHORS $(srcdir)/ChangeLog)
E
Eric Blake 已提交
1063
maint.mk Makefile: _autogen
1064 1065
  endif
endif
1066
endif
1067

E
Eric Blake 已提交
1068 1069 1070 1071 1072 1073 1074
# It is necessary to call autogen any time gnulib changes.  Autogen
# reruns configure, then we regenerate all Makefiles at once.
.PHONY: _autogen
_autogen:
	$(srcdir)/autogen.sh
	./config.status

1075
# regenerate HACKING as part of the syntax-check
1076
ifneq ($(_gl-Makefile),)
1077 1078
syntax-check: $(top_srcdir)/HACKING spacing-check test-wrap-argv \
	prohibit-duplicate-header
1079
endif
1080

1081 1082 1083 1084 1085
# Don't include duplicate header in the source (either *.c or *.h)
prohibit-duplicate-header:
	$(AM_V_GEN)files=$$($(VC_LIST_EXCEPT) | grep '\.[chx]$$'); \
	$(PERL) -W $(top_srcdir)/build-aux/prohibit-duplicate-header.pl $$files

1086
spacing-check:
1087
	$(AM_V_GEN)files=`$(VC_LIST) | grep '\.c$$'`; \
1088
	$(PERL) $(top_srcdir)/build-aux/check-spacing.pl $$files || \
1089
	  { echo '$(ME): incorrect formatting, see HACKING for rules' 1>&2; \
1090
	    exit 1; }
1091

1092 1093
test-wrap-argv:
	$(AM_V_GEN)files=`$(VC_LIST) | grep -E '\.(ldargs|args)'`; \
1094
	$(PERL) $(top_srcdir)/tests/test-wrap-argv.pl --check $$files
1095

1096
# sc_po_check can fail if generated files are not built first
1097 1098 1099
sc_po_check: \
		$(srcdir)/daemon/remote_dispatch.h \
		$(srcdir)/daemon/qemu_dispatch.h \
1100
		$(srcdir)/src/remote/remote_client_bodies.h \
1101
		$(srcdir)/daemon/admin_dispatch.h \
1102
		$(srcdir)/src/admin/admin_client.h
1103
$(srcdir)/daemon/remote_dispatch.h: $(srcdir)/src/remote/remote_protocol.x
1104
	$(MAKE) -C daemon remote_dispatch.h
1105 1106 1107
$(srcdir)/daemon/qemu_dispatch.h: $(srcdir)/src/remote/qemu_protocol.x
	$(MAKE) -C daemon qemu_dispatch.h
$(srcdir)/src/remote/remote_client_bodies.h: $(srcdir)/src/remote/remote_protocol.x
1108
	$(MAKE) -C src remote/remote_client_bodies.h
1109 1110
$(srcdir)/daemon/admin_dispatch.h: $(srcdir)/src/admin/admin_protocol.x
	$(MAKE) -C daemon admin_dispatch.h
1111 1112
$(srcdir)/src/admin/admin_client.h: $(srcdir)/src/admin/admin_protocol.x
	$(MAKE) -C src admin/admin_client.h
1113

1114
# List all syntax-check exemptions:
1115
exclude_file_name_regexp--sc_avoid_strcase = ^tools/vsh\.h$$
1116

1117
_src1=libvirt-stream|fdstream|qemu/qemu_monitor|util/(vircommand|virfile)|xen/xend_internal|rpc/virnetsocket|lxc/lxc_controller|locking/lock_daemon|logging/log_daemon
1118
_test1=shunloadtest|virnettlscontexttest|virnettlssessiontest|vircgroupmock
1119
exclude_file_name_regexp--sc_avoid_write = \
1120
  ^(src/($(_src1))|daemon/libvirtd|tools/virsh-console|tests/($(_test1)))\.c$$
1121

1122 1123 1124
exclude_file_name_regexp--sc_bindtextdomain = .*

exclude_file_name_regexp--sc_gettext_init = ^(tests|examples)/
1125

1126 1127 1128
exclude_file_name_regexp--sc_copyright_format = \
	^cfg\.mk$$

1129
exclude_file_name_regexp--sc_copyright_usage = \
1130
  ^COPYING(|\.LESSER)$$
1131

1132
exclude_file_name_regexp--sc_flags_usage = \
1133
  ^(cfg\.mk|docs/|src/util/virnetdevtap\.c$$|tests/(vir(cgroup|pci|test|usb)|nss|qemuxml2argv)mock\.c$$)
1134

1135
exclude_file_name_regexp--sc_libvirt_unmarked_diagnostics = \
1136
  ^(src/rpc/gendispatch\.pl$$|tests/)
1137

1138
exclude_file_name_regexp--sc_po_check = ^(docs/|src/rpc/gendispatch\.pl$$)
1139 1140

exclude_file_name_regexp--sc_prohibit_VIR_ERR_NO_MEMORY = \
1141 1142 1143 1144
  ^(cfg\.mk|include/libvirt/virterror\.h|daemon/dispatch\.c|src/util/virerror\.c|docs/internals/oomtesting\.html\.in)$$

exclude_file_name_regexp--sc_prohibit_PATH_MAX = \
	^cfg\.mk$$
1145

1146 1147
exclude_file_name_regexp--sc_prohibit_access_xok = \
	^(cfg\.mk|src/util/virutil\.c)$$
E
Eric Blake 已提交
1148

1149
exclude_file_name_regexp--sc_prohibit_asprintf = \
1150
  ^(cfg\.mk|bootstrap.conf$$|src/util/virstring\.[ch]$$|tests/vircgroupmock\.c$$)
E
Eric Blake 已提交
1151

1152
exclude_file_name_regexp--sc_prohibit_strdup = \
1153
  ^(docs/|examples/|src/util/virstring\.c|tests/vir(netserverclient|cgroup)mock.c$$)
1154

1155
exclude_file_name_regexp--sc_prohibit_close = \
1156
  (\.p[yl]$$|\.spec\.in$$|^docs/|^(src/util/virfile\.c|src/libvirt-stream\.c|tests/vir.+mock\.c)$$)
1157 1158

exclude_file_name_regexp--sc_prohibit_empty_lines_at_EOF = \
1159
  (^tests/(qemuhelp|virhostcpu|virpcitest)data/|\.diff|tests/virconfdata/no-newline\.conf$$)
1160

1161
_src2=src/(util/vircommand|libvirt|lxc/lxc_controller|locking/lock_daemon|logging/log_daemon)
1162
exclude_file_name_regexp--sc_prohibit_fork_wrappers = \
1163
  (^($(_src2)|tests/testutils|daemon/libvirtd)\.c$$)
1164

1165
exclude_file_name_regexp--sc_prohibit_gethostname = ^src/util/virutil\.c$$
1166

E
Eric Blake 已提交
1167
exclude_file_name_regexp--sc_prohibit_internal_functions = \
1168
  ^src/(util/(viralloc|virutil|virfile)\.[hc]|esx/esx_vi\.c)$$
E
Eric Blake 已提交
1169

1170
exclude_file_name_regexp--sc_prohibit_newline_at_end_of_diagnostic = \
1171
  ^src/rpc/gendispatch\.pl$$
1172

1173
exclude_file_name_regexp--sc_prohibit_nonreentrant = \
1174
  ^((po|tests)/|docs/.*(py|html\.in)|run.in$$|tools/wireshark/util/genxdrstub\.pl$$)
1175

1176 1177 1178
exclude_file_name_regexp--sc_prohibit_select = \
	^cfg\.mk$$

E
Eric Blake 已提交
1179
exclude_file_name_regexp--sc_prohibit_raw_allocation = \
1180
  ^(docs/hacking\.html\.in|src/util/viralloc\.[ch]|examples/.*|tests/(securityselinuxhelper|vircgroupmock)\.c|tools/wireshark/src/packet-libvirt\.c)$$
E
Eric Blake 已提交
1181

1182
exclude_file_name_regexp--sc_prohibit_readlink = \
1183
  ^src/(util/virutil|lxc/lxc_container)\.c$$
1184

1185
exclude_file_name_regexp--sc_prohibit_setuid = ^src/util/virutil\.c$$
E
Eric Blake 已提交
1186

1187
exclude_file_name_regexp--sc_prohibit_sprintf = \
1188
  ^(cfg\.mk|docs/hacking\.html\.in|.*\.stp|.*\.pl)$$
1189

1190
exclude_file_name_regexp--sc_prohibit_strncpy = ^src/util/virstring\.c$$
1191

1192
exclude_file_name_regexp--sc_prohibit_strtol = ^examples/dom.*/.*\.c$$
E
Eric Blake 已提交
1193

M
Michal Privoznik 已提交
1194 1195
exclude_file_name_regexp--sc_prohibit_gethostby = ^docs/nss.html.in$$

1196
exclude_file_name_regexp--sc_prohibit_xmlGetProp = ^src/util/virxml\.c$$
1197

M
Martin Kletzander 已提交
1198 1199
exclude_file_name_regexp--sc_prohibit_xmlURI = ^src/util/viruri\.c$$

1200 1201
exclude_file_name_regexp--sc_prohibit_return_as_function = \.py$$

1202 1203
exclude_file_name_regexp--sc_require_config_h = \
	^(examples/|tools/virsh-edit\.c$$)
1204

1205 1206
exclude_file_name_regexp--sc_require_config_h_first = \
	^(examples/|tools/virsh-edit\.c$$)
1207

1208
exclude_file_name_regexp--sc_trailing_blank = \
1209
  /qemuhelpdata/|/sysinfodata/.*\.data|/virhostcpudata/.*\.cpuinfo$$
1210 1211 1212

exclude_file_name_regexp--sc_unmarked_diagnostics = \
  ^(docs/apibuild.py|tests/virt-aa-helper-test)$$
1213 1214

exclude_file_name_regexp--sc_size_of_brackets = cfg.mk
1215 1216 1217

exclude_file_name_regexp--sc_correct_id_types = \
  (^src/locking/lock_protocol.x$$)
1218 1219

exclude_file_name_regexp--sc_m4_quote_check = m4/virt-lib.m4
1220

1221
exclude_file_name_regexp--sc_prohibit_include_public_headers_quote = \
1222
  ^(src/internal\.h$$|tools/wireshark/src/packet-libvirt.h$$)
1223 1224

exclude_file_name_regexp--sc_prohibit_include_public_headers_brackets = \
1225
  ^(tools/|examples/|include/libvirt/(virterror|libvirt(-(admin|qemu|lxc))?)\.h$$)
1226 1227

exclude_file_name_regexp--sc_prohibit_int_ijk = \
1228
  ^(src/remote_protocol-structs|src/remote/remote_protocol\.x|cfg\.mk|include/libvirt/libvirt.+|src/admin_protocol-structs|src/admin/admin_protocol\.x)$$
1229 1230 1231

exclude_file_name_regexp--sc_prohibit_getenv = \
  ^tests/.*\.[ch]$$
1232 1233

exclude_file_name_regexp--sc_avoid_attribute_unused_in_header = \
M
Martin Kletzander 已提交
1234
  ^(src/util/virlog\.h|src/network/bridge_driver\.h)$$
1235 1236 1237

exclude_file_name_regexp--sc_prohibit_mixed_case_abbreviations = \
  ^src/(vbox/vbox_CAPI.*.h|esx/esx_vi.(c|h)|esx/esx_storage_backend_iscsi.c)$$
1238 1239

exclude_file_name_regexp--sc_prohibit_empty_first_line = \
1240
  ^(README|daemon/THREADS\.txt|src/esx/README|docs/library.xen|tests/(vmwarever|virhostcpu)data/.*)$$
1241 1242 1243

exclude_file_name_regexp--sc_prohibit_useless_translation = \
  ^tests/virpolkittest.c
1244 1245 1246

exclude_file_name_regexp--sc_prohibit_devname = \
  ^(tools/virsh.pod|cfg.mk|docs/.*)$$
1247 1248

exclude_file_name_regexp--sc_prohibit_virXXXFree = \
1249
  ^(docs/|tests/|examples/|tools/|cfg.mk|src/test/test_driver.c|src/libvirt_public.syms|include/libvirt/libvirt-(domain|network|nodedev|storage|stream|secret|nwfilter|interface|domain-snapshot).h|src/libvirt-(domain|qemu|network|nodedev|storage|stream|secret|nwfilter|interface|domain-snapshot).c$$)
1250 1251 1252

exclude_file_name_regexp--sc_prohibit_sysconf_pagesize = \
  ^(cfg\.mk|src/util/virutil\.c)$$
J
Jiri Denemark 已提交
1253 1254 1255

exclude_file_name_regexp--sc_prohibit_pthread_create = \
  ^(cfg\.mk|src/util/virthread\.c|tests/.*)$$
1256 1257 1258 1259 1260 1261

exclude_file_name_regexp--sc_prohibit_not_streq = \
  ^tests/.*\.[ch]$$

exclude_file_name_regexp--sc_prohibit_not_strneq = \
  ^tests/.*\.[ch]$$
1262 1263 1264

exclude_file_name_regexp--sc_prohibit_dt_without_code = \
  ^docs/(newapi\.xsl|(apps|contact)\.html\.in)$$
1265 1266 1267

exclude_file_name_regexp--sc_prohibit_always-defined_macros = \
  ^tests/virtestmock.c$$
J
Ján Tomko 已提交
1268 1269 1270

exclude_file_name_regexp--sc_prohibit_readdir = \
  ^tests/.*mock\.c$$