xenia-project/xenia

Convert old-style kernel convention to new-style convention

Open

#631 opened on Nov 19, 2016

View on GitHub
 (37 comments) (0 reactions) (0 assignees)C++ (7,418 stars) (1,077 forks)batch import
good first issuekernel

Description

Just rewrite exports using the old shim convention to the new convention.

xboxkrnl

  • xboxkrnl_audio.cc
  • xboxkrnl_audio_xma.cc
  • xboxkrnl_crypt.cc
  • xboxkrnl_debug.cc
  • xboxkrnl_error.cc
  • xboxkrnl_hal.cc
  • xboxkrnl_io.cc
  • xboxkrnl_memory.cc
  • xboxkrnl_misc.cc
  • xboxkrnl_modules.cc
  • xboxkrnl_ob.cc
  • xboxkrnl_rtl.cc
  • xboxkrnl_strings.cc
  • xboxkrnl_threading.cc
  • xboxkrnl_usbcam.cc
  • xboxkrnl_video.cc

xam

  • xam_avatar.cc
  • xam_content.cc
  • xam_info.cc
  • xam_input.cc
  • xam_msg.cc
  • xam_net.cc
  • xam_notify.cc
  • xam_ui.cc
  • xam_user.cc
  • xam_video.cc
  • xam_voice.cc

E.g. XAudioGetSpeakerConfig

SHIM_CALL XAudioGetSpeakerConfig_shim(PPCContext* ppc_context,
                                      KernelState* kernel_state) {
  uint32_t config_ptr = SHIM_GET_ARG_32(0);

  XELOGD("XAudioGetSpeakerConfig(%.8X)", config_ptr);

  SHIM_SET_MEM_32(config_ptr, 0x00010001);

  SHIM_SET_RETURN_32(X_ERROR_SUCCESS);
}

...

SHIM_SET_MAPPING("xboxkrnl.exe", XAudioGetSpeakerConfig, state);

Becomes

dword_result_t XAudioGetSpeakerConfig(lpdword_t config_ptr) {
  *config_ptr = 0x00010001;
  return X_ERROR_SUCCESS;
}
DECLARE_XBOXKRNL_EXPORT(XAudioGetSpeakerConfig, ExportTag::kImplemented);

// (Call to SHIM_SET_MAPPING removed)

Fairly easy to do, just use others already converted as guidelines if you get lost. Be sure to add appropriate ExportTags and test the exports after conversion to make sure they still work!

Visual Studio can sometimes glitch out and cause you to hit an assert when starting Xenia after you convert an export. If that happens, clean and rebuild xenia-kernel.

Do not remove the Register*Exports functions, even if they become blank. They are still required for proper linkage.

Contributor guide

Tech stack
cpp
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C++ knowledgeFamiliarity with Xenia kernelVisual Studio setupBasic understanding of emulation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the remaining unconverted files listed in the issue (xboxkrnl strings.cc, xboxkrnl threading.cc, xam content.cc, xam ui.cc). Use the provided example of XAudioGetSpeakerConfig as a guide to convert each function from SHIM CALL pattern to the new dword result t pattern. After conversion, clean and rebuild xenia kernel to test for any assertions.