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

Jump to bottom

HPCC-32845 Guard against KJ reading TLKs as regular index parts #19223

Merged
merged 1 commit into from
Oct 29, 2024
Merged

HPCC-32845 Guard against KJ reading TLKs as regular index parts #19223

merged 1 commit into from
Oct 29, 2024

Conversation

jakesmith
Copy link
Member

@jakesmith jakesmith commented Oct 22, 2024 •
edited
Loading

Also remove some redundant 'delayed' functionality.

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@github-actions GitHub Actions
Copy link

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-32845

Jirabot Action Result:
Assigning user: [email protected]
Workflow Transition To: Merge Pending
Updated PR

@jakesmith jakesmith requested a review from ghalliday October 22, 2024 09:44
ghalliday
ghalliday reviewed Oct 22, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

Does there need to be a similar check in index read?
Also, as discussed we want this to be able to error but continue.

@jakesmith jakesmith force-pushed the HPCC-32845-kj-check-tlk branch from aa52969 to 8b86f78 Compare October 28, 2024 14:29
@jakesmith jakesmith requested a review from ghalliday October 28, 2024 14:42
ghalliday
ghalliday approved these changes Oct 28, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

one question/comment and one minor suggestion.
Happy to merge as is.

thorlcr/thorutil/thormisc.cpp Outdated
part.getFilename(rfn);
StringBuffer filename;
rfn.getPath(filename);
Owned<IKeyIndex> index = createKeyIndex(filename, 0, false, 0);
Copy link
Member

Choose a reason for hiding this comment

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

Is there any way of avoiding this on indexes that really do not have a TLK? Since we do not think this occurs in practice it can wait/maybe never be done.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think in practice all indexes > 1 part will/should have TLK since they are by def. created by Thor and default with buildLocalTlks default on.

It could workout that the group is N and this is N+1 so means it really is an index with a TLK - and only check then, but don't think it's worth it?

thorlcr/thorutil/thormisc.cpp
bool hasTLK(IDistributedFile &file, CActivityBase *activity)
{
unsigned np = file.numParts();
IDistributedFilePart &part = file.queryPart(np-1);
Copy link
Member

Choose a reason for hiding this comment

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

minor: could move test from line 1718 earlier:

if (np [<]= 1)
   return false;

Copy link
Member Author

Choose a reason for hiding this comment

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

have made that change.

@jakesmith jakesmith force-pushed the HPCC-32845-kj-check-tlk branch from 8b86f78 to 8a51134 Compare October 28, 2024 16:25
ghalliday
ghalliday approved these changes Oct 29, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

@jakesmith please squash and I will merge

thorlcr/activities/indexwrite/thindexwrite.cpp
@@ -159,9 +159,9 @@ class IndexWriteActivityMaster : public CMasterActivity
checkFormatCrc(this, _f, helper->getFormatCrc(), nullptr, helper->getFormatCrc(), nullptr, true);
Copy link
Member

Choose a reason for hiding this comment

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

future: could add extra protection against user error:

   if (!isFileKey(_f))
        throw MakeActivityException(this, ENGINEERR_FILE_TYPE_MISMATCH, "Attempting to read flat file as an index: %s", indexFileName.get());

@jakesmith
HPCC-32845 Guard against KJ reading TLKs as regular index parts
c415ffd 
Check that the last part in an index/subindex is a TLK if the
meta data is missing.
Also remove some redundant 'delayed' functionality.

Signed-off-by: Jake Smith <[email protected]>
@jakesmith jakesmith force-pushed the HPCC-32845-kj-check-tlk branch from f1ffb34 to c415ffd Compare October 29, 2024 11:01
@jakesmith
Copy link
Member Author

@ghalliday - squashed

@ghalliday ghalliday merged commit cf4b015 into hpcc-systems:candidate-9.6.x Oct 29, 2024
51 checks passed
@github-actions GitHub Actions
Copy link

Jirabot Action Result:
Added fix version: 9.6.60
Added fix version: 9.8.34
Workflow Transition: 'Resolve issue'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ghalliday ghalliday ghalliday approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jakesmith @ghalliday