On Wed, Aug 29, 2018 at 02:04:55PM -0700, Jaegeuk Kim wrote:
> Thank you so much for kind explanation. This is really awesome especially for
> newbies like me. This gives answers to me for all my own stupid questions like
> why I need to investigate all the lib changes in order to determine bumping
> current/revision/age numbers or not.
>
> I'd definitely like to follow this rule to avoid any verion changes later, as
> I expect the next release will be the last major update. For dependency parts,
> I'll study and practice them for a while.
If you are going to be making one less major update, this is the
perfect time to make sure that data structures are allocated by the
library, and are (ideally) opaque to the calling application (so they
only manipulate structure poitners). That is, the structure
definition is not exposed in the public header file, and you use
accessor functions to set and get fields in the structure.
If you can't do that for all data structures, if you can do that with
your primary data structure that's going to make your life much easier
in the long term. For ext2fs, that's the file systme handle. It's
created by ext2fs_open(), and it's passed to all other library
functions as the first argument.
The other thing you might want to consider doing is adding a magic
number to the beginning of each structure. That way you can tell if
the wrong structure gets passed to a library. It's also helpful for
doing the equivalent of subclassing in C.
This is how we do it in libext2fs --- we use com_err to define the
magic numbers:
error_table ext2
ec EXT2_ET_BASE,
"EXT2FS Library version @E2FSPROGS_VERSION@"
ec EXT2_ET_MAGIC_EXT2FS_FILSYS,
"Wrong magic number for ext2_filsys structure"
ec EXT2_ET_MAGIC_BADBLOCKS_LIST,
"Wrong magic number for badblocks_list structure"
...
And then every single structure starts like so:
struct struct_ext2_filsys {
errcode_t magic;
...
struct ext2_struct_inode_scan {
errcode_t magic;
...
And then before we use any pointer we do this:
if (file->magic != EXT2_ET_MAGIC_EXT2_FILE)
return EXT2_ET_MAGIC_EXT2_FILE;
Anyway, you don't have to do any of this, but if you're thinking about
making a big major version number bump, this is a great opportunity to
do some of these things.
> BTW, can I archive this like in f2fs-tools/VERSIONING?
Sure, feel free!
- Ted
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Linux-f2fs-devel mailing list
Linux-f2fs-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
