mktag.c: consolidate tag functions by merging mktag.c into builtin-tag.c
A message that is not in the archive (sent off-list or not yet received): [email protected]
A message that is not in the archive (sent off-list or not yet received): [email protected]
A message that is not in the archive (sent off-list or not yet received): [email protected]
A message that is not in the archive (sent off-list or not yet received): [email protected]
A message that is not in the archive (sent off-list or not yet received): [email protected]
PATCH 5/5 git-tag: call verify_tag_buffer to validate the generated tag object
From: Brandon Casey <[email protected]>
This will ensure that both git-tag and git-mktag "produce valid tags, with the same definition of validity."
--- builtin-tag.c | 2 ++ 1 files changed, 2 insertions(+), 0 deletions(-)
builtin-tag.c +2 -0
@@ -508,6 +508,8 @@ static void create_tag(const unsigned char *object, const char *tag,if (sign &&do_sign (buf) <0 )die ("unable to sign the tag" ); +if (verify_tag_buffer (buf->buf, buf->len) <0 ) +die ("invalid tag object" );if (write_sha1_file (buf->buf, buf->len, tag_type, result) <0 )die ("unable to write tag file" ); }
Signature · 1 line
1.5.5.67.g9a49
PATCH 4/5 mktag.c: consolidate tag functions by merging mktag.c into builtin-tag.c
In reply to a message not in the archiveFrom: Brandon Casey <[email protected]>
--- Makefile | 1 - builtin-tag.c | 181 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ mktag.c | 183 --------------------------------------------------------- 3 files changed, 181 insertions(+), 184 deletions(-) delete mode 100644 mktag.c
Makefile +0 -1
@@ -423,7 +423,6 @@ LIB_OBJS += log-tree.o LIB_OBJS += mailmap.o LIB_OBJS += match-trees.o LIB_OBJS += merge-file.o -LIB_OBJS += mktag.o LIB_OBJS += object.o LIB_OBJS += pack-check.o LIB_OBJS += pack-revindex.o
builtin-tag.c +181 -0
190 lines not on this page · raw message
mktag.c deleted +0 -183
183 lines not on this page · raw message
Signature · 1 line
1.5.5.67.g9a49
PATCH 3/5 mktag.c: rename verify_tag to verify_tag_buffer
In reply to a message not in the archiveFrom: Brandon Casey <[email protected]>
This is in preparation for merging mktag.c with builtin-tag.c and using verify_tag_buffer within the git-tag code path.
--- mktag.c | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-)
mktag.c +2 -2
@@ -39,7 +39,7 @@ static int verify_object(unsigned char *sha1, const char *expected_type)#define PD_FMT "%td"#endif -static int verify_tag (const char *buffer,size_t size) +static int verify_tag_buffer (const char *buffer,size_t size) {int typelen;char type[20 ];
@@ -171,7 +171,7 @@ int cmd_mktag(int argc, const char **argv, const char *prefix)/* Verify it for some basic sanity: it needs to start with "object <sha1>\ntype\ntagger " */ -if (verify_tag (buf.buf, buf.len) <0 ) +if (verify_tag_buffer (buf.buf, buf.len) <0 )die ("invalid tag signature file" );if (write_sha1_file (buf.buf, buf.len, tag_type, result_sha1) <0 )
Signature · 1 line
1.5.5.67.g9a49
PATCH 2/5 Make mktag a builtin.
In reply to a message not in the archiveFrom: Brandon Casey <[email protected]>
--- Makefile | 3 ++- builtin.h | 1 + git.c | 1 + mktag.c | 4 +--- 4 files changed, 5 insertions(+), 4 deletions(-)
Makefile +2 -1
@@ -282,7 +282,6 @@ PROGRAMS += git-imap-send$X PROGRAMS += git-index-pack$X PROGRAMS += git-merge-index$X PROGRAMS += git-merge-tree$X -PROGRAMS += git-mktag$X PROGRAMS += git-mktree$X PROGRAMS += git-pack-redundant$X PROGRAMS += git-patch-id$X
@@ -306,6 +305,7 @@ BUILT_INS += git-fsck-objects$X BUILT_INS += git-get-tar-commit-id$X BUILT_INS += git-init$X BUILT_INS += git-merge-subtree$X +BUILT_INS += git-mktag$X BUILT_INS += git-peek-remote$X BUILT_INS += git-repo-config$X BUILT_INS += git-show$X
@@ -423,6 +423,7 @@ LIB_OBJS += log-tree.o LIB_OBJS += mailmap.o LIB_OBJS += match-trees.o LIB_OBJS += merge-file.o +LIB_OBJS += mktag.o LIB_OBJS += object.o LIB_OBJS += pack-check.o LIB_OBJS += pack-revindex.o
builtin.h +1 -0
@@ -58,6 +58,7 @@ extern int cmd_merge_base(int argc, const char **argv, const char *prefix);extern int cmd_merge_ours (int argc,const char **argv,const char *prefix);extern int cmd_merge_file (int argc,const char **argv,const char *prefix);extern int cmd_merge_recursive (int argc,const char **argv,const char *prefix); +extern int cmd_mktag (int argc,const char **argv,const char *prefix);extern int cmd_mv (int argc,const char **argv,const char *prefix);extern int cmd_name_rev (int argc,const char **argv,const char *prefix);extern int cmd_pack_objects (int argc,const char **argv,const char *prefix);
git.c +1 -0
@@ -325,6 +325,7 @@ static void handle_internal_command(int argc, const char **argv) { "merge-ours", cmd_merge_ours, RUN_SETUP }, { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE }, { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE }, + { "mktag", cmd_mktag, RUN_SETUP }, { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE }, { "name-rev", cmd_name_rev, RUN_SETUP }, { "pack-objects", cmd_pack_objects, RUN_SETUP },
mktag.c +1 -3
@@ -156,7 +156,7 @@ static int verify_tag(const char *buffer, size_t size)#undef PD_FMT -int main (int argc,char **argv) +int cmd_mktag (int argc,const char **argv,const char *prefix) {struct strbuf buf;unsigned char result_sha1[20 ];
@@ -164,8 +164,6 @@ int main(int argc, char **argv)if (argc !=1 )usage ("git-mktag < signaturefile" ); -setup_git_directory (); -strbuf_init (&buf,0 );if (strbuf_read (&buf,0 ,4096 ) <0 ) {die ("could not read from stdin" );
Signature · 1 line
1.5.5.67.g9a49
Re: [PATCH 2/5] Make mktag a builtin.
Quoted 13 lines · [email protected] writes:
From: Brandon Casey <[email protected]>
Signed-off-by Brandon Casey <[email protected]>Makefile +1
-0@@ -306,6 +305,7 @@ BUILT_INS += git-fsck-objects$X BUILT_INS += git-get-tar-commit-id$X BUILT_INS += git-init$X BUILT_INS += git-merge-subtree$X +BUILT_INS += git-mktag$X BUILT_INS += git-peek-remote$X BUILT_INS += git-repo-config$X BUILT_INS += git-show$X
Makefile LIB_OBJS += log-tree.o · line 426
Quoted 4 lines
Makefile +1
-0@@ -423,6 +423,7 @@ LIB_OBJS += log-tree.o LIB_OBJS += mailmap.o LIB_OBJS += match-trees.o LIB_OBJS += merge-file.o +LIB_OBJS += mktag.o
This is unusual for a builtin. Why didn't it migrate to builtin-mktag?
Re: [PATCH 2/5] Make mktag a builtin.
Quoted 6 lines · Junio C Hamano
Quoted 3 lines · [email protected] writes:
From: Brandon Casey <[email protected]>
Signed-off-by Brandon Casey <[email protected]>
Quoted 15 lines
Review LIB_OBJS += log-tree.o · line 426
Quoted 13 lines
(quoted diff) +2
-0@@ -306,6 +305,7 @@ BUILT_INS += git-fsck-objects$X BUILT_INS += git-get-tar-commit-id$X BUILT_INS += git-init$X BUILT_INS += git-merge-subtree$X +BUILT_INS += git-mktag$X BUILT_INS += git-peek-remote$X BUILT_INS += git-repo-config$X BUILT_INS += git-show$X@@ -423,6 +423,7 @@ LIB_OBJS += log-tree.o LIB_OBJS += mailmap.o LIB_OBJS += match-trees.o LIB_OBJS += merge-file.o +LIB_OBJS += mktag.oThis is unusual for a builtin. Why didn't it migrate to builtin-mktag?
That is, something along this line, instead.
-- >8 --
From: Brandon Casey <[email protected]>
Date: Thu, 8 May 2008 21:19:46 -0500
Subject: [PATCH] Make mktag a builtin
--- Makefile | 2 +- mktag.c => builtin-mktag.c | 4 +--- builtin.h | 1 + git.c | 1 + 4 files changed, 4 insertions(+), 4 deletions(-) rename mktag.c => builtin-mktag.c (98%)
Makefile +1 -1
@@ -282,7 +282,6 @@ PROGRAMS += git-imap-send$X PROGRAMS += git-index-pack$X PROGRAMS += git-merge-index$X PROGRAMS += git-merge-tree$X -PROGRAMS += git-mktag$X PROGRAMS += git-mktree$X PROGRAMS += git-pack-redundant$X PROGRAMS += git-patch-id$X
@@ -510,6 +509,7 @@ BUILTIN_OBJS += builtin-merge-base.o BUILTIN_OBJS += builtin-merge-file.o BUILTIN_OBJS += builtin-merge-ours.o BUILTIN_OBJS += builtin-merge-recursive.o +BUILTIN_OBJS += builtin-mktag.o BUILTIN_OBJS += builtin-mv.o BUILTIN_OBJS += builtin-name-rev.o BUILTIN_OBJS += builtin-pack-objects.o
builtin-mktag.c renamed from mktag.c +1 -3
@@ -149,7 +149,7 @@ static int verify_tag(const char *buffer, size_t size)#undef PD_FMT -int main (int argc,char **argv) +int cmd_mktag (int argc,const char **argv,const char *prefix) {struct strbuf buf;unsigned char result_sha1[20 ];
@@ -157,8 +157,6 @@ int main(int argc, char **argv)if (argc !=1 )usage ("git-mktag < signaturefile" ); -setup_git_directory (); -strbuf_init (&buf,0 );if (strbuf_read (&buf,0 ,4096 ) <0 ) {die ("could not read from stdin" );
builtin.h +1 -0
@@ -58,6 +58,7 @@ extern int cmd_merge_base(int argc, const char **argv, const char *prefix);extern int cmd_merge_ours (int argc,const char **argv,const char *prefix);extern int cmd_merge_file (int argc,const char **argv,const char *prefix);extern int cmd_merge_recursive (int argc,const char **argv,const char *prefix); +extern int cmd_mktag (int argc,const char **argv,const char *prefix);extern int cmd_mv (int argc,const char **argv,const char *prefix);extern int cmd_name_rev (int argc,const char **argv,const char *prefix);extern int cmd_pack_objects (int argc,const char **argv,const char *prefix);
git.c +1 -0
@@ -325,6 +325,7 @@ static void handle_internal_command(int argc, const char **argv) { "merge-ours", cmd_merge_ours, RUN_SETUP }, { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE }, { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE }, + { "mktag", cmd_mktag, RUN_SETUP }, { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE }, { "name-rev", cmd_name_rev, RUN_SETUP }, { "pack-objects", cmd_pack_objects, RUN_SETUP },
Signature · 1 line
1.5.5.1.295.g4c42f
Re: [PATCH 2/5] Make mktag a builtin.
In reply to Junio C HamanoQuoted 6 lines · Junio C Hamano
Quoted 3 lines · [email protected] writes:
From: Brandon Casey <[email protected]>
Signed-off-by Brandon Casey <[email protected]>
Quoted 15 lines
Makefile LIB_OBJS += log-tree.o · line 426
Quoted 13 lines
Makefile +2
-0@@ -306,6 +305,7 @@ BUILT_INS += git-fsck-objects$X BUILT_INS += git-get-tar-commit-id$X BUILT_INS += git-init$X BUILT_INS += git-merge-subtree$X +BUILT_INS += git-mktag$X BUILT_INS += git-peek-remote$X BUILT_INS += git-repo-config$X BUILT_INS += git-show$X@@ -423,6 +423,7 @@ LIB_OBJS += log-tree.o LIB_OBJS += mailmap.o LIB_OBJS += match-trees.o LIB_OBJS += merge-file.o +LIB_OBJS += mktag.oThis is unusual for a builtin. Why didn't it migrate to builtin-mktag?
I didn't know how to do it.
I was trying not to do a code move and a code change at the same time. I didn't think I should move the non-builtin mktag.c to builtin-mktag.c, and then after I modified mktag to be a builtin I knew I was moving it to builtin-tag.c so I didn't see a point to renaming it.
Also, I decided about those things _before_ I realized how small the changes would be to mktag to make it a builtin.
Do you think the modified patch you posted conflicts with the idea that "code move should be separate from code change"?
-brandon
Re: [PATCH 2/5] Make mktag a builtin.
Quoted 3 lines · Brandon Casey
I didn't think I should move the non-builtin
mktag.ctobuiltin-mktag.c, and then after I modified mktag to be a builtin I knew I was moving it tobuiltin-tag.cso I didn't see a point to renaming it.
I see. I did not realize that the eventual shape would be to have both mktag and tag to be in builtin-tag.c, just like builtin-log.c supports many other commands from the log family, and that was where my question came from.
But I think the arrangement to have both in builtin-tag.c actually makes sense --- mktag needs to be kept supported but most of its internal should be shared with tag anyway.
Quoted 5 lines
Also, I decided about those things _before_ I realized how small the changes would be to mktag to make it a builtin.
Do you think the modified patch you posted conflicts with the idea that "code move should be separate from code change"?
Yes, it does, but I do not subscribe to the "idea". Therefor I do not see any problem.
If you were to stop at making mktag a builtin, then the patch I sent would be the change that is necessary to do so. A code movement can and often does need some adjustment (e.g. if you move "a.c" to "src/a.c", its '#include "a.h"' may need to become '#include "../a.h"' (or preferably to '#include <a.h>' with appropriate -I.. option in the Makefile). It does not help anybody to insist on a blanket dogma that forbids modification and movement at the same time.
We do discourage rolling unrelated things in one commit, but creating a builtin "foo" typically involves creation of builtin-foo.c and associated changes to the Makefile and builtin.h, and in this case the initial contents of builtin-mktag.c happens to come from an existing file mktag.c, while making the original mktag.c obsolete and unnecessary along the way. That is a single logical change, and I do not think there is anything wrong to do it in one commit. In fact, splitting such a change into more than one commit is just plain silly and wrong, isn't it?
Re: [PATCH 2/5] Make mktag a builtin.
In reply to Brandon CaseyHi,
Quoted 23 lines · Brandon Casey
Quoted 6 lines · Junio C Hamano
Quoted 3 lines · [email protected] writes:
From: Brandon Casey <[email protected]>
Signed-off-by Brandon Casey <[email protected]>Quoted 15 lines
Makefile LIB_OBJS += log-tree.o · line 426
Quoted 13 lines
Makefile +2
-0@@ -306,6 +305,7 @@ BUILT_INS += git-fsck-objects$X BUILT_INS += git-get-tar-commit-id$X BUILT_INS += git-init$X BUILT_INS += git-merge-subtree$X +BUILT_INS += git-mktag$X BUILT_INS += git-peek-remote$X BUILT_INS += git-repo-config$X BUILT_INS += git-show$X@@ -423,6 +423,7 @@ LIB_OBJS += log-tree.o LIB_OBJS += mailmap.o LIB_OBJS += match-trees.o LIB_OBJS += merge-file.o +LIB_OBJS += mktag.oThis is unusual for a builtin. Why didn't it migrate to builtin-mktag?
Quoted 3 lines
I didn't know how to do it.
I was trying not to do a code move and a code change at the same time.
Why did you not consult Git's own history for guidance? See e.g.
$ git log next --diff-filter=A builtin-*.c
Ciao,
Dscho
Re: [PATCH 2/5] Make mktag a builtin.
Quoted 24 lines · Johannes Schindelin
Hi,
Quoted 20 lines · Brandon Casey
Quoted 19 lines · Junio C Hamano
Quoted 12 lines · [email protected] writes:
From: Brandon Casey <[email protected]>
Signed-off-by Brandon Casey <[email protected]>Makefile +1
-0@@ -306,6 +305,7 @@ BUILT_INS += git-fsck-objects$X BUILT_INS += git-get-tar-commit-id$X BUILT_INS += git-init$X BUILT_INS += git-merge-subtree$X +BUILT_INS += git-mktag$X BUILT_INS += git-peek-remote$X BUILT_INS += git-repo-config$X BUILT_INS += git-show$XMakefile LIB_OBJS += log-tree.o · line 426
Quoted 4 lines
Makefile +1
-0@@ -423,6 +423,7 @@ LIB_OBJS += log-tree.o LIB_OBJS += mailmap.o LIB_OBJS += match-trees.o LIB_OBJS += merge-file.o +LIB_OBJS += mktag.oThis is unusual for a builtin. Why didn't it migrate to builtin-mktag?
Quoted 5 lines
Quoted 3 lines
I didn't know how to do it.
I was trying not to do a code move and a code change at the same time.
Why did you not consult Git's own history for guidance? See e.g.
I did, but not exhaustively. I found only examples of converting a shell/perl script to a c version. That is straight-forward.
Quoted 1 line
$ git log next --diff-filter=A builtin-*.c
And indeed the first two results here are examples of converting scripts to builtin c versions.
The third result is applicable and converts merge-recursive from a standalone c version to builtin.
If I had known about (or looked for) the --diff-filter option I would have used the 'R' argument, since I am interested in a rename event, but it produces no results.
$ git log next --diff-filter=R builtin-*.c
Adding -M does not help.
-brandon
PATCH 1/5 mktag.c: adjust verify_tag parameters
In reply to a message not in the archiveFrom: Brandon Casey <[email protected]>
The size parameter should be a size_t since it is a string length.
There is no reason that the buffer argument should not be constant except for the nul termination that is performed in the first few lines of this function. This is not necessary, since a valid c string must always be nul terminated and we can check whether we have exceeded the caller's size parameter at the end of parsing the buffer.
--- mktag.c | 11 ++++++++--- 1 files changed, 8 insertions(+), 3 deletions(-)
mktag.c +8 -3
@@ -39,7 +39,7 @@ static int verify_object(unsigned char *sha1, const char *expected_type)#define PD_FMT "%td"#endif -static int verify_tag (char *buffer,unsigned long size) +static int verify_tag (const char *buffer,size_t size) {int typelen;char type[20 ];
@@ -50,8 +50,6 @@ static int verify_tag(char *buffer, unsigned long size)if (size <84 )return error ("wanna fool me ? you obviously got the size wrong !" ); - buffer[size] =0 ; -/* Verify object line */ object = buffer;if (memcmp (object,"object " ,7 ))
@@ -145,6 +143,13 @@ static int verify_tag(char *buffer, unsigned long size)return error ("char" PD_FMT ": trailing garbage in tag header" , tagger_line - buffer); +/* +* Make sure we haven't advanced past what the caller said the +* buffer size was. +*/ +if (tagger_line - buffer >= size) +return error ("char" PD_FMT ": tag truncated" , size); +/* The actual stuff afterwards we don't care about.. */ return 0 ; }
Signature · 1 line
1.5.5.67.g9a49
Re: [PATCH 1/5] mktag.c: adjust verify_tag parameters
Quoted 3 lines · [email protected] writes:
From: Brandon Casey <[email protected]>
The size parameter should be a
size_tsince it is a string length.
Correct.
Quoted 5 lines
There is no reason that the buffer argument should not be constant except for the nul termination that is performed in the first few lines of this function. This is not necessary, since a valid c string must always be nul terminated and we can check whether we have exceeded the caller's size parameter at the end of parsing the buffer.
Wait a minute. The point of passing a stringlet as a tuple of <pointer to the beginning, length> is that you may not have a valid C string to begin with, isn't it? We shouldn't be assuming that reading past the given size is Ok --- you may not be lucky enough to have any NUL byte after the given string before you hit the page boundary and encounter unmapped page.
The generic-looking argument you made is bogus, but for this particular code it is true, as the parameter you are passing to the function is prepared by strbuf_read() which gives you a NUL terminated buffer.
So the code is correct -- justification is not.
Quoted 43 lines
Signed-off-by Brandon Casey <[email protected]>--- mktag.c | 11 ++++++++--- 1 files changed, 8 insertions(+), 3 deletions(-)mktag.c +8
-3@@ -39,7 +39,7 @@ static int verify_object(unsigned char *sha1, const char *expected_type)#define PD_FMT "%td"#endif -static int verify_tag (char *buffer,unsigned long size) +static int verify_tag (const char *buffer,size_t size) {int typelen;char type[20 ];@@ -50,8 +50,6 @@ static int verify_tag(char *buffer, unsigned long size)if (size <84 )return error ("wanna fool me ? you obviously got the size wrong !" ); - buffer[size] =0 ; -/* Verify object line */ object = buffer;if (memcmp (object,"object " ,7 ))@@ -145,6 +143,13 @@ static int verify_tag(char *buffer, unsigned long size)return error ("char" PD_FMT ": trailing garbage in tag header" , tagger_line - buffer); +/* +* Make sure we haven't advanced past what the caller said the +* buffer size was. +*/ +if (tagger_line - buffer >= size) +return error ("char" PD_FMT ": tag truncated" , size); +/* The actual stuff afterwards we don't care about.. */ return 0 ; }Signature · 1 line
1.5.5.67.g9a49
Re: [PATCH 1/5] mktag.c: adjust verify_tag parameters
Quoted 14 lines · Junio C Hamano
Quoted 3 lines · [email protected] writes:
From: Brandon Casey <[email protected]>
The size parameter should be a
size_tsince it is a string length.Correct.
Quoted 5 lines
There is no reason that the buffer argument should not be constant except for the nul termination that is performed in the first few lines of this function. This is not necessary, since a valid c string must always be nul terminated and we can check whether we have exceeded the caller's size parameter at the end of parsing the buffer.
Quoted 3 lines
Wait a minute. The point of passing a stringlet as a tuple of <pointer to the beginning, length> is that you may not have a valid C string to begin with, isn't it?
I thought it was just to limit the scope of parsing.
Other functions that deal with non-nul-terminated memory segments (like memchr) do not use char*, they instead use void*.
If we want to handle non-nul-terminated memory segments here, we should probably allocate a new string to copy the memory segment into so we can ensure it is nul-terminated. Otherwise we can't use any of the str*() functions safely.
-brandon