forked from efabless/foss-asic-tools
-
Notifications
You must be signed in to change notification settings - Fork 68
/
start_x.sh
executable file
·204 lines (188 loc) · 6.8 KB
/
start_x.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
#!/bin/bash
# ========================================================================
# Start script for IIC docker images (X11)
#
# SPDX-FileCopyrightText: 2022-2023 Harald Pretl and Georg Zachl
# Johannes Kepler University, Institute for Integrated Circuits
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# SPDX-License-Identifier: Apache-2.0
# ========================================================================
if [ -n "${DRY_RUN}" ]; then
echo "[INFO] This is a dry run, all commands will be printed to the shell (Commands printed but not executed are marked with $)!"
ECHO_IF_DRY_RUN="echo $"
fi
if [ -z ${CONTAINER_NAME+z} ]; then
CONTAINER_NAME="iic-osic-tools_xserver_uid_"$(id -u)
fi
# Check if the container exists and if it is running.
if [ "$(docker ps -q -f name="${CONTAINER_NAME}")" ]; then
echo "[WARNING] Container is running!"
echo "[HINT] It can also be stopped with \"docker stop ${CONTAINER_NAME}\" and removed with \"docker rm ${CONTAINER_NAME}\" if required."
echo
echo -n "Press \"s\" to stop, and \"r\" to stop & remove: "
read -r -n 1 k <&1
echo
if [[ $k = s ]] ; then
${ECHO_IF_DRY_RUN} docker stop "${CONTAINER_NAME}"
elif [[ $k = r ]] ; then
${ECHO_IF_DRY_RUN} docker stop "${CONTAINER_NAME}"
${ECHO_IF_DRY_RUN} docker rm "${CONTAINER_NAME}"
fi
fi
# SET YOUR DESIGN PATH RIGHT!
if [ -z ${DESIGNS+z} ]; then
DESIGNS=$HOME/eda/designs
if [ ! -d "$DESIGNS" ]; then
${ECHO_IF_DRY_RUN} mkdir -p "$DESIGNS"
fi
echo "[INFO] Design directory auto-set to $DESIGNS."
fi
if [ -z ${DOCKER_USER+z} ]; then
DOCKER_USER="hpretl"
fi
if [ -z ${DOCKER_IMAGE+z} ]; then
DOCKER_IMAGE="iic-osic-tools"
fi
if [ -z ${DOCKER_TAG+z} ]; then
DOCKER_TAG="latest"
fi
PARAMS=""
if [[ "$OSTYPE" == "linux"* ]]; then
echo "[INFO] Auto detected Linux."
# Should also be a sensible default
if [ -z ${CONTAINER_USER+z} ]; then
CONTAINER_USER=$(id -u)
fi
if [ -z ${CONTAINER_GROUP+z} ]; then
CONTAINER_GROUP=$(id -g)
fi
if [ -z ${XSOCK+z} ]; then
if [ -d "/tmp/.X11-unix" ]; then
XSOCK="/tmp/.X11-unix"
else
echo "[ERROR] X11 socket could not be found. Please set it manually!"
exit 1
fi
fi
PARAMS="$PARAMS -v $XSOCK:/tmp/.X11-unix:rw"
if [ -z ${DISP+z} ]; then
if [ -z ${DISPLAY+z} ]; then
echo "[ERROR] No DISPLAY set!"
exit 1
else
DISP=$DISPLAY
fi
fi
if [ -z ${XAUTH+z} ]; then
# Senseful defaults (uses XAUTHORITY Shell variable if set, or the default .Xauthority -file in the caller home directory)
if [ -z ${XAUTHORITY+z} ]; then
if [ -f "$HOME/.Xauthority" ]; then
XAUTH="$HOME/.Xauthority"
else
echo "[ERROR] Xauthority could not be found. Please set it manually!"
exit 1
fi
else
XAUTH=$XAUTHORITY
fi
# Thanks to https://stackoverflow.com/a/25280523
XAUTH_TMP="/tmp/.${CONTAINER_NAME}_xauthority"
#create an empty file
${ECHO_IF_DRY_RUN} echo -n > "${XAUTH_TMP}"
if [ -z "${ECHO_IF_DRY_RUN}" ]; then
xauth -f "${XAUTH}" nlist "${DISP}" | sed -e 's/^..../ffff/' | xauth -f "${XAUTH_TMP}" nmerge -
else
${ECHO_IF_DRY_RUN} "xauth -f ${XAUTH} nlist ${DISP} | sed -e 's/^..../ffff/' | xauth -f ${XAUTH_TMP} nmerge -"
fi
XAUTH=${XAUTH_TMP}
if [ -d "/dev/dri" ]; then
echo "[INFO] /dev/dri detected, forwarding GPU for graphics acceleration."
PARAMS="${PARAMS} --device=/dev/dri:/dev/dri"
else
echo "[INFO] No /dev/dri detected!"
FORCE_LIBGL_INDIRECT=1
fi
fi
PARAMS="$PARAMS -v $XAUTH:/headless/.xauthority:rw -e XAUTHORITY=/headless/.xauthority"
elif [[ "$OSTYPE" == "darwin"* ]]; then
if [ -z ${CONTAINER_USER+z} ]; then
CONTAINER_USER=1000
fi
if [ -z ${CONTAINER_GROUP+z} ]; then
CONTAINER_GROUP=1000
fi
if [ -z ${DISP+z} ]; then
DISP="host.docker.internal:0"
if [[ $(type -P "xhost") ]]; then
${ECHO_IF_DRY_RUN} xhost +localhost
else
echo "[WARNING] xhost could not be found, access control to the X server must be managed manually!"
fi
fi
if [ "$(defaults read org.xquartz.x11 enable_iglx)" = 0 ]; then
${ECHO_IF_DRY_RUN} defaults write org.xquartz.x11 enable_iglx 1
echo "[INFO] Enabled XQuartz OpenGL for indirect rendering."
echo "[ERROR] Please restart XQuartz!"
exit 1
fi
FORCE_LIBGL_INDIRECT=1
else
echo "[ERROR] Not setup for ${OSTYPE}!"
exit 1
fi
if [ -n "${FORCE_LIBGL_INDIRECT}" ]; then
echo "[INFO] Using indirect rendering."
PARAMS="${PARAMS} -e LIBGL_ALWAYS_INDIRECT=1"
fi
if [ -n "${DOCKER_EXTRA_PARAMS}" ]; then
PARAMS="${PARAMS} ${DOCKER_EXTRA_PARAMS}"
fi
# Check for UIDs and GIDs below 1000, except 0 (root)
if [[ ${CONTAINER_USER} -ne 0 ]] && [[ ${CONTAINER_USER} -lt 1000 ]]; then
prt_str="# [WARNING] Selected User ID ${CONTAINER_USER} is below 1000. This ID might interfere with User-IDs inside the container and cause undefined behavior! #"
printf -- '#%.0s' $(seq 1 ${#prt_str})
echo
echo "${prt_str}"
printf -- '#%.0s' $(seq 1 ${#prt_str})
echo
fi
if [[ ${CONTAINER_GROUP} -ne 0 ]] && [[ ${CONTAINER_GROUP} -lt 1000 ]]; then
prt_str="# [WARNING] Selected Group ID ${CONTAINER_GROUP} is below 1000. This ID might interfere with Group-IDs inside the container and cause undefined behavior! #"
printf -- '#%.0s' $(seq 1 ${#prt_str})
echo
echo "${prt_str}"
printf -- '#%.0s' $(seq 1 ${#prt_str})
echo
fi
# If the container exists but is exited, it can be restarted.
if [ "$(docker ps -aq -f name="${CONTAINER_NAME}")" ]; then
echo "[WARNING] Container ${CONTAINER_NAME} exists."
echo "[HINT] It can also be restarted with \"docker start ${CONTAINER_NAME}\" or removed with \"docker rm ${CONTAINER_NAME}\" if required."
echo
echo -n "Press \"s\" to start, and \"r\" to remove: "
read -r -n 1 k <&1
echo
if [[ $k = s ]] ; then
${ECHO_IF_DRY_RUN} docker start "${CONTAINER_NAME}"
elif [[ $k = r ]] ; then
${ECHO_IF_DRY_RUN} docker rm "${CONTAINER_NAME}"
fi
else
echo "[INFO] Container does not exist, creating ${CONTAINER_NAME} ..."
# Finally, run the container, and set DISPLAY to the local display number
${ECHO_IF_DRY_RUN} docker pull "${DOCKER_USER}/${DOCKER_IMAGE}:${DOCKER_TAG}"
# Disable SC2086, $PARAMS must be globbed and splitted.
# shellcheck disable=SC2086
${ECHO_IF_DRY_RUN} docker run -d --user "${CONTAINER_USER}:${CONTAINER_GROUP}" -e "DISPLAY=${DISP}" -v "${DESIGNS}:/foss/designs:rw" ${PARAMS} --name "${CONTAINER_NAME}" "${DOCKER_USER}/${DOCKER_IMAGE}:${DOCKER_TAG}"
fi