[llvm-libtool-darwin] Add support for -static option

[sameerarora101]

Summary

Add support for creating static libraries when the input
includes only binaries (and not libraries/archives themselves)
Depends on D82923

[sameerarora101]

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

15

Thanks, I added --implicit-check-not. Furthermore, I also added -DPREFIX=create-static-lib.test.tmp as the file names are represented by [[PREFIX]]-input1.o and [[PREFIX]]-input2.o

19

Yup, I now check that the symbol is in the right member using the following:

## Check that symbols are present:
# RUN: llvm-nm --print-armap %t.lib | \
# RUN:   FileCheck %s --check-prefix=CHECK-SYMBOLS -DPREFIX=create-static-lib.test.tmp

# CHECK-SYMBOLS:      Archive map
# CHECK-SYMBOLS-NEXT: _symbol1 in [[PREFIX]]-input1.o
# CHECK-SYMBOLS-NEXT: _symbol2 in [[PREFIX]]-input2.o
# CHECK-SYMBOLS-EMPTY:

Would this be ok?

llvm/test/tools/llvm-libtool-darwin/invalid-arguments.test

7

Yes, the actual error msg also has the double space:

Library Type:  option: must be specified at least once!

9–18

Ok, I have placed all 4 tests into invalid-input-output-args.test now. Please lemme know in case we needed a separate test file for the first test above ## Missing -static option:

20

yup, I added error: in the error message too now, thanks!

llvm/tools/llvm-libtool-darwin/llvm-libtool-darwin.cpp

34–38

this is what help text looks like:

OVERVIEW: llvm-libtool-darwin

USAGE: llvm-libtool-darwin [options] <input files>

OPTIONS:

Color Options:

  --color             - Use colors in output (default=autodetect)

Generic Options:

  --help              - Display available options (--help-hidden for more)
  --help-list         - Display list of available options (--help-list-hidden for more)
  --version           - Display the version of this program

llvm-libtool-darwin options:

  -o                  - Alias for -output
  --output=<filename> - Specify output filename
  Library Type: 
      --static           - Produce a statically linked library from the input files

I created an enum Operation here so that in future we can add support for dynamic operation easily. I can very well make the -static option a boolean flag as well. What do you think?

[sameerarora101]

Updating tests

[sameerarora101]

llvm/tools/llvm-libtool-darwin/llvm-libtool-darwin.cpp

84

@jhenderson Should I replace the type of Member back to auto. clang-tidy raises a warning with StringRef?

[jhenderson]

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

12

It's not widely used, but there is %basename_t which substitutes for just the file name part of %t. This allows the test to not make assumptions about how %t expands, and also keeps the check independent of the test name. I'd recommend trying that.

19

Mostly fine, but use %basename_t here too.

35

Checking -> Check

38

Here and below, use %basename_t too, to avoid baking in file names.

45

Ditto.

51–53

Ditto.

llvm/test/tools/llvm-libtool-darwin/invalid-arguments.test

7

Okay, bonus marks for fixing it in another patch if you want. Or file a bug against the CommandLine code.

llvm/test/tools/llvm-libtool-darwin/invalid-input-output-args.test

27 ↗

