Linux commando: locate

Je hebt een bestand nodig en je weet hoe het heet, maar je weet niet waar het staat. Het kan overal op een server met miljoenen bestanden staan. Je zou de hele schijf kunnen doorzoeken met find en wachten, of je kunt een programma gebruiken dat al weet waar alles staat en antwoord geeft nog voordat je klaar bent met typen. Dat programma is locate. Het doorzoekt de schijf helemaal niet; het zoekt het antwoord op in een index, en daarom lijkt het alsof het direct gebeurt.

2. Waar komt de naam vandaan?

Net als find is de naam locate geen afkorting of grap. Het is het gewone Engelse werkwoord voor de taak: to locate, een bestand lokaliseren. De vroege Unix-auteurs hielden van korte, gewone woorden voor gewone taken, en korter dan dit wordt het woord niet.

Het interessante zit in de letter ervoor. Op een modern Linux-systeem heet het commando dat je uitvoert bijna nooit gewoon locate; het is een van een familie waarvan de eenletterige prefix de geschiedenis van de tool vastlegt:

Dus als je vandaag locate typt, voer je vrijwel zeker plocate of mlocate uit onder die vriendelijke naam. Elke prefix markeert een stap vooruit: maak het eerst veilig, maak dan de dagelijkse update goedkoop, maak vervolgens het zoeken zelf razendsnel. De prefix lezen is de changelog lezen.

4. Eenvoudige toepassingen

4.1 Het eenvoudigste gebruik

Geef locate een woord, en het print elk pad in de database dat dat woord ergens bevat:

$ locate sshd_config
/etc/ssh/sshd_config
/usr/share/man/man5/sshd_config.5.gz

Merk op dat het woord overal in het pad kan voorkomen, niet alleen aan het eind. Standaard wordt het patroon behandeld als een gewone deelreeks: locate hosts matcht /etc/hosts en ook /usr/lib/ghostscript, omdat de letters hosts in ghostscript zitten. Dit is de grootste verrassing voor nieuwe gebruikers, en sectie 5 laat zien hoe je het aanscherpt.

4.2 Hoofdletterongevoelig zoeken

Standaard is de match hoofdlettergevoelig. De vlag -i (kort voor ignore case) laat het matchen ongeacht hoofdletters, wat je wilt als je niet zeker weet hoe een bestand is genoemd:

$ locate -i readme
/opt/app/README.md
/usr/share/doc/bash/readme.txt

4.3 Tellen in plaats van opsommen

Als je alleen wilt weten hoeveel matches er zijn, print de vlag -c (kort voor count) een getal in plaats van een lange lijst:

$ locate -c .conf
1873

Dit is een snelle manier om de omvang van een resultaat in te schatten voordat je je scherm ermee overspoelt.

4.4 Zoeken naar meerdere woorden tegelijk

Je kunt meer dan een patroon meegeven. Dit is het ene gedrag waar plocate en het oudere mlocate echt verschillen, dus het is goed om te weten welke je hebt. Op plocate betekent meerdere patronen meegeven "match ze allemaal", als een AND:

$ locate nginx conf         # plocate: paths containing BOTH "nginx" and "conf"
/etc/nginx/nginx.conf
/etc/nginx/conf.d/default.conf

Op mlocate betekent hetzelfde commando "match er een van" (een OR), en zou je -A (kort voor all) toevoegen om ze allemaal te vereisen. plocate accepteert -A ook, maar negeert het, omdat AND al de standaard is.

6. Geavanceerde toepassingen

6.1 Waar de database vandaan komt: updatedb

Alles wat locate weet komt uit een bestand, de database, en een commando bouwt het: updatedb. Het draait als root zodat het de hele schijf kan zien, doorloopt het bestandssysteem en schrijft de index die locate later leest. Op een modern systeem draait het automatisch een keer per dag via een systemd-timer of een cron-taak:

$ systemctl list-timers | grep updatedb
plocate-updatedb.timer  plocate-updatedb.service

Als je net bestanden hebt aangemaakt en er nu naar wilt zoeken, hoef je niet op de run van morgen te wachten. Trigger het zelf:

$ sudo updatedb          # rebuild the index now, then locate sees new files

6.2 Bepalen wat wordt geindexeerd

Je wilt zelden elk pad in de index. Tijdelijke bestanden, netwerkschijven en virtuele bestandssystemen zouden hem alleen opblazen en de dagelijkse run vertragen. Het bestand /etc/updatedb.conf vertelt updatedb wat het moet overslaan:

PRUNEPATHS="/tmp /var/spool /media"
PRUNEFS="nfs cifs tmpfs proc sysfs devtmpfs"
PRUNENAMES=".git .svn .hg"

• PRUNEPATHS somt mappen op die volledig worden overgeslagen.
• PRUNEFS somt bestandssysteemtypes op om over te slaan, zodat een aangekoppelde netwerkschijf of een virtuele /proc nooit wordt doorlopen.
• PRUNENAMES somt mapnamen op om over te slaan waar ze ook voorkomen, zoals .git-mappen.

Daarom vindt locate meestal geen bestand onder /tmp: dat pad wordt met opzet overgeslagen. Als een heel deel van je schijf onzichtbaar lijkt voor locate, is dit bestand de eerste plek om te kijken.

6.3 Een andere database doorzoeken

Je bent niet beperkt tot de systeemindex. De vlag -d (kort voor database) wijst locate naar een ander indexbestand, wat handig is voor een eigen index van een groot project of een externe schijf:

