Replicant

h1. How to backup the data partition

{{toc}}

h2. /!\ Warning: Draft

This article is in draft form and is being written:

* Everybody is welcome to contribute

* Some things might not be accurate yet, so beware before using the information contained in it.

h2. What does the data partition contains?

See [[DataPartition]] for more details.

h2. Howto

h2. Reserve some space

The data partition is often big as it contains space for user data. For instance on the Galaxy SIII (GT-I9300), its size is about 11.5GiB for the 16GiB versions of that device.

If you don't need to know precisely how much space it's going to take, you could make sure that you have as much space as the internal storage. For instance for a Galaxy SIII (GT-I9300) with 16GiB of internal storage, just make sure you have 16GiB of free space.

If instead you need to know the size more precisely (here 11.5GiB), you could look if your device's page has that information in its @Partition@ section. For instance the [[GalaxySIIIGTI9300|Galaxy SIII (GT-I9300)]] wiki page has a [[GalaxySIIIGTI9300#Partitions|Partitions section]] with the relevant information, but only for the 16GiB version of that device.

h3. Setup ADB

Follow the instructions for [[ADB|setting up ADB on your computer]] so that you can access a root shell on your device.

*NOTE*: when prompted on your Replicant device, make sure that you check the box that says *Always allow from this computer* when you grant your computer USB debugging permissions. Otherwise, you will be unable to obtain root shell access on your Replicant device when you reboot it into the recovery OS to actually perform the backup.

