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