Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement direct.h functions #636

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

Implement direct.h functions #636

Changes from 2 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
680b892
winapi: Implement all `direct.h` functions apart from path manipulation
Jun 10, 2023
18c6acf
winapi: Remove `MAXDIR`, `MAXEXT` and `MAXFILE` constants
Jun 10, 2023
0b37066
winapi: Fix ending newlines in `direct.h`
ExoSkye Jun 11, 2023
e2f40bf
winapi: Remove `MAXPATH` and `MAXDRIVE`
ExoSkye Jun 11, 2023
72ae765
winapi: Remove uneeded functions
ExoSkye Jun 11, 2023
aa89850
winapi: Add `direct.c` to xboxrt makefile
ExoSkye Jun 16, 2023
8893c02
winapi: Add a simple function to convert errors from winapi to errno …
ExoSkye Jun 17, 2023
6078f61
winapi: Use `assert(0)` to stop the use of stubs
Jun 17, 2023
a5e09e0
winapi: Fix -Wreturn-type warnings
Jun 17, 2023
cd71cb3
winapi: Fix typo
Jun 18, 2023
21fe551
winapi: Actually include `assert.h`
Jun 18, 2023
57cded3
winapi: Add fallback to return `EINVAL`
Jun 18, 2023
5ef78d2
winapi: Edit functions to actually use the new `convert_error` function
Jun 18, 2023
014d662
winapi: Fix debugPrint format specifier
Jun 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions lib/xboxrt/libc_extensions/direct.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,26 +46,28 @@ static int convert_error(DWORD winerror)
*/

int _chdir(char* path) {
Ryzee119 marked this conversation as resolved.
Show resolved Hide resolved
return 0;
assert(0);
return -1; // Unreachable
Copy link
Member

@JayFoxRox JayFoxRox Jun 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is reachable when disabling assertions.
In that case, errno must be set, so I suggest setting it to EACCES?

(Other functions, too - but you need to look up appropriate error codes)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah crap, forgot you could do that, I'll sort it out

}

int _chdrive(int drive) {
return 0;
assert(0);
return -1; // Unreachable
}

char* _getcwd(char* buffer, size_t length) {
errno = -EINVAL;
return NULL;
assert(0);
return NULL; // Unreachable
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we can hard-code this for now, so at least apps which use this to find files will work (sometimes some SDK or API will require absolute paths, and then the application might query the base path through this).

I can see how that would be a lot of additional implementation effort, so it can be done in a follow-up PR.

If this follows the same convention, we might be able to use:

nxdk/lib/nxdk/path.c

Lines 9 to 14 in 500354e

void nxGetCurrentXbeNtPath (char *path)
{
// Retrieve the XBE path
strncpy(path, XeImageFileName->Buffer, XeImageFileName->Length);
path[XeImageFileName->Length] = '\0';
}

Otherwise, we might be able to hardcode it to D:\\ which is either (I don't remember) a kernel requirement or at least a dashboard- or self-imposed XBE controlled symlink?

Eitherway, we'd have to follow conventions of the MS implementation (regarding forward vs backward slash, device names vs driver letters etc.).

Similar reasoning for _getdrive, although I speculate that this is required much less.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

D drive letter mount is handled by XDK on boot when D drive letter isn't set by the kernel. Otherwise, it is handled by the kernel on reboot.

Though, I highly recommended to check LaunchDataPage->Header.szLaunchPath first for semicolon character which is mount as working directory by the kernel itself. Then fallback to XeImageFileName with null terminate append at end of string.

fyi: I provided this type of information in XboxDev discord server based on what I had researched years ago.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer XeImageFileName (which the kernel uses to talk to the app / after launching) over LaunchDataPage (which is used by the app to talk to the kernel / before launching)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, LaunchDataPage is used to talk to the kernel but that's only half correct. It is also used by the app as well hence the LaunchData member variable from LAUNCH_DATA_PAGE structure is used to tell the app, either from same xbe or another xbe, what to do next after reboot occur. The kernel doesn't modify LaunchDataPage created by the app. The kernel read from LaunchDataPage->Header structure to do what the app want the kernel to do on reboot.

Here's a log of how it works on first boot and reboot:

---- first boot ----
LaunchDataPage is NULL.
XeImageFileName: \Device\Harddisk0\Partition1\Games\reboot\default.xbe
\??\D: == \Device\Harddisk0\Partition1\Games\reboot
Relaunching... LaunchDataPage->Header.szLaunchPath: \Device\Harddisk0\Partition1\Games;reboot\default.xbe
============
------ reboot ------
LaunchDataPage->Header.szLaunchPath: \Device\Harddisk0\Partition1\Games;reboot\default.xbe
XeImageFileName: \Device\Harddisk0\Partition1\Games\reboot\default.xbe
\??\D: == \Device\Harddisk0\Partition1\Games
============

As you can see XeImageFileName doesn't include semicolon which break working directory mount from D: symlink pointing to a parent directory than the same directory according to reboot process.
This is the same/similar concept on Windows' command prompt or powershell usage. When you change directory from the terminal itself, i.e. C:\logs> . Then execute D:\build\UnitTest.exe which will create log file into C:\logs instead of D:\build directory.

In summary, this is how demo discs and even xbox live works when they focus on D:\ symlink as a working directory. Otherwise attempting to access the contents wouldn't work engineered by original xbox team. I hope this is more clarified for you and everyone else reading this.

}

char* _getwd(char* path_name) {
errno = -EINVAL;
return NULL;
assert(0);
return NULL; // Unreachable
Copy link
Member

@JayFoxRox JayFoxRox Jun 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The macOS man page says:

The function getwd() is a compatibility routine which calls getcwd() with its buf argument and a size of MAXPATHLEN (as defined in the include file <sys/param.h>). Obviously, buf should be at least MAXPATHLEN bytes in length.

Regarding return values:

In addition, getwd() copies the error message associated with errno into the memory referenced by buf.

Similar wording is in POSIX https://pubs.opengroup.org/onlinepubs/009696699/functions/getwd.html

which should be trivial to implement.

I can't find anything about it in the MSDN docs though. Is it contained in the Windows SDK / MS implementations?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yea, Wikipedia, and digitalmars state that getwd exists so I'm going on that
Should be trivial to implement though

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't find anything about it in the MSDN docs though. Is it contained in the Windows SDK / MS implementations?

I don't see it in https://github.com/microsoft/win32metadata/blob/main/generation/WinSDK/RecompiledIdlHeaders/ucrt/direct.h either.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like getwd is a legacy function which was discontinued. The question is when did it get removed? As for digitalmars state it exists, I don't see getwd mentioned in the referenced link from the OP post. Heck, even did a search for whole site which also has no mention too.

}

int _getdrive(void) {
errno = -EINVAL;
return 0;
assert(0);
return -1; // Unreachable
}

/*
Expand Down