[dpdk-dev] Dynamic Logging Name Formatting

[dpdk-dev] Dynamic Logging Name Formatting

[Van Haaren, Harry]

Hi All,

I'm looking at the output of  app/test >> dump_log_types

There are a number of naming systems, and I think it would be good to standardize on one (before we diverge further than we already have..) Below a summary of current state, which is becoming a little messy IMO. A proposed (hopefully consistent) naming scheme suggested below that again.

Based on the suggested scheme, I think the OPDL PMD and OcteonTX would change - so adding Maintainers of those components to CC.

Feedback welcome, -Harry


=== Current State ===
=====================

Libraries:
   lib.<name>

Ethdev PMDs:
   pmd.<name>.info
   pmd.<name>.driver

Other PMDs
   pmd.<platform>.ethdev
   pmd.<platform>.ethdev.init
   pmd.<platform>.eventdev
   pmd.<platform>.mempool

More PMDs:
   eventdev.<pmd-name>.init
   eventdev.<pmd-name>.driver


=== Suggested Consistent Schema ===
===================================

Libraries:
  lib.<name>.specialization

Net PMDs:
  pmd.<name>.specialization
  // one could argue consistency would be pmd.ethdev.<name>
  // but the change is larger than the value IMO - thoughts?

Eventdev PMDs:
  pmd.eventdev.<name>.specialization

Crypto PMDs:
  pmd.cryptodev.<name>.specialization

BBdev PMDs:
  pmd.bbdev.<name>.specialization

Busses:
  bus.<name>.specialization

Re: [dpdk-dev] Dynamic Logging Name Formatting

[Ferruh Yigit]

On 1/23/2018 5:31 PM, Van Haaren, Harry wrote:
> === Suggested Consistent Schema ===
> ===================================
> 
> Libraries:
>   lib.<name>.specialization
> 
> Net PMDs:
>   pmd.<name>.specialization
>   // one could argue consistency would be pmd.ethdev.<name>
>   // but the change is larger than the value IMO - thoughts?
> 
> Eventdev PMDs:
>   pmd.eventdev.<name>.specialization
> 
> Crypto PMDs:
>   pmd.cryptodev.<name>.specialization
> 
> BBdev PMDs:
>   pmd.bbdev.<name>.specialization
> 
> Busses:
>   bus.<name>.specialization

+1 to suggested schema, looks good to me.

Re: [dpdk-dev] Dynamic Logging Name Formatting

[Bruce Richardson]

On Tue, Jan 23, 2018 at 05:45:09PM +0000, Ferruh Yigit wrote:
> On 1/23/2018 5:31 PM, Van Haaren, Harry wrote:
> > === Suggested Consistent Schema ===
> > ===================================
> > 
> > Libraries:
> >   lib.<name>.specialization
> > 
> > Net PMDs:
> >   pmd.<name>.specialization
> >   // one could argue consistency would be pmd.ethdev.<name>
> >   // but the change is larger than the value IMO - thoughts?

pmd.net ??

> > 
> > Eventdev PMDs:
> >   pmd.eventdev.<name>.specialization
> > 
> > Crypto PMDs:
> >   pmd.cryptodev.<name>.specialization
> > 

"event" and "crypto" without the "dev" on the end, which would also
match "net" above.

> > BBdev PMDs:
> >   pmd.bbdev.<name>.specialization
> > 
> > Busses:
> >   bus.<name>.specialization
> 
> +1 to suggested schema, looks good to me.

Re: [dpdk-dev] Dynamic Logging Name Formatting

[Andrew Rybchenko]

On 01/23/2018 11:54 PM, Bruce Richardson wrote:
> On Tue, Jan 23, 2018 at 05:45:09PM +0000, Ferruh Yigit wrote:
>> On 1/23/2018 5:31 PM, Van Haaren, Harry wrote:
>>> === Suggested Consistent Schema ===
>>> ===================================
>>>
>>> Libraries:
>>>    lib.<name>.specialization
>>>
>>> Net PMDs:
>>>    pmd.<name>.specialization
>>>    // one could argue consistency would be pmd.ethdev.<name>
>>>    // but the change is larger than the value IMO - thoughts?
> pmd.net ??
>
>>> Eventdev PMDs:
>>>    pmd.eventdev.<name>.specialization
>>>
>>> Crypto PMDs:
>>>    pmd.cryptodev.<name>.specialization
>>>
> "event" and "crypto" without the "dev" on the end, which would also
> match "net" above.

