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