samples: Make winapi samples unmount drives before finishing execution #421

kosmas12 · 2021-01-14T10:16:54Z

This PR fixes issue #381. While I had previously opened a PR for this (#382), it was getting bloated, so I am opening this new one after I improved upon all the suggestions in the other PR.

samples/winapi_filefind/main.c

thrimbor

Left a few more review comments. When you make changes to your PR, I recommend to also leave a comment or respond to the feedback comments, it makes it easier to see that you changed something and which feedback you addressed. When you just quietly push changes, they might go unnoticed.

samples/winapi_filefind/main.c

samples/winapi_drivelist/main.c

samples/winapi_filefind/main.c

kosmas12 · 2021-03-04T09:38:25Z

Fixed the indentation and added gotos and labels

thrimbor

You seem to have had a bit of trouble understanding how exactly goto works or how my review comment was meant, so let me try to explain a bit further.

goto is like a jump instruction, whenever it executes, it simply jumps to the place where the label is located, it's not like function call, there is no returning back to where the goto is.

My idea of handling the errors is something like this (pseudo-code):

    if(mount C fails) {
        print error;
        goto done;
    }

    if(mount E fails) {
        print error;
        goto unmount_c;
    }

    if(something else fails) {
        print error;
        goto unmount_e;
    }

    do whatever the sample is intended to do

unmount_e:
    unmount E here
unmount_c:
    unmount C here

    while(1) {
        Sleep(2000);
    }

   return 0;

Notice how C is mounted first, but unmounted last. This is important because a goto unmount_e; will first unmount E, and execution will then "fall through" to unmount_c, so both drives will get unmounted, but a goto unmount_c will only unmount C, not E.
When no error happens, execution will simply continue normally, never executing a goto, but still running the code after the labels, so the drives will get unmounted, too.

thrimbor · 2021-03-05T13:54:57Z

samples/winapi_drivelist/main.c

+            error = GetLastError();
+            debugPrint("\nCouldn't unmount E: drive! Error code: %x\n", error);
+        }
+}


You seem to have accidentally removed a newline at the end here.

I'm almost certain this was fixed before, but now the newline is removed again.

samples/winapi_drivelist/main.c

samples/winapi_filefind/main.c

kosmas12 · 2021-03-25T11:14:34Z

Changes made, hope it's all good now

samples/winapi_drivelist/main.c

samples/winapi_filefind/main.c

samples/winapi_drivelist/main.c

samples/winapi_filefind/main.c

samples/winapi_drivelist/main.c

JayFoxRox · 2021-04-10T09:45:01Z

samples/winapi_drivelist/main.c

+
+unmount_e:
+    ret = nxUnmountDrive('E');
+    // If there was an error while unmounting


This comment adds nothing in my opinion.
The "GetLastError" in combination with !ret strongly implies that this is error-checking.

JayFoxRox · 2021-04-10T09:50:41Z

samples/winapi_filefind/main.c

