1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 3 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <libtest/common.h>
25 using namespace libtest
;
38 #include <sys/types.h>
42 static char **environ
= NULL
;
46 static int exited_successfully(int status
)
53 if (WIFEXITED(status
) == true)
55 return WEXITSTATUS(status
);
57 else if (WIFSIGNALED(status
) == true)
59 return WTERMSIG(status
);
68 std::string
print_argv(char * * & built_argv
, const size_t& argc
)
70 std::stringstream arg_buffer
;
72 for (size_t x
= 0; x
< argc
; x
++)
74 arg_buffer
<< built_argv
[x
] << " ";
77 return arg_buffer
.str();
80 std::string
print_argv(char** argv
)
82 std::stringstream arg_buffer
;
84 for (char** ptr
= argv
; *ptr
; ptr
++)
86 arg_buffer
<< *ptr
<< " ";
89 return arg_buffer
.str();
92 static Application::error_t
int_to_error_t(int arg
)
97 return Application::INVALID
;
100 return Application::SUCCESS
;
104 return Application::FAILURE
;
111 Application::Application(const std::string
& arg
, const bool _use_libtool_arg
) :
112 _use_libtool(_use_libtool_arg
),
113 _use_valgrind(false),
115 _use_ptrcheck(false),
118 stdin_fd(STDIN_FILENO
),
119 stdout_fd(STDOUT_FILENO
),
120 stderr_fd(STDERR_FILENO
),
126 if (libtool() == NULL
)
128 fatal_message("libtool requested, but know libtool was found");
132 // Find just the name of the application with no path
134 size_t found
= arg
.find_last_of("/\\");
137 _exectuble_name
= arg
.substr(found
+1);
141 _exectuble_name
= arg
;
145 if (_use_libtool
and getenv("PWD"))
147 _exectuble_with_path
+= getenv("PWD");
148 _exectuble_with_path
+= "/";
150 _exectuble_with_path
+= _exectuble
;
153 Application::~Application()
159 Application::error_t
Application::run(const char *args
[])
164 _stdout_buffer
.clear();
165 _stderr_buffer
.clear();
167 posix_spawn_file_actions_t file_actions
;
168 posix_spawn_file_actions_init(&file_actions
);
170 stdin_fd
.dup_for_spawn(Application::Pipe::READ
, file_actions
);
171 stdout_fd
.dup_for_spawn(Application::Pipe::WRITE
, file_actions
);
172 stderr_fd
.dup_for_spawn(Application::Pipe::WRITE
, file_actions
);
174 posix_spawnattr_t spawnattr
;
175 posix_spawnattr_init(&spawnattr
);
179 fatal_assert(posix_spawnattr_setsigmask(&spawnattr
, &set
) == 0);
186 std::string gdb_run_file
= create_tmpfile(_exectuble_name
);
187 std::fstream file_stream
;
188 file_stream
.open(gdb_run_file
.c_str(), std::fstream::out
| std::fstream::trunc
);
190 _gdb_filename
= create_tmpfile(_exectuble_name
);
192 << "set logging redirect on" << std::endl
193 << "set logging file " << _gdb_filename
<< std::endl
194 << "set logging overwrite on" << std::endl
195 << "set logging on" << std::endl
196 << "set environment LIBTEST_IN_GDB=1" << std::endl
197 << "run " << arguments() << std::endl
198 << "thread apply all bt" << std::endl
199 << "quit" << std::endl
;
201 fatal_assert(file_stream
.good());
206 // libtool --mode=execute gdb -f -x binary
208 const_cast<char *>(libtool()),
209 const_cast<char *>("--mode=execute"),
210 const_cast<char *>("gdb"),
211 const_cast<char *>("-batch"),
212 const_cast<char *>("-f"),
213 const_cast<char *>("-x"),
214 const_cast<char *>(gdb_run_file
.c_str()),
215 const_cast<char *>(_exectuble_with_path
.c_str()),
218 spawn_ret
= posix_spawnp(&_pid
, libtool(), &file_actions
, &spawnattr
, argv
, environ
);
224 const_cast<char *>("gdb"),
225 const_cast<char *>("-batch"),
226 const_cast<char *>("-f"),
227 const_cast<char *>("-x"),
228 const_cast<char *>(gdb_run_file
.c_str()),
229 const_cast<char *>(_exectuble_with_path
.c_str()),
231 spawn_ret
= posix_spawnp(&_pid
, "gdb", &file_actions
, &spawnattr
, argv
, environ
);
238 spawn_ret
= posix_spawn(&_pid
, built_argv
[0], &file_actions
, &spawnattr
, built_argv
, NULL
);
242 spawn_ret
= posix_spawnp(&_pid
, built_argv
[0], &file_actions
, &spawnattr
, built_argv
, NULL
);
246 posix_spawn_file_actions_destroy(&file_actions
);
247 posix_spawnattr_destroy(&spawnattr
);
249 stdin_fd
.close(Application::Pipe::READ
);
250 stdout_fd
.close(Application::Pipe::WRITE
);
251 stderr_fd
.close(Application::Pipe::WRITE
);
255 Error
<< strerror(spawn_ret
) << "(" << spawn_ret
<< ")";
257 return Application::INVALID
;
260 return Application::SUCCESS
;
263 bool Application::check() const
265 if (_pid
> 1 and kill(_pid
, 0) == 0)
273 void Application::murder()
278 while ((count
--) > 0 and check())
280 int kill_ret
= kill(_pid
, SIGTERM
);
285 if ((waitpid_ret
= waitpid(_pid
, &status
, WNOHANG
)) == -1)
294 Error
<< "waitpid() failed after kill with error of " << strerror(errno
);
299 if (waitpid_ret
== 0)
301 libtest::dream(1, 0);
306 Error
<< "kill(pid, SIGTERM) failed after kill with error of " << strerror(errno
);
313 // If for whatever reason it lives, kill it hard
316 (void)kill(_pid
, SIGKILL
);
322 // false means that no data was returned
323 bool Application::slurp()
325 struct pollfd fds
[2];
326 fds
[0].fd
= stdout_fd
.fd();
327 fds
[0].events
= POLLRDNORM
;
329 fds
[1].fd
= stderr_fd
.fd();
330 fds
[1].events
= POLLRDNORM
;
334 if ((active_fd
= poll(fds
, 2, 0)) == -1)
337 switch ((error
= errno
))
339 #ifdef TARGET_OS_LINUX
347 fatal_message(strerror(error
));
351 fatal_message("RLIMIT_NOFILE exceeded, or if OSX the timeout value was invalid");
355 fatal_message(strerror(error
));
367 bool data_was_read
= false;
368 if (fds
[0].revents
& POLLRDNORM
)
370 if (stdout_fd
.read(_stdout_buffer
) == true)
376 if (fds
[1].revents
& POLLRDNORM
)
378 if (stderr_fd
.read(_stderr_buffer
) == true)
384 return data_was_read
;
387 Application::error_t
Application::wait(bool nohang
)
391 return Application::INVALID
;
396 error_t exit_code
= FAILURE
;
400 if ((waited_pid
= waitpid(_pid
, &status
, nohang
? WNOHANG
: 0)) == -1)
405 exit_code
= Application::SUCCESS
;
412 Error
<< "Error occured while waitpid(" << strerror(errno
) << ") on pid " << int(_pid
);
416 else if (waited_pid
== 0)
418 exit_code
= Application::SUCCESS
;
422 if (waited_pid
!= _pid
)
424 throw libtest::fatal(LIBYATL_DEFAULT_PARAM
, "Pid mismatch, %d != %d", int(waited_pid
), int(_pid
));
426 exit_code
= int_to_error_t(exited_successfully(status
));
433 if (exit_code
== Application::INVALID
)
435 Error
<< print_argv(built_argv
, _argc
);
442 void Application::add_long_option(const std::string
& name
, const std::string
& option_value
)
444 std::string
arg(name
);
446 _options
.push_back(std::make_pair(arg
, std::string()));
449 void Application::add_option(const std::string
& arg
)
451 _options
.push_back(std::make_pair(arg
, std::string()));
454 void Application::add_option(const std::string
& name
, const std::string
& value
)
456 _options
.push_back(std::make_pair(name
, value
));
459 Application::Pipe::Pipe(int arg
) :
468 int Application::Pipe::Pipe::fd()
470 if (_std_fd
== STDOUT_FILENO
)
472 return _pipe_fd
[READ
];
474 else if (_std_fd
== STDERR_FILENO
)
476 return _pipe_fd
[READ
];
479 return _pipe_fd
[WRITE
]; // STDIN_FILENO
483 bool Application::Pipe::read(libtest::vchar_t
& arg
)
485 fatal_assert(_std_fd
== STDOUT_FILENO
or _std_fd
== STDERR_FILENO
);
487 bool data_was_read
= false;
490 char buffer
[1024]= { 0 };
491 while ((read_length
= ::read(_pipe_fd
[READ
], buffer
, sizeof(buffer
))))
493 if (read_length
== -1)
501 Error
<< strerror(errno
);
509 arg
.reserve(read_length
+1);
510 for (size_t x
= 0; x
< read_length
; x
++)
512 arg
.push_back(buffer
[x
]);
514 // @todo Suck up all errput code here
517 return data_was_read
;
520 void Application::Pipe::nonblock()
523 if ((ret
= fcntl(_pipe_fd
[READ
], F_GETFL
, 0)) == -1)
525 Error
<< "fcntl(F_GETFL) " << strerror(errno
);
526 throw strerror(errno
);
529 if ((ret
= fcntl(_pipe_fd
[READ
], F_SETFL
, ret
| O_NONBLOCK
)) == -1)
531 Error
<< "fcntl(F_SETFL) " << strerror(errno
);
532 throw strerror(errno
);
536 void Application::Pipe::reset()
542 if (pipe2(_pipe_fd
, O_NONBLOCK
) == -1)
544 if (pipe(_pipe_fd
) == -1)
547 fatal_message(strerror(errno
));
559 void Application::Pipe::cloexec()
562 if ((ret
= fcntl(_pipe_fd
[WRITE
], F_GETFD
, 0)) == -1)
564 Error
<< "fcntl(F_GETFD) " << strerror(errno
);
565 throw strerror(errno
);
568 if ((ret
= fcntl(_pipe_fd
[WRITE
], F_SETFD
, ret
| FD_CLOEXEC
)) == -1)
570 Error
<< "fcntl(F_SETFD) " << strerror(errno
);
571 throw strerror(errno
);
575 Application::Pipe::~Pipe()
581 void Application::Pipe::dup_for_spawn(const close_t
& arg
, posix_spawn_file_actions_t
& file_actions
)
586 if ((ret
= posix_spawn_file_actions_adddup2(&file_actions
, _pipe_fd
[type
], _std_fd
)) < 0)
588 Error
<< "posix_spawn_file_actions_adddup2(" << strerror(ret
) << ")";
589 fatal_message(strerror(ret
));
592 if ((ret
= posix_spawn_file_actions_addclose(&file_actions
, _pipe_fd
[type
])) < 0)
594 Error
<< "posix_spawn_file_actions_adddup2(" << strerror(ret
) << ")";
595 fatal_message(strerror(ret
));
599 void Application::Pipe::close(const close_t
& arg
)
606 if (::close(_pipe_fd
[type
]) == -1)
608 Error
<< "close(" << strerror(errno
) << ")";
615 void Application::create_argv(const char *args
[])
618 fatal_assert(_argc
== 0);
622 _argc
+= 2; // +2 for libtool --mode=execute
625 _argc
+= 1; // For the command
628 valgrind --error-exitcode=1 --leak-check=yes --show-reachable=yes --track-fds=yes --track-origin=yes --malloc-fill=A5 --free-fill=DE --log-file=
634 else if (_use_ptrcheck
)
637 valgrind --error-exitcode=1 --tool=exp-ptrcheck --log-file=
641 else if (_use_gdb
) // gdb
646 for (Options::const_iterator iter
= _options
.begin(); iter
!= _options
.end(); iter
++)
649 if ((*iter
).second
.empty() == false)
657 for (const char **ptr
= args
; *ptr
; ++ptr
)
663 _argc
+= 1; // for the NULL
665 built_argv
= new char * [_argc
];
671 built_argv
[x
++]= strdup(libtool());
672 built_argv
[x
++]= strdup("--mode=execute");
678 valgrind --error-exitcode=1 --leak-check=yes --show-reachable=yes --track-fds=yes --malloc-fill=A5 --free-fill=DE
680 built_argv
[x
++]= strdup("valgrind");
681 built_argv
[x
++]= strdup("--error-exitcode=1");
682 built_argv
[x
++]= strdup("--leak-check=yes");
683 built_argv
[x
++]= strdup("--show-reachable=yes");
684 built_argv
[x
++]= strdup("--track-fds=yes");
686 built_argv
[x
++]= strdup("--track-origin=yes");
688 built_argv
[x
++]= strdup("--malloc-fill=A5");
689 built_argv
[x
++]= strdup("--free-fill=DE");
691 std::string log_file
= create_tmpfile("valgrind");
693 int length
= snprintf(buffer
, sizeof(buffer
), "--log-file=%s", log_file
.c_str());
694 fatal_assert(length
> 0 and length
< sizeof(buffer
));
695 built_argv
[x
++]= strdup(buffer
);
697 else if (_use_ptrcheck
)
700 valgrind --error-exitcode=1 --tool=exp-ptrcheck --log-file=
702 built_argv
[x
++]= strdup("valgrind");
703 built_argv
[x
++]= strdup("--error-exitcode=1");
704 built_argv
[x
++]= strdup("--tool=exp-ptrcheck");
706 std::string log_file
= create_tmpfile("ptrcheck");
708 int length
= snprintf(buffer
, sizeof(buffer
), "--log-file=%s", log_file
.c_str());
709 fatal_assert(length
> 0 and length
< sizeof(buffer
));
710 built_argv
[x
++]= strdup(buffer
);
714 built_argv
[x
++]= strdup("gdb");
717 built_argv
[x
++]= strdup(_exectuble_with_path
.c_str());
719 for (Options::const_iterator iter
= _options
.begin(); iter
!= _options
.end(); iter
++)
721 built_argv
[x
++]= strdup((*iter
).first
.c_str());
722 if ((*iter
).second
.empty() == false)
724 built_argv
[x
++]= strdup((*iter
).second
.c_str());
730 for (const char **ptr
= args
; *ptr
; ++ptr
)
732 built_argv
[x
++]= strdup(*ptr
);
735 built_argv
[x
++]= NULL
;
736 fatal_assert(x
== _argc
);
739 std::string
Application::print()
741 return print_argv(built_argv
, _argc
);
744 std::string
Application::arguments()
746 std::stringstream arg_buffer
;
748 for (size_t x
= 1 + _use_libtool
? 2 : 0;
749 x
< _argc
and built_argv
[x
];
752 arg_buffer
<< built_argv
[x
] << " ";
755 return arg_buffer
.str();
758 void Application::delete_argv()
762 for (size_t x
= 0; x
< _argc
; x
++)
766 ::free(built_argv
[x
]);
776 int exec_cmdline(const std::string
& command
, const char *args
[], bool use_libtool
)
778 Application
app(command
, use_libtool
);
780 Application::error_t ret
= app
.run(args
);
782 if (ret
!= Application::SUCCESS
)
787 return int(app
.wait(false));
790 const char *gearmand_binary()
792 return GEARMAND_BINARY
;
795 } // namespace exec_cmdline