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, which is kinda important
  25 if you are going to drop USD 16 million on 7nm Mask Charges.
  26
  27     $ git clone https://git.libre-soc.org/git/dev-env-setup.git
  28     $ cd dev-env-setup
  29     $ sudo bash
  30     # ./mk-deb-chroot libresoc
  31     # ./cp-scripts-to-chroot libresoc # copies dev-env-setup to chroot
  32     # exit
  33     $ schroot -c libresoc
  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)# ./binutils-gdb-install    # needed for binutils-svp64
  40     (libresoc)# exit
  41     (libresoc)$
  42
  43 <https://git.libre-soc.org/?p=dev-env-setup.git;a=blob;f=hdl-dev-repos;hb=HEAD>
  44
  45 Additional scripts in the dev-env-setup repository will install yosys,
  46 verilator, coriolis2, ghdl, gdb and so on: from the above it is pretty
  47 straightforward and obvious to work out what to do (just run them).
  48 There is an accompanying walkthrough video which goes through the above
  49 <https://m.youtube.com/watch?v=1-4eJKTNrEk> and includes running some
  50 unit tests, explaining some of the background, and also files some bugs.
  51
  52 **You are now done, you need only read the rest below if interested
  53 to see how we made the above scripts**
  54
  55 =======
  56 =======
  57 =======
  58 =======
  59 =======
  60
  61 # Notes about Script "mk-deb-chroot"
  62
  63 This section is developer-notes **only** it documents the
  64 process by which mk-deb-chroot was established and explains
  65 its decisions and effect.
  66
  67 The script sets up an schroot debootstrap jail with debian 10.
  68 This chroot can then be used for nmigen, coriolis, or any other development.
  69 These instructions are based on information taken from here:
  70 <https://www.debian.org/releases/stretch/amd64/apds03.html.en>
  71
  72 The chroot name for this section is assumed to be "libresoc"
  73
  74 In advance, on the host system, edit /etc/fstab and add mount points:
  75
  76 (edit: personally I prefer using mount --bind points.  however if doing
  77 that then after a reboot the chroot will lose the bind mountpoints
  78 and the commands need to be re-run, without which the chroot is
  79 unusable)
  80
  81     /dev    /home/chroot/libresoc/dev   none    bind    0   0
  82     /dev/pts /home/chroot/libresoc/dev/pts  none    bind    0   0
  83     /proc   /home/chroot/libresoc/proc  none    bind    0   0
  84     /sys    /home/chroot/libresoc/sys   none    bind    0   0
  85     /tmp    /home/chroot/libresoc/tmp   none    bind    0   0
  86
  87 Then run these commands:
  88
  89     sudo bash
  90     apt-get install debootstrap schroot
  91     mkdir /opt/chroot/libresoc
  92     /usr/sbin/debootstrap buster !$ http://ftp.us.debian.org/debian
  93     mount /home/chroot/libresoc/dev
  94     mount /home/chroot/libresoc/dev/pts
  95     mount   /home/chroot/libresoc/proc
  96     mount   /home/chroot/libresoc/sys
  97     mount   /home/chroot/libresoc/tmp
  98     echo "libresoc" > /home/chroot/libresoc/etc/debian_chroot
  99
 100 To do some preparation (users):
 101
 102     chroot -c libresoc /bin/bash
 103     adduser {yourpreferredusername}
 104
 105 It is best to make the username the same as the first user that
 106 was added during the *main* (non-chroot) debian install, so that
 107 uid 1000 matches between both main and chroot.  You can check
 108 this by looking at /etc/passwd as root, or by typing "id".
 109
 110     lkcl@fizzy:~$ id
 111     uid=1000(lkcl) gid=1000(lkcl) groups=1000(lkcl),5(tty),....
 112
 113 Alternatively, /etc/passwd and /etc/group may
 114 be mount-bound as well as /home however if you later forget you did
 115 this and decide to delete the chroot, you will delete the entire /home
 116 of your main system, as well as /etc/passwd.
 117
 118 You may wish to follow some of the other things such as configuring apt,
 119 locales and keyboard, from the above-linked debian-admin HOWTO.
 120
 121 bootloader, kernel, ssh access, are unnecessary. Do run "apt clean"
 122 to clear out /var/cache/apt/archives in the chroot.
 123
 124
 125
 126
 127 Create an schroot file section for the libresoc chroot by
 128 editing /etc/schroot/schroot.conf:
 129
 130     [libresoc]
 131     description=Debian Buster for Coriolis
 132     directory=/home/chroot/libresoc
 133     groups=sbuild-security,lkcl,users
 134
 135 Now as an *ordinary* user - not as root - you may type:
 136
 137     lkcl@fizzy:~$ schroot -c libresoc
 138
 139 and, due to the contents of /etc/debian\_chroot, and that you were in
 140 fact logged in as uid 1000 and did in fact add a user to the chroot
 141 as uid 1000, the prompt should become:
 142
 143     (libresoc)lkcl@fizzy:~$
 144
 145 If however you need to run as root, then from outside the chroot,
 146 as *root*, you run this:
 147
 148     lkcl@fizzy:~# schroot -c libresoc
 149
 150 and you will see this as a result:
 151
 152     (libresoc)lkcl@fizzy:~#
 153