Contribute/BiteSizedTasks

From QEMU
Revision as of 18:13, 25 January 2024 by Pm215 (talk | contribs) (add a general notes section with some hopefully helpful orienting information for the rest of the page)

This list is in the process of being re-evaluated and migrated to the QEMU issue tracker using the Bite Sized issue label.

For QEMU maintainers: Please add your new suggestions to the issue tracker instead, and add the Bite Sized label. Please migrate any existing still relevant ideas to the issue tracker and remove them from this page afterward.

For new contributors: Before starting on one of the tasks on this page, you should check the mailing list archives to ensure no one else has recently submitted similar cleanups for the same task. If nobody has, and the task appears valid, please reach out on the QEMU development mailing list and let us know you'd like to start working on the issue. Please CC: John Snow <jsnow AT redhat.com> when doing so, they'll help get you assigned a GitLab issue and find the right points of contact.

For tasks on the issue tracker or on this page, patches are still handled by submitting patches to the mailing list and not via Gitlab merge requests. Before submitting a patch to the mailing list, please make sure that you've read and understood the patch submission page.

General Notes

In many cases, items on this page describe tasks that might apply to many files in QEMU's sources. In this case, you shouldn't try to solve the problem for the whole of QEMU all at once. Instead, pick a small part of it, ideally related to what you're interested in, and look only at the file or files relevant to that. (For instance, if you're interested in Arm emulation, look at whether one of the tasks affects an Arm device model source file.)

Where there is a gitlab issue for a task, that will usually have more detail than the entry on this page; gitlab issues generally are probably more likely to have been defined in a way that will make them tractable for a first-time contributor.

Some of these tasks are described very briefly and somewhat cryptically. If you're not sure what a task involves, then feel free to ask for clarification on the qemu-devel mailing list, or the contact person for the task (if the task has been marked with a contact).

Gitlab "Bite Sized" Issues

Issues tagged "Bite Sized" on the issue tracker may be good candidates for first contributions. If you're interested in solving one of these problems, please register for a Gitlab account and participate in the discussion on the issue so it will be evident to others that you are engaged in researching and fixing the issue.

The issues may sometimes appear to be cryptic or vague. Don't hesitate to ask for more information if the task is not clear. If there is no obvious point of contact from the issue page itself, please reach out for help on the qemu development mailing list.

