path: root/x11/nvidia-driver/Makefile

# Created by: Stijn Hoop <stijn@win.tue.nl>
# $FreeBSD$
#
# For those wondering why this port is not under `x11-drivers' category,
# have a look at https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=121930.
#
# Starting with version 1.0-7667, NVidia has dropped support for numerous
# "legacy" GPUs.  Consult NVidia README (the Appendix) to find out whether
# you need to use legacy driver version and install one of corresponding
# slave ports instead (`x11/nvidia-driver-173', `x11/nvidia-driver-304',
# or `x11/nvidia-driver-340').

PORTNAME=   nvidia-driver
DISTVERSION?=   346.35
# Always try to set PORTREVISION as it can be overridden by the slave ports
PORTREVISION?=  0
CATEGORIES= x11
MASTER_SITES=   ${MASTER_SITE_NVIDIA}
# MASTER_SITE_SUBDIR has to be set later because it depends on NVVERSION
DISTNAME=   NVIDIA-FreeBSD-${ARCH_SUFX}-${DISTVERSION}

MAINTAINER= danfe@FreeBSD.org
COMMENT=    NVidia graphics card binary drivers for hardware OpenGL rendering

LICENSE=    NVIDIA
LICENSE_NAME=   License For Customer Use of NVIDIA Software
LICENSE_FILE=   ${WRKSRC}/doc/license.txt
LICENSE_PERMS=  dist-mirror no-dist-sell pkg-mirror no-pkg-sell auto-accept