@@ -10,10 +10,15 @@ int main(void)
 {
    XVideoSetMode(640, 480, 32, REFRESH_DEFAULT);

+    // Create a variable for WinAPI error checking
+    DWORD error;


This can be a highly local variable, I don't see a benefit for putting it at function scope?
If you declare it where it's used it also won't require any additional comment.

If the variable is redeclared, you should use different names to differentiate them; in this particular sample this only seems to happen after FindNextFile, so you could probably do DWORD findFileError = GetLastError() in that instance.

This wasn't done everywhere

samples/winapi_drivelist/main.c

kosmas12 · 2021-04-10T18:38:30Z

I just applied all the suggested changes, ready to make more if needed

kosmas12 · 2021-04-10T18:59:13Z

Building failed previously, tired me forgot to test before pushing haha.

Errors fixed and building of both samples tested to work fine.

JayFoxRox · 2021-04-10T20:58:31Z

samples/winapi_drivelist/main.c

-        return 1;
+        error = GetLastError();
+        debugPrint("Failed to mount E: drive! Error code: %x\n", error);
+        goto unmount_c;


This code makes little sense to me; mounting E failed, so it jumps to unmounting C?
The labels should be named more appropriately.

I believe that this specific label should stay as unmount_c, it's a good enough name IMO.

@JayFoxRox What would you suggest? Personally, it doesn't bother me, imho it looks just like when a function is freeing a previous allocation before returning due to an error.

I'm not sure; I'd probably cause a fatal error if anything fails to init (to avoid having to do conditional cleanup).

If conditional cleanup is mandatory I'd probably have a boolean which stores which drives were mounted correctly (mountedC / mountedE), I'd then have a generic cleanup function at the end of the scope which unmounts it (a single label called cleanup, which would conditionally deal with cleanup).

In a real application I'd probably have something like atexit / destructors which deal with this (= no labels); also ensures proper order of destruction without having to think about it.
Probably not practical for a sample because it adds too much complexity.

Especially with a generic label such as cleanup now, I think this should use booleans / keep track of it and handle everything in cleanup.

samples/winapi_drivelist/main.c

samples/winapi_filefind/main.c

samples/winapi_drivelist/main.c

JayFoxRox · 2021-04-10T21:09:13Z

I just applied all the suggested changes, ready to make more if needed

No, you didn't. And it's very hard to keep track of what you did or how you resolved things.

I suggest to leave a comment on each review comment, telling the reviewer what you did to resolve it.
That way it's much easier to confirm if you understood the feedback + to spot potential logic errors in the new solution.
This is especially important for beginners like you, but should also be expected of experienced coders.

This is also taking up a lot of reviewer time and too many iterations for such a small change.

Building failed previously, tired me forgot to test before pushing haha.

This also confirms why it's taking so much time: to little testing locally, and too little reflection / review on your own work.
You should review your own changes to make sure you only send a finalized version to reviewers, otherwise you are wasting everyones time (yours included).

Because this PR discussion is getting hard to follow (too much review feedback), I'd even consider starting a new PR if this doesn't reach an acceptable state in the next iteration.

kosmas12 · 2021-04-10T21:47:24Z

Changed what I could and tested. If anything more is left I'd also gladly move it to a new PR (even though I know that I should have got it right a looooong time ago and that opening even this 2nd PR is a bit absurd)

kosmas12 · 2021-04-11T15:48:57Z

I believe this is ready for a review and hopefully it's (at least one of the) final iteration(s).

samples/winapi_drivelist/main.c

samples/winapi_filefind/main.c

kosmas12 · 2021-06-28T14:26:42Z

Removal of return was indeed stupid of me, added it back now and ready for a new round of reviews if needed

kosmas12 · 2021-09-26T07:34:20Z

I believe I have solved the merge conflicts, so this might be in the clear.

thrimbor

There are some review comments still unaddressed, and a couple of issues that seem to be new - newlines are getting removed again, the commit author is incorrect, and somehow f2c634f got mixed in.

This is also branching off a rather old version of nxdk now and imho should be rebased onto current master to make sure there aren't any conflicts.

thrimbor · 2023-02-04T16:02:01Z

lib/usb/libusbohci_xbox/xid_driver.c

 static void free_xid_device(xid_dev_t *xid_dev) {
-    //Find the device head in the linked list
    xid_dev_t *head = pxid_list;
+
+    //If the xid is at the head of the list, remove now.
+    if (xid_dev == head)
+    {
+        pxid_list = head->next;
+        head = NULL;
+    }
+
+    //Find the device head in the linked list
    while (head != NULL && head->next != xid_dev)


What is this change doing here? (f2c634f)

thrimbor · 2023-02-04T16:03:44Z

samples/winapi_drivelist/main.c

+            error = GetLastError();
+            debugPrint("\nCouldn't unmount E: drive! Error code: %x\n", error);
+        }
+}


I'm almost certain this was fixed before, but now the newline is removed again.

thrimbor · 2023-02-04T16:05:35Z

samples/winapi_filefind/main.c

-}
+}


This newline should not get removed.

thrimbor reviewed Jan 20, 2021

View reviewed changes

samples/winapi_filefind/main.c Outdated Show resolved Hide resolved

Teufelchen1 reviewed Jan 27, 2021

View reviewed changes

samples/winapi_filefind/main.c Outdated Show resolved Hide resolved

Teufelchen1 reviewed Jan 27, 2021

View reviewed changes

samples/winapi_filefind/main.c Outdated Show resolved Hide resolved

kosmas12 force-pushed the unmountsamples branch 3 times, most recently from 2337f43 to d8e7826 Compare February 7, 2021 12:34

thrimbor requested changes Feb 17, 2021

View reviewed changes

kosmas12 force-pushed the unmountsamples branch from d8e7826 to b849d74 Compare March 4, 2021 09:38

thrimbor requested changes Mar 5, 2021

View reviewed changes

kosmas12 force-pushed the unmountsamples branch from b849d74 to ca09cdd Compare March 25, 2021 11:14

thrimbor requested changes Mar 25, 2021

View reviewed changes

JayFoxRox reviewed Apr 10, 2021

View reviewed changes

samples/winapi_drivelist/main.c Outdated Show resolved Hide resolved

JayFoxRox reviewed Apr 10, 2021

View reviewed changes

samples/winapi_drivelist/main.c Show resolved Hide resolved

JayFoxRox reviewed Apr 10, 2021

View reviewed changes

samples/winapi_drivelist/main.c Outdated Show resolved Hide resolved

kosmas12 force-pushed the unmountsamples branch from ca09cdd to c7b5269 Compare April 10, 2021 18:37

