General purpose, language independent. The following tools work based on log files that can be generated from various systems. Time (Unix) - can be used to determine the run time of a program, separately counting user time vs. System time, and CPU time vs. Limitless scalability to deploy smartphone-like UIs on ultra-low-cost hardware and advanced graphics on supercomputers. Qt 6.0 is the foundation we will build on to deliver the productivity platform for the future.
This is a list of performance analysis tools for use in software development.
Download the necessary proof parameters. This is a few gigabytes of data that is downloaded once. Import the snapshot (if specified) and start syncing the Lotus chain. The daemon will start producing lots of log messages right away. From this point, you will have to work on a new terminal and lotus commands will communicate with the running daemon. This repo contains the 'Hardware' files to support STM32 based boards on Arduino version 1.8.x (some older versions may also work) including LeafLabs Maple, and Maple mini, and other generic STM32F103 boards.
General purpose, language independent[edit]
The following tools work based on log files that can be generated from various systems.
- time (Unix) - can be used to determine the run time of a program, separately counting user time vs. system time, and CPU time vs. clock time.[1]
- timem (Unix) - can be used to determine the wall-clock time, CPU time, and CPU utilization similar to time (Unix) but supports numerous extensions.
- Supports reporting peak resident set size, major and minor page faults, priority and voluntary context switches via getrusage.
- Supports sampling procfs on supporting systems to report metrics such as page-based resident set size, virtual memory size, read-bytes, and write-bytes, etc.
- Supports collecting hardware counters when built with PAPI support.
Multiple languages[edit]
The following tools work for multiple languages or binaries.
| Name/Manufacturer | OS | Compiler/Language | What It Does | License |
|---|---|---|---|---|
| Arm MAP | Linux | C, C++, Fortran/Fortran90 and Python applications. | Performance profiler. Shows I/O, communication, floating point operation usage and memory access costs. Supports multi-threaded and multi-process applications - such as those with MPI or OpenMP parallelism and scales to very high node counts. |
GUI based code profiler; does only basic timer-based profiling on Intel processors. Based on OProfile.
Group of events are monitored by selecting specific instruments from: File Activity, Memory Allocations, Time Profiler, GPU activity etc. For system wide impact of the executable: System Trace, System usage, Network Usage, Energy log etc are useful.
Free. Proprietary. Bundled with Xcode, which is also free.Intel AdvisorLinux and Windows. Viewer only on macOS.C, C++, Data Parallel C++ and FortranA collection of design and analysis tools - vectorization (SIMD) optimization, thread prototyping, automated roofline analysis, offload modeling and flow graph analysisFreeware and Proprietary. Available as part of Intel oneAPI Base Toolkit.Linux Trace Toolkit (LTT)LinuxRequires patched kernelCollects data on processes blocking, context switches, and execution time. This helps identify performance problems over multiple processes or threads. Superseded by LTTng.GPLLTTng (Linux Trace Toolkit Next Generation)LinuxSystem software package for correlated tracing of kernel, applications and libraries.GPL/LGPL/MITOProfileLinuxProfiles everything running on the Linux system, including hard-to-profile programs such as interrupt handlers and the kernel itself.Sampling profiler for Linux that counts cache misses, stalls, memory fetches, etc.Open Source GPLv2Linux, SolarisC, C++, Fortran, Java; MPIPerformance and memory profiler.Proprietary freewareperf toolsLinux kernel 2.6.31+Sampling profiler with support of hardware events on several architectures.GPLPerformance Application Programming Interface (PAPI)VariousLibrary for hardware performance counters on modern microprocessors.LIKWIDLinuxC/C++, Fortran, Python, Java and LuaToolsuite of command line applications and library for performance oriented programmers (hardware performance monitoring, affinity control, etc.).GPLv3Pin by IntelLinux, Windows, macOS, AndroidDynamic binary instrumentation system that allows users to create custom program analysis tools.Proprietary but free for non-commercial useRational PurifyPlusAIX, Linux, Solaris, WindowsPerformance profiling tool, memory debugger and code coverage tool.ProprietaryScalascaLinuxC/C++, FortranParallel trace analyser.Free/open source (BSD license)Shark by ApplemacOS (discontinued with 10.7)Performance analyzer.Proprietary freewareSuperluminal PerformanceWindows, Xbox, PlayStationC, C++, RustHybrid sampling & instrumenting profiler, built with usability and scalability in mind.ProprietarySystemtapLinuxProgrammable system tracing/probing tool; may be scripted to generate time- or performance-counter- or function-based profiles of the kernel and/or its userspace.Open sourcetimemoryLinux, macOS, WindowsC, C++, Python, FortranModular C++ toolkit for creating scalable custom instrumentation and sampling tools for performance analysis. Designed to minimize overhead by adapting to the interface of each performance analysis component at compile-time and simplify adding support for invocation and data storage within multi-threaded and multi-process runtimes. Includes many pre-built components for timing, resource usage, hardware-counters, Roofline Model, and the instrumentation APIs for VTune, Intel Advisor, LIKWID, and Arm MAP, among others. Components can be arbitrarily bundled together into a single handle for collective invocations and input argument broadcasting. Python bindings are provided for every component as a stand-alone class for implementing low-overhead Python profiling tools. Profiling via dynamic instrumentation is available on Linux.Free/Open-source (MIT)ValgrindLinux, macOS, Solaris, AndroidAny, including assemblerSystem for debugging and profiling; supports tools to either detect memory management and threading bugs, or profile performance (cachegrind and callgrind). KCacheGrind, valkyrie and alleyoop are front-ends for valgrind.Free/open source (GPL)VTune Profiler by Intel Corporation(formerly VTune Amplifier)
Linux, Windows, viewer only for macOSC, C++, C#, Data Parallel C++ (DPC++), Fortran, .NET, Java, Python, Go, ASM AssemblyA collection of profiling analyses implemented with sampling, instrumentation and processor trace technologies. Includes Hotspot, Threading, HPC, I/O, FPGA, GPU, System, Throttling and Microarchitecture analyses.Freeware and Proprietary. Also available as a part of Intel oneAPI base toolkit.C and C++[edit]
- Arm MAP, a performance profiler supporting Linux platforms.
- AppDynamics, an application performance management solution[buzzword] for C/C++ applications via SDK.
- AQtime Pro, a performance profiler and memory allocation debugger that can be integrated into Microsoft Visual Studio, and Embarcadero RAD Studio, or can run as a stand-alone application.
- IBM Rational Purify was a memory debugger allowing performance analysis.
- Instruments (bundled with Xcode) is used to profile an executable's memory allocations, time usage, filesystem activity, GPU activity etc.
- Intel Parallel Studio contains Intel VTune Amplifier, which tunes both serial and parallel programs. It also includes Intel Advisor and Intel Inspector. Intel Advisor optimizes vectorization (use of SIMD instructions) and prototypes threading implementations. Intel Inspector detects and debugs races, deadlocks and memory errors.
- ParasoftInsure++ provides a graphical tool that displays and animates memory allocations in real time to expose memory blowout, fragmentation, overuse, bottlenecks and leaks.
- Timemory, a modular C++ toolkit for creating performance analysis tools which provides numerous command-line tools and libraries as a by-product of its flexibility and reusability.
- Visual Studio Team System Profiler, commercial profiler by Microsoft.
Java[edit]
- inspectIT is an open-source application performance management (APM) solution[buzzword] for monitoring and analyzing software applications, available under the Apache License, Version 2.0 (ALv2).
- JConsole is the profiler which comes with the Java Development Kit
- JRockit Mission Control, a profiler with low overhead.
- Netbeans Profiler, a profiler integrated into the NetBeans IDE (internally uses jvisualvm profiler)
- Plumbr, Java application performance monitoring with automated root cause detection. Links memory leaks, GC inefficiency, slow database and external web service calls, locked threads, and other performance problems to the line in source code that causes them.
- OverOps, Continuous reliability for the modern software supply chain, automatically detect and deliver root cause automation for all errors.
- VisualVM is a visual tool integrating several commandline JDK tools and lightweight profiling capabilities. It is bundled with the Java Development Kit since version 6, update 7.
- FusionReactor, Java application performance monitoring - low overhead, production grade tools for production debugging, code profiling, memory and thread analysis
JavaScript[edit]
- Firebug is a Firefox plug-in for web development, also has a profiler for JavaScript.
- Microsoft Visual Studio AJAX Profiling Extensions is a free profiling tool for JavaScript by Microsoft Research.
.NET[edit]
- CLR Profiler is a free memory profiler provided by Microsoft for CLR applications.
- GlowCode is a performance and memory profiler for .NET applications using C# and other .NET languages. It identifies time-intensive functions and detects memory leaks and errors in native, managed and mixed Windows x64 and x86 applications.
PHP[edit]
- Xdebug is a PHP extension which provides debugging and profiling capabilities.
See also[edit]
- Memory debugger (includes list of memory profilers)
References[edit]
- ^'CodeXL'. Archived from the original on 19 September 2013. Retrieved 26 September 2013.
External links[edit]
- Performance Analysis Tools, article from the Lawrence Livermore National Laboratory
This guide covers how to install the Lotus applications and launch a Lotus Node. This guide covers installing lotus, lotus-miner and lotus-worker to your computer, and then runs through setting up a Lotus node. For information on running the miner, check the Lotus Miner documentation.
# Minimal requirements
To run a Lotus node, your computer must have:
- macOS or Linux installed. Windows is not yet supported.
- 8-core CPU and 32 GiB RAM. Models with support for Intel SHA Extensions (AMD since Zen microarchitecture, or Intel since Ice Lake) will significantly speed things up.
- Enough space to store the current Lotus chain (preferably on an SSD storage medium). The chain grows at approximately 12 GiB per week. The chain can be also synced from trusted state snapshots and compacted.
WARNING
These are the minimal requirements to run a Lotus node. Hardware requirements for Miners are different.
# Linux
The following instructions are specific to Linux installations. Head to the macOS section if you want to install Lotus on a Mac.
# Software dependencies
You will need the following software installed to install and run Lotus.
# System-specific
Building Lotus requires some system dependencies, usually provided by your distribution.
Arch:
Ubuntu/Debian:
Fedora:
OpenSUSE:
Amazon Linux 2:
# Rustup
Lotus needs rustup(opens new window). The easiest way to install it is:
TIP
Make sure your $PATH variable is correctly configured after the rustup installation so that cargo and rustc are found in their rustup-configured locations.
# Go
To build Lotus, you need a working installation of Go 1.15.5 or higher(opens new window):
Make sure that /usr/local/go/bin is in your PATH. If you are running into problems, check the official Go installation instructions(opens new window) for your operating system.
# Build and install Lotus
Once all the dependencies are installed, you can build and install the Lotus suite (lotus, lotus-miner, and lotus-worker).
Clone the repository:
To join mainnet, checkout the master branch and latest release(opens new window).
If you are changing networks from a previous Lotus installation or there has been a network reset, read the Switch networks guide before proceeding.
For networks other than mainnet, look up the current branch or tag and commit for the network you want to join in the Filecoin networks dashboard(opens new window), then build Lotus for your specific network below.
Currently, the master branch corresponds to mainnet.
If you are in China, check out the specific tips.
Depending on your CPU model, you will want to export additional environment variables:
If you have an AMD Zen or Intel Ice Lake CPU (or later), enable the use of SHA extensions by adding these two environment variables:
See the Native Filecoin FFI section for more details about this process.
Some older Intel and AMD processors without the ADX instruction support may panic with illegal instruction errors. To fix this, add the
CGO_CFLAGSenvironment variable:This is due to a Lotus bug that prevents Lotus from running on processor without
adxinstruction support, and should be fixed soon.Build and install Lotus:
This will put
lotus,lotus-minerandlotus-workerin/usr/local/bin.lotuswill use the$HOME/.lotusfolder by default for storage (configuration, chain data, wallets, etc). See advanced options for information on how to customize the Lotus folder.You should now have Lotus installed. You can now start the Lotus daemon.
# Native Filecoin FFI
Some newer CPU architectures like AMD's Zen and Intel's Ice Lake, have support for SHA extensions. Having these extensions enabled significantly speeds up your Lotus node. To make full use of your processor's capabilities, make sure you set the following variables before building from source:
This method of building does not produce portable binaries. Make sure you run the binary on the same computer as you built it.
# Systemd service files
Lotus provides generic Systemd service files. They can be installed with:
WARNING
Provided service files should be inspected and edited according to user needs as they are very generic and may lack specific environment variabes and settings needed by the users.
One example is that logs are redirected to files in /var/log/lotus by default and not visible in journalctl.
# macOS
These instructions are specific to macOS. If you are installing Lotus on a Linux distribution, head over to the Linux section.
# XCode Command Line Tools
Lotus requires that X-Code CLI tools be installed before building the Lotus binaries.
# Install Homebrew
We recommend that MacOS users use Homebrew(opens new window) to install each of the necessary packages.
Use the command
brew installto install the following packages:Clone the repository:
To join mainnet, checkout the master branch and browse for the latest release(opens new window).
If you are changing networks from a previous Lotus installation or there has been a network reset, read the Switch networks guide before proceeding.
To join networks other than mainnet, look up the correct branch or tag and commit for the network you want to join in the Filecoin networks dashboard(opens new window), then build Lotus for your specific network below.
Currently, the master branch corresponds to mainnet.
If you are in China, check out the specific tips.
Some older Intel and AMD processors without the ADX instruction support may panic with illegal instruction errors. To fix this, add the
CGO_CFLAGSenvironment variable:This is due to a Lotus bug that prevents Lotus from running on processor without
adxinstruction support, and should be fixed soon.Build Lotus:
You should now have Lotus installed. You can now start the Lotus daemon.
# Start the Lotus daemon and sync the chain
GUI based code profiler; does only basic timer-based profiling on Intel processors. Based on OProfile.
Group of events are monitored by selecting specific instruments from: File Activity, Memory Allocations, Time Profiler, GPU activity etc. For system wide impact of the executable: System Trace, System usage, Network Usage, Energy log etc are useful.
Free. Proprietary. Bundled with Xcode, which is also free.Intel AdvisorLinux and Windows. Viewer only on macOS.C, C++, Data Parallel C++ and FortranA collection of design and analysis tools - vectorization (SIMD) optimization, thread prototyping, automated roofline analysis, offload modeling and flow graph analysisFreeware and Proprietary. Available as part of Intel oneAPI Base Toolkit.Linux Trace Toolkit (LTT)LinuxRequires patched kernelCollects data on processes blocking, context switches, and execution time. This helps identify performance problems over multiple processes or threads. Superseded by LTTng.GPLLTTng (Linux Trace Toolkit Next Generation)LinuxSystem software package for correlated tracing of kernel, applications and libraries.GPL/LGPL/MITOProfileLinuxProfiles everything running on the Linux system, including hard-to-profile programs such as interrupt handlers and the kernel itself.Sampling profiler for Linux that counts cache misses, stalls, memory fetches, etc.Open Source GPLv2Linux, SolarisC, C++, Fortran, Java; MPIPerformance and memory profiler.Proprietary freewareperf toolsLinux kernel 2.6.31+Sampling profiler with support of hardware events on several architectures.GPLPerformance Application Programming Interface (PAPI)VariousLibrary for hardware performance counters on modern microprocessors.LIKWIDLinuxC/C++, Fortran, Python, Java and LuaToolsuite of command line applications and library for performance oriented programmers (hardware performance monitoring, affinity control, etc.).GPLv3Pin by IntelLinux, Windows, macOS, AndroidDynamic binary instrumentation system that allows users to create custom program analysis tools.Proprietary but free for non-commercial useRational PurifyPlusAIX, Linux, Solaris, WindowsPerformance profiling tool, memory debugger and code coverage tool.ProprietaryScalascaLinuxC/C++, FortranParallel trace analyser.Free/open source (BSD license)Shark by ApplemacOS (discontinued with 10.7)Performance analyzer.Proprietary freewareSuperluminal PerformanceWindows, Xbox, PlayStationC, C++, RustHybrid sampling & instrumenting profiler, built with usability and scalability in mind.ProprietarySystemtapLinuxProgrammable system tracing/probing tool; may be scripted to generate time- or performance-counter- or function-based profiles of the kernel and/or its userspace.Open sourcetimemoryLinux, macOS, WindowsC, C++, Python, FortranModular C++ toolkit for creating scalable custom instrumentation and sampling tools for performance analysis. Designed to minimize overhead by adapting to the interface of each performance analysis component at compile-time and simplify adding support for invocation and data storage within multi-threaded and multi-process runtimes. Includes many pre-built components for timing, resource usage, hardware-counters, Roofline Model, and the instrumentation APIs for VTune, Intel Advisor, LIKWID, and Arm MAP, among others. Components can be arbitrarily bundled together into a single handle for collective invocations and input argument broadcasting. Python bindings are provided for every component as a stand-alone class for implementing low-overhead Python profiling tools. Profiling via dynamic instrumentation is available on Linux.Free/Open-source (MIT)ValgrindLinux, macOS, Solaris, AndroidAny, including assemblerSystem for debugging and profiling; supports tools to either detect memory management and threading bugs, or profile performance (cachegrind and callgrind). KCacheGrind, valkyrie and alleyoop are front-ends for valgrind.Free/open source (GPL)VTune Profiler by Intel Corporation(formerly VTune Amplifier)
Linux, Windows, viewer only for macOSC, C++, C#, Data Parallel C++ (DPC++), Fortran, .NET, Java, Python, Go, ASM AssemblyA collection of profiling analyses implemented with sampling, instrumentation and processor trace technologies. Includes Hotspot, Threading, HPC, I/O, FPGA, GPU, System, Throttling and Microarchitecture analyses.Freeware and Proprietary. Also available as a part of Intel oneAPI base toolkit.C and C++[edit]
- Arm MAP, a performance profiler supporting Linux platforms.
- AppDynamics, an application performance management solution[buzzword] for C/C++ applications via SDK.
- AQtime Pro, a performance profiler and memory allocation debugger that can be integrated into Microsoft Visual Studio, and Embarcadero RAD Studio, or can run as a stand-alone application.
- IBM Rational Purify was a memory debugger allowing performance analysis.
- Instruments (bundled with Xcode) is used to profile an executable's memory allocations, time usage, filesystem activity, GPU activity etc.
- Intel Parallel Studio contains Intel VTune Amplifier, which tunes both serial and parallel programs. It also includes Intel Advisor and Intel Inspector. Intel Advisor optimizes vectorization (use of SIMD instructions) and prototypes threading implementations. Intel Inspector detects and debugs races, deadlocks and memory errors.
- ParasoftInsure++ provides a graphical tool that displays and animates memory allocations in real time to expose memory blowout, fragmentation, overuse, bottlenecks and leaks.
- Timemory, a modular C++ toolkit for creating performance analysis tools which provides numerous command-line tools and libraries as a by-product of its flexibility and reusability.
- Visual Studio Team System Profiler, commercial profiler by Microsoft.
Java[edit]
- inspectIT is an open-source application performance management (APM) solution[buzzword] for monitoring and analyzing software applications, available under the Apache License, Version 2.0 (ALv2).
- JConsole is the profiler which comes with the Java Development Kit
- JRockit Mission Control, a profiler with low overhead.
- Netbeans Profiler, a profiler integrated into the NetBeans IDE (internally uses jvisualvm profiler)
- Plumbr, Java application performance monitoring with automated root cause detection. Links memory leaks, GC inefficiency, slow database and external web service calls, locked threads, and other performance problems to the line in source code that causes them.
- OverOps, Continuous reliability for the modern software supply chain, automatically detect and deliver root cause automation for all errors.
- VisualVM is a visual tool integrating several commandline JDK tools and lightweight profiling capabilities. It is bundled with the Java Development Kit since version 6, update 7.
- FusionReactor, Java application performance monitoring - low overhead, production grade tools for production debugging, code profiling, memory and thread analysis
JavaScript[edit]
- Firebug is a Firefox plug-in for web development, also has a profiler for JavaScript.
- Microsoft Visual Studio AJAX Profiling Extensions is a free profiling tool for JavaScript by Microsoft Research.
.NET[edit]
- CLR Profiler is a free memory profiler provided by Microsoft for CLR applications.
- GlowCode is a performance and memory profiler for .NET applications using C# and other .NET languages. It identifies time-intensive functions and detects memory leaks and errors in native, managed and mixed Windows x64 and x86 applications.
PHP[edit]
- Xdebug is a PHP extension which provides debugging and profiling capabilities.
See also[edit]
- Memory debugger (includes list of memory profilers)
References[edit]
- ^'CodeXL'. Archived from the original on 19 September 2013. Retrieved 26 September 2013.
External links[edit]
- Performance Analysis Tools, article from the Lawrence Livermore National Laboratory
This guide covers how to install the Lotus applications and launch a Lotus Node. This guide covers installing lotus, lotus-miner and lotus-worker to your computer, and then runs through setting up a Lotus node. For information on running the miner, check the Lotus Miner documentation.
# Minimal requirements
To run a Lotus node, your computer must have:
- macOS or Linux installed. Windows is not yet supported.
- 8-core CPU and 32 GiB RAM. Models with support for Intel SHA Extensions (AMD since Zen microarchitecture, or Intel since Ice Lake) will significantly speed things up.
- Enough space to store the current Lotus chain (preferably on an SSD storage medium). The chain grows at approximately 12 GiB per week. The chain can be also synced from trusted state snapshots and compacted.
WARNING
These are the minimal requirements to run a Lotus node. Hardware requirements for Miners are different.
# Linux
The following instructions are specific to Linux installations. Head to the macOS section if you want to install Lotus on a Mac.
# Software dependencies
You will need the following software installed to install and run Lotus.
# System-specific
Building Lotus requires some system dependencies, usually provided by your distribution.
Arch:
Ubuntu/Debian:
Fedora:
OpenSUSE:
Amazon Linux 2:
# Rustup
Lotus needs rustup(opens new window). The easiest way to install it is:
TIP
Make sure your $PATH variable is correctly configured after the rustup installation so that cargo and rustc are found in their rustup-configured locations.
# Go
To build Lotus, you need a working installation of Go 1.15.5 or higher(opens new window):
Make sure that /usr/local/go/bin is in your PATH. If you are running into problems, check the official Go installation instructions(opens new window) for your operating system.
# Build and install Lotus
Once all the dependencies are installed, you can build and install the Lotus suite (lotus, lotus-miner, and lotus-worker).
Clone the repository:
To join mainnet, checkout the master branch and latest release(opens new window).
If you are changing networks from a previous Lotus installation or there has been a network reset, read the Switch networks guide before proceeding.
For networks other than mainnet, look up the current branch or tag and commit for the network you want to join in the Filecoin networks dashboard(opens new window), then build Lotus for your specific network below.
Currently, the master branch corresponds to mainnet.
If you are in China, check out the specific tips.
Depending on your CPU model, you will want to export additional environment variables:
If you have an AMD Zen or Intel Ice Lake CPU (or later), enable the use of SHA extensions by adding these two environment variables:
See the Native Filecoin FFI section for more details about this process.
Some older Intel and AMD processors without the ADX instruction support may panic with illegal instruction errors. To fix this, add the
CGO_CFLAGSenvironment variable:This is due to a Lotus bug that prevents Lotus from running on processor without
adxinstruction support, and should be fixed soon.Build and install Lotus:
This will put
lotus,lotus-minerandlotus-workerin/usr/local/bin.lotuswill use the$HOME/.lotusfolder by default for storage (configuration, chain data, wallets, etc). See advanced options for information on how to customize the Lotus folder.You should now have Lotus installed. You can now start the Lotus daemon.
# Native Filecoin FFI
Some newer CPU architectures like AMD's Zen and Intel's Ice Lake, have support for SHA extensions. Having these extensions enabled significantly speeds up your Lotus node. To make full use of your processor's capabilities, make sure you set the following variables before building from source:
This method of building does not produce portable binaries. Make sure you run the binary on the same computer as you built it.
# Systemd service files
Lotus provides generic Systemd service files. They can be installed with:
WARNING
Provided service files should be inspected and edited according to user needs as they are very generic and may lack specific environment variabes and settings needed by the users.
One example is that logs are redirected to files in /var/log/lotus by default and not visible in journalctl.
# macOS
These instructions are specific to macOS. If you are installing Lotus on a Linux distribution, head over to the Linux section.
# XCode Command Line Tools
Lotus requires that X-Code CLI tools be installed before building the Lotus binaries.
Check if you already have the XCode Command Line Tools installed via the CLI, run:
If this command returns a path, you can move on to the next step. Otherwise, to install via the CLI, run:
To update, run:
The Apple Mac was powered by intel processors till November 10, 2020, when they introduced their own processer known as the M1 chip series. They also have almost the same GPU as a PC, so it is possible to install Mac OS on a PC. Now if we get into detail in order to run a MAC OS on PC. Originally Answered: Does it worth to install Mac OSX on PC designed for windows? No, and it's nearly impossible to make it full functional since apple doesn' provide drivers (because using their system on non-apple product is illegal) but their products and only.
# Install Homebrew
We recommend that MacOS users use Homebrew(opens new window) to install each of the necessary packages.
Use the command
brew installto install the following packages:Clone the repository:
To join mainnet, checkout the master branch and browse for the latest release(opens new window).
If you are changing networks from a previous Lotus installation or there has been a network reset, read the Switch networks guide before proceeding.
To join networks other than mainnet, look up the correct branch or tag and commit for the network you want to join in the Filecoin networks dashboard(opens new window), then build Lotus for your specific network below.
Currently, the master branch corresponds to mainnet.
If you are in China, check out the specific tips.
Some older Intel and AMD processors without the ADX instruction support may panic with illegal instruction errors. To fix this, add the
CGO_CFLAGSenvironment variable:This is due to a Lotus bug that prevents Lotus from running on processor without
adxinstruction support, and should be fixed soon.Build Lotus:
You should now have Lotus installed. You can now start the Lotus daemon.
# Start the Lotus daemon and sync the chain
The lotus application runs as a daemon and a client to control and interact with that daemon. A daemon is a long-running program that is usually run in the background.
When using mainnet, we recommend to start the daemon syncing from a trusted state snapshot. In any case, you can start the deamon with the following command:
During the first run, Lotus will:
- Setup its data folder at
~/.lotus. - Download the necessary proof parameters. This is a few gigabytes of data that is downloaded once.
- Import the snapshot (if specified) and start syncing the Lotus chain.
The daemon will start producing lots of log messages right away. From this point, you will have to work on a new terminal and lotus commands will communicate with the running daemon.
TIP
Do not be concerned by the number of warnings and sometimes errors showing in the logs. They are a normal part of the daemon lifecycle as it participates in the global distributed consensus network.
If you used snapshots, subsequent daemon starts can proceed as normal without any options:
For more information about syncing and snapshots, see the Chain management section.
We recommend waiting until the syncing process has completed, which should be relatively fast when using trusted state snapshot imports:
# Interact with the daemon
The lotus command allows you to interact with a running Lotus daemon. The lotus-miner and lotus-worker commands work in the same way.
Lotus comes with built-in CLI documentation:
Hardware Io Tools For Xcode Download Windows
For example, after your Lotus daemon has been running for a few minutes, use lotus to check the number of other peers that it is connected to in the Filecoin network:
# Stop the Lotus daemon
Hardware Io Tools For Xcode Download Mac
In order to gracefully stop the running lotus daemon (required when restarting the daemon to update Lotus), use the following command:
