[ovs-dev] [PATCH] ovs-numa: Add module description.

[Alex Wang]

Thx for the clarification, I'll replace the 'socket' with 'numa' and repost
the series.


On Thu, Sep 4, 2014 at 1:32 PM, Pravin Shelar <pshelar at nicira.com> wrote:

> On Thu, Sep 4, 2014 at 1:26 PM, Alex Wang <alexw at nicira.com> wrote:
> > Add a short description of the module and its assumption.
> >
> > Signed-off-by: Alex Wang <alexw at nicira.com>
> > ---
> >  lib/ovs-numa.c |   12 ++++++++++++
> >  1 file changed, 12 insertions(+)
> >
> > diff --git a/lib/ovs-numa.c b/lib/ovs-numa.c
> > index 2de2aa2..ad44d95 100644
> > --- a/lib/ovs-numa.c
> > +++ b/lib/ovs-numa.c
> > @@ -36,6 +36,18 @@
> >
> >  VLOG_DEFINE_THIS_MODULE(ovs_numa);
> >
> > +/* ovs-numa module
> > + * ===============
> > + *
> > + * This module stores the affinity information of cpu sockets and cpu
> cores.
> > + * It also provides functions to bookkeep the pin of threads on cpu
> cores.
> > + *
> > + * It is assumed that the cpu socket ids and cpu core ids all start
> from 0 and
> > + * range continuously.  So, for example, if 'ovs_numa_get_n_cores()'
> returns N,
> > + * user can assume core ids from 0 to N-1 are all valid and there is a
> > + * 'struct cpu_core' for each id.
> > + */
> > +
> >  #define MAX_CPU_SOCKETS 128
>
> numa and socket is used interchangeably in this module which is not
> always the case. Most of cases numa node is same as socket but some
> platform can have multiple socket on a numa node. We should be more
> specific and use only one term.
>