Skip to contentSkip to conversation

Discuss GSoC: Implement consistency checks for refs

DISCUSSION shejialuo 2 participants 2 messages Mar 10, 2024 – Mar 14, 2024

lore
Share & tools
lore

shejialuo

author
#0 lore raw

Thanks for you help. I'm sorry for the delay in resonding to your email due to my internship.

Quoted 3 lines

I know this is splitting hairs, but git-fsck(1) doesn't give us the tools to avoid corruption. It only gives us the tools to detect it after the fact.

I DO misundestood the git-fsck(1).

This time, I have read more source codes about git-fsck and refs internal. So I wanna discuss some implementation of the infrastructure this time.

I am inspired by refs-internal.h, this file declares ref_storage_be, and for every backend, it should implement the interfaces like ref_store_init_fn, ref_init_db_fn and etc. And in refs.h, it provides the interfaces to other modules.

Based above idea, I think we could just create files in refs directory and we could implement a file called ref-check.h, we design the interfaces for different backends.

After that, we could compose this structure into ref_storage_be and we could call these interfaces in fsck.c. If there are some different interfaces, we could downcast to a specified type to call the specified functions. (Actually, I have learned a lot how OOP is implemented in C).

Quoted 4 lines

For what it's worth, not all of the checks need to be implemented as part of GSoC. At a minimum, it should result in the infra to allow for backend-specific checks and a couple of checks for at least one of the backends.

I think using the above idea, we could provide an infrastructure to allow more checks later.

Quoted 6 lines

You will certainly need to learn about ref internals a bit. There are some common rules and restrictions that are important in order to figure out what we want to check in the first place. Understanding the "reftable" format would be great, but you may also get away with only implementing generic or "files"-backend specific consistency checks. This depends on the scope you are aiming for.

I think I will at least implement the generic part and files-backend consistency check. I will then read some specs about the reftable and the source code of it. If there is sufficient time available, I think I could implement all of them. However, I am currently interning remotely, the response may slow.

#1 lore raw

Hi Jialuo,

Just wanted to chime in to mention one thing.

Quoted 7 lines · shejialuo

I think I will at least implement the generic part and files-backend consistency check. I will then read some specs about the reftable and the source code of it. If there is sufficient time available, I think I could implement all of them. However, I am currently interning remotely, the response may slow.

Thanks for mentioning this. If your current internship would overlap with the GSoC period, kindly clarify the same in your proposal. Also, if it does overlap kindly clarify the amount of time you'll be able to allocate for the GSoC project in the proposal.

This would be helpful to set the expectations right.

Signature · 3 lines
Sivaraam

Sent from my Android device with K-9 Mail. Please excuse my brevity.