Homebrew ugrep formula for MacOS and Linux

[genivia-inc]

EDIT: The repo includes a Homebrew formula to install the latest version of ugrep, fully-featured and AVX/SSE2 optimized:

$ brew install https://raw.githubusercontent.com/Genivia/ugrep/master/Formula/ugrep.rb

Still, it would be nice to have an official homebrew formula for ugrep. The problem is that I am stuck with brew audit reporting "GitHub repository not notable enough (<30 forks, <30 watchers and <75 stars)".

1. If you're happy with ugrep, please ⭐️ the project.

2. If you want easy installation with homebrew and other installers, please ⭐️ the project.

3. If you want more features in ugrep, please let us know what you want and don't forget to ⭐️ the project when you are happy with the ugrep updates.

But if you are somehow unhappy and have problems with ugrep, please submit your issue with technical details so we can improve ugrep.

[shmidt]

Thank you for the amazing tool!
It seems to me, that it would be better to place this info in readme, since mac users will search for brew info there and might not visit issues page.

[genivia-inc]

Thank you and sorry for the delayed response. I've been busy working on ugrep 2.0 that is now released today.

It seems to me, that it would be better to place this info in readme, since mac users will search for brew info there and might not visit issues page.

Agreed. This "issue" isn't entirely the right way to ask for help. I hope to close it soon.

More important to me is to continue to add feature enhancements to ugrep such as the new query UI option -Q released with 2.0.

I am considering creating a Linux rpm package, in addition to Homebrew formulas.

[shmidt]

Thank you so much for your work!

[EnricoMonese]

In the meantime a Tap could be made, it's basically the same thing but not in the official repo.

[moonfruit]

@genivia-inc @EnricoMonese It would be great if there is a Tap for now!

[genivia-inc]

According to homebrew, you should be able to run brew tap https://github.com/Genivia/ugrep to clone ugrep on MacOS, assuming you have homebrew installed. Then run brew install ugrep to install ugrep and you can use the usual brew commands to update.

[EnricoMonese]

I believe that won't be enough, since homebrew would not know how to compile and install. Here are more info.
Homebrew needs a "formula", a file that has all the the metadata and build/install instructions.
Basically what you need is a file like any one of these and then host it somewhere, in either this repo or a separate repo or even a website may work

[shmidt]

Enrico is right, Homebrew gives an error when I try *brew tap https://github.com/Genivia/ugrep <https://github.com/Genivia/ugrep>*: *Error: Invalid tap name 'https://github.com/Genivia/ugrep <https://github.com/Genivia/ugrep>'.* Best, Dmitry Shmidt

…

On Tue, Apr 28, 2020 at 10:34 AM Enrico Monese ***@***.***> wrote: I believe that won't be enough, since homebrew would not know how to compile and install. Here are more info <https://docs.brew.sh/Formula-Cookbook#grab-the-url>. Homebrew needs a "formula", a file that has all the the metadata and build/install instructions. Basically what you need is a file like any one of these <https://github.com/Homebrew/homebrew-core/tree/master/Formula> and then host it somewhere, in either this repo or a separate repo or even a website may work — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#21 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AALHO4TTOSB3TO3IPIP6QTTRO4HR7ANCNFSM4LGVJM3A> .

[genivia-inc]

OK, that makes more sense. I was not familiar with the way Tap works. I already had a formula, which I updated to the latest v2.0.6 and committed to the master branch:

https://github.com/Genivia/ugrep/tree/master/Formula

[EnricoMonese]

That does work, with running

brew install https://raw.githubusercontent.com/Genivia/ugrep/master/Formula/ugrep.rb

It does however fail at the make install step

Error log

==> make install
Last 15 lines from /Users/enrico/Library/Logs/Homebrew/ugrep/02.make:
          __m256i vlcpeq = _mm256_cmpeq_epi8(vlcp, vlcpm);
                           ^
matcher.cpp:504:28: error: always_inline function '_mm256_cmpeq_epi8' requires target feature 'avx2', but would be inlined into function 'advance' that is compiled without support for 'avx2'
          __m256i vlcseq = _mm256_cmpeq_epi8(vlcs, vlcsm);
                           ^
matcher.cpp:505:27: error: always_inline function '_mm256_movemask_epi8' requires target feature 'avx2', but would be inlined into function 'advance' that is compiled without support for 'avx2'
          uint32_t mask = _mm256_movemask_epi8(_mm256_and_si256(vlcpeq, vlcseq));
                          ^
matcher.cpp:505:48: error: always_inline function '_mm256_and_si256' requires target feature 'avx2', but would be inlined into function 'advance' that is compiled without support for 'avx2'
          uint32_t mask = _mm256_movemask_epi8(_mm256_and_si256(vlcpeq, vlcseq));
                                               ^
4 errors generated.
make[1]: *** [libreflex_a-matcher.o] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [install-recursive] Error 1

[genivia-inc]

Well, this is interesting. Homebrew screws up the build process by removing the essential option -march=native as you can see here in the ~/Library/Logs/Homebrew/ugrep/02.make.cc log (superenv removed: -march=native):

clang++ called with: -std=gnu++11 -DHAVE_CONFIG_H -I. -I.. -I../include -march=native -mavx -DHAVE_AVX -I/usr/local/include -I/usr/local/include -I/usr/include -I/usr/include -I/usr/include -I/usr/include -I/usr/local/include -I/usr/local/include -Wall -Wextra -Wunused -O2 -c -o libreflex_a-matcher.o matcher.cpp
superenv removed:  -march=native -I/usr/local/include -I/usr/local/include -I/usr/local/include -I/usr/local/include -Wall -Wextra -Wunused -O2
superenv added:    -pipe -w -Os -march=core2 -isystem/usr/local/include -isystem/usr/include/libxml2 -isystem/System/Library/Frameworks/OpenGL.framework/Versions/Current/Headers
superenv executed: clang++ -pipe -w -Os -march=core2 -std=gnu++11 -DHAVE_CONFIG_H -I. -I.. -I../include -mavx -DHAVE_AVX -I/usr/include -c -o libreflex_a-matcher.o matcher.cpp -isystem/usr/local/include -isystem/usr/include/libxml2 -isystem/System/Library/Frameworks/OpenGL.framework/Versions/Current/Headers

It replaces this option with -march=core2.

So I made a few changes to the formula:

class Ugrep < Formula
  env :std
  ...
  def install
    ENV.O2
    ENV.deparallelize
    ENV.delete('CFLAGS')
    ENV.delete('CXXFLAGS')
    system "./configure", "--enable-color",
                          "--disable-dependency-tracking",
                          "--disable-silent-rules",
                          "--prefix=#{prefix}"
    system "make"
    system "make", "install"

It works now to install ugrep as follows:

brew install https://raw.githubusercontent.com/Genivia/ugrep/master/Formula/ugrep.rb

[EnricoMonese]

Can confirm, it works now