Re: __FUNCTION__

Ian S. Nelson
2002-01-08T22:00:36Z

Vladimir Kondratiev wrote:

> Hello,
> Modern C standard (C99) defines __FUNCTION__ as if immediately after
> function open brace string with function name is declared. Thus, it's
> invalid to use string concatenations like __FILE__ ":" __FUNCTION__.
>
> Gcc 3.03 gives warning for such use of __FUNCTION__. Before this
> warnings become error, it's worth to fix this in the kernel source.
>
> I found tons of improper __FUNCTION__ usage in USB drivers. I am not
> to say, USB is the only place, I just started with it. In USB, typical
> use is with dbg() and alike macros. dbg() defined in usb.h as follows:
>
> #define dbg(format, arg...) printk(KERN_DEBUG __FILE__ ": " format
> "\n" , ## arg)
>
> In source it is usually used like
>
> dbg(__FUNCTION__ " endpoint %d\n", usb_pipeendpoint(this_urb->pipe));
>
> I propose modification for dbg() and friends like
>
> #define dbg(format, arg...) printk(KERN_DEBUG __FILE__ ":%s - " format
> "\n", __FUNCTION__, ## arg)
>
> This will enable the same usage, but will incorporate __FUNCTION__ in
> the common message prefix. This centralization will force function
> name in all messages, and make it easy to fix code. Code will be
> shorter and cleaner. It may be worth to (#ifdef MODULE) add module
> name to message prefix.
>
> Any comments?

I suspect this might be about as religious an issue as there is but has
anyone thought about coming up with some "standard" debugging macros,
perhaps something that can be configured at compile time from the
configuration for everyone to use everywhere? I've got my own debug
macros, essentially a printk with the file, function and line added
wrapped in #ifdef DEBUG. I've seen several other schemes in other parts
of the kernel and now some of them aren't correct.

I guess what I would envision is some kind of debug menu item in the
configuration tool that let's you select if you want messages, and/or
filenames, and/or line numbers, and/or function names, or nothing at
all. They could still be controlled at the module level by defining or
not defining some constant. It just seems kind of pointless to have
10-20 different macros or methods that all do the same thing for
different parts of the kernel.

Ian

--
Ian S. Nelson <nelcomp@attglobal.net> 303-666-0315
Nelson Computing of Boulder Colorado
Networking/Contracting/Custom Software/Linux Fast and Personal service