I like the scheme suggested by Bruce including pmd.net. Shorter and 
consistent.

Re: [dpdk-dev] Dynamic Logging Name Formatting

[Olivier Matz]

On Wed, Jan 24, 2018 at 09:32:33AM +0300, Andrew Rybchenko wrote:
> On 01/23/2018 11:54 PM, Bruce Richardson wrote:
> > On Tue, Jan 23, 2018 at 05:45:09PM +0000, Ferruh Yigit wrote:
> > > On 1/23/2018 5:31 PM, Van Haaren, Harry wrote:
> > > > === Suggested Consistent Schema ===
> > > > ===================================
> > > > 
> > > > Libraries:
> > > >    lib.<name>.specialization
> > > > 
> > > > Net PMDs:
> > > >    pmd.<name>.specialization
> > > >    // one could argue consistency would be pmd.ethdev.<name>
> > > >    // but the change is larger than the value IMO - thoughts?
> > pmd.net ??
> > 
> > > > Eventdev PMDs:
> > > >    pmd.eventdev.<name>.specialization
> > > > 
> > > > Crypto PMDs:
> > > >    pmd.cryptodev.<name>.specialization
> > > > 
> > "event" and "crypto" without the "dev" on the end, which would also
> > match "net" above.
> 
> I like the scheme suggested by Bruce including pmd.net. Shorter and
> consistent.

Agree.

Re: [dpdk-dev] Dynamic Logging Name Formatting

[Van Haaren, Harry]

> From: Olivier Matz [mailto:olivier.matz@6wind.com]
> Sent: Wednesday, January 24, 2018 9:28 AM
> To: Andrew Rybchenko <arybchenko@solarflare.com>
> Cc: Richardson, Bruce <bruce.richardson@intel.com>; Yigit, Ferruh
> <ferruh.yigit@intel.com>; Van Haaren, Harry <harry.van.haaren@intel.com>;
> dev@dpdk.org; Ma, Liang J <liang.j.ma@intel.com>; Mccarthy, Peter
> <peter.mccarthy@intel.com>; santosh.shukla@caviumnetworks.com;
> jerin.jacob@caviumnetworks.com
> Subject: Re: [dpdk-dev] Dynamic Logging Name Formatting
> 
> On Wed, Jan 24, 2018 at 09:32:33AM +0300, Andrew Rybchenko wrote:
> > On 01/23/2018 11:54 PM, Bruce Richardson wrote:
> > > On Tue, Jan 23, 2018 at 05:45:09PM +0000, Ferruh Yigit wrote:
> > > > On 1/23/2018 5:31 PM, Van Haaren, Harry wrote:
> > > > > === Suggested Consistent Schema ===
> > > > > ===================================
> > > > >
> > > > > Libraries:
> > > > >    lib.<name>.specialization
> > > > >
> > > > > Net PMDs:
> > > > >    pmd.<name>.specialization
> > > > >    // one could argue consistency would be pmd.ethdev.<name>
> > > > >    // but the change is larger than the value IMO - thoughts?
> > > pmd.net ??
> > >
> > > > > Eventdev PMDs:
> > > > >    pmd.eventdev.<name>.specialization
> > > > >
> > > > > Crypto PMDs:
> > > > >    pmd.cryptodev.<name>.specialization
> > > > >
> > > "event" and "crypto" without the "dev" on the end, which would also
> > > match "net" above.
> >
> > I like the scheme suggested by Bruce including pmd.net. Shorter and
> > consistent.
> 
> Agree.

Thanks for feedback all, I'll send a patch to rework the existing names into the scheme as converged on here, and document the naming scheme in the docs.

Re: [dpdk-dev] Dynamic Logging Name Formatting

[Shreyansh Jain]

Hi Harry,

A trivial question(s)...

