linux-kernel - Re: [PATCH 5/5] ocxl: Remove some unused exported symbols

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <1dd6d24f3ee5a2029ee6fbb2890356197e881101.camel@au1.ibm.com>
Date:   Thu, 14 Mar 2019 13:23:21 +1100
From:   "Alastair D'Silva" <alastair@....ibm.com>
To:     Greg Kurz <groug@...d.org>
Cc:     Arnd Bergmann <arnd@...db.de>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        linux-kernel@...r.kernel.org,
        Andrew Donnellan <andrew.donnellan@....ibm.com>,
        Frederic Barrat <fbarrat@...ux.ibm.com>,
        linuxppc-dev@...ts.ozlabs.org
Subject: Re: [PATCH 5/5] ocxl: Remove some unused exported symbols

On Wed, 2019-03-13 at 10:10 +0100, Greg Kurz wrote:
> On Wed, 13 Mar 2019 15:07:01 +1100
> "Alastair D'Silva" <alastair@....ibm.com> wrote:
> 
> > From: Alastair D'Silva <alastair@...ilva.org>
> > 
> > Remove some unused exported symbols.
> > 
> > Signed-off-by: Alastair D'Silva <alastair@...ilva.org>
> > ---
> >  drivers/misc/ocxl/config.c        |  2 --
> >  drivers/misc/ocxl/ocxl_internal.h | 23 +++++++++++++++++++++++
> >  include/misc/ocxl.h               | 23 -----------------------
> >  3 files changed, 23 insertions(+), 25 deletions(-)
> > 
> > diff --git a/drivers/misc/ocxl/config.c
> > b/drivers/misc/ocxl/config.c
> > index 026ac2ac4f9c..c90c2e4875bf 100644
> > --- a/drivers/misc/ocxl/config.c
> > +++ b/drivers/misc/ocxl/config.c
> > @@ -299,7 +299,6 @@ int ocxl_config_check_afu_index(struct pci_dev
> > *dev,
> >  	}
> >  	return 1;
> >  }
> > -EXPORT_SYMBOL_GPL(ocxl_config_check_afu_index);
> >  
> >  static int read_afu_name(struct pci_dev *dev, struct
> > ocxl_fn_config *fn,
> >  			struct ocxl_afu_config *afu)
> > @@ -535,7 +534,6 @@ int ocxl_config_get_pasid_info(struct pci_dev
> > *dev, int *count)
> >  {
> >  	return pnv_ocxl_get_pasid_count(dev, count);
> >  }
> > -EXPORT_SYMBOL_GPL(ocxl_config_get_pasid_info);
> >  
> >  void ocxl_config_set_afu_pasid(struct pci_dev *dev, int pos, int
> > pasid_base,
> >  			u32 pasid_count_log)
> > diff --git a/drivers/misc/ocxl/ocxl_internal.h
> > b/drivers/misc/ocxl/ocxl_internal.h
> > index 321b29e77f45..06fd98c989c8 100644
> > --- a/drivers/misc/ocxl/ocxl_internal.h
> > +++ b/drivers/misc/ocxl/ocxl_internal.h
> > @@ -107,6 +107,29 @@ void ocxl_pasid_afu_free(struct ocxl_fn *fn,
> > u32 start, u32 size);
> >  int ocxl_actag_afu_alloc(struct ocxl_fn *fn, u32 size);
> >  void ocxl_actag_afu_free(struct ocxl_fn *fn, u32 start, u32 size);
> >  
> > +/*
> > + * Get the max PASID value that can be used by the function
> > + */
> > +int ocxl_config_get_pasid_info(struct pci_dev *dev, int *count);
> > +
> > +/*
> > + * Check if an AFU index is valid for the given function.
> > + *
> > + * AFU indexes can be sparse, so a driver should check all indexes
> > up
> > + * to the maximum found in the function description
> > + */
> > +int ocxl_config_check_afu_index(struct pci_dev *dev,
> > +				struct ocxl_fn_config *fn, int
> > afu_idx);
> > +
> > +/**
> 
> Two *s ?
> 

These are Sphinx formatted comments (similar, but not quite the same as
Doxygen).

> Also, this results in an ocxl_internal.h header file where only these
> three functions are documented... which looks a bit weird IMHO. Since
> these are ocxl internals, do we _really_ need to keep the comments ?

I believe we should, it's a courtesy to the next person who has to work
in the area.

There are more documentation comments coming in further series.

-- 
Alastair D'Silva
Open Source Developer
Linux Technology Centre, IBM Australia
mob: 0423 762 819