kosmas12 force-pushed the unmountsamples branch from c7b5269 to f9e1ed2 Compare April 10, 2021 18:58

JayFoxRox reviewed Apr 10, 2021

View reviewed changes

samples/winapi_drivelist/main.c Outdated Show resolved Hide resolved

JayFoxRox reviewed Apr 10, 2021

View reviewed changes

samples/winapi_drivelist/main.c Outdated Show resolved Hide resolved

JayFoxRox reviewed Apr 10, 2021

View reviewed changes

samples/winapi_filefind/main.c Outdated Show resolved Hide resolved

JayFoxRox reviewed Apr 10, 2021

View reviewed changes

samples/winapi_filefind/main.c Outdated Show resolved Hide resolved

JayFoxRox reviewed Apr 10, 2021

View reviewed changes

samples/winapi_drivelist/main.c Outdated Show resolved Hide resolved

kosmas12 force-pushed the unmountsamples branch from f9e1ed2 to 39c32b1 Compare April 10, 2021 21:46

thrimbor reviewed May 6, 2021

View reviewed changes

samples/winapi_drivelist/main.c Outdated Show resolved Hide resolved

samples/winapi_filefind/main.c Outdated Show resolved Hide resolved

kosmas12 force-pushed the unmountsamples branch from 2147b7e to 6296f79 Compare June 28, 2021 14:26

kosmas12 force-pushed the unmountsamples branch from d4171ea to 026da0f Compare September 22, 2021 19:09

kosmas12 force-pushed the unmountsamples branch 8 times, most recently from 64d0dec to 4db54c3 Compare September 26, 2021 15:42

kosmas12 requested a review from thrimbor February 2, 2023 17:45

kosmas12 force-pushed the unmountsamples branch 3 times, most recently from 1ccc6cb to 6d7deb7 Compare February 3, 2023 13:23

thrimbor requested changes Feb 4, 2023

View reviewed changes

samples: Make winapi samples unmount drives when exiting

535e842

kosmas12 force-pushed the unmountsamples branch from 6d7deb7 to 535e842 Compare February 5, 2023 09:38

thrimbor force-pushed the master branch from 8cc3520 to 88d18d6 Compare October 9, 2023 14:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

samples: Make winapi samples unmount drives before finishing execution #421

samples: Make winapi samples unmount drives before finishing execution #421

kosmas12 commented Jan 14, 2021

thrimbor left a comment

kosmas12 commented Mar 4, 2021

thrimbor left a comment

thrimbor Mar 5, 2021

thrimbor Feb 4, 2023 •

edited

Loading

kosmas12 commented Mar 25, 2021

JayFoxRox Apr 10, 2021

JayFoxRox Apr 10, 2021

JayFoxRox Apr 10, 2021

kosmas12 commented Apr 10, 2021

kosmas12 commented Apr 10, 2021

JayFoxRox Apr 10, 2021 •

edited

Loading

kosmas12 Apr 10, 2021

thrimbor May 6, 2021

JayFoxRox May 15, 2021

JayFoxRox Feb 5, 2023 •

edited

Loading

JayFoxRox commented Apr 10, 2021 •

edited

Loading

kosmas12 commented Apr 10, 2021

kosmas12 commented Apr 11, 2021

kosmas12 commented Jun 28, 2021

kosmas12 commented Sep 26, 2021

thrimbor left a comment

thrimbor Feb 4, 2023

thrimbor Feb 4, 2023 •

edited

Loading

thrimbor Feb 4, 2023

samples: Make winapi samples unmount drives before finishing execution #421

Are you sure you want to change the base?

samples: Make winapi samples unmount drives before finishing execution #421

Conversation

kosmas12 commented Jan 14, 2021

thrimbor left a comment

Choose a reason for hiding this comment

kosmas12 commented Mar 4, 2021

thrimbor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thrimbor Feb 4, 2023 • edited Loading

Choose a reason for hiding this comment

kosmas12 commented Mar 25, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kosmas12 commented Apr 10, 2021

kosmas12 commented Apr 10, 2021

JayFoxRox Apr 10, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JayFoxRox Feb 5, 2023 • edited Loading

Choose a reason for hiding this comment

JayFoxRox commented Apr 10, 2021 • edited Loading

kosmas12 commented Apr 10, 2021

kosmas12 commented Apr 11, 2021

kosmas12 commented Jun 28, 2021

kosmas12 commented Sep 26, 2021

thrimbor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thrimbor Feb 4, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thrimbor Feb 4, 2023 •

edited

Loading

JayFoxRox Apr 10, 2021 •

edited

Loading

JayFoxRox Feb 5, 2023 •

edited

Loading

JayFoxRox commented Apr 10, 2021 •

edited

Loading

thrimbor Feb 4, 2023 •

edited

Loading