(On Diff #275767)

Maybe make this more generic, e.g. "Missing library type option:"

I don't really know where to put this test. It might want to be its own test case entirely, e.g. "missing-library-type.test"

44 ↗

(On Diff #275767)

Use %basename_t here too.

51 ↗

(On Diff #275767)

Use %basename_t here too.

llvm/tools/llvm-libtool-darwin/llvm-libtool-darwin.cpp

27

Adding the categories sounds like a different change to me? You might want to include it alongside a test case to show that unrelated options aren't incldued.

34–38

Your current approach seems fine. I was just making sure it didn't do anything too weird.

84

Well typically you don't want to use a const & for StringRef because it is already a light-weight construct (much the same as you wouldn't use const & to a pointer or primitive type). That is probably the cause of the problem here.

96

See above re. option category change.

[sameerarora101]

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

12

thanks, I now have -DPREFIX=%basename_t.tmp as %basename_t substitutes for the last path component of %t but without the .tmp extension

llvm/test/tools/llvm-libtool-darwin/invalid-arguments.test

7

😂I can fix it in another patch.

llvm/test/tools/llvm-libtool-darwin/invalid-input-output-args.test

27 ↗

(On Diff #275767)

Isn't it similar to ## Missing output file? (That's why I thought it would go here). But I have placed it in missing-library-type.test for now.

llvm/tools/llvm-libtool-darwin/llvm-libtool-darwin.cpp

27

yup, I added OptionCategory in order to prevent the general option --safepoint-ir-verifier-print-only from showing up in the help text. Added a test case for it as well. Thanks

84

ok thanks

[sameerarora101]

Use %basename_t and add test for unrelated options.

[smeenai]

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

19

Might wanna add --match-full-lines here, to ensure there's no unexpected symbol name prefix or member name suffix.

33

You have an underscore instead of a dash :)

Is the purpose to ensure that there's no other members? I assume a -EMPTY would work for that. We should also check for the "Archive : " header, to ensure there's no members before the table of contents member.

48

Might be worth noting that cctools libtool warns in this case, and we don't implement that warning yet.

llvm/test/tools/llvm-libtool-darwin/hide-unrelated-options.test

1 ↗

(On Diff #276081)

This seems unrelated to this diff; perhaps it should be in the previous one?

llvm/test/tools/llvm-libtool-darwin/invalid-input-output-args.test

1 ↗

(On Diff #276081)

Can you add -static to all of the tests in this file, so that the only invalid part of the command line is the aspect being tested?

llvm/tools/llvm-libtool-darwin/llvm-libtool-darwin.cpp

27

Yup, this should either go in the previous diff or be its own diff.

[jhenderson]

Mostly looks good, barring @smeenai's comments.

llvm/test/tools/llvm-libtool-darwin/invalid-input-output-args.test

27 ↗

(On Diff #275767)

Similar in concept, but different behaviour (it's checking the behaviour of the cl::Required on the Library operation option, which is a different thing to the input and output files).

llvm/test/tools/llvm-libtool-darwin/missing-library-type.test

3–5 ↗

(On Diff #276081)

I don't think it's necessary to add --strict-whitespace here, as the exact formatting of the message isn't really the tool's responsibility. I'd get rid of the double space, as if the message was correct, and the option, so that you don't have to modify this test when you fix the command line message.

llvm/tools/llvm-libtool-darwin/llvm-libtool-darwin.cpp

84

You can get rid of the const too if you want. StringRef itself is immutable, so all this does is stop you re-assigning Member.

[sameerarora101]

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

33

Thanks for catching the underscore.

I added a check for "Archive : " header now. However, using FORMAT-EMPTY would just check that the next line (after 2nd member) has nothing on it. What I thought we wanted to check was that there is nothing at all after the second member. For eg,

Archive : ...
... __.SYMDEF
...<prefix>-input1.o
...<prefix>-input2.o

something here

would pass with FORMAT-EMPTY just below the check for second member, right? But we want it to fail.

llvm/test/tools/llvm-libtool-darwin/hide-unrelated-options.test

1 ↗

(On Diff #276081)

Yup, thanks. Moved it to the previous diff D82923

[sameerarora101]

Updating tests

[smeenai]

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

33

You're right, that makes sense.

[smeenai]

LGTM, but please wait for @jhenderson too.

[jhenderson]

LGTM, with one optional suggestion.

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

52

It might be worth adding a 2&>1 and check the output is empty here, to flag up if a warning starts getting emitted. That way, it points to where to add testing for the warning.

[sameerarora101]

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

52

ok, added

# RUN: llvm-libtool-darwin -static -o %t.lib %t-input1.o %t-input2.o %t-input1.o 2>&1 | \
# RUN:   FileCheck %s --allow-empty --implicit-check-not={{.}}

I hope --alow-empty is the right way to go about empty input files (found it here http://lists.llvm.org/pipermail/llvm-commits/Week-of-Mon-20140804/229905.html). The flag is not there in the documentation

[sameerarora101]

Updating test files

[sameerarora101]

llvm/test/tools/llvm-libtool-darwin/help-message.test

10 ↗

(On Diff #276751)

added --implicit-check-not="--safepoint-ir-verifier-print-only as we know the headers won't be present because of LIST-NOT checks below.

[alexander-shaposhnikov]

llvm/tools/llvm-libtool-darwin/llvm-libtool-darwin.cpp

33

enum class
+ i would add a blank line between the lines 34 and 35

[sameerarora101]

enum -> enum class

[sameerarora101]

As per @alexshap's recommendation, verifyDarwinObject -> verifyMachOObject

[jhenderson]

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

26

If I'm not mistaken, the canonical name is "Mach-O" (we use MachO for variable and tool names etc, but the file format is technically Mach-O, so we should use that in comments etc).

52

Sounds like a documentation bug. Feel free to update the doc if you get a minute. By default, FileCheck emits an error if the input is empty, but this can be overridden with the use of --allow-empty. That in turn has got me wondering whether --allow-empty should be replaced by a new option that also implies --implicit-check-not. I've raised that on llvm-dev.

llvm/test/tools/llvm-libtool-darwin/help-message.test

10 ↗

(On Diff #276751)

Sounds reasonable, but I'd get rid of the -- bit of the implicit-check-not pattern, so that it doesn't matter whether options are printed in the help with one or two dashes.

llvm/tools/llvm-libtool-darwin/llvm-libtool-darwin.cpp

51

Mach-O (same as mentioned elsewhere).

72

Ditto.

[sameerarora101]

MachO -> Mach-O in comments and update help-message.test

[sameerarora101]

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

52

ok, I'll create a diff for the doc, thanks!

[sameerarora101]

llvm/test/tools/llvm-libtool-darwin/create-static-lib.test

52

added it here : D83682

[jhenderson]

LGTM again.

[sameerarora101]

Mach-O -> Darwin for archive format in comments