HACKING 21.3 KB
Newer Older
1 2 3
-*- buffer-read-only: t -*- vi: set ro:
DO NOT EDIT THIS FILE!  IT IS GENERATED AUTOMATICALLY!

4 5 6 7 8


                         Contributor guidelines
                         ======================

9 10


11 12
General tips for contributing patches
=====================================
13 14
(1) Discuss any large changes on the mailing list first. Post patches early and
listen to feedback.
15

16
(2) Post patches in unified diff format. A command similar to this should work:
17 18 19 20 21

  diff -urp libvirt.orig/ libvirt.modified/ > libvirt-myfeature.patch

or:

22
  git diff > libvirt-myfeature.patch
23

24 25 26
(3) Split large changes into a series of smaller patches, self-contained if
possible, with an explanation of each patch and an explanation of how the
sequence of patches fits together.
27

28 29
(4) Make sure your patches apply against libvirt GIT. Developers only follow GIT
and don't care much about released versions.
30

31 32
(5) Run the automated tests on your code before submitting any changes. In
particular, configure with compile warnings set to -Werror:
33 34 35 36 37 38 39 40 41 42 43

  ./configure --enable-compile-warnings=error

and run the tests:

  make check
  make syntax-check
  make -C tests valgrind

The latter test checks for memory leaks.

44 45 46 47 48 49 50
If you encounter any failing tests, the VIR_TEST_DEBUG environment variable
may provide extra information to debug the failures. Larger values of
VIR_TEST_DEBUG may provide larger amounts of information:

  VIR_TEST_DEBUG=1 make check    (or)
  VIR_TEST_DEBUG=2 make check

51
Also, individual tests can be run from inside the "tests/" directory, like:
52 53 54

  ./qemuxml2xmltest

55 56
(6) Update tests and/or documentation, particularly if you are adding a new
feature or changing the output of a program.
57 58


59

60 61
There is more on this subject, including lots of links to background reading
on the subject, on
62

63 64
  Richard Jones' guide to working with open source projects
  http://et.redhat.com/~rjones/how-to-supply-code-to-open-source-projects/
65

66

67 68 69
Code indentation
================
Libvirt's C source code generally adheres to some basic code-formatting
70 71 72 73
conventions. The existing code base is not totally consistent on this front,
but we do prefer that contributed code be formatted similarly. In short, use
spaces-not-TABs for indentation, use 4 spaces for each indentation level, and
other than that, follow the K&R style.
74 75 76 77 78 79 80 81 82 83 84 85 86