$ updatedb -l 0 -o photos.db -U /mnt/photos     # build a private index
$ locate -d photos.db beach                      # search only that index

De -l 0 hierboven schakelt de permissie-zichtbaarheidsfunctie uit voor een eigen index die je zelf bouwt, en -U vertelt updatedb welke map het moet indexeren. Je kunt ook de omgevingsvariabele LOCATE_PATH instellen om automatisch een extra database aan elke zoekactie toe te voegen.

6.4 Echte reguliere expressies

Als globs niet expressief genoeg zijn, kan locate matchen met reguliere expressies. De vlag -r (kort voor regexp) gebruikt POSIX basic regex, en --regex gebruikt de extended variant, hetzelfde als grep -E:

$ locate --regex '/(nginx|apache2)/.*\.conf$'
/etc/nginx/nginx.conf
/etc/apache2/apache2.conf

Er zijn kosten die het waard zijn te begrijpen. Normaal springt plocate met zijn index meteen naar kandidaten en raakt het de database nauwelijks aan. Een regex kan die index niet gebruiken, dus dwingt het een trage lineaire scan van elke regel af. Gebruik regex als je het nodig hebt, maar geef de voorkeur aan een glob als een glob volstaat.

6.5 Waarom locate geen prive-bestanden lekt

De index wordt gebouwd door root en somt bestanden op die gewone gebruikers niet kunnen lezen. Hoe voorkomt locate dan dat het je de prive-paden van je buurman laat zien? Het draait met de setgid-bit, waardoor het de beveiligde index kan openen, maar voordat het een resultaat print controleert het of jij permissie hebt om dat pad te bereiken. Als je lees- en uitvoerrechten op de bovenliggende mappen mist, wordt de match stilletjes weggelaten. De kaartenbak is compleet, maar iedereen ziet alleen zijn eigen deel ervan.

8. Beste werkwijzen

• Grijp eerst naar locate, dan naar find. Voor een simpele "waar staat dit bestand"-vraag is het veel sneller; gebruik find als je live resultaten of metadatatests nodig hebt.
• Voer sudo updatedb uit na grote wijzigingen. Als je net software hebt geinstalleerd of bestanden hebt aangemaakt en locate ze niet ziet, is de index gewoon verouderd. Ververs hem.
• Zet patronen met jokertekens tussen aanhalingstekens. Schrijf locate '*/passwd', niet locate */passwd, anders breidt de shell het patroon uit voordat locate het ziet.
• Gebruik -b om ruis te beperken. Als een veelvoorkomend woord in veel mapnamen verstopt zit, match dan alleen de basename.
• Voeg -e toe als je iets met de resultaten gaat doen. Het laat paden weg die niet meer bestaan, zodat je geen verwijderd bestand najaagt.
• Geef de voorkeur aan een glob boven een regex. Een glob gebruikt de snelle index; -r en --regex forceren een volledige scan.
• Gebruik -0 | xargs -0 in pijpen. Het is de enige veilige manier om resultaten met spaties of regeleindes aan een ander commando door te geven.

Als je alle details nodig hebt, is de documentatie een commando ver weg:

$ man locate      # the manual for your locate (often plocate or mlocate)
$ locate --help   # a quick summary of every option
$ man updatedb    # how the index is built and scheduled

10. Samenvatting

Het commando locate vindt bestanden op naam op het hele systeem vrijwel onmiddellijk, door ze op te zoeken in een voorbereide index in plaats van de schijf te doorzoeken.

• locate leest een database die eens per dag door updatedb wordt gebouwd; het is snel omdat het nooit het live bestandssysteem doorloopt.
• De keerzijde is actualiteit: gloednieuwe bestanden ontbreken tot de index bijwerkt, dus voer sudo updatedb uit als je actuele resultaten nodig hebt.
• De naam die je typt is meestal plocate of mlocate; de prefix legt de geschiedenis van de tool vast, van secure naar merging naar posting-list.
• Patronen matchen standaard als deelreeks; een jokerteken maakt van het patroon een verankerde glob, en -b beperkt de match tot de bestandsnaam.
• Alledaagse vlaggen: -i (hoofdletters negeren), -c (tellen), -e (alleen bestaande), -l (limiet), -0 (veilig doorgeven).
• Bepaal wat wordt geindexeerd via /etc/updatedb.conf, en gebruik find als je actualiteit, metadata of zoeken in inhoud nodig hebt.

Dit is het overzicht dat het waard is om te bewaren:

locate hosts                 paths containing "hosts" anywhere
locate -i readme             same, ignoring upper/lower case
locate -c .conf              count the matches instead of listing them
locate nginx conf            plocate: paths matching BOTH words
locate -b '\.conf'           match the file name only, not the folders
locate '*/passwd'            glob: path must end in /passwd
locate -e report.pdf         only results that still exist on disk
locate -l 5 .service         stop after the first 5 matches
locate -0 '*.bak' | xargs -0 ls -lh   safe pipe for odd names
locate --regex '\.log$'      match with an extended regular expression
sudo updatedb                rebuild the index now
man updatedb                 how the index is built and pruned

Als locate eenmaal onderdeel van je gewoontes is, voelt een grote server niet meer als een doolhof. Je stopt met gissen waar dingen staan en vraagt het gewoon, en het antwoord komt voordat je de gedachte hebt afgemaakt. Als je servers zijn uitgegroeid tot iets waar niemand nog echt de weg in vindt, is dat op orde brengen, en het snel en netjes houden, precies het soort werk waar ik bij help.