*NOTE*: for security reasons, you may want to [[ADB#Revoking-all-computers-USB-debugging-permissions|revoke these non-expiring permissions]] once the backup is complete.

h3. Reboot into the recovery

To reboot in the recovery, you can follow the instructions in the [[RebootIntoTheRecovery]] wiki page.

h3. Making sure that the data partition isn't mounted

First, you need to make sure that the data partition is not mounted. 

To do that, you can run this command:

<pre>

adb shell "umount -l /data"

</pre>

If the /data partition was mounted, it will unmount it, and your command and its output will look more or less like that:

<pre>

$ adb shell "umount -l /data"

$ 

</pre>

If it was not mounted, it will instead show an error that we can ignore. In this case your command and its output will look more or less like that:

<pre>

$ adb shell "umount -l /data"

umount: /data: Invalid argument

</pre>

h3. Backuping the data partition

Once we verified that the data partition isn't mounted, we can finally backup the partition.

h4. Galaxy S III (GT-I9300)

For the Galaxy S III (GT-I9300), you can use the following command:

<pre>

adb pull /dev/block/platform/dw_mmc/by-name/USERDATA ./USERDATA.img

</pre>

h4. Other devices.

We don't have instructions yet for other devices yet.

Feel free to request instructions for the device you have on IRC, the mailing list, or to add the instructions here if you're confortable enough with the command line.

h2. Using the backup

h3. Restoring the partition

Before we did command like that to backup the device:

<pre>

adb pull /dev/block/platform/dw_mmc/by-name/USERDATA ./USERDATA.img

</pre>

However if we use the following command:

<pre>

adb push USERDATA.img /dev/block/platform/dw_mmc/by-name/USERDATA

</pre>

It will fail to write any data to the partition: Instead of writing to it, it deletes the @/dev/block/platform/dw_mmc/by-name/USERDATA@ symlink and recreate a file at the same path with the data from USERDATA.img.

Since no data is being written on the disk, it most often ends up exhausting the ramdisk of the recovery (which is smaller than the data partition) and we are left with this error:

<pre>

adb: error: failed to copy 'USERDATA.img' to '/dev/block/platform/dw_mmc/by-name/USERDATA': remote No space left on device

USERDATA.img: 0 files pushed. 4.3 MB/s (436154368 bytes in 96.842s)

</pre>

So to avoid that we will the path that symlink points to.

We can get the symlink path with the following command:

<pre>

adb shell "readlink /dev/block/platform/dw_mmc/by-name/USERDATA"

</pre>

Here for the Galaxy SIII (GT-I9300), it gives the following:

<pre>

/dev/block/mmcblk0p12

</pre>

You will then need to down the result (here @/dev/block/mmcblk0p12@) as we will reuse it later.

You should also really not skip that part, and make sure that the commands above didn't output any error. 

If you skip that and for instance blindly use @/dev/block/mmcblk0p12@ because it's written above, you could end up breaking your device because some partitions are really needed for the device to work.

This is also why we have backup instructions (like [[BackupTheEFS]] ) to backup important partitions, however other partitions than the EFS are probably crucial too (but less susceptible to data corruption).

So to restore the data partition, you could use the following command:

<pre>

adb push USERDATA.img /dev/block/PARTITION

</pre>

Make sure to replace @/dev/block/PARTITON@ with the data you just wrote down. The example above uses @/dev/block/mmcblk0p12@, but it might differ for your device, so make sure to replace @/dev/block/mmcblk0p12@ with the result you got on your device.

If everything goes fine, the output of the command above should look like this:

<pre>

USERDATA.img: 1 file pushed. 3.6 MB/s (1760559104 bytes in 466.067s)

</pre>

h3. Restoring individual application data.

Here we will use the @udisksctl@ command instead of the more classical @mount@ and @losetup@ as it integrates better with graphical environments like Gnome or KDE.

As the partition backup is now in a file, to access its data we will make it available as a partition again. This can be done with the following command:

<pre>

udisksctl loop-setup -f  USERDATA.img

</pre>

If that doesn't work you might need to use @sudo@ like that:

<pre>

sudo udisksctl loop-setup -f  USERDATA.img

</pre>

Or you may also need to verify that your current users has the right to read and write the file that contains the partition (here USERDATA.img) file.

If this works, it should produce an output that looks more or less like that:

<pre>

Mapped file USERDATA.img as /dev/loop0.

</pre>

Here you can see that it made the file content available in the @/dev/loop0@ partition. 

We can then reuse this information to mount that partition. We can do that with the following command:

<pre>

udisksctl mount -b /dev/loop0 -o ro

</pre>

The @-o ro@ option will make sure that the partition is mounted in read only mode. This will make sure that we don't accidentally change its content.

The command above should produce an output that looks more or less like that:

<pre>

Mounted /dev/loop0 at /run/media/gnutoo/2Of967c7-ac7e-7ae0-ef5b-30f0b6e2dc41

</pre>

It most probably change a bit from the output above as:

* Your username is probably not @gnutoo@.

* The @2Of967c7-ac7e-7ae0-ef5b-30f0b6e2dc41@ is a randomly created identifier for the partition that is created when formatting it.

* Even @/run/media/@ can change depending on the GNU/Linux distribution and its version. For instance between Parabola and Trisquel 8 it is different.

You can write down the location of the directory where this partition is mounted (here @/run/media/gnutoo/2Of967c7-ac7e-7ae0-ef5b-30f0b6e2dc41@) as we will need it later on.

We will also reuse the partition location (here @/dev/loop0@) at the end.

Now that this partition is mounted, we will be able to use the RestoreApplicationInternalData tutorial to make a backup of the data of a specific application and restore it.

To do that, locate the following command in the [[RestoreApplicationInternalData#Backuping-Silences-data-from-the-old-device|Backuping Silence's data from the old device]] section of the RestoreApplicationInternalData wiki page:

<pre>

cd /data/data

</pre>

You will then need to replace it by a command that looks like that:

<pre>

cd /run/media/gnutoo/2Of967c7-ac7e-7ae0-ef5b-30f0b6e2dc41/data/

</pre>

In the command above, you'll need to replace @/run/media/gnutoo/2Of967c7-ac7e-7ae0-ef5b-30f0b6e2dc41/@ by the location of the directory where the partition is mounted.

In addition you might not have the permissions to access the applications data. 

For instance we can look at the permissions of the silence data with the following command:

<pre>

ls -ld org.smssecure.smssecure/

</pre>

And it should give you something that looks more or less like that:

<pre>

drwxr-x--x 9 10063 10063 4096 26 oct.  19:44 org.smssecure.smssecure/

</pre>

See the [[RestoreApplicationInternalData#How-to-find-which-directory-holds-the-internal-data-of-an-application|How to find which directory holds the internal data of an application]] section in the RestoreApplicationInternalData wiki page for more details to understand why @org.smssecure.smssecure@ directory has the Silence application's data.

In the output above, the first @10063@ is the user ID and the second @10063@ is the group id. 

This is because Android sandboxes applications as part of their security model: each applications run in their own user and group ID. The result is that theses are most likely present on your phone but not on your GNU/Linux computer.

To fix that you can become root with the following command:

<pre>

sudo su

</pre>

Now you can then continue to follow the RestoreApplicationInternalData tutorial.

h4. Unmount and close the loop

Once you are finished with the RestoreApplicationInternalData tutorial, it would be a good idea to umount the data partition and make it inaccessible again.

To umount the data partition we can use a command that looks like that:

<pre>

udisksctl unmount -b /dev/loop0

</pre>

Here the @/dev/loop0@ may differ, so make sure to use the partition location you used earlier.

The output of that command will look like that:

<pre>

Unmounted /dev/loop0.

</pre>

Once it is unmounted you can make it inaccessible again with the following command:

<pre>

udisksctl unmount -b /dev/loop0

</pre>

Again here may will need to replace @/dev/loop0@ by your partition location if it differs.

The output of that command should then show something that looks like that:

<pre>

Unmounted /dev/loop0.

</pre>

h2. See also

* The [[BackupsResearch]] page has information on why the backup is done this way. It might also be useful to read and contribute to it if you intend to change the way the backups are done.