If you use Emacs, add the following to one of one of your start-up files
(e.g., ~/.emacs), to help ensure that you get indentation right:

  ;;; When editing C sources in libvirt, use this style.
  (defun libvirt-c-mode ()
    "C mode with adjusted defaults for use with libvirt."
    (interactive)
    (c-set-style "K&R")
    (setq indent-tabs-mode nil) ; indent using spaces, not TABs
    (setq c-indent-level 4)
    (setq c-basic-offset 4))
  (add-hook 'c-mode-hook
87 88 89
            '(lambda () (if (string-match "/libvirt" (buffer-file-name))
                            (libvirt-c-mode))))

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
If you use vim, append the following to your ~/.vimrc file:

  set nocompatible
  filetype on
  set autoindent
  set smartindent
  set cindent
  set tabstop=8
  set shiftwidth=4
  set expandtab
  set cinoptions=(0,:0,l1,t0
  filetype plugin indent on
  au FileType make setlocal noexpandtab
  au BufRead,BufNewFile *.am setlocal noexpandtab
  match ErrorMsg /\s\+$\| \+\ze\t/

Or if you don't want to mess your ~/.vimrc up, you can save the above into a
file called .lvimrc (not .vimrc) located at the root of libvirt source, then
install a vim script from
http://www.vim.org/scripts/script.php?script_id=1408, which will load the
.lvimrc only when you edit libvirt code.

112 113 114

Code formatting (especially for new code)
=========================================
115 116 117
With new code, we can be even more strict. Please apply the following function
(using GNU indent) to any new code. Note that this also gives you an idea of
the type of spacing we prefer around operators and keywords:
118 119 120 121 122 123 124 125

  indent-libvirt()
  {
    indent -bad -bap -bbb -bli4 -br -ce -brs -cs -i4 -l75 -lc75 \
      -sbi4 -psl -saf -sai -saw -sbi4 -ss -sc -cdw -cli4 -npcs -nbc \
      --no-tabs "$@"
  }

126 127 128
Note that sometimes you'll have to post-process that output further, by piping
it through "expand -i", since some leading TABs can get through. Usually
they're in macro definitions or strings, and should be converted anyhow.
129 130


131 132 133 134
Curly braces
============
Omit the curly braces around an "if", "while", "for" etc. body only when that
body occupies a single line. In every other case we require the braces. This
135 136
ensures that it is trivially easy to identify a single-'statement' loop: each
has only one 'line' in its body.
137 138 139

Omitting braces with a single-line body is fine:

140 141
  while (expr) // one-line body -> omitting curly braces is ok
      single_line_stmt();
142 143 144 145

However, the moment your loop/if/else body extends onto a second line, for
whatever reason (even if it's just an added comment), then you should add
braces. Otherwise, it would be too easy to insert a statement just before that
146
comment (without adding braces), thinking it is already a multi-statement loop:
147

148 149 150
  while (true) // BAD! multi-line body with no braces
      /* comment... */
      single_line_stmt();
151 152 153

Do this instead:

154 155 156 157
  while (true) { // Always put braces around a multi-line body.
      /* comment... */
      single_line_stmt();
  }
158 159 160 161

There is one exception: when the second body line is not at the same
indentation level as the first body line:

162 163 164
  if (expr)
      die("a diagnostic that would make this line"
          " extend past the 80-column limit"));
165 166 167 168 169 170

It is safe to omit the braces in the code above, since the further-indented
second body line makes it obvious that this is still a single-statement body.

To reiterate, don't do this:

171 172 173 174
  if (expr)            // BAD: no braces around...
      while (expr_2) { // ... a multi-line body
          ...
      }
175 176 177

Do this, instead:

178 179 180 181 182
  if (expr) {
      while (expr_2) {
          ...
      }
  }
183 184 185

However, there is one exception in the other direction, when even a one-line
block should have braces. That occurs when that one-line, brace-less block is
186 187 188 189 190
an "if" or "else" block, and the counterpart block *does* use braces. In that
case, put braces around both blocks. Also, if the "else" block is much shorter
than the "if" block, consider negating the "if"-condition and swapping the
bodies, putting the short block first and making the longer, multi-line block
be the "else" block.
191

192 193 194 195 196
  if (expr) {
      ...
      ...
  }
  else
197 198
      x = y;    // BAD: braceless "else" with braced "then",
                // and short block last
199

200 201 202 203 204 205
  if (expr)
      x = y;    // BAD: braceless "if" with braced "else"
  else {
      ...
      ...
  }
206

207 208 209 210 211 212
Keeping braces consistent and putting the short block first is preferred,
especially when the multi-line body is more than a few lines long, because it
is easier to read and grasp the semantics of an if-then-else block when the
simpler block occurs first, rather than after the more involved block:

  if (!expr) {
213
    x = y; // putting the smaller block first is more readable
214
  } else {
215 216 217
      ...
      ...
  }
218

219
But if negating a complex condition is too ugly, then at least add braces:
220

221
  if (complex expr not worth negating) {
222 223 224 225 226
      ...
      ...
  } else {
      x = y;
  }
227 228


229 230 231 232
Preprocessor
============
For variadic macros, stick with C99 syntax:

233
  #define vshPrint(_ctl, ...) fprintf(stdout, __VA_ARGS__)
234

235 236
Use parenthesis when checking if a macro is defined, and use indentation to
track nesting:
237

238 239 240
  #if defined(HAVE_POSIX_FALLOCATE) && !defined(HAVE_FALLOCATE)
  # define fallocate(a,ignored,b,c) posix_fallocate(a,b,c)
  #endif
241 242


243 244 245 246 247 248
C types
=======
Use the right type.

Scalars
-------
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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
- If you're using "int" or "long", odds are good that there's a better type.

- If a variable is counting something, be sure to declare it with an unsigned
type.

- If it's memory-size-related, use "size_t" (use "ssize_t" only if required).

- If it's file-size related, use uintmax_t, or maybe "off_t".

- If it's file-offset related (i.e., signed), use "off_t".

- If it's just counting small numbers use "unsigned int"; (on all but oddball
embedded systems, you can assume that that type is at least four bytes wide).

