3 # This allows for launching of multiple QEMU instances, with independent
4 # communication possible to each instance.
6 # Each instance can choose, at launch, to use either the QMP or the
7 # HMP (monitor) interface.
9 # All instances are cleaned up via _cleanup_qemu, including killing the
10 # running qemu instance.
12 # Copyright (C) 2014 Red Hat, Inc.
14 # This program is free software; you can redistribute it and/or modify
15 # it under the terms of the GNU General Public License as published by
16 # the Free Software Foundation; either version 2 of the License, or
17 # (at your option) any later version.
19 # This program is distributed in the hope that it will be useful,
20 # but WITHOUT ANY WARRANTY; without even the implied warranty of
21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 # GNU General Public License for more details.
24 # You should have received a copy of the GNU General Public License
25 # along with this program. If not, see <http://www.gnu.org/licenses/>.
30 QEMU_FIFO_IN
="${TEST_DIR}/qmp-in-$$"
31 QEMU_FIFO_OUT
="${TEST_DIR}/qmp-out-$$"
35 # If bash version is >= 4.1, these will be overwritten and dynamic
36 # file descriptor values assigned.
40 # Wait for expected QMP response from QEMU. Will time out
41 # after 10 seconds, which counts as failure.
43 # Override QEMU_COMM_TIMEOUT for a timeout different than the
46 # $1: The handle to use
47 # $2+ All remaining arguments comprise the string to search for
50 # If $silent is set to anything but an empty string, then
51 # response is not echoed out.
52 function _timed_wait_for
()
58 while read -t ${QEMU_COMM_TIMEOUT} resp
<&${QEMU_OUT[$h]}
60 if [ -z "${silent}" ]; then
61 echo "${resp}" | _filter_testdir | _filter_qemu \
62 | _filter_qemu_io | _filter_qmp
64 grep -q "${*}" < <(echo ${resp})
70 if [ -z "${qemu_error_no_exit}" ]; then
71 echo "Timeout waiting for ${*} on handle ${h}"
72 exit 1 # Timeout means the test failed
77 # Sends QMP or HMP command to QEMU, and waits for the expected response
79 # $1: QEMU handle to use
80 # $2: String of the QMP command to send
81 # ${@: -1} (Last string passed)
82 # String that the QEMU response should contain. If it is a null
83 # string, do not wait for a response
85 # Set qemu_cmd_repeat to the number of times to repeat the cmd
86 # until either timeout, or a response. If it is not set, or <=0,
87 # then the command is only sent once.
89 # If $qemu_error_no_exit is set, then even if the expected response
90 # is not seen, we will not exit. $QEMU_STATUS[$1] will be set it -1 in
92 function _send_qemu_cmd
()
97 local use_error
=${qemu_error_no_exit}
100 if [ ${qemu_cmd_repeat} -gt 0 ] 2>/dev
/null
; then
101 count
=${qemu_cmd_repeat}
104 # This array element extraction is done to accommodate pathnames with spaces
108 while [ ${count} -gt 0 ]
110 echo "${cmd}" >&${QEMU_IN[${h}]}
111 if [ -n "${1}" ]; then
112 qemu_error_no_exit=${use_error} _timed_wait_for ${h} "${1}"
113 if [ ${QEMU_STATUS[$h]} -eq 0 ]; then
119 if [ ${QEMU_STATUS[$h]} -ne 0 ] && [ -z "${qemu_error_no_exit}" ]; then
120 echo "Timeout waiting for ${1} on handle ${h}"
121 exit 1 #Timeout means the test failed
126 # Launch a QEMU process.
129 # $qemu_comm_method: set this variable to 'monitor' (case insensitive)
130 # to use the QEMU HMP monitor for communication.
131 # Otherwise, the default of QMP is used.
133 # $QEMU_HANDLE: set to a handle value to communicate with this QEMU instance.
135 function _launch_qemu
()
141 if (shopt -s nocasematch
; [[ "${qemu_comm_method}" == "monitor" ]])
143 comm="-monitor stdio"
145 local qemu_comm_method
="qmp"
146 comm="-monitor none -qmp stdio"
149 fifo_out
=${QEMU_FIFO_OUT}_
${_QEMU_HANDLE}
150 fifo_in
=${QEMU_FIFO_IN}_
${_QEMU_HANDLE}
155 ${QEMU} -nographic -serial none ${comm} -machine accel=qtest "${@}" \
160 if [[ "${BASH_VERSINFO[0]}" -ge "5" ||
161 ("${BASH_VERSINFO[0]}" -ge "4" && "${BASH_VERSINFO[1]}" -ge "1") ]]
163 # bash >= 4.1 required for automatic fd
164 exec {_out_fd}<"${fifo_out}"
165 exec {_in_fd}>"${fifo_in}"
169 eval "exec ${_out_fd}<'${fifo_out}'"
170 eval "exec ${_in_fd}>'${fifo_in}'"
173 QEMU_OUT[${_QEMU_HANDLE}]=${_out_fd}
174 QEMU_IN[${_QEMU_HANDLE}]=${_in_fd}
175 QEMU_STATUS[${_QEMU_HANDLE}]=0
177 if [ "${qemu_comm_method}" == "qmp
" ]
179 # Don't print response, since it has version information in it
180 silent=yes _timed_wait_for ${_QEMU_HANDLE} "capabilities
"
182 QEMU_HANDLE=${_QEMU_HANDLE}
187 # Silenty kills the QEMU process
189 # If $wait is set to anything other than the empty string, the process will not
190 # be killed but only waited for, and any output will be forwarded to stdout. If
191 # $wait is empty, the process will be killed and all output will be suppressed.
192 function _cleanup_qemu()
194 # QEMU_PID[], QEMU_IN[], QEMU_OUT[] all use same indices
195 for i in "${!QEMU_OUT[@]}"
198 if [ -f "${TEST_DIR}/qemu-
${i}.pid
" ]; then
199 read QEMU_PID < "${TEST_DIR}/qemu-
${i}.pid
"
200 rm -f "${TEST_DIR}/qemu-
${i}.pid
"
201 if [ -z "${wait}" ] && [ -n "${QEMU_PID}" ]; then
202 kill -KILL ${QEMU_PID} 2>/dev/null
204 if [ -n "${QEMU_PID}" ]; then
205 wait ${QEMU_PID} 2>/dev/null # silent kill
209 if [ -n "${wait}" ]; then
210 cat <&${QEMU_OUT[$i]} | _filter_testdir | _filter_qemu \
211 | _filter_qemu_io | _filter_qmp
213 rm -f "${QEMU_FIFO_IN}_${i}" "${QEMU_FIFO_OUT}_${i}"
214 eval "exec ${QEMU_IN[$i]}<&-" # close file descriptors
215 eval "exec ${QEMU_OUT[$i]}<&-"