Coverity fixes for vchan-socket-proxy
cover Coverity fixes for vchan-socket-proxy
This series addresses some Coverity reports. To handle closing FDs, a state struct is introduced to track FDs closed in both main() and data_loop().
Jason Andryuk (8):
vchan-socket-proxy: Ensure UNIX path NUL terminated
vchan-socket-proxy: Check xs_watch return value
vchan-socket-proxy: Unify main return value
vchan-socket-proxy: Use a struct to store state
vchan-socket-proxy: Switch data_loop() to take state
vchan-socket-proxy: Set closed FDs to -1
vchan-socket-proxy: Cleanup resources on exit
vchan-socket-proxy: Handle closing shared input/output_fd
tools/libvchan/vchan-socket-proxy.c | 164 ++++++++++++++++++---------- 1 file changed, 106 insertions(+), 58 deletions(-)
Signature · 1 line
2.25.1
PATCH 1/8 vchan-socket-proxy: Ensure UNIX path NUL terminated
Check the socket path length to ensure sun_path is NUL terminated.
This was spotted by Citrix's Coverity.
--- tools/libvchan/vchan-socket-proxy.c | 12 ++++++++++++ 1 file changed, 12 insertions(+)
tools/libvchan/vchan-socket-proxy.c +12 -0
@@ -148,6 +148,12 @@ static int connect_socket(const char *path_or_fd) {return fd; } +if (strlen (path_or_fd) >=sizeof (addr.sun_path)) { +fprintf (stderr,"UNIX socket path \"%s\" too long (%zd >= %zd)\n" , + path_or_fd,strlen (path_or_fd),sizeof (addr.sun_path)); +return -1 ; + } + fd =socket (AF_UNIX ,SOCK_STREAM ,0 );if (fd ==-1 )return -1 ;
@@ -174,6 +180,12 @@ static int listen_socket(const char *path_or_fd) {return fd; } +if (strlen (path_or_fd) >=sizeof (addr.sun_path)) { +fprintf (stderr,"UNIX socket path \"%s\" too long (%zd >= %zd)\n" , + path_or_fd,strlen (path_or_fd),sizeof (addr.sun_path)); +return -1 ; + } +/* if not a number, assume a socket path */ fd =socket (AF_UNIX ,SOCK_STREAM ,0 );if (fd ==-1 )
Signature · 1 line
2.25.1
Re: [PATCH 1/8] vchan-socket-proxy: Ensure UNIX path NUL terminated
Quoted 5 lines · Jason Andryuk
Check the socket path length to ensure
sun_pathis NUL terminated.This was spotted by Citrix's Coverity.
Signed-off-by Jason Andryuk <[email protected]>
Quoted 34 lines
--- tools/libvchan/vchan-socket-proxy.c | 12 ++++++++++++ 1 file changed, 12 insertions(+)tools/libvchan/vchan-socket-proxy.c +12
-0@@ -148,6 +148,12 @@ static int connect_socket(const char *path_or_fd) {return fd; } +if (strlen (path_or_fd) >=sizeof (addr.sun_path)) { +fprintf (stderr,"UNIX socket path \"%s\" too long (%zd >= %zd)\n" , + path_or_fd,strlen (path_or_fd),sizeof (addr.sun_path)); +return -1 ; + } + fd =socket (AF_UNIX ,SOCK_STREAM ,0 );if (fd ==-1 )return -1 ;@@ -174,6 +180,12 @@ static int listen_socket(const char *path_or_fd) {return fd; } +if (strlen (path_or_fd) >=sizeof (addr.sun_path)) { +fprintf (stderr,"UNIX socket path \"%s\" too long (%zd >= %zd)\n" , + path_or_fd,strlen (path_or_fd),sizeof (addr.sun_path)); +return -1 ; + } +/* if not a number, assume a socket path */ fd =socket (AF_UNIX ,SOCK_STREAM ,0 );if (fd ==-1 )
Signature · 5 lines
Best Regards, Marek Marczykowski-Górecki Invisible Things Lab A: Because it messes up the order in which people normally read text. Q: Why is top-posting such a bad thing?
PATCH 2/8 vchan-socket-proxy: Check xs_watch return value
In reply to Jason AndryukCheck the return value of xs_watch and error out on failure.
This was found by Citrix's Coverity.
--- tools/libvchan/vchan-socket-proxy.c | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-)
tools/libvchan/vchan-socket-proxy.c +9 -2
@@ -225,8 +225,15 @@ static struct libxenvchan *connect_vchan(int domid, const char *path) { goto out; }/* wait for vchan server to create *path* */ -xs_watch (xs, path,"path" ); -xs_watch (xs,"@releaseDomain" ,"release" ); +if (!xs_watch (xs, path,"path" )) { +fprintf (stderr,"xs_watch(%s) failed.\n" , path); + goto out; + } +if (!xs_watch (xs,"@releaseDomain" ,"release" )) { +fprintf (stderr,"xs_watch(@releaseDomain failed.\n" ); + goto out; + } +while ((watch_ret =xs_read_watch (xs, &watch_num))) {/* don't care about exact which fired the watch */ free (watch_ret);
Signature · 1 line
2.25.1
PATCH 3/8 vchan-socket-proxy: Unify main return value
In reply to Jason AndryukIntroduce 'ret' for main's return value and remove direct returns. This is in preparation for a unified exit path with resource cleanup.
--- tools/libvchan/vchan-socket-proxy.c | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-)
tools/libvchan/vchan-socket-proxy.c +11 -4
@@ -381,6 +381,7 @@ int main(int argc, char **argv)const char *vchan_path;const char *state_path =NULL ;int opt; +int ret;while ((opt =getopt_long (argc, argv,"m:vs:" , options,NULL )) !=-1 ) {switch (opt) {
@@ -447,6 +448,8 @@ int main(int argc, char **argv)xs_close (xs); } + ret =0 ; +for (;;) {if (is_server) {/* wait for vchan connection */
@@ -461,7 +464,8 @@ int main(int argc, char **argv) }if (input_fd ==-1 ) {perror ("connect socket" ); -return 1 ; + ret =1 ; +break ; }if (data_loop (ctrl, input_fd, output_fd) !=0 )break ;
@@ -474,14 +478,16 @@ int main(int argc, char **argv) input_fd = output_fd =accept (socket_fd,NULL ,NULL );if (input_fd ==-1 ) {perror ("accept" ); -return 1 ; + ret =1 ; +break ; }set_nonblocking (input_fd,1 );set_nonblocking (output_fd,1 ); ctrl =connect_vchan (domid, vchan_path);if (!ctrl) {perror ("vchan client init" ); -return 1 ; + ret =1 ; +break ; }if (data_loop (ctrl, input_fd, output_fd) !=0 )break ;
@@ -493,5 +499,6 @@ int main(int argc, char **argv) ctrl =NULL ; } } -return 0 ; + +return ret; }
Signature · 1 line
2.25.1
PATCH 4/8 vchan-socket-proxy: Use a struct to store state
In reply to Jason AndryukUse a struct to group the vchan ctrl and FDs. This will facilite tracking the state of open and closed FDs and ctrl in data_loop().
--- tools/libvchan/vchan-socket-proxy.c | 52 +++++++++++++++++------------ 1 file changed, 30 insertions(+), 22 deletions(-)
tools/libvchan/vchan-socket-proxy.c +30 -22
@@ -89,6 +89,12 @@ int insiz = 0;int outsiz =0 ;int verbose =0 ; +struct vchan_proxy_state { +struct libxenvchan *ctrl; +int output_fd; +int input_fd; +}; +static void vchan_wr (struct libxenvchan *ctrl) {int ret;
@@ -374,8 +380,9 @@ int main(int argc, char **argv) {int is_server =0 ;int socket_fd =-1 ; -int input_fd, output_fd; -struct libxenvchan *ctrl =NULL ; +struct vchan_proxy_state state = { .ctrl =NULL , + .input_fd =-1 , + .output_fd =-1 };const char *socket_path;int domid;const char *vchan_path;
@@ -415,15 +422,15 @@ int main(int argc, char **argv) socket_path = argv[optind+2 ];if (is_server) { - ctrl =libxenvchan_server_init (NULL , domid, vchan_path,0 ,0 ); -if (!ctrl) { + state.ctrl =libxenvchan_server_init (NULL , domid, vchan_path,0 ,0 ); +if (!state.ctrl) {perror ("libxenvchan_server_init" );exit (1 ); } }else {if (strcmp (socket_path,"-" ) ==0 ) { - input_fd =0 ; - output_fd =1 ; + state.input_fd =0 ; + state.output_fd =1 ; }else { socket_fd =listen_socket (socket_path);if (socket_fd ==-1 ) {
@@ -453,21 +460,21 @@ int main(int argc, char **argv)for (;;) {if (is_server) {/* wait for vchan connection */ -while (libxenvchan_is_open (ctrl) !=1 ) -libxenvchan_wait (ctrl); +while (libxenvchan_is_open (state.ctrl) !=1 ) +libxenvchan_wait (state.ctrl);/* vchan client connected, setup local FD if needed */ if (strcmp (socket_path,"-" ) ==0 ) { - input_fd =0 ; - output_fd =1 ; + state.input_fd =0 ; + state.output_fd =1 ; }else { - input_fd = output_fd =connect_socket (socket_path); + state.input_fd = state.output_fd =connect_socket (socket_path); } -if (input_fd ==-1 ) { +if (state.input_fd ==-1 ) {perror ("connect socket" ); ret =1 ;break ; } -if (data_loop (ctrl, input_fd, output_fd) !=0 ) +if (data_loop (state.ctrl, state.input_fd, state.output_fd) !=0 )break ;/* keep it running only when get UNIX socket path */ if (socket_path[0 ] !='/' )
@@ -475,28 +482,29 @@ int main(int argc, char **argv) }else {/* wait for local socket connection */ if (strcmp (socket_path,"-" ) !=0 ) - input_fd = output_fd =accept (socket_fd,NULL ,NULL ); -if (input_fd ==-1 ) { + state.input_fd = state.output_fd =accept (socket_fd, +NULL ,NULL ); +if (state.input_fd ==-1 ) {perror ("accept" ); ret =1 ;break ; } -set_nonblocking (input_fd,1 ); -set_nonblocking (output_fd,1 ); - ctrl =connect_vchan (domid, vchan_path); -if (!ctrl) { +set_nonblocking (state.input_fd,1 ); +set_nonblocking (state.output_fd,1 ); + state.ctrl =connect_vchan (domid, vchan_path); +if (!state.ctrl) {perror ("vchan client init" ); ret =1 ;break ; } -if (data_loop (ctrl, input_fd, output_fd) !=0 ) +if (data_loop (state.ctrl, state.input_fd, state.output_fd) !=0 )break ;/* don't reconnect if output was stdout */ if (strcmp (socket_path,"-" ) ==0 )break ; -libxenvchan_close (ctrl); - ctrl =NULL ; +libxenvchan_close (state.ctrl); + state.ctrl =NULL ; } }
Signature · 1 line
2.25.1
PATCH 5/8 vchan-socket-proxy: Switch data_loop() to take state
In reply to Jason AndryukSwitch data_loop to take a pointer to vchan_proxy_state.
No functional change.
This removes a dead store to input_fd identified by Coverity.
--- tools/libvchan/vchan-socket-proxy.c | 65 +++++++++++++++-------------- 1 file changed, 33 insertions(+), 32 deletions(-)
tools/libvchan/vchan-socket-proxy.c +33 -32
@@ -279,13 +279,13 @@ static void discard_buffers(struct libxenvchan *ctrl) { } } -int data_loop (struct libxenvchan *ctrl,int input_fd,int output_fd) +int data_loop (struct vchan_proxy_state *state) {int ret;int libxenvchan_fd;int max_fd; - libxenvchan_fd =libxenvchan_fd_for_select (ctrl); + libxenvchan_fd =libxenvchan_fd_for_select (state->ctrl);for (;;) {fd_set rfds;fd_set wfds;
@@ -293,15 +293,15 @@ int data_loop(struct libxenvchan *ctrl, int input_fd, int output_fd)FD_ZERO (&wfds); max_fd =-1 ; -if (input_fd !=-1 && insiz !=BUFSIZE ) { -FD_SET (input_fd, &rfds); -if (input_fd > max_fd) - max_fd = input_fd; +if (state->input_fd !=-1 && insiz !=BUFSIZE ) { +FD_SET (state->input_fd, &rfds); +if (state->input_fd > max_fd) + max_fd = state->input_fd; } -if (output_fd !=-1 && outsiz) { -FD_SET (output_fd, &wfds); -if (output_fd > max_fd) - max_fd = output_fd; +if (state->output_fd !=-1 && outsiz) { +FD_SET (state->output_fd, &wfds); +if (state->output_fd > max_fd) + max_fd = state->output_fd; }FD_SET (libxenvchan_fd, &rfds);if (libxenvchan_fd > max_fd)
@@ -312,52 +312,53 @@ int data_loop(struct libxenvchan *ctrl, int input_fd, int output_fd)exit (1 ); }if (FD_ISSET (libxenvchan_fd, &rfds)) { -libxenvchan_wait (ctrl); -if (!libxenvchan_is_open (ctrl)) { +libxenvchan_wait (state->ctrl); +if (!libxenvchan_is_open (state->ctrl)) {if (verbose)fprintf (stderr,"vchan client disconnected\n" );while (outsiz) -socket_wr (output_fd); -close (output_fd); -close (input_fd); -discard_buffers (ctrl); +socket_wr (state->output_fd); +close (state->output_fd); +close (state->input_fd); +discard_buffers (state->ctrl);break ; } -vchan_wr (ctrl); +vchan_wr (state->ctrl); } -if (FD_ISSET (input_fd, &rfds)) { - ret =read (input_fd, inbuf + insiz,BUFSIZE - insiz); +if (FD_ISSET (state->input_fd, &rfds)) { + ret =read (state->input_fd, inbuf + insiz,BUFSIZE - insiz);if (ret <0 && errno !=EAGAIN )exit (1 );if (verbose)fprintf (stderr,"from-unix: %.*s\n" , ret, inbuf + insiz);if (ret ==0 ) {/* EOF on socket, write everything in the buffer and close the -* input_fd socket */ +* state->input_fd socket */ while (insiz) { -vchan_wr (ctrl); -libxenvchan_wait (ctrl); +vchan_wr (state->ctrl); +libxenvchan_wait (state->ctrl); } -close (input_fd); - input_fd =-1 ; +close (state->input_fd); + state->input_fd =-1 ;/* TODO: maybe signal the vchan client somehow? */ break ; }if (ret) insiz += ret; -vchan_wr (ctrl); +vchan_wr (state->ctrl); } -if (FD_ISSET (output_fd, &wfds)) -socket_wr (output_fd); -while (libxenvchan_data_ready (ctrl) && outsiz <BUFSIZE ) { - ret =libxenvchan_read (ctrl, outbuf + outsiz,BUFSIZE - outsiz); +if (FD_ISSET (state->output_fd, &wfds)) +socket_wr (state->output_fd); +while (libxenvchan_data_ready (state->ctrl) && outsiz <BUFSIZE ) { + ret =libxenvchan_read (state->ctrl, outbuf + outsiz, +BUFSIZE - outsiz);if (ret <0 )exit (1 );if (verbose)fprintf (stderr,"from-vchan: %.*s\n" , ret, outbuf + outsiz); outsiz += ret; -socket_wr (output_fd); +socket_wr (state->output_fd); } }return 0 ;
@@ -474,7 +475,7 @@ int main(int argc, char **argv) ret =1 ;break ; } -if (data_loop (state.ctrl, state.input_fd, state.output_fd) !=0 ) +if (data_loop (&state) !=0 )break ;/* keep it running only when get UNIX socket path */ if (socket_path[0 ] !='/' )
@@ -497,7 +498,7 @@ int main(int argc, char **argv) ret =1 ;break ; } -if (data_loop (state.ctrl, state.input_fd, state.output_fd) !=0 ) +if (data_loop (&state) !=0 )break ;/* don't reconnect if output was stdout */ if (strcmp (socket_path,"-" ) ==0 )
Signature · 1 line
2.25.1
PATCH 6/8 vchan-socket-proxy: Set closed FDs to -1
In reply to Jason AndryukThese FDs are closed, so set them to -1 so they are no longer valid.
--- tools/libvchan/vchan-socket-proxy.c | 2 ++ 1 file changed, 2 insertions(+)
tools/libvchan/vchan-socket-proxy.c +2 -0
@@ -319,7 +319,9 @@ int data_loop(struct vchan_proxy_state *state)while (outsiz)socket_wr (state->output_fd);close (state->output_fd); + state->output_fd =-1 ;close (state->input_fd); + state->input_fd =-1 ;discard_buffers (state->ctrl);break ; }
Signature · 1 line
2.25.1
PATCH 7/8 vchan-socket-proxy: Cleanup resources on exit
In reply to Jason AndryukClose open FDs and close th vchan connection when exiting the program.
This addresses some Coverity findings about leaking file descriptors.
--- tools/libvchan/vchan-socket-proxy.c | 9 +++++++++ 1 file changed, 9 insertions(+)
tools/libvchan/vchan-socket-proxy.c +9 -0
@@ -511,5 +511,14 @@ int main(int argc, char **argv) } } +if (state.output_fd >=0 ) +close (state.output_fd); +if (state.input_fd >=0 ) +close (state.input_fd); +if (state.ctrl) +libxenvchan_close (state.ctrl); +if (socket_fd >=0 ) +close (socket_fd); +return ret; }
Signature · 1 line
2.25.1
PATCH 8/8 vchan-socket-proxy: Handle closing shared input/output_fd
In reply to Jason Andryukinput_fd & output_fd may be the same FD. In that case, mark both as -1 when closing one. That avoids a dangling FD reference.
--- tools/libvchan/vchan-socket-proxy.c | 2 ++ 1 file changed, 2 insertions(+)
tools/libvchan/vchan-socket-proxy.c +2 -0
@@ -342,6 +342,8 @@ int data_loop(struct vchan_proxy_state *state)libxenvchan_wait (state->ctrl); }close (state->input_fd); +if (state->input_fd == state->output_fd) + state->output_fd =-1 ; state->input_fd =-1 ;/* TODO: maybe signal the vchan client somehow? */ break ;
Signature · 1 line
2.25.1
Quoted 4 lines · Jason Andryuk
This series addresses some Coverity reports. To handle closing FDs, a state struct is introduced to track FDs closed in both
main()anddata_loop().
I've realized the changes here are insufficient to handle the FD leaks. That is, the accept()-ed FDs need to be closed inside the for loop so they aren't leaked with each iteration. I'll re-work for a v2.
-Jason
Quoted 11 lines · Jason Andryuk
Quoted 4 lines · Jason Andryuk
This series addresses some Coverity reports. To handle closing FDs, a state struct is introduced to track FDs closed in both
main()anddata_loop().I've realized the changes here are insufficient to handle the FD leaks. That is, the accept()-ed FDs need to be closed inside the for loop so they aren't leaked with each iteration. I'll re-work for a v2.
So it turns out this series doesn't leak FDs in the for loop. FDs are necessarily closed down in data_loop() when the read() returns 0. The only returns from data_loop() are after the FDs have been closed. data_loop() and some of the functions it calls will call exit(1) on error, but that won't leak FDs.
Please review this series. Sorry for the confusion.
Regards,
Jason
Marek Marczykowski-Górecki
Reviewed-byQuoted 13 lines · Jason Andryuk
Quoted 11 lines · Jason Andryuk
Quoted 4 lines · Jason Andryuk
This series addresses some Coverity reports. To handle closing FDs, a state struct is introduced to track FDs closed in both
main()anddata_loop().I've realized the changes here are insufficient to handle the FD leaks. That is, the accept()-ed FDs need to be closed inside the for loop so they aren't leaked with each iteration. I'll re-work for a v2.
Quoted 7 lines
So it turns out this series doesn't leak FDs in the for loop. FDs are necessarily closed down in
data_loop()when theread()returns 0. The only returns fromdata_loop()are after the FDs have been closed.data_loop()and some of the functions it calls will call exit(1) on error, but that won't leak FDs.Please review this series. Sorry for the confusion.
For the whole series:
Signature · 5 lines
Best Regards, Marek Marczykowski-Górecki Invisible Things Lab A: Because it messes up the order in which people normally read text. Q: Why is top-posting such a bad thing?
Quoted 21 lines · Marek Marczykowski-Górecki
Quoted 19 lines · Jason Andryuk
Quoted 11 lines · Jason Andryuk
Quoted 4 lines · Jason Andryuk
This series addresses some Coverity reports. To handle closing FDs, a state struct is introduced to track FDs closed in both
main()anddata_loop().I've realized the changes here are insufficient to handle the FD leaks. That is, the accept()-ed FDs need to be closed inside the for loop so they aren't leaked with each iteration. I'll re-work for a v2.
So it turns out this series doesn't leak FDs in the for loop. FDs are necessarily closed down in
data_loop()when theread()returns 0. The only returns fromdata_loop()are after the FDs have been closed.data_loop()and some of the functions it calls will call exit(1) on error, but that won't leak FDs.
Quoted 5 lines
Quoted 1 line
Please review this series. Sorry for the confusion.
For the whole series:
Reviewed-by Marek Marczykowski-Górecki <[email protected]>
Thanks for the review. Sorry for forgetting to CC you on this series and the v2 posted on Jun 10th as well. For v2, patch 1 now also changes strncpy to strcpy to avoid a gcc-10 warning reported by Olaf Hering. Patches 2 & 3 are new to move some perror calls. v1 patches 2-8 shifted to 4-10 in v2, but are unchanged.
Thanks,
Jason