- If a variable has boolean semantics, give it the "bool" type and use the
corresponding "true" and "false" macros. It's ok to include <stdbool.h>, since
libvirt's use of gnulib ensures that it exists and is usable.

- In the unusual event that you require a specific width, use a standard type
like "int32_t", "uint32_t", "uint64_t", etc.

- While using "bool" is good for readability, it comes with minor caveats:

-- Don't use "bool" in places where the type size must be constant across all
systems, like public interfaces and on-the-wire protocols. Note that it would
be possible (albeit wasteful) to use "bool" in libvirt's logical wire
protocol, since XDR maps that to its lower-level "bool_t" type, which *is*
fixed-size.

-- Don't compare a bool variable against the literal, "true", since a value with
a logical non-false value need not be "1". I.e., don't write "if (seen ==
true) ...". Rather, write "if (seen)...".





Of course, take all of the above with a grain of salt. If you're about to use
some system interface that requires a type like "size_t", "pid_t" or "off_t",
use matching types for any corresponding variables.

Also, if you try to use e.g., "unsigned int" as a type, and that conflicts
with the signedness of a related variable, sometimes it's best just to use the
*wrong* type, if 'pulling the thread' and fixing all related variables would
be too invasive.

Finally, while using descriptive types is important, be careful not to go
overboard. If whatever you're doing causes warnings, or requires casts, then
reconsider or ask for help.
298 299 300

Pointers
--------
301 302 303 304 305 306
Ensure that all of your pointers are 'const-correct'. Unless a pointer is used
to modify the pointed-to storage, give it the "const" attribute. That way, the
reader knows up-front that this is a read-only pointer. Perhaps more
importantly, if we're diligent about this, when you see a non-const pointer,
you're guaranteed that it is used to modify the storage it points to, or it is
aliased to another pointer that is.
307 308


309 310 311
Low level memory management
===========================
Use of the malloc/free/realloc/calloc APIs is deprecated in the libvirt
312 313
codebase, because they encourage a number of serious coding bugs and do not
enable compile time verification of checks for NULL. Instead of these
314
routines, use the macros from memory.h.
315

316
- To allocate a single object:
317

318 319 320 321 322 323
  virDomainPtr domain;

  if (VIR_ALLOC(domain) < 0) {
      virReportOOMError();
      return NULL;
  }
324 325 326



327
- To allocate an array of objects:
328

329
  virDomainPtr domains;
330
  size_t ndomains = 10;
331 332 333 334 335

  if (VIR_ALLOC_N(domains, ndomains) < 0) {
      virReportOOMError();
      return NULL;
  }
336 337 338



339
- To allocate an array of object pointers:
340

341
  virDomainPtr *domains;
342
  size_t ndomains = 10;
343

344 345 346 347 348 349 350
  if (VIR_ALLOC_N(domains, ndomains) < 0) {
      virReportOOMError();
      return NULL;
  }