ARCH_SUFX=  x86${ARCH:S/i386//:S/amd/_/}
USES=       kmod uidfix
USE_XORG=   xorg-server
USE_GL=     gl
USE_LDCONFIG=   yes

# NVIDIA_ROOT is not set in src/Makefile, which results in bogus -I/src
# passed to compiler and broken build on HEAD since r221320 when option
# -Wmissing-include-dirs was added for kernel sources.  Until properly
# fixed upstream (across all versions, including legacy ones), use this
# hack below to universally set NVIDIA_ROOT.  Also provide X11BASE value
# since it is still used by legacy drivers.
MAKE_ENV=   NVIDIA_ROOT=${WRKSRC} X11BASE=${LOCALBASE}
SUB_FILES=  pkg-deinstall pkg-install pkg-message
DOCSDIR=    ${PREFIX}/share/doc/NVIDIA_GLX-1.0
MODULESDIR= lib/xorg/modules
PORTDOCS=   *

# NVVERSION is float since r372065 (integer values become less readable
# after minor version could occupy three digits)
.if ${DISTVERSION:C/[0-9]+//g} == ".."      # major.minor.update
NVVERSION=  ${DISTVERSION:S/./.0/:R}${DISTVERSION:E}
.else                       # major.minor
.  if ${DISTVERSION:E} < 100
NVVERSION=  ${DISTVERSION:S/./.0/}      # allow minor > 99
.  else
NVVERSION=  ${DISTVERSION}
.  endif
.endif

.if ${NVVERSION} >= 195.022
MASTER_SITE_SUBDIR= XFree86/FreeBSD-${ARCH_SUFX}/${DISTVERSION}
ONLY_FOR_ARCHS= i386 amd64
.else
MASTER_SITE_SUBDIR= freebsd/${DISTVERSION}
ONLY_FOR_ARCHS= i386
.endif

.if ${NVVERSION} <= 190.042
EXTRA_PATCHES=  ${FILESDIR}/legacy-patch-mk-nvidia.lib.mk
.else
EXTRA_PATCHES=  ${FILESDIR}/extra-patch-mk-nvidia.lib.mk
.endif

.if ${NVVERSION} >= 304.088
EXTRA_PATCHES+= ${FILESDIR}/extra-patch-src-Makefile \
        ${FILESDIR}/extra-patch-src-nv-freebsd.h \
        ${FILESDIR}/extra-patch-src-nv-misc.h
.endif

.if ${NVVERSION} >= 304.125 # 331.020
EXTRA_PATCHES+= ${FILESDIR}/extra-patch-x11-driver-Makefile
.else
EXTRA_PATCHES+= ${FILESDIR}/legacy-patch-x11-driver-Makefile
.endif

# Fix recent arbitrary memory access vulnerability in legacy drivers
.if ${NVVERSION} <= 190.053
.  if ${NVVERSION} != 173.01435
EXTRA_PATCHES+= ${FILESDIR}/security-patch-CVE-2012-0946
.  endif
EXTRA_PATCHES+= ${FILESDIR}/security-patch-CVE-2012-4225
.endif

OPTIONS_DEFINE= ACPI_PM LINUX DOCS
OPTIONS_DEFAULT=    LINUX

ACPI_PM_DESC=       ACPI Power Management support
LINUX_DESC=     Linux compatibility support

.if ${NVVERSION} < 310.014
OPTIONS_DEFINE+=    FREEBSD_AGP
FREEBSD_AGP_DESC=   Use FreeBSD AGP GART driver
.endif

.if ${NVVERSION} >= 195.022
OPTIONS_DEFINE+=    WBINVD
WBINVD_DESC=        Flush CPU caches directly with WBINVD
.endif

.if ${NVVERSION} >= 304.088
OPTIONS_DEFINE_i386=    PAE
PAE_DESC=       Physical Address Extensions support
.endif

PLIST_SUB+= LINUXBASE=${LINUXBASE} SHLIB_VERSION=${PORTVERSION} \
        MODULESDIR=${MODULESDIR}

.include <bsd.port.options.mk>

.if ${PORT_OPTIONS:MLINUX}
CONFLICTS_INSTALL=  linux[-_]dri-[0-9]* linux-f10-dri-[0-9]*
USE_LINUX=  yes
PLIST_SUB+= LINUX=""
.else
PLIST_SUB+= LINUX="@comment "
# Propagate WITHOUT_LINUX variable down to inner Makefiles
MAKE_ENV+=  WITHOUT_LINUX=yes
.endif

.if ${NVVERSION} < 195.022
# ABI version is hardcoded inside the binary, so specify it explicitly here
LIB_DEPENDS=    libm.so.3:${PORTSDIR}/misc/compat5x
.endif

post-patch: .SILENT
# We should support -CURRENT: kill the check
    ${REINPLACE_CMD} -e '24,26d' ${WRKSRC}/src/nv-freebsd.h
# Adjust legacy drivers for updated d_mmap() since FreeBSD src SVN r201223
.if ${OSVERSION} > 900005 && ${NVVERSION} < 195.022
    ${REINPLACE_CMD} -e 's/vm_offset_t offset/vm_ooffset_t offset/ ; \
        s/vm_offset_t \*address/vm_paddr_t *address/ ; \
        s/int nprot/&, vm_memattr_t *memattr/' \
            ${WRKSRC}/src/nvidia_dev.c
.endif
# In the legacy drivers: remove page queue locking and add page locking
# around vm_page_(un)wire() after FreeBSD src SVN r207410, r207617, and
# r207644; also remove page queue locking around vm_page_wakeup() after
# FreeBSD src SVN r163622
.if ${OSVERSION} > 900011 && ${NVVERSION} < 304.064
    ${REINPLACE_CMD} -E '/vm_page_(un)?lock_queues\(\);/d ; \
        s/(vm_page_(un)?wire\()([^,]+)(, 0)?(\);)/vm_page_lock(\3); & vm_page_unlock(\3);/' \
            ${WRKSRC}/src/nvidia_subr.c
.endif
# Catch up legacy drivers with FreeBSD src SVN r225617
.if ${OSVERSION} > 900043 && ${NVVERSION} < 195.022
    ${REINPLACE_CMD} -e '/return/s/ioctl/sys_&/' \
        ${WRKSRC}/src/nvidia_linux.c
.endif
# Adjust Linux headers #include's after FreeBSD src SVN r246085
.if ${OSVERSION} > 1000027 && ${NVVERSION} >= 96.04323
    ${REINPLACE_CMD} -E '/#include "machine\/\.\.\/linux(32)?\/linux.h"/ \
        { x ; s/.*/#include "machine\/..\/..\/compat\/linux\/linux_ioctl.h"/ ; H ; x ; }' \
            ${WRKSRC}/src/nvidia_linux.c
.endif
# Adjust vm_object locking after FreeBSD src SVN r248084
.if ${OSVERSION} > 1000029
    ${REINPLACE_CMD} -e '/#include <vm\/vm_object.h>/ \
        { x ; s/.*/#include <sys\/rwlock.h>/ ; G ; }' \
            ${WRKSRC}/src/nv-freebsd.h
    ${REINPLACE_CMD} -E 's/(VM_OBJECT_)(UN)?(LOCK)/\1W\2\3/' \
        ${WRKSRC}/src/nvidia_subr.c
.endif
# Adjust kmem(9) calls after FreeBSD src SVN r254025
.if ${OSVERSION} > 1000040 && ${NVVERSION} < 331.067
    ${REINPLACE_CMD} -e '/kmem_/s/kernel_map/kernel_arena/' \
        ${WRKSRC}/src/nvidia_subr.c
.endif
# Argument count of vm_map_find() changed in FreeBSD src SVN r255426
.if ${OSVERSION} > 1000054 && ${NVVERSION} < 304.123 # < 331.067
    ${REINPLACE_CMD} -e 's/virtual_address, size,/& 0,/' \
        ${WRKSRC}/src/nvidia_subr.c
.endif
# Fix CTLFLAG_* values for SYSCTL_ADD_PROC() after FreeBSD src SVN r273377
.if ${OSVERSION} > 1100039 || ${OSVERSION} > 1001501 && ${OSVERSION} < 1100000
    ${REINPLACE_CMD} -e '/SYSCTL_ADD_PROC/,/;/ \
        s/^[[:blank:]]*CTLFLAG_RD/CTLTYPE_STRING |&/' \
            ${WRKSRC}/src/nvidia_sysctl.c
.endif
# Replace d_thread_t (compat shim to support FreeBSD 4) with `struct thread'
    ${REINPLACE_CMD} -e 's/d_thread_t/struct thread/' \
        ${WRKSRC}/src/nvidia_ctl.c ${WRKSRC}/src/nvidia_dev.c \
        ${WRKSRC}/src/nvidia_linux.c
# Fix stack buffer overflow in nvidia_sysctl_bus_type()
    ${REINPLACE_CMD} -e 's/8 bus_type\[4\]/8 bus_type[8]/' \
        ${WRKSRC}/src/nvidia_sysctl.c
# Unbreak the build of 173.14.xx legacy series on recent -CURRENT
.if ${NVVERSION} < 195.022 && ${NVVERSION} >= 169.004
    ${REINPLACE_CMD} -E 's/os_(alloc|free)_contig_pages/NV_API_CALL &/' \
        ${WRKSRC}/src/nv-freebsd.h
.endif
# Process OPTIONS
.if ${PORT_OPTIONS:MFREEBSD_AGP}
    ${REINPLACE_CMD} -E 's/undef (NV_SUPPORT_OS_AGP)/define \1/' \
        ${WRKSRC}/src/nv-freebsd.h
.endif
.if ${PORT_OPTIONS:MACPI_PM}
    ${REINPLACE_CMD} -E 's/undef (NV_SUPPORT_ACPI_PM)/define \1/' \
        ${WRKSRC}/src/nv-freebsd.h
.endif
.if ! ${PORT_OPTIONS:MLINUX}
    ${REINPLACE_CMD} -E 's/define (NV_SUPPORT_LINUX_COMPAT)/undef \1/' \
        ${WRKSRC}/src/nv-freebsd.h
.endif
.if ${PORT_OPTIONS:MPAE}
    ${REINPLACE_CMD} -E 's/undef (NV_SUPPORT_PAE)/define \1/' \
        ${WRKSRC}/src/nv-freebsd.h
.endif
.if ${PORT_OPTIONS:MWBINVD}
    ${REINPLACE_CMD} -E 's/undef (NV_USE_WBINVD)/define \1/' \
        ${WRKSRC}/src/nv-freebsd.h
.endif
    ${REINPLACE_CMD} -e 's/exists(\/.*/& \&\& !defined(WITHOUT_LINUX)/' \
        ${WRKSRC}/lib/Makefile
# Do not install VDPAU libraries which are provided by `multimedia/libvdpau'
# port for a while now
.if ${NVVERSION} >= 180.029
    ${REINPLACE_CMD} -e '/libvdpau[[:blank:]_][^n]/d ; \
        s/name libvdpau/&_nvidia/' ${WRKSRC}/lib/Makefile
.endif
# Do not build any binaries (native nvidia-settings and nvidia-xconfig are
# provided by corresponding ports) and manual pages
.if ${NVVERSION} < 97.046 || ${NVVERSION} >= 195.022
    ${REINPLACE_CMD} -E 's/(extension).*/\1/' ${WRKSRC}/x11/Makefile
.else
    ${REINPLACE_CMD} -E 's/(lib).*/\1/' ${WRKSRC}/x11/Makefile
.endif
    ${REINPLACE_CMD} -e '/bin/d ; /man/d' ${WRKSRC}/x11/Makefile
# Also do not install libnvidia-gtk* libraries which are for nvidia-settings
.if ${NVVERSION} >= 346.016
    ${REINPLACE_CMD} -e '/libnvidia-gtk/d' ${WRKSRC}/lib/Makefile
.endif
# Conditionally install documentation (but you generally want it)
.if ! ${PORT_OPTIONS:MDOCS}
    ${REINPLACE_CMD} -E 's/(x11).*/\1/ ; /doc/d' ${WRKSRC}/Makefile
.endif
# Adjust installation paths of some conflicting files (shared also between
# libGL, libEGL, libglesv2 and xorg-server) to ease package manager work.
    ${REINPLACE_CMD} -e '/LIBDIR/s:xorg/modules/extensions:&/.nvidia:' \
        ${WRKSRC}/x11/extension/Makefile
    ${REINPLACE_CMD} -e '/LIBDIR/s:lib:&/.nvidia:' \
        ${WRKSRC}/lib/libGL/Makefile
.if ${NVVERSION} >= 331.013
    ${REINPLACE_CMD} -e '/LIBDIR/s:lib:&/.nvidia:' \
        ${WRKSRC}/lib/libEGL/Makefile
    ${REINPLACE_CMD} -e '/LIBDIR/s:lib:&/.nvidia:' \
        ${WRKSRC}/lib/libGLESv2/Makefile
.endif
# Do not execute afterinstall target (prevent automatic module registration
# and "smart" installation of conflicting files heuristics)
    ${REINPLACE_CMD} -e 's/afterinstall/&_dontexecute/' ${WRKSRC}/Makefile
    ${REINPLACE_CMD} -e 's/beforeinstall/&_dontexecute/' \
        ${WRKSRC}/lib/Makefile ${WRKSRC}/src/Makefile
# /usr/share/nvidia path is hardcoded in libGL and nvidia-settings, but we
# won't adhere to this stupidity and install nvidia-application-profiles-*
# files as part of documentation
.if ${NVVERSION} >= 334.016
    ${REINPLACE_CMD} -e 's,/usr/share/nvidia,${STAGEDIR}${DOCSDIR},' \
        ${WRKSRC}/lib/libGL/Makefile ${WRKSRC}/doc/Makefile
.endif

pre-install:
    @${MKDIR} ${STAGEDIR}${PREFIX}/${MODULESDIR}/drivers \
        ${STAGEDIR}${PREFIX}/${MODULESDIR}/extensions

post-install: .SILENT
    ${INSTALL_SCRIPT} ${WRKSRC}/obj/nvidia-bug-report.sh \
        ${STAGEDIR}${PREFIX}/bin
# pkg-plist is already overbloated, so use these hacks instead of PLIST_SUB's
.if ${NVVERSION} < 81.074
    ${REINPLACE_CMD} -e '/libnvidia-cfg/d' ${TMPPLIST}
.endif
.if ${NVVERSION} < 97.046 || ${NVVERSION} >= 195.022
    ${REINPLACE_CMD} -e '/wfb/d' ${TMPPLIST}
.endif
.if ${NVVERSION} < 180.029
    ${REINPLACE_CMD} -e '/vdpau/d' ${TMPPLIST}
.endif
.if ${NVVERSION} < 185.01829
    ${REINPLACE_CMD} -e '/libcuda/d' ${TMPPLIST}
.endif
.if ${NVVERSION} >= 256.053
    ${REINPLACE_CMD} -E 's/libGLcore/libnvidia-glcore/ ; \
        /usr.*(glcore|tls).*so\.1$$/d' ${TMPPLIST}
.endif
.if ${NVVERSION} >= 310.019
    ${REINPLACE_CMD} -e '/libXvMCNVIDIA/d' ${TMPPLIST}
.else   # some applications need this symlink (see PR ports/72877)
    ${LN} -sf libXvMCNVIDIA.so.1 \
        ${STAGEDIR}${PREFIX}/lib/libXvMCNVIDIA_dynamic.so.1
.endif
.if ${NVVERSION} < 331.013 || ${ARCH} == amd64 && ${NVVERSION} < 334.016
    ${REINPLACE_CMD} -E '/lib(nvidia-)?(EGL|eglcore|GLESv|glsi)/d' \
        ${TMPPLIST}
.endif
.if ${NVVERSION} >= 195.022
    ${REINPLACE_CMD} -e '/does not support PAE/,+1d' ${PKGMESSAGE}
.endif

# Target below can be used instead of standard `makesum' to correctly
# update distinfo (i.e., keeping other driver version entries intact)
.if ${.TARGETS:Mupdate-distinfo}
DISTINFO_FILE=  ${MASTERDIR}/distinfo.new
JOIN?=      /usr/bin/join
.endif

update-distinfo: makesum .SILENT
    ${REINPLACE_CMD} -i '' -e '/${ARCH_SUFX}-${NVVERSION:R}/s/^/~/' \
        ${MASTERDIR}/distinfo ${DISTINFO_FILE}
    ${SED} -e '/^~/s/(.*//' ${MASTERDIR}/distinfo | ${JOIN} -a 1 \
        - ${DISTINFO_FILE} | ${SED} -e 's/^~//' \
        > ${MASTERDIR}/distinfo.tmp
    ${MV} ${MASTERDIR}/distinfo.tmp ${MASTERDIR}/distinfo
    ${RM} ${DISTINFO_FILE}

.include <bsd.port.mk>