On Wednesday 24 January 2018 02:24 AM, Bruce Richardson wrote:
> On Tue, Jan 23, 2018 at 05:45:09PM +0000, Ferruh Yigit wrote:
>> On 1/23/2018 5:31 PM, Van Haaren, Harry wrote:
>>> === Suggested Consistent Schema ===
>>> ===================================
>>>
>>> Libraries:
>>>    lib.<name>.specialization
>>>
>>> Net PMDs:
>>>    pmd.<name>.specialization
>>>    // one could argue consistency would be pmd.ethdev.<name>
>>>    // but the change is larger than the value IMO - thoughts?
> 
> pmd.net ??

Just to clarify, with 'pmd.net' as fixed string, <specialization> would 
be driver name along with any meta info?

For example:

pmd.net.dpaa2
pmd.net.dpaa2.info
pmd.net.dpaa2.base

Is that right understanding?
And, for mempool I can do...

pmd.mempool.<specialization>

for example:

pmd.mempool.dpaa2
pmd.mempool.dpaa2.something

> 
>>>
>>> Eventdev PMDs:
>>>    pmd.eventdev.<name>.specialization
>>>
>>> Crypto PMDs:
>>>    pmd.cryptodev.<name>.specialization
>>>
> 
> "event" and "crypto" without the "dev" on the end, which would also
> match "net" above.
> 
>>> BBdev PMDs:
>>>    pmd.bbdev.<name>.specialization
>>>
>>> Busses:
>>>    bus.<name>.specialization
>>
>> +1 to suggested schema, looks good to me.
> 

I am working on sending out dynamic logging patches for dpaa2 within rc1 
window. I can make changes as agreed here.

Re: [dpdk-dev] Dynamic Logging Name Formatting

[Van Haaren, Harry]

> From: Shreyansh Jain [mailto:shreyansh.jain@nxp.com]
> Sent: Thursday, January 25, 2018 9:35 AM
> To: Van Haaren, Harry <harry.van.haaren@intel.com>
> Cc: Richardson, Bruce <bruce.richardson@intel.com>; Yigit, Ferruh
> <ferruh.yigit@intel.com>; olivier.matz@6wind.com; dev@dpdk.org; Ma, Liang J
> <liang.j.ma@intel.com>; Mccarthy, Peter <peter.mccarthy@intel.com>;
> santosh.shukla@caviumnetworks.com; jerin.jacob@caviumnetworks.com
> Subject: Re: Dynamic Logging Name Formatting
> 
> Hi Harry,
> 
> A trivial question(s)...
> 
> On Wednesday 24 January 2018 02:24 AM, Bruce Richardson wrote:
> > On Tue, Jan 23, 2018 at 05:45:09PM +0000, Ferruh Yigit wrote:
> >> On 1/23/2018 5:31 PM, Van Haaren, Harry wrote:
> >>> === Suggested Consistent Schema ===
> >>> ===================================
> >>>
> >>> Libraries:
> >>>    lib.<name>.specialization
> >>>
> >>> Net PMDs:
> >>>    pmd.<name>.specialization
> >>>    // one could argue consistency would be pmd.ethdev.<name>
> >>>    // but the change is larger than the value IMO - thoughts?
> >
> > pmd.net ??
> 
> Just to clarify, with 'pmd.net' as fixed string, <specialization> would
> be driver name along with any meta info?
> 
> For example:
> 
> pmd.net.dpaa2
> pmd.net.dpaa2.info
> pmd.net.dpaa2.base

Yes exactly


> Is that right understanding?
> And, for mempool I can do...
> 
> pmd.mempool.<specialization>
> 
> for example:
> 
> pmd.mempool.dpaa2
> pmd.mempool.dpaa2.something

Yep.


> >>> Eventdev PMDs:
> >>>    pmd.eventdev.<name>.specialization
> >>>
> >>> Crypto PMDs:
> >>>    pmd.cryptodev.<name>.specialization
> >>>
> >
> > "event" and "crypto" without the "dev" on the end, which would also
> > match "net" above.
> >
> >>> BBdev PMDs:
> >>>    pmd.bbdev.<name>.specialization
> >>>
> >>> Busses:
> >>>    bus.<name>.specialization
> >>
> >> +1 to suggested schema, looks good to me.
> >
> 
> I am working on sending out dynamic logging patches for dpaa2 within rc1
> window. I can make changes as agreed here.

Great!

The patchset has just been sent - so if there's any confusion you
can see the proposed docs here:
http://dpdk.org/dev/patchwork/patch/34444/