351 352 353 354 355 356
- To re-allocate the array of domains to be 1 element longer (however, note that
repeatedly expanding an array by 1 scales quadratically, so this is
recommended only for smaller arrays):

  virDomainPtr domains;
  size_t ndomains = 0;
357

358
  if (VIR_EXPAND_N(domains, ndomains, 1) < 0) {
359 360 361
      virReportOOMError();
      return NULL;
  }
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
  domains[ndomains - 1] = domain;



- To ensure an array has room to hold at least one more element (this approach
scales better, but requires tracking allocation separately from usage)

  virDomainPtr domains;
  size_t ndomains = 0;
  size_t ndomains_max = 0;

  if (VIR_RESIZE_N(domains, ndomains_max, ndomains, 1) < 0) {
      virReportOOMError();
      return NULL;
  }
  domains[ndomains++] = domain;
378 379 380



381 382
- To trim an array of domains from its allocated size down to the actual used
size:
383

384 385 386 387
  virDomainPtr domains;
  size_t ndomains = x;
  size_t ndomains_max = y;

388
  VIR_SHRINK_N(domains, ndomains_max, ndomains_max - ndomains);
389 390 391



392
- To free an array of domains:
393

394 395 396 397 398 399 400 401 402
  virDomainPtr domains;
  size_t ndomains = x;
  size_t ndomains_max = y;
  size_t i;

  for (i = 0; i < ndomains; i++)
      VIR_FREE(domains[i]);
  VIR_FREE(domains);
  ndomains_max = ndomains = 0;
403 404 405 406 407 408






409 410
File handling
=============
411 412 413 414 415
Usage of the "fdopen()", "close()", "fclose()" APIs is deprecated in libvirt
code base to help avoiding double-closing of files or file descriptors, which
is particulary dangerous in a multi-threaded applications. Instead of these
APIs, use the macros from files.h

416
- Open a file from a file descriptor:
417 418 419 420 421 422 423 424 425

  if ((file = VIR_FDOPEN(fd, "r")) == NULL) {
      virReportSystemError(errno, "%s",
                           _("failed to open file from file descriptor"));
      return -1;
  }
  /* fd is now invalid; only access the file using file variable */


426

427
- Close a file descriptor:
428 429

  if (VIR_CLOSE(fd) < 0) {
430 431 432 433 434
      virReportSystemError(errno, "%s", _("failed to close file"));
  }



435
- Close a file:
436 437 438

  if (VIR_FCLOSE(file) < 0) {
      virReportSystemError(errno, "%s", _("failed to close file"));
439 440 441 442
  }



443 444
- Close a file or file descriptor in an error path, without losing the previous
"errno" value:
445 446

  VIR_FORCE_CLOSE(fd);
447
  VIR_FORCE_FCLOSE(file);
448 449


450 451 452



453 454 455

String comparisons
==================
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
Do not use the strcmp, strncmp, etc functions directly. Instead use one of the
following semantically named macros

- For strict equality:

  STREQ(a,b)
  STRNEQ(a,b)



- For case insensitive equality:

  STRCASEEQ(a,b)
  STRCASENEQ(a,b)


472

473
- For strict equality of a substring:
474

475 476
  STREQLEN(a,b,n)
  STRNEQLEN(a,b,n)
477 478 479



480
- For case insensitive equality of a substring:
481

482 483
  STRCASEEQLEN(a,b,n)
  STRCASENEQLEN(a,b,n)
484 485 486



487 488 489 490 491
- For strict equality of a prefix:

  STRPREFIX(a,b)


492 493 494 495




C
Chris Lalancette 已提交
496 497
String copying
==============
498 499 500
Do not use the strncpy function. According to the man page, it does *not*
guarantee a NULL-terminated buffer, which makes it extremely dangerous to use.
Instead, use one of the functionally equivalent functions:
C
Chris Lalancette 已提交
501

502
  virStrncpy(char *dest, const char *src, size_t n, size_t destbytes)
C
Chris Lalancette 已提交
503

