HDL_workflow/devscripts.mdwn

   1 # Dev setup scripts
   2
   3 Setting up the dependencies and repositories for Libre-SOC is big enough
   4 that it is just much easier to do in an automated fashion.  Follow these
   5 steps after making sure that you review the scripts line by line because
   6 they run as root and it is your responsibility to check them, not ours.
   7
   8 Note the reason for entering the chroot as a user (not root) and
   9 then running sudo bash again is due to this procedure setting the
  10 SUDO_USER environment, on which the scripts critically rely.  Also:
  11 the dev-env-setup repository is cloned twice, once to get the chroot
  12 script and a second time to use scripts *inside* the chroot. Feel free
  13 to simply copy the repository into the chroot to save bandwidth.
  14
  15 **no you do not need to blow away your system and install debian 10 native**
  16 you can e.g. use debian/11 at the "host" level and some people have managed
  17 to use archlinux but you are **on your own if you do so**.
  18
  19 Note: these scripts assume that you are using debian/10 and that you
  20 understand and accept why we have standardised on that as an OS
  21 (reproduceability and minimising "support").  If you use anything
  22 different it risks creating non-reproducible HDL. It's not about
  23 "what's the favurite OS", it's about making sure that two developers
  24 can produce the **exact** same GDS-II files.
  25
  26     $ git clone https://git.libre-soc.org/git/dev-env-setup.git
  27     $ cd dev-env-setup
  28     $ sudo bash
  29     # ./mk-deb-chroot libresoc
  30     # exit
  31     $ schroot -c libresoc
  32     (libresoc)$ git clone https://git.libre-soc.org/git/dev-env-setup.git
  33     (libresoc)$ cd dev-env-setup
  34     (libresoc)$ sudo bash
  35     (libresoc)# ./install-hdl-apt-reqs
  36     (libresoc)# ./hdl-tools-yosys
  37     (libresoc)# ./hdl-dev-repos
  38     (libresoc)# ./ppc64-gdb-gcc           # needed for compiling unit tests
  39     (libresoc)# exit
  40     (libresoc)$
  41
  42 <https://git.libre-soc.org/?p=dev-env-setup.git;a=blob;f=hdl-dev-repos;hb=HEAD>
  43
  44 Additional scripts in the dev-env-setup repository will install yosys,
  45 verilator, coriolis2, ghdl, gdb and so on: from the above it is pretty
  46 straightforward and obvious to work out what to do (just run them).
  47 There is an accompanying walkthrough video which goes through the above
  48 <https://m.youtube.com/watch?v=1-4eJKTNrEk> and includes running some
  49 unit tests, explaining some of the background, and also files some bugs.
  50
  51 **You are now done, you need only read the rest below if interested
  52 to see how we made the above scripts**
  53
  54 # Notes about Script "mk-deb-chroot"
  55
  56 This section is developer-notes **only** it documents the
  57 process by which mk-deb-chroot was established and explains
  58 its decisions and effect.
  59
  60 The script sets up an schroot debootstrap jail with debian 10.
  61 This chroot can then be used for nmigen, coriolis, or any other development.
  62 These instructions are based on information taken from here:
  63 <https://www.debian.org/releases/stretch/amd64/apds03.html.en>
  64
  65 The chroot name for this section is assumed to be "libresoc"
  66
  67 In advance, on the host system, edit /etc/fstab and add mount points:
  68
  69 (edit: personally I prefer using mount --bind points.  however if doing
  70 that then after a reboot the chroot will lose the bind mountpoints
  71 and the commands need to be re-run, without which the chroot is
  72 unusable)
  73
  74     /dev    /home/chroot/libresoc/dev   none    bind    0   0
  75     /dev/pts /home/chroot/libresoc/dev/pts  none    bind    0   0
  76     /proc   /home/chroot/libresoc/proc  none    bind    0   0
  77     /sys    /home/chroot/libresoc/sys   none    bind    0   0
  78     /tmp    /home/chroot/libresoc/tmp   none    bind    0   0
  79
  80 Then run these commands:
  81
  82     sudo bash
  83     apt-get install debootstrap schroot
  84     mkdir /opt/chroot/libresoc
  85     /usr/sbin/debootstrap buster !$ http://ftp.us.debian.org/debian
  86     mount /home/chroot/libresoc/dev
  87     mount /home/chroot/libresoc/dev/pts
  88     mount   /home/chroot/libresoc/proc
  89     mount   /home/chroot/libresoc/sys
  90     mount   /home/chroot/libresoc/tmp
  91     echo "libresoc" > /home/chroot/libresoc/etc/debian_chroot
  92
  93 To do some preparation (users):
  94
  95     chroot -c libresoc /bin/bash
  96     adduser {yourpreferredusername}
  97
  98 It is best to make the username the same as the first user that
  99 was added during the *main* (non-chroot) debian install, so that
 100 uid 1000 matches between both main and chroot.  You can check
 101 this by looking at /etc/passwd as root, or by typing "id".
 102
 103     lkcl@fizzy:~$ id
 104     uid=1000(lkcl) gid=1000(lkcl) groups=1000(lkcl),5(tty),....
 105
 106 Alternatively, /etc/passwd and /etc/group may
 107 be mount-bound as well as /home however if you later forget you did
 108 this and decide to delete the chroot, you will delete the entire /home
 109 of your main system, as well as /etc/passwd.
 110
 111 You may wish to follow some of the other things such as configuring apt,
 112 locales and keyboard, from the above-linked debian-admin HOWTO.
 113
 114 bootloader, kernel, ssh access, are unnecessary. Do run "apt clean"
 115 to clear out /var/cache/apt/archives in the chroot.
 116
 117
 118
 119
 120 Create an schroot file section for the libresoc chroot by
 121 editing /etc/schroot/schroot.conf:
 122
 123     [libresoc]
 124     description=Debian Buster for Coriolis
 125     directory=/home/chroot/libresoc
 126     groups=sbuild-security,lkcl,users
 127
 128 Now as an *ordinary* user - not as root - you may type:
 129
 130     lkcl@fizzy:~$ schroot -c libresoc
 131
 132 and, due to the contents of /etc/debian\_chroot, and that you were in
 133 fact logged in as uid 1000 and did in fact add a user to the chroot
 134 as uid 1000, the prompt should become:
 135
 136     (libresoc)lkcl@fizzy:~$
 137
 138 If however you need to run as root, then from outside the chroot,
 139 as *root*, you run this:
 140
 141     lkcl@fizzy:~# schroot -c libresoc
 142
 143 and you will see this as a result:
 144
 145     (libresoc)lkcl@fizzy:~#
 146