Linux Manual Pages development
 help / color / mirror / Atom feed
From: David Wragg <david-vIJKVkNGfPnYtjvyW6yDsg@public.gmane.org>
To: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
Cc: linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Subject: [PATCH] cmsg.3: ensure buf is suitably aligned in sending example
Date: Mon, 13 Oct 2014 09:14:51 +0100	[thread overview]
Message-ID: <sa7fvesqt4y.fsf@dwragg-laptop.config> (raw)

Inspection of the definition of CMSG_FIRSTHDR (both in glibc and the
suggested definition in RFC3542) shows that it yields the msg_control
field.  So when sending, the pointer placed in msg_control should be
suitably aligned as a struct cmsghdr. In the sending example, buf was
declared as a bare char array, and so is not necessarily suitably aligned.

The solution here involves placing buf inside a union, and is based on
the sockets/scm_rights_send.c sample from The Linux Programming
Interface "dist" source code collection.

Signed-off-by: David Wragg <david-vIJKVkNGfPnYtjvyW6yDsg@public.gmane.org>
---
 man3/cmsg.3 | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/man3/cmsg.3 b/man3/cmsg.3
index f355e6b..03f542e 100644
--- a/man3/cmsg.3
+++ b/man3/cmsg.3
@@ -198,11 +198,16 @@ UNIX domain socket using
 struct msghdr msg = {0};
 struct cmsghdr *cmsg;
 int myfds[NUM_FD]; /* Contains the file descriptors to pass. */
-char buf[CMSG_SPACE(sizeof myfds)];  /* ancillary data buffer */
+union {
+    /* ancillary data buffer, wrapped in a union in order to ensure it is
+       suitably aligned */
+    char buf[CMSG_SPACE(sizeof myfds)];
+    struct cmsghdr align;
+} u;
 int *fdptr;
 
-msg.msg_control = buf;
-msg.msg_controllen = sizeof buf;
+msg.msg_control = u.buf;
+msg.msg_controllen = sizeof u.buf;
 cmsg = CMSG_FIRSTHDR(&msg);
 cmsg\->cmsg_level = SOL_SOCKET;
 cmsg\->cmsg_type = SCM_RIGHTS;
-- 
1.9.3

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

             reply	other threads:[~2014-10-13  8:14 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-10-13  8:14 David Wragg [this message]
  -- strict thread matches above, loose matches on Subject: below --
2014-11-02 23:08 [PATCH] cmsg.3: ensure buf is suitably aligned in sending example David Wragg
     [not found] ` <sa7fve1i4jw.fsf-vIJKVkNGfPnYtjvyW6yDsg@public.gmane.org>
2014-11-11  9:04   ` Michael Kerrisk (man-pages)

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=sa7fvesqt4y.fsf@dwragg-laptop.config \
    --to=david-vijkvkngfpnytjvyw6ydsg@public.gmane.org \
    --cc=linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.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