mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Benedikt Spranger <b.spranger@linutronix.de>
To: linux-kernel@vger.kernel.org
Cc: hjk@hansjkoch.de, gregkh@linuxfoundation.org,
	Alexander.Frank@eberspaecher.com,
	Benedikt Spranger <b.spranger@linutronix.de>
Subject: [PATCH 1/2] uio: add warning to documentation
Date: Wed, 12 Dec 2012 00:12:01 +0100	[thread overview]
Message-ID: <1355267523-19724-2-git-send-email-b.spranger@linutronix.de> (raw)
In-Reply-To: <1355267523-19724-1-git-send-email-b.spranger@linutronix.de>

The documentation has no clear statement to the POSIX 1003.1 mmap()
feature, wich allows open(), mmap(), close() while the mmaped pointer is valid.
The release() hook inveigled driver programmer to activate owermanagement
functuonality in the release hook. This may harm.

Signed-off-by: Benedikt Spranger <b.spranger@linutronix.de>
---
 Documentation/DocBook/uio-howto.tmpl |    7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/Documentation/DocBook/uio-howto.tmpl b/Documentation/DocBook/uio-howto.tmpl
index ac3d001..59a886d 100644
--- a/Documentation/DocBook/uio-howto.tmpl
+++ b/Documentation/DocBook/uio-howto.tmpl
@@ -499,8 +499,13 @@ device is actually used.
 <listitem><para>
 <varname>int (*release)(struct uio_info *info, struct inode *inode)
 </varname>: Optional. If you define your own
-<function>open()</function>, you will probably also want a custom
+<function>release()</function>, you will probably also want a custom
 <function>release()</function> function.
+</para><para>CAVE: The release hook may be processed, even if a mmap is aktive.
+Disabling clocks or other powermanagement functionality may cause a system
+crash, hangup or other unwanted sideeffects.
+</para><para><emphasis>The mmap() function shall add an extra reference to the file associated with the file descriptor fildes which is not removed by a subsequent close() on that file descriptor. This reference shall be removed when there are no more mappings to the file.</emphasis></para><para>
+<link xlink:href="http://pubs.opengroup.org/onlinepubs/009695399/functions/mmap.html">IEEE Std 1003.1, 2004 Edition, mmap()</link>
 </para></listitem>
 
 <listitem><para>
-- 
1.7.10.4


  reply	other threads:[~2012-12-11 23:12 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-12-11 23:12 [PATCH 0/2] uio: open(), mmap(), close() Benedikt Spranger
2012-12-11 23:12 ` Benedikt Spranger [this message]
2012-12-11 23:18   ` [PATCH 1/2] uio: add warning to documentation Greg KH
2012-12-12  0:45     ` Benedikt Spranger
2012-12-12  4:49       ` Greg KH
2012-12-12  1:56     ` Hans J. Koch
2012-12-12  4:47       ` Greg KH
2012-12-11 23:12 ` [PATCH 2/2] uio: do not expose inode to uio open/release hooks Benedikt Spranger
2012-12-11 23:20   ` Greg KH
2012-12-12  1:42     ` Hans J. Koch
2012-12-12  4:46       ` Greg KH
2012-12-12  8:50         ` Hans J. Koch
2012-12-12  8:56           ` Benedikt Spranger
2012-12-12 15:08             ` Greg KH
2012-12-13  0:08               ` Hans J. Koch
2012-12-13  0:15                 ` Greg KH

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1355267523-19724-2-git-send-email-b.spranger@linutronix.de \
    --to=b.spranger@linutronix.de \
    --cc=Alexander.Frank@eberspaecher.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=hjk@hansjkoch.de \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®