Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is the meaning of leading and trailing underscores in Linux kernel identifiers?

I keep running across little conventions like __KERNEL__.

Are the __ in this case a naming convention used by kernel developers or is it a syntax specific reason for naming a macro this way?

There are many examples of this throughout the code.

For example some functions and variables begin with an _ or even __.

Is there a specific reason for this?

It seems pretty widely used and I just need some clarification as to whether these things have a syntactical purpose or is it simply a naming convention.

Furthermore I see lots of user declared types such as uid_t. Again I assume this is a naming convention telling the reader that it is a user-defined type?

like image 909
A.Smith Avatar asked Feb 24 '12 14:02

A.Smith


1 Answers

There are several cases:

  • In public facing headers, i.e. anything that libc will be taking over and putting under /usr/include/linux, the standards specify which symbols should be defined and any other symbols specific to the system shall start with underscore and capital letter or two underscores. That's the reason for __KERNEL__ in particular, because it is used in headers that are included both in kernel and in libc and some declarations are different.
  • In internal code, the convention usually is that symbol __something is workhorse for something excluding some management, often locking. That is a reason for things like __d_lookup . Similar convention for system calls is that sys_something is the system call entry point that handles context switch to and from kernel and calls do_something to do the actual work.
  • The _t suffix is standard library convention for typedefs. E.g. size_t, ptrdiff_t, foff_t and such. Kernel code follows this convention for it's internal types too.
like image 133
Jan Hudec Avatar answered Nov 15 '22 08:11

Jan Hudec