repo: Add an API to get min-free-space-* reserved bytes #1715

uajain · 2018-08-30T11:06:40Z

https://phabricator.endlessm.com/T23694

pwithnall

A few comments. I’d be pretty keen to see a unit test for this too, otherwise there’s zero code in libostree.git which actually calls this new function.

src/libostree/ostree-repo.c

src/libostree/ostree-repo.h

src/libostree/ostree-repo.c

pwithnall

I still think this would really benefit from a unit test.

pwithnall · 2018-08-31T09:56:06Z

src/libostree/ostree-repo-commit.c

+  if (self->reserved_blocks > G_MAXUINT64 / self->txn.blocksize)
+    {
+      g_mutex_unlock (&self->txn_lock);
+      return glnx_throw (error, "min-free-space value(in bytes) was too high");


It would be good to include the maximum permitted value in this error message. For example:

return glnx_throw ("min-free-space value is greater than the maximum allowed value of %" G_GUINT64_FORMAT " bytes", G_MAXUINT64 / self->txn.blocksize);

pwithnall · 2018-08-31T09:56:51Z

src/libostree/ostree-repo.c

+ * If the configuration value of min-free-space-* value is too high(overflow)
+ * then @error is set with status code %G_IO_ERROR_FAILED.
+ *
+ * Returns: Value(in bytes) of min-free-space-* config option


Nitpick: Put a space before ( here and in the paragraph above.

pwithnall · 2018-08-31T09:57:13Z

src/libostree/ostree-repo.c

+
+  g_assert (self->txn.blocksize != 0);
+  if (self->reserved_blocks > G_MAXUINT64 / self->txn.blocksize)
+    return glnx_throw (error, "min-free-space(in bytes) value was too high");


(Make sure this error message is the same as whatever you change the one above to be.)

pwithnall · 2018-08-31T15:44:52Z

tests/test-repo.c

+  const char *values_to_test[] = { "500MB",
+                                   "0MB",
+                             //    "17179869185GB", /* Overflow parameter: bytes > G_MAXUINT64 */
+                             //      "17179869183GB", /* bytes approx. under G_MAXUINT64 */ //TODO: Bypass failure


Do both of these values error out in ostree_repo_prepare_transaction()? If so, that’s probably the best testing we’re going to get, and there’s no point in coming up with contortions to get more coverage.

Yes, they both error out in ostree_repo_prepare_transaction with different appropriate error messages.

If so, that’s probably the best testing we’re going to get, and there’s no point in coming up with > contortions to get more coverage.

Can you explain this a bit more? Does it mean there is no need for 0MB, 500MB test etc.?

As in, don’t try and make the prepare_transaction() call artificially succeed so you can test those large values with the get_min_free_space_bytes() call.

uajain · 2018-08-31T16:10:06Z

src/libostree/ostree-repo.c

+  g_return_val_if_fail (self->in_transaction == TRUE, 0);
+
+  g_assert (self->txn.blocksize != 0);
+  if (self->reserved_blocks > G_MAXUINT64 / self->txn.blocksize)


@pwithnall So I was asking about this check. Do we check(again) for overflows here when min_free_space_calculate_reserved_blocks() already does it before setting self->reserved_blocks ?

calculate_reserved_blocks() does a different check, though; it checks for overflow with a << 20 shift. You should only remove the check here if you can statically guarantee that if << 20 won’t overflow, then * self->txn.blocksize won’t overflow. You can do that by checking in prepare_transaction() that self->txn.blocksize < 2^20. That would be a good change to make, because you could then drop the GError argument from get_min_free_space_bytes().

when converted to bytes In a subsequent commit, we add a public API to read the value of min-free-space-* value in bytes. The value for free space check is enforced in terms of block size instead of bytes. Therefore, for consistency we check while preparing the transaction that the value doesn't overflow when converted to bytes. https://phabricator.endlessm.com/T23694

https://phabricator.endlessm.com/T23694

pwithnall · 2018-09-03T11:13:06Z

tests/test-repo.c

+
+  config = ostree_repo_copy_config (repo);
+
+  while (values_to_test[i] != NULL)


Nitpick: Use a for loop for this. That saves you having to manually increment i on every loop path below.

i.e. for (i = 0; values_to_test[i] != NULL; i++)

https://phabricator.endlessm.com/T23694

uajain · 2018-09-03T12:45:31Z

@cgwalters @jlebon Can you take a look ? it's LGTM from @pwithnall's side now.
Thank you.

cgwalters · 2018-09-04T18:17:23Z

tests/test-repo.c

+  const char *values_to_test[] = { "500MB",
+                                   "0MB",
+                                   "17179869185GB", /* Overflow parameter: bytes > G_MAXUINT64 */
+                                   NULL


It'd be slightly cleaner I think to have this be an array of 2-tuple (struct) { const char *val; bool should_succeeed } and assert that error is set if and only if should_succeed.

That said, up to you, I don't mind merging as is.

Thank you for the suggestion.

Pushed a fixup commit.

cgwalters · 2018-09-04T19:58:22Z

test-symbols.sh wanted leading whitespace in front of symbol names, I pushed a fixup!. Thanks for the patch!

@rh-atomic-bot r+ 9ba887d

rh-atomic-bot · 2018-09-04T19:58:27Z

⌛ Testing commit 9ba887d with merge 472a693...

when converted to bytes In a subsequent commit, we add a public API to read the value of min-free-space-* value in bytes. The value for free space check is enforced in terms of block size instead of bytes. Therefore, for consistency we check while preparing the transaction that the value doesn't overflow when converted to bytes. https://phabricator.endlessm.com/T23694 Closes: #1715 Approved by: cgwalters

https://phabricator.endlessm.com/T23694 Closes: #1715 Approved by: cgwalters

rh-atomic-bot · 2018-09-04T20:47:44Z

💔 Test failed - status-atomicjenkins

cgwalters · 2018-09-04T20:50:59Z

Looks like a flake. @rh-atomic-bot retry

rh-atomic-bot · 2018-09-04T21:31:37Z

⌛ Testing commit 9ba887d with merge a70d2f6...

https://phabricator.endlessm.com/T23694 Closes: #1715 Approved by: cgwalters

rh-atomic-bot · 2018-09-04T22:10:28Z

☀️ Test successful - status-atomicjenkins
Approved by: cgwalters
Pushing a70d2f6 to master...

…onverted to bytes In a subsequent commit, we add a public API to read the value of min-free-space-* value in bytes. The value for free space check is enforced in terms of block size instead of bytes. Therefore, for consistency we check while preparing the transaction that the value doesn't overflow when converted to bytes. https://phabricator.endlessm.com/T23694 Closes: ostreedev#1715 Approved by: cgwalters (cherry-picked from 3814d07)

https://phabricator.endlessm.com/T23694 Closes: ostreedev#1715 Approved by: cgwalters (cherry-picked from 68420f7)

https://phabricator.endlessm.com/T23694 Closes: ostreedev#1715 Approved by: cgwalters (cherry-picked from a70d2f6)

uajain force-pushed the expose-min-free-space branch from c9f2da2 to 43900c7 Compare August 30, 2018 14:24

pwithnall requested changes Aug 30, 2018

View reviewed changes

uajain force-pushed the expose-min-free-space branch from 43900c7 to d5aab1c Compare August 31, 2018 09:14

pwithnall requested changes Aug 31, 2018

View reviewed changes

uajain force-pushed the expose-min-free-space branch 2 times, most recently from ae8c3eb to cadfb9b Compare August 31, 2018 15:35

pwithnall reviewed Aug 31, 2018

View reviewed changes

uajain commented Aug 31, 2018

View reviewed changes

uajain force-pushed the expose-min-free-space branch 2 times, most recently from cd17970 to 2a188fc Compare September 3, 2018 10:21

Umang Jain added 2 commits September 3, 2018 15:55

lib/repo: Add an API to get min-free-space-* reserved bytes

3b29b68

https://phabricator.endlessm.com/T23694

uajain force-pushed the expose-min-free-space branch from 2a188fc to d056bbd Compare September 3, 2018 10:28

pwithnall reviewed Sep 3, 2018

View reviewed changes

Add tests for ostree_repo_get_min_free_space_bytes

1bb9bb0

https://phabricator.endlessm.com/T23694

uajain force-pushed the expose-min-free-space branch from d056bbd to 1bb9bb0 Compare September 3, 2018 12:44

cgwalters reviewed Sep 4, 2018

View reviewed changes

Umang Jain and others added 2 commits September 5, 2018 00:28

fixup! Add tests for ostree_repo_get_min_free_space_bytes

03ce8d6

fixup! Add tests for ostree_repo_get_min_free_space_bytes

9ba887d

rh-atomic-bot pushed a commit that referenced this pull request Sep 4, 2018

lib/repo: Add an API to get min-free-space-* reserved bytes

239d5af

https://phabricator.endlessm.com/T23694 Closes: #1715 Approved by: cgwalters

rh-atomic-bot pushed a commit that referenced this pull request Sep 4, 2018

Add tests for ostree_repo_get_min_free_space_bytes

472a693

https://phabricator.endlessm.com/T23694 Closes: #1715 Approved by: cgwalters

cgwalters added the homu/approved label Sep 4, 2018

rh-atomic-bot pushed a commit that referenced this pull request Sep 4, 2018

lib/repo: Add an API to get min-free-space-* reserved bytes

68420f7

https://phabricator.endlessm.com/T23694 Closes: #1715 Approved by: cgwalters

rh-atomic-bot pushed a commit that referenced this pull request Sep 4, 2018

Add tests for ostree_repo_get_min_free_space_bytes

a70d2f6

https://phabricator.endlessm.com/T23694 Closes: #1715 Approved by: cgwalters

rh-atomic-bot closed this in 3814d07 Sep 4, 2018

uajain mentioned this pull request Sep 12, 2018

Rework ostree_repo_get_min_free_space_bytes () #1720

Closed

mwleeds pushed a commit to mwleeds/ostree that referenced this pull request Sep 24, 2018

lib/repo: Add an API to get min-free-space-* reserved bytes

170fc6a

https://phabricator.endlessm.com/T23694 Closes: ostreedev#1715 Approved by: cgwalters (cherry-picked from 68420f7)

mwleeds pushed a commit to mwleeds/ostree that referenced this pull request Sep 24, 2018

Add tests for ostree_repo_get_min_free_space_bytes

560242e

https://phabricator.endlessm.com/T23694 Closes: ostreedev#1715 Approved by: cgwalters (cherry-picked from a70d2f6)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

repo: Add an API to get min-free-space-* reserved bytes #1715

repo: Add an API to get min-free-space-* reserved bytes #1715

uajain commented Aug 30, 2018

pwithnall left a comment

pwithnall left a comment

pwithnall Aug 31, 2018

pwithnall Aug 31, 2018

pwithnall Aug 31, 2018

pwithnall Aug 31, 2018

uajain Aug 31, 2018

pwithnall Aug 31, 2018

uajain Aug 31, 2018

pwithnall Aug 31, 2018

pwithnall Sep 3, 2018

uajain commented Sep 3, 2018

cgwalters Sep 4, 2018

uajain Sep 4, 2018

cgwalters commented Sep 4, 2018

rh-atomic-bot commented Sep 4, 2018

rh-atomic-bot commented Sep 4, 2018

cgwalters commented Sep 4, 2018 via email

rh-atomic-bot commented Sep 4, 2018

rh-atomic-bot commented Sep 4, 2018


		config = ostree_repo_copy_config (repo);

		while (values_to_test[i] != NULL)

repo: Add an API to get min-free-space-* reserved bytes #1715

repo: Add an API to get min-free-space-* reserved bytes #1715

Conversation

uajain commented Aug 30, 2018

pwithnall left a comment

Choose a reason for hiding this comment

pwithnall left a comment

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

uajain commented Sep 3, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cgwalters commented Sep 4, 2018

rh-atomic-bot commented Sep 4, 2018

rh-atomic-bot commented Sep 4, 2018

cgwalters commented Sep 4, 2018 via email

rh-atomic-bot commented Sep 4, 2018

rh-atomic-bot commented Sep 4, 2018