Difference between revisions of "Platform Notes (Mac OS X)"

From FreeM Wiki
Jump to navigation Jump to search
(Update testing details to reflect recent macOS Monterey testing efforts.)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Port Status ==
 
== Port Status ==
  
−
The Mac OS X port is a [[Tier 3 Port]]
+
The Mac OS X port is a [[Tier 2 Port]].
 +
The main branch will compile on macOS Monterey (12.6.8) on Intel, and it can run if the <code>kern.sysv.shmmax</code> parameter is correct (see below).
  
 
== Verified Releases ==
 
== Verified Releases ==
−
TBD
+
* [[FreeM Lite]]
 +
* FreeM 0.65.1-rc0
 +
 
 +
== Build Notes ==
 +
 
 +
In order to build FreeM on macOS, you will need to install the following:
 +
 
 +
* Apple XCode command-line tools
 +
* Homebrew
 +
 
 +
Then, install the following with the brew package manager:
 +
 
 +
* automake
 +
* autoconf
 +
* gcc
 +
* libtool
 +
* texinfo
 +
* texi2html
 +
* git
  
 
== Testing Details ==
 
== Testing Details ==
−
The macos-fixes branch will compile on macOS Monterey (12.6.8) on Intel, but the default shared memory size on this operating system is too small to accommodate the default FreeM shared memory segment size. Reducing the segment size results in the following error:
 
  
−
freem [FATAL]: memory allocation failure in job_init [errno 2 No such file or directory]
+
We build the macOS port on the following hardware:
 +
 
 +
* MacBook Air (Early 2015) running macOS Monterey (12.6.8)
 +
* M1 Mac Mini running macOS Sequoia
 +
 
 +
== Required Kernel Tuning ==
 +
 
 +
You will need to set the <code>kern.sysv.shmmax</code> sysctl parameter to at least 17002496 (the value must be a multiple of the system page size; generally 4096).
 +
 
 +
To determine the current setting, see below:
 +
 
 +
<pre>
 +
$ sudo sysctl -a | grep shmmax
 +
kern.sysv.shmmax: 4194304
 +
</pre>
 +
 
 +
In the above example, the <code>shmmax</code> value is <code>4194304</code>, and thus insufficient for proper FreeM operation.
 +
 
 +
See your macOS version below for instructions on modifying this value.
 +
 
 +
=== All Versions ===
 +
 
 +
* Find the file <code>com.startup.sysctl.plist</code> file in the <code>scripts</code> subdirectory of the FreeM distribution
 +
* Copy it to <code>/Library/LaunchDaemons</code>
 +
* Change the ownership of <code>/Library/LaunchDaemons/com.startup.sysctl.plist</code> to <code>root:wheel</code>
 +
* Run <code>sudo launchctl load /Library/LaunchDaemons/com.startup.sysctl.plist</code>
 +
* Reboot
 +
 
 +
See the following example:
 +
 
 +
<pre>
 +
$ sudo cp scripts/com.startup.sysctl.plist /Library/LaunchDaemons/
 +
$ sudo chown root:wheel /Library/LaunchDaemons/com.startup.sysctl.plist
 +
$ sudo launchctl load /Library/LaunchDaemons/com.startup.sysctl.plist
 +
</pre>
 +
 
 +
 
 +
== Starting the FreeM Daemon Automatically ==
 +
Coming soon.
  
 
== Port Challenges ==
 
== Port Challenges ==
−
Apple makes it extremely difficult to build traditional UNIX software, in the name of "security". Also, Apple silicon (M1 and descendants) cannot likely be supported with the current shared memory architecture.
+
The shared memory architecture of FreeM had to be rewritten to support Apple's System V IPC changes for their Unified Memory Architecture.
  
−
We will most likely support only PowerPC and Intel Macs.
 
  
 
[[Category:Platform Notes]]
 
[[Category:Platform Notes]]
−
[[Category:Tier 3 Ports]]
+
[[Category:Tier 2 Ports]]

Latest revision as of 07:02, 16 May 2025

Port Status

The Mac OS X port is a Tier 2 Port. The main branch will compile on macOS Monterey (12.6.8) on Intel, and it can run if the kern.sysv.shmmax parameter is correct (see below).

Verified Releases

Build Notes

In order to build FreeM on macOS, you will need to install the following:

  • Apple XCode command-line tools
  • Homebrew

Then, install the following with the brew package manager:

  • automake
  • autoconf
  • gcc
  • libtool
  • texinfo
  • texi2html
  • git

Testing Details

We build the macOS port on the following hardware:

  • MacBook Air (Early 2015) running macOS Monterey (12.6.8)
  • M1 Mac Mini running macOS Sequoia

Required Kernel Tuning

You will need to set the kern.sysv.shmmax sysctl parameter to at least 17002496 (the value must be a multiple of the system page size; generally 4096).

To determine the current setting, see below: 

$ sudo sysctl -a | grep shmmax
kern.sysv.shmmax: 4194304

In the above example, the shmmax value is 4194304, and thus insufficient for proper FreeM operation.

See your macOS version below for instructions on modifying this value.

All Versions

  • Find the file com.startup.sysctl.plist file in the scripts subdirectory of the FreeM distribution
  • Copy it to /Library/LaunchDaemons
  • Change the ownership of /Library/LaunchDaemons/com.startup.sysctl.plist to root:wheel
  • Run sudo launchctl load /Library/LaunchDaemons/com.startup.sysctl.plist
  • Reboot

See the following example: 

$ sudo cp scripts/com.startup.sysctl.plist /Library/LaunchDaemons/
$ sudo chown root:wheel /Library/LaunchDaemons/com.startup.sysctl.plist
$ sudo launchctl load /Library/LaunchDaemons/com.startup.sysctl.plist


Starting the FreeM Daemon Automatically

Coming soon.

Port Challenges

The shared memory architecture of FreeM had to be rewritten to support Apple's System V IPC changes for their Unified Memory Architecture.

Retrieved from "https://freem-wiki.coherent-logic.com/index.php?title=Platform_Notes_(Mac_OS_X)&oldid=407"