API conversion

  • Replace manual qemu_mutex_lock() and qemu_mutex_unlock() calls with QEMU_LOCK_GUARD() where it makes the code easier to read. See ToDo/LockGuards for details.
  • Look for uses of malloc, and convert them to g_new or similar. See the fuller writeup in the issue on the bug tracker for more information and a list of the remaining places that need conversion (and the places that don't need it).
  • Replace calls to functions named cpu_physical_memory_* with address_space_*.
  • Replace calls to object_child_foreach() with object_child_foreach_recursive() when applicable: nvdimm_device_list, nmi_monitor_handle, find_sysbus_device, pc_dimm_slot2bitmap, build_dimm_list.
  • The ToDo/CodeTransitions page tracks ongoing internal QEMU API transitions. Most are not trivial but it's a good source of ideas, and some items should be doable for newcomers, too.
  • QSIMPLEQ_REMOVE and QSLIST_REMOVE are inefficient. Check if they could be replaced by QSIMPLEQ_REMOVE_HEAD and QSLIST_REMOVE_HEAD; if not, use a QTAILQ or QLIST respectively.

Code Modernization

  • Convert routines with multiple goto exit-paths to use g_autoptr/g_autofree to handle clean-up and allow direct returns
  • Replace common idioms like if (s->len > 0) { g_string_append(s, ", "); } g_string_append(s, "foo") with common helper function
  • Replace hand-coded uri_string_escape/uri_string_unescape with glib equivalents, for bonus points unify open-coded to/from hex routines with the gdbstub equivilents

Device models

Error checking

  • Use qemu_strtol/qemu_strtoul/qemu_strtoll/qemu_strtoull more. (contact: eblake)

Compiler-driven cleanups

  • Use of -Wframe-larger-than=4096 can prevent the use of potential security flaws caused by stack overflows made possible with over-large stack allocations.
  • The following functions have very large stack frames (as obtained with -Wstack-usage=16383), mostly due to huge arrays. Make the stack array smaller and allocate on the heap in the rare case that the data does not fit in the small array:
hw/dma/xilinx_axidma.c               stream_process_mem2s             16480 bytes
hw/net/virtio-net.c                  virtio_net_receive               16544 bytes
net/tap.c                            net_init_tap                     16752 bytes
hw/display/vmware_vga.c              vmsvga_fifo_run                  20688 bytes
hw/virtio/virtio.c                   virtqueue_pop                    24768 bytes
hw/net/virtio-net.c                  virtio_net_flush_tx              32928 bytes
hw/virtio/virtio.c                   qemu_get_virtqueue_element       49216 bytes
hw/virtio/virtio.c                   qemu_put_virtqueue_element       49216 bytes
hw/net/opencores_eth.c               open_eth_start_xmit              65664 bytes
hw/arm/nseries.c                     n8x0_init                        65728 bytes
net/net.c                            nc_sendv_compat                  69680 bytes
net/socket.c                         net_socket_send                  69712 bytes

Note that this list is likely out of date. If you want to work on this you should start by identifying some functions worth looking at by building QEMU yourself with --extra-cflags=-Wstack-usage=16383 --disable-werror . Then you can capture the output of the compile process (e.g. with make -C build -j8 2>&1 | tee stack-usage.log) and look for the warnings in the log file. Come and talk to us on the qemu-devel list about this before putting much work into it -- there are quite a lot of functions with large or even theoretically unbounded stack usage, but not all of them are in places in the code where it's important.

Tracing

  • Add tracepoints. All functions that are named something_helper, and all functions mentioned in MemoryRegionOps are good candidates.
  • Convert DPRINTF() calls to tracepoints (see https://gitlab.com/qemu-project/qemu/-/issues/1827 in the bug tracker for more details)

Bitrot prevention

  • Files with conditional debug statements should ensure that the printf is always compiled, and merely hidden behind if (0) when not debugging, rather than #ifdef'd out. This prevents bitrot of the format string of the debug statement. See this (commit c691320faa6) for an example. Or, go one step further and convert the debug statements to tracepoints. For more detail on tracepoint conversion, see the issue in the bug tracker: https://gitlab.com/qemu-project/qemu/-/issues/1827 (contact: eblake)

Functions that should be static

  • For example: vga_sync_dirty_bitmap, WC_CONFIG_STRING, WC_FULL_CONFIG_STRING, WC_MODEL_STRING, timer_put, vfio_region_ops, vfio_reset_handler, cpu_gen_init, monitor_read_bdrv_key_start, pdu_marshal, pdu_unmarshal, qcrypto_hmac_alg_map (crypto/hmap-nettle.c), spapr_tce_set_need_vfio, virtqueue_map, vnc_disconnect_finish, vnc_display_init, gicv3_full_update_noirqset, cpu_disable_ticks, cpu_enable_ticks, qemu_thread_exit (actually unused in thread-posix.c), qemu_egl_init_dpy_mesa, monitor_defs (3 occurrences), apic_deliver_irq, pcie_host_mmcfg_map, pcie_host_mmcfg_unmap
  • tracetool-generated arrays (e.g. hw_mem_trace_events in the generated file hw/mem/trace.c) should be static.
  • The property types defined in hw/core/qdev-properties-system.c should be moved to other directories (e.g. hw/net for network-related property types). After doing this, some functions probably could become static, too.

Contact persons

For tasks above marked with a "(contact: foo)" point of contact, these are those peoples' names, IRC nicks, and email addresses to get in contact with them.

  • eblake: Eric Blake (mail: eblake AT redhat.com -- IRC: eblake)
  • jsnow: John Snow (mail: jsnow AT redhat.com -- IRC: jsnow)
Retrieved from "https://wiki.qemu.org/index.php?title=Contribute/BiteSizedTasks&oldid=11620"