504 505 506 507 508 509
The first three arguments have the same meaning as for strncpy; namely the
destination, source, and number of bytes to copy, respectively. The last
argument is the number of bytes available in the destination string; if a copy
of the source string (including a \0) will not fit into the destination, no
bytes are copied and the routine returns NULL. Otherwise, n bytes from the
source are copied into the destination and a trailing \0 is appended.
C
Chris Lalancette 已提交
510

511
  virStrcpy(char *dest, const char *src, size_t destbytes)
C
Chris Lalancette 已提交
512

513 514 515
Use this variant if you know you want to copy the entire src string into dest.
Note that this is a macro, so arguments could be evaluated more than once.
This is equivalent to virStrncpy(dest, src, strlen(src), destbytes)
C
Chris Lalancette 已提交
516

517 518 519 520 521 522 523
  virStrcpyStatic(char *dest, const char *src)

Use this variant if you know you want to copy the entire src string into dest
*and* you know that your destination string is a static string (i.e. that
sizeof(dest) returns something meaningful). Note that this is a macro, so
arguments could be evaluated more than once. This is equivalent to
virStrncpy(dest, src, strlen(src), sizeof(dest)).
C
Chris Lalancette 已提交
524 525


526 527
Variable length string buffer
=============================
528 529 530
If there is a need for complex string concatenations, avoid using the usual
sequence of malloc/strcpy/strcat/snprintf functions and make use of the
virBuffer API described in buf.h
531

532
Typical usage is as follows:
533 534

  char *
535 536
  somefunction(...)
  {
537 538 539 540 541
     virBuffer buf = VIR_BUFFER_INITIALIZER;

     ...

     virBufferAddLit(&buf, "<domain>\n");
542
     virBufferVSprintf(&buf, "  <memory>%d</memory>\n", memory);
543 544 545
     ...
     virBufferAddLit(&buf, "</domain>\n");

546
     ...
547 548

     if (virBufferError(&buf)) {
549
         virBufferFreeAndReset(&buf);
550
         virReportOOMError();
551 552 553 554 555
         return NULL;
     }

     return virBufferContentAndReset(&buf);
  }
556 557 558 559


Include files
=============
560 561 562
There are now quite a large number of include files, both libvirt internal and
external, and system includes. To manage all this complexity it's best to
stick to the following general plan for all *.c source files:
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578

  /*
   * Copyright notice
   * ....
   * ....
   * ....
   *
   */

  #include <config.h>             Must come first in every file.

  #include <stdio.h>              Any system includes you need.
  #include <string.h>
  #include <limits.h>

  #if HAVE_NUMACTL                Some system includes aren't supported
J
Jim Meyering 已提交
579
  # include <numa.h>              everywhere so need these #if guards.
580 581 582 583 584 585 586
  #endif

  #include "internal.h"           Include this first, after system includes.

  #include "util.h"               Any libvirt internal header files.
  #include "buf.h"

587 588
  static int
  myInternalFunc()                The actual code.
