Aren't you already tired of using the crappy string handling functions that libc provides? I see a lot of really ugly code in git that exists just because this.
I also see a lot of potential buffer overflows because either no overflow checking is done, or it's done wrong. Perhaps it doesn't matter now if you're manually inspecting each patch before feeding to git, but I fear that in future someone's automated git handler will be responsible for getting malicious code added into Linux, just because of a simple buffer overflow that could have been easily avoided.
So here's my try on starting with something simple. Unlike almost all other string handling libraries, it doesn't allocate the memory dynamically. This makes it really easy to convert existing code to use it. I'm including some example changes in the other patches. Besides making the code safer, it can also make it faster, especially those strcat() replacements.
I'm aware of strbuf.[ch], but I wasn't sure if I should have merged this code with it or what. It had this "eof" field which I think makes it more like a "file reader string" and not a "string buffer". So I just added new str.[ch] files.
--- Makefile | 4 ++-- str.c | 40 ++++++++++++++++++++++++++++++++++++++++ str.h | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 74 insertions(+), 2 deletions(-) create mode 100644 str.c create mode 100644 str.h
Show changes to 3 files +74 −2
Makefile, str.c, str.h
diff --git a/Makefile b/Makefile index 29243c6..f61ad50 100644 --- a/Makefile +++ b/Makefile @@ -294,7 +294,7 @@ XDIFF_LIB=xdiff/lib.a LIB_H = \ archive.h blob.h cache.h commit.h csum-file.h delta.h grep.h \ diff.h object.h pack.h pkt-line.h quote.h refs.h list-objects.h sideband.h \ - run-command.h strbuf.h tag.h tree.h git-compat-util.h revision.h \ + run-command.h strbuf.h str.h tag.h tree.h git-compat-util.h revision.h \ tree-walk.h log-tree.h dir.h path-list.h unpack-trees.h builtin.h \ utf8.h reflog-walk.h patch-ids.h attr.h decorate.h progress.h mailmap.h @@ -312,7 +312,7 @@ LIB_OBJS = \ object.o pack-check.o pack-write.o patch-delta.o path.o pkt-line.o \ sideband.o reachable.o reflog-walk.o \ quote.o read-cache.o refs.o run-command.o dir.o object-refs.o \ - server-info.o setup.o sha1_file.o sha1_name.o strbuf.o \ + server-info.o setup.o sha1_file.o sha1_name.o strbuf.o str.o \ tag.o tree.o usage.o config.o environment.o ctype.o copy.o \ revision.o pager.o tree-walk.o xdiff-interface.o \ write_or_die.o trace.o list-objects.o grep.o match-trees.o \ diff --git a/str.c b/str.c new file mode 100644 index 0000000..d46e7f4 --- /dev/null +++ b/str.c @@ -0,0 +1,40 @@ +#include "str.h" + +void _str_append(struct string *str, const char *cstr) +{ + unsigned int avail = str->size - str->len; + unsigned int len = strlen(cstr); + + if (len >= avail) { + len = avail - 1; + str->overflowed = 1; + } + memcpy(str->buf + str->len, cstr, len); + str->len += len; + str->buf[str->len] = '\0'; +} + +void _str_printfa(struct string *str, const char *fmt, ...) +{ + unsigned int avail = str->size - str->len; + va_list va; + int ret; + + va_start(va, fmt); + ret = vsnprintf(str->buf + str->len, avail, fmt, va); + if (ret < avail) + str->len += ret; + else { + str->len += avail - 1; + str->overflowed = 1; + } + va_end(va); +} + +void _str_truncate(struct string *str, unsigned int len) +{ + if (len >= str->size) + len = str->size - 1; + str->len = len; + str->buf[len] = '\0'; +} diff --git a/str.h b/str.h new file mode 100644 index 0000000..99d3215 --- /dev/null +++ b/str.h @@ -0,0 +1,32 @@ +#ifndef STR_H +#define STR_H + +#include "git-compat-util.h" + +struct string { + unsigned int size; + unsigned int len:31; + unsigned int overflowed:1; + char buf[]; +}; + +#define stringbuf(name, size) \ + union { \ + struct string string; \ + char string_buf[sizeof(struct string) + (size) + 1]; \ + } name = { { (size)+1, 0, 0 } } + +extern void _str_append(struct string *str, const char *cstr); +extern void _str_printfa(struct string *str, const char *fmt, ...) + __attribute__((format (printf, 2, 3))); +extern void _str_truncate(struct string *str, unsigned int len); + +#define str_append(str, cstr) _str_append(&(str).string, cstr) +#define str_printfa(str, fmt, ...) _str_printfa(&(str).string, fmt, __VA_ARGS__) +#define str_truncate(str, len) _str_truncate(&(str).string, len) + +#define str_c(str) ((str).string.buf) +#define str_len(str) ((str).string.len) +#define str_overflowed(str) ((str).string.overflowed) + +#endif
-- 1.5.1.4
