From 24a31d632b2763f2792895ae34aeb51dac643b98 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Wed, 3 Feb 2016 13:10:04 +0100 Subject: [PATCH] accept.2, bind.2, connect.2, getpeername.2, getsockname.2, recv.2, recvmmsg.2, select_tut.2, send.2, sendmmsg.2, getaddrinfo.3, getnameinfo.3, epoll.7, unix.7: Use consistent argument/variable names for socket addresses and lengths As noted by Carlos, there's quite a bit of inconsistency across pages. Use 'addr' and 'addrlen' consistently in variables and function arguments. Cowritten-by: Carlos O'Donell Signed-off-by: Michael Kerrisk --- man2/recvmmsg.2 | 10 +++++----- man2/select_tut.2 | 30 +++++++++++++++--------------- man2/sendmmsg.2 | 10 +++++----- man3/getnameinfo.3 | 16 ++++++++-------- man7/epoll.7 | 2 +- man7/unix.7 | 12 ++++++------ 6 files changed, 40 insertions(+), 40 deletions(-) diff --git a/man2/recvmmsg.2 b/man2/recvmmsg.2 index a2b1f431a..9031945c3 100644 --- a/man2/recvmmsg.2 +++ b/man2/recvmmsg.2 @@ -219,7 +219,7 @@ main(void) #define BUFSIZE 200 #define TIMEOUT 1 int sockfd, retval, i; - struct sockaddr_in sa; + struct sockaddr_in addr; struct mmsghdr msgs[VLEN]; struct iovec iovecs[VLEN]; char bufs[VLEN][BUFSIZE+1]; @@ -231,10 +231,10 @@ main(void) exit(EXIT_FAILURE); } - sa.sin_family = AF_INET; - sa.sin_addr.s_addr = htonl(INADDR_LOOPBACK); - sa.sin_port = htons(1234); - if (bind(sockfd, (struct sockaddr *) &sa, sizeof(sa)) == \-1) { + addr.sin_family = AF_INET; + addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK); + addr.sin_port = htons(1234); + if (bind(sockfd, (struct sockaddr *) &addr, sizeof(addr)) == \-1) { perror("bind()"); exit(EXIT_FAILURE); } diff --git a/man2/select_tut.2 b/man2/select_tut.2 index d514ed0d5..da05a3946 100644 --- a/man2/select_tut.2 +++ b/man2/select_tut.2 @@ -553,7 +553,7 @@ static int forward_port; static int listen_socket(int listen_port) { - struct sockaddr_in a; + struct sockaddr_in addr; int s; int yes; @@ -569,10 +569,10 @@ listen_socket(int listen_port) close(s); return \-1; } - memset(&a, 0, sizeof(a)); - a.sin_port = htons(listen_port); - a.sin_family = AF_INET; - if (bind(s, (struct sockaddr *) &a, sizeof(a)) == \-1) { + memset(&addr, 0, sizeof(addr)); + addr.sin_port = htons(listen_port); + addr.sin_family = AF_INET; + if (bind(s, (struct sockaddr *) &addr, sizeof(addr)) == \-1) { perror("bind"); close(s); return \-1; @@ -585,7 +585,7 @@ listen_socket(int listen_port) static int connect_socket(int connect_port, char *address) { - struct sockaddr_in a; + struct sockaddr_in addr; int s; s = socket(AF_INET, SOCK_STREAM, 0); @@ -595,17 +595,17 @@ connect_socket(int connect_port, char *address) return \-1; } - memset(&a, 0, sizeof(a)); - a.sin_port = htons(connect_port); - a.sin_family = AF_INET; + memset(&addr, 0, sizeof(addr)); + addr.sin_port = htons(connect_port); + addr.sin_family = AF_INET; - if (!inet_aton(address, (struct in_addr *) &a.sin_addr.s_addr)) { + if (!inet_aton(address, (struct in_addr *) &addr.sin_addr.s_addr)) { perror("bad IP address format"); close(s); return \-1; } - if (connect(s, (struct sockaddr *) &a, sizeof(a)) == \-1) { + if (connect(s, (struct sockaddr *) &addr, sizeof(addr)) == \-1) { perror("connect()"); shutdown(s, SHUT_RDWR); close(s); @@ -701,10 +701,10 @@ main(int argc, char *argv[]) if (FD_ISSET(h, &rd)) { unsigned int l; - struct sockaddr_in client_address; + struct sockaddr_in client_addr; - memset(&client_address, 0, l = sizeof(client_address)); - r = accept(h, (struct sockaddr *) &client_address, &l); + memset(&client_addr, 0, l = sizeof(client_addr)); + r = accept(h, (struct sockaddr *) &client_addr, &l); if (r == \-1) { perror("accept()"); } else { @@ -718,7 +718,7 @@ main(int argc, char *argv[]) SHUT_FD1; else printf("connect from %s\\n", - inet_ntoa(client_address.sin_addr)); + inet_ntoa(client_addr.sin_addr)); } } diff --git a/man2/sendmmsg.2 b/man2/sendmmsg.2 index cd5ce6694..e4974d941 100644 --- a/man2/sendmmsg.2 +++ b/man2/sendmmsg.2 @@ -188,7 +188,7 @@ int main(void) { int sockfd; - struct sockaddr_in sa; + struct sockaddr_in addr; struct mmsghdr msg[2]; struct iovec msg1[2], msg2; int retval; @@ -199,10 +199,10 @@ main(void) exit(EXIT_FAILURE); } - sa.sin_family = AF_INET; - sa.sin_addr.s_addr = htonl(INADDR_LOOPBACK); - sa.sin_port = htons(1234); - if (connect(sockfd, (struct sockaddr *) &sa, sizeof(sa)) == \-1) { + addr.sin_family = AF_INET; + addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK); + addr.sin_port = htons(1234); + if (connect(sockfd, (struct sockaddr *) &addr, sizeof(addr)) == \-1) { perror("connect()"); exit(EXIT_FAILURE); } diff --git a/man3/getnameinfo.3 b/man3/getnameinfo.3 index 0dc1d29f8..91473c298 100644 --- a/man3/getnameinfo.3 +++ b/man3/getnameinfo.3 @@ -15,7 +15,7 @@ getnameinfo \- address-to-name translation in protocol-independent manner .B #include .B #include .sp -.BI "int getnameinfo(const struct sockaddr *" "sa" ", socklen_t " "salen" , +.BI "int getnameinfo(const struct sockaddr *" "addr" ", socklen_t " "addrlen" , .BI " char *" "host" ", socklen_t " "hostlen" , .BI " char *" "serv" ", socklen_t " "servlen" ", int " "flags" ); .fi @@ -53,7 +53,7 @@ argument is a pointer to a generic socket address structure or .IR sockaddr_in6 ) of size -.I salen +.I addrlen that holds the input IP address and port number. The arguments .I host @@ -261,11 +261,11 @@ a particular address family. .in +4n .nf -struct sockaddr *sa; /* input */ -socklen_t len; /* input */ +struct sockaddr *addr; /* input */ +socklen_t addrlen; /* input */ char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV]; -if (getnameinfo(sa, len, hbuf, sizeof(hbuf), sbuf, +if (getnameinfo(addr, addrlen, hbuf, sizeof(hbuf), sbuf, sizeof(sbuf), NI_NUMERICHOST | NI_NUMERICSERV) == 0) printf("host=%s, serv=%s\en", hbuf, sbuf); .fi @@ -276,11 +276,11 @@ reverse address mapping. .in +4n .nf -struct sockaddr *sa; /* input */ -socklen_t len; /* input */ +struct sockaddr *addr; /* input */ +socklen_t addrlen; /* input */ char hbuf[NI_MAXHOST]; -if (getnameinfo(sa, len, hbuf, sizeof(hbuf), +if (getnameinfo(addr, addrlen, hbuf, sizeof(hbuf), NULL, 0, NI_NAMEREQD)) printf("could not resolve hostname"); else diff --git a/man7/epoll.7 b/man7/epoll.7 index ddc6f1ad2..94be6ed34 100644 --- a/man7/epoll.7 +++ b/man7/epoll.7 @@ -288,7 +288,7 @@ for (;;) { for (n = 0; n < nfds; ++n) { if (events[n].data.fd == listen_sock) { conn_sock = accept(listen_sock, - (struct sockaddr *) &local, &addrlen); + (struct sockaddr *) &addr, &addrlen); if (conn_sock == \-1) { perror("accept"); exit(EXIT_FAILURE); diff --git a/man7/unix.7 b/man7/unix.7 index e06934851..94d921053 100644 --- a/man7/unix.7 +++ b/man7/unix.7 @@ -817,7 +817,7 @@ main(int argc, char *argv[]) int main(int argc, char *argv[]) { - struct sockaddr_un name; + struct sockaddr_un addr; int i; int ret; int data_socket; @@ -837,14 +837,14 @@ main(int argc, char *argv[]) * the structure. */ - memset(&name, 0, sizeof(struct sockaddr_un)); + memset(&addr, 0, sizeof(struct sockaddr_un)); - /* Connect socket to socket name. */ + /* Connect socket to socket address */ - name.sun_family = AF_UNIX; - strncpy(name.sun_path, SOCKET_NAME, sizeof(name.sun_path) \- 1); + addr.sun_family = AF_UNIX; + strncpy(addr.sun_path, SOCKET_NAME, sizeof(addr.sun_path) \- 1); - ret = connect (data_socket, (const struct sockaddr *) &name, + ret = connect (data_socket, (const struct sockaddr *) &addr, sizeof(struct sockaddr_un)); if (ret == \-1) { fprintf(stderr, "The server is down.\\n");