589
  {
590
      ...
591

592 593 594
Of particular note: *Do not* include libvirt/libvirt.h or libvirt/virterror.h.
It is included by "internal.h" already and there are some special reasons why
you cannot include these files explicitly.
595 596


597 598
Printf-style functions
======================
599 600 601 602 603 604 605 606 607 608 609
Whenever you add a new printf-style function, i.e., one with a format string
argument and following "..." in its prototype, be sure to use gcc's printf
attribute directive in the prototype. For example, here's the one for
virAsprintf, in util.h:

  int virAsprintf(char **strp, const char *fmt, ...)
      ATTRIBUTE_FORMAT(printf, 2, 3);

This makes it so gcc's -Wformat and -Wformat-security options can do their
jobs and cross-check format strings with the number and types of arguments.

E
Eric Blake 已提交
610 611 612 613 614 615
When printing to a string, consider using virBuffer for incremental
allocations, virAsprintf for a one-shot allocation, and snprintf for
fixed-width buffers. Do not use sprintf, even if you can prove the buffer
won't overflow, since gnulib does not provide the same portability guarantees
for sprintf as it does for snprintf.

616 617 618 619 620 621 622 623 624

Use of goto
===========
The use of goto is not forbidden, and goto is widely used throughout libvirt.
While the uncontrolled use of goto will quickly lead to unmaintainable code,
there is a place for it in well structured code where its use increases
readability and maintainability. In general, if goto is used for error
recovery, it's likely to be ok, otherwise, be cautious or avoid it all
together.
625

626 627 628 629 630 631 632 633 634
The typical use of goto is to jump to cleanup code in the case of a long list
of actions, any of which may fail and cause the entire operation to fail. In
this case, a function will have a single label at the end of the function.
It's almost always ok to use this style. In particular, if the cleanup code
only involves free'ing memory, then having multiple labels is overkill.
VIR_FREE() and every function named XXXFree() in libvirt is required to handle
NULL as its arg. Thus you can safely call free on all the variables even if
they were not yet allocated (yes they have to have been initialized to NULL).
This is much simpler and clearer than having multiple labels.
635

636
There are a couple of signs that a particular use of goto is not ok:
637

638 639 640
- You're using multiple labels. If you find yourself using multiple labels,
you're strongly encouraged to rework your code to eliminate all but one of
them.
641

642 643 644 645 646
- The goto jumps back up to a point above the current line of code being
executed. Please use some combination of looping constructs to re-execute code
instead; it's almost certainly going to be more understandable by others. One
well-known exception to this rule is restarting an i/o operation following
EINTR.
647

648 649 650 651
- The goto jumps down to an arbitrary place in the middle of a function followed
by further potentially failing calls. You should almost certainly be using a
conditional and a block instead of a goto. Perhaps some of your function's
logic would be better pulled out into a helper function.
652 653


654 655 656 657 658 659 660 661 662 663 664 665

Although libvirt does not encourage the Linux kernel wind/unwind style of
multiple labels, there's a good general discussion of the issue archived at

  KernelTrap
  http://kerneltrap.org/node/553/2131

When using goto, please use one of these standard labels if it makes sense:

      error: A path only taken upon return with an error code
    cleanup: A path taken upon return with success code + optional error
  no_memory: A path only taken upon return with an OOM error code
666
      retry: If needing to jump upwards (e.g., retry on EINTR)
667 668 669 670 671 672


Libvirt committer guidelines
============================
The AUTHORS files indicates the list of people with commit access right who
can actually merge the patches.
673

J
Jim Meyering 已提交
674
The general rule for committing a patch is to make sure it has been reviewed
675 676 677 678 679 680 681 682 683 684 685
properly in the mailing-list first, usually if a couple of people gave an ACK
or +1 to a patch and nobody raised an objection on the list it should be good
to go. If the patch touches a part of the code where you're not the main
maintainer, or where you do not have a very clear idea of how things work,
it's better to wait for a more authoritative feedback though. Before
committing, please also rebuild locally, run 'make check syntax-check', and
make sure you don't raise errors. Try to look for warnings too; for example,
configure with

  --enable-compile-warnings=error

686 687
which adds -Werror to compile flags, so no warnings get missed

688 689 690 691 692 693 694 695 696 697 698 699 700 701
An exception to 'review and approval on the list first' is fixing failures to
build:

- if a recently committed patch breaks compilation on a platform or for a given
driver, then it's fine to commit a minimal fix directly without getting the
review feedback first

- if make check or make syntax-check breaks, if there is an obvious fix, it's
fine to commit immediately. The patch should still be sent to the list (or
tell what the fix was if trivial), and 'make check syntax-check' should pass
too, before committing anything

- fixes for documentation and code comments can be managed in the same way, but
still make sure they get